Skip to content

Commit 10c152b

Browse files
jsalwenjsalwen
committed
update doco
1 parent b4aea4a commit 10c152b

10 files changed

+34
-34
lines changed

‎docs/v1/query/get_fulfillment_grouped_messages.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To get the messages in their native format, use [`getFulfillmentMessages`](get_f
3434
### Grouping Cards
3535
```js
3636
const dfUtils = require('dialogflow-api-utils').v1
37-
var dialogFlowResponse = {
37+
var dfQueryResponse = {
3838
"result": {
3939
"fulfillment": {
4040
"speech": "hi",
@@ -68,7 +68,7 @@ var dialogFlowResponse = {
6868
}
6969
}
7070

71-
var messages = dfUtils.Query.getFulfillmentGroupedMessages(dialogFlowResponse)
71+
var messages = dfUtils.Query.getFulfillmentGroupedMessages(dfQueryResponse)
7272
```
7373
`messages` value
7474
@@ -106,7 +106,7 @@ notes: the 2 Card Message objects are grouped into a single Card set
106106
### Filter Messages
107107
```js
108108
const dfUtils = require('dialogflow-api-utils').v1
109-
var dialogFlowResponse = {
109+
var dfQueryResponse = {
110110
"result": {
111111
"fulfillment": {
112112
"speech": "hi",
@@ -155,7 +155,7 @@ var dialogFlowResponse = {
155155
}
156156
}
157157

158-
var filteredMessages = dfUtils.Query.getFulfillmentGroupedMessages(dialogFlowResponse, 'facebook')
158+
var filteredMessages = dfUtils.Query.getFulfillmentGroupedMessages(dfQueryResponse, 'facebook')
159159
```
160160
`filteredMessages` value
161161

‎docs/v1/query/get_fulfillment_messages.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The Dialogflow [`/query`](https://dialogflow.com/docs/reference/agent/query#get_
3030
## Examples
3131
```js
3232
const dfUtils = require('dialogflow-api-utils').v1
33-
var dialogFlowResponse = {
33+
var dfQueryResponse = {
3434
"result": {
3535
"fulfillment": {
3636
"speech": "hi",
@@ -64,7 +64,7 @@ var dialogFlowResponse = {
6464
}
6565
}
6666

67-
var messages = dfUtils.Query.getFulfillmentMessages(dialogFlowResponse)
67+
var messages = dfUtils.Query.getFulfillmentMessages(dfQueryResponse)
6868
```
6969
`messages` value
7070
@@ -100,7 +100,7 @@ var messages = dfUtils.Query.getFulfillmentMessages(dialogFlowResponse)
100100
### Filter Messages
101101
```js
102102
const dfUtils = require('dialogflow-api-utils').v1
103-
var dialogFlowResponse = {
103+
var dfQueryResponse = {
104104
"result": {
105105
"fulfillment": {
106106
"speech": "hi",
@@ -149,7 +149,7 @@ var dialogFlowResponse = {
149149
}
150150
}
151151

152-
var filteredMessages = dfUtils.Query.getFulfillmentMessages(dialogFlowResponse, 'facebook')
152+
var filteredMessages = dfUtils.Query.getFulfillmentMessages(dfQueryResponse, 'facebook')
153153
```
154154
`filteredMessages` value
155155

‎docs/v1/query/get_response_context.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A helper method which always returns an object. `getResponseContext` either retu
3131
3232
```js
3333
const dfUtils = require('dialogflow-api-utils').v1
34-
var dialogFlowResponse = {
34+
var dfQueryResponse = {
3535
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3636
"timestamp": "2017-04-14T16:04:44.343Z",
3737
"lang": "en",
@@ -84,9 +84,9 @@ var dialogFlowResponse = {
8484
},
8585
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
8686
}
87-
var result = dfUtils.Query.getResponseContext(dialogFlowResponse, 'profile')
87+
var context = dfUtils.Query.getResponseContext(dfQueryResponse, 'profile')
8888
```
89-
`result` value
89+
`context` value
9090
9191
```js
9292
{

‎docs/v1/query/get_response_context_parameters.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A helper method which always returns an object. `getResponseContextParameters` e
3030
3131
```js
3232
const dfUtils = require('dialogflow-api-utils').v1
33-
var dialogFlowResponse = {
33+
var dfQueryResponse = {
3434
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3535
"timestamp": "2017-04-14T16:04:44.343Z",
3636
"lang": "en",
@@ -83,9 +83,9 @@ var dialogFlowResponse = {
8383
},
8484
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
8585
}
86-
var result = dfUtils.Query.getResponseContext(dialogFlowResponse, 'profile')
86+
var params = dfUtils.Query.getResponseContextParameters(dfQueryResponse, 'profile')
8787
```
88-
`result` value
88+
`params` value
8989
9090
```js
9191
{

‎docs/v1/query/get_response_contexts.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A helper method which always returns an array. `getResponseContexts` either retu
3131
### Get all Contexts
3232
```js
3333
const dfUtils = require('dialogflow-api-utils').v1
34-
var dialogFlowResponse = {
34+
var dfQueryResponse = {
3535
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3636
"timestamp": "2017-04-14T16:04:44.343Z",
3737
"lang": "en",
@@ -84,9 +84,9 @@ var dialogFlowResponse = {
8484
},
8585
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
8686
}
87-
var result = dfUtils.Query.getResponseContexts(dialogFlowResponse)
87+
var contexts = dfUtils.Query.getResponseContexts(dfQueryResponse)
8888
```
89-
`result` value
89+
`contexts` value
9090
9191
```js
9292
[{
@@ -114,7 +114,7 @@ var result = dfUtils.Query.getResponseContexts(dialogFlowResponse)
114114
### Get set of Contexts
115115
```js
116116
const dfUtils = require('dialogflow-api-utils').v1
117-
var dialogFlowResponse = {
117+
var dfQueryResponse = {
118118
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
119119
"timestamp": "2017-04-14T16:04:44.343Z",
120120
"lang": "en",
@@ -175,9 +175,9 @@ var dialogFlowResponse = {
175175
},
176176
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
177177
}
178-
var result = dfUtils.Query.getResponseContexts(dialogFlowResponse, '^profile')
178+
var contexts = dfUtils.Query.getResponseContexts(dfQueryResponse, '^profile')
179179
```
180-
`result` value
180+
`contexts` value
181181
182182
```js
183183
[{

‎docs/v1/query/get_response_fulfillment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A helper method which always returns an object. `getResponseFulfillment` either
2727
## Examples
2828
```js
2929
const dfUtils = require('dialogflow-api-utils').v1
30-
var dialogFlowResponse = {
30+
var dfQueryResponse = {
3131
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3232
"timestamp": "2017-04-14T16:04:44.343Z",
3333
"lang": "en",
@@ -72,7 +72,7 @@ var dialogFlowResponse = {
7272
},
7373
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
7474
}
75-
var fulfillment = dfUtils.Query.getResponseFulfillment(dialogFlowResponse)
75+
var fulfillment = dfUtils.Query.getResponseFulfillment(dfQueryResponse)
7676
```
7777
`fulfillment` value
7878

‎docs/v1/query/get_response_result.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A helper method which always returns an object. `getResponseResult` either retur
2727
## Examples
2828
```js
2929
const dfUtils = require('dialogflow-api-utils').v1
30-
var dialogFlowResponse = {
30+
var dfQueryResponse = {
3131
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3232
"timestamp": "2017-04-14T16:04:44.343Z",
3333
"lang": "en",
@@ -72,7 +72,7 @@ var dialogFlowResponse = {
7272
},
7373
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
7474
}
75-
var result = dfUtils.Query.getResponseResult(dialogFlowResponse)
75+
var result = dfUtils.Query.getResponseResult(dfQueryResponse)
7676
```
7777
`result` value
7878

‎docs/v1/query/get_result_parameter.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A helper method which always returns an object. `getResultParameter` either retu
3535
### Get a Parameter with a value
3636
```js
3737
const dfUtils = require('dialogflow-api-utils').v1
38-
var dialogFlowResponse = {
38+
var dfQueryResponse = {
3939
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
4040
"timestamp": "2017-04-14T16:04:44.343Z",
4141
"lang": "en",
@@ -88,7 +88,7 @@ var dialogFlowResponse = {
8888
},
8989
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
9090
}
91-
var paramValue = dfUtils.Query.getResultParameter(dialogFlowResponse, 'address', '')
91+
var paramValue = dfUtils.Query.getResultParameter(dfQueryResponse, 'address', '')
9292
```
9393
`paramValue` value
9494
@@ -98,7 +98,7 @@ var paramValue = dfUtils.Query.getResultParameter(dialogFlowResponse, 'address',
9898
### Get a missing parameter
9999
```js
100100
const dfUtils = require('dialogflow-api-utils').v1
101-
var dialogFlowResponse = {
101+
var dfQueryResponse = {
102102
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
103103
"timestamp": "2017-04-14T16:04:44.343Z",
104104
"lang": "en",
@@ -151,10 +151,10 @@ var dialogFlowResponse = {
151151
},
152152
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
153153
}
154-
var paramValue1 = dfUtils.Query.getResultParameter(dialogFlowResponse, 'city', 'Washington')
155-
var paramValue2 = dfUtils.Query.getResultParameter(dialogFlowResponse, 'city', null)
154+
var paramValue1 = dfUtils.Query.getResultParameter(dfQueryResponse, 'city', 'Washington')
155+
var paramValue2 = dfUtils.Query.getResultParameter(dfQueryResponse, 'city', null)
156156
```
157-
`paramValue1` value
157+
values
158158
159159
```js
160160
// paramValue1 value

‎docs/v1/query/get_result_parameters.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A helper method which always returns an object. `getResultParameters` either ret
2828
2929
```js
3030
const dfUtils = require('dialogflow-api-utils').v1
31-
var dialogFlowResponse = {
31+
var dfQueryResponse = {
3232
"id": "119a93ae-0e20-4df9-a595-97c239205de1",
3333
"timestamp": "2017-04-14T16:04:44.343Z",
3434
"lang": "en",
@@ -81,7 +81,7 @@ var dialogFlowResponse = {
8181
},
8282
"sessionId": "1ad23fa6-7758-4cf6-8525-c88a08c87293"
8383
}
84-
var parameters = dfUtils.Query.getResultParameters(dialogFlowResponse)
84+
var parameters = dfUtils.Query.getResultParameters(dfQueryResponse)
8585
```
8686
`parameters` value
8787

‎docs/v1/query/merge_contexts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# mergeContexts
2-
The `mergeContexts()` method is used to merge two arrays of `context` objects.
2+
The `mergeContexts()` method is used to merge two `Array`s of `context` objects.
33

44
## Synopsis
5-
Returns an array of `context` objects.
5+
Returns an `Array` of `context` objects.
66

77
## Syntax
88

0 commit comments

Comments
 (0)