Skip to content

Commit 1c99d74

Browse files
authored
Update README.md (dialogflow#10)
Clarify and clear up README
1 parent 2781a7e commit 1c99d74

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

samples/README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ To get started, [download][maven-download] and [install][maven-install] it.
3434
```bash
3535
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your-project-credentials.json
3636
```
37+
* To run tests, set GOOGLE_CLOUD_PROJECT to your PROJECT_ID:
38+
```
39+
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
40+
```
41+
```
42+
mvn clean verify
43+
```
3744
* Set PROJECT_ID in pom.xml to your Google Cloud Project Id.
45+
* Set SESSION_ID in pom.xml to a session name of your choice. (Defaults to SESSION_ID)
46+
* Set CONTEXT_ID in pom.xml to a context name of your choice. (Defaults to CONTEXT_ID)
3847
3948
[cloud-console]: https://console.cloud.google.com
4049
[dialogflow-api]: https://pantheon.corp.google.com/apis/library/dialogflow.googleapis.com
@@ -69,6 +78,7 @@ mvn exec:java -DDetectIntentTexts
6978
DialogFlow API Detect Intent sample with audio files. Returns the result of detect intent with an
7079
audio file as input.
7180

81+
Note: Execute the following commands in order to yield reasonable outputs.
7282
```
7383
mvn exec:java -DDetectIntentAudioBookARoom
7484
```
@@ -101,15 +111,15 @@ mvn exec:java -DDetectIntentStreamMountainView
101111
### Context Management
102112
DialogFlow API Context sample.
103113

104-
Lists contexts:
114+
Lists contexts
105115
```
106116
mvn exec:java -DContextManagementList
107117
```
108-
Create an entity type with the given display name:
118+
Create an entity type
109119
```
110120
mvn exec:java -DContextManagementCreate
111121
```
112-
Delete entity type with the given entity type name:
122+
Delete entity type
113123
```
114124
mvn exec:java -DContextManagementDelete
115125
```
@@ -121,11 +131,11 @@ List entities
121131
```
122132
mvn exec:java -DEntityManagementList
123133
```
124-
Create an entity of the given entity type
134+
Create an entity
125135
```
126136
mvn exec:java -DEntityManagementCreate
127137
```
128-
Delete entity with the given entity type and entity value
138+
Delete entity
129139
```
130140
mvn exec:java -DEntityManagementDelete
131141
```
@@ -137,11 +147,11 @@ List entity types
137147
```
138148
mvn exec:java -DEntityTypeManagementList
139149
```
140-
Create an entity type with the given display name
150+
Create an entity type
141151
```
142152
mvn exec:java -DEntityTypeManagementCreate
143153
```
144-
Delete entity type with the given entity type name
154+
Delete entity type
145155
```
146156
mvn exec:java -DEntityTypeManagementDelete
147157
```
@@ -153,11 +163,11 @@ List intents
153163
```
154164
mvn exec:java -DIntentManagementList
155165
```
156-
Create an intent of the given intent type
166+
Create an intent
157167
```
158168
mvn exec:java -DIntentManagementCreate
159169
```
160-
Delete intent with the given intent type and intent value
170+
Delete intent
161171
```
162172
mvn exec:java -DIntentManagementDelete
163173
```
@@ -169,11 +179,11 @@ List session entity types
169179
```
170180
mvn exec:java -DSessionEntityTypeManagementList
171181
```
172-
Create an entity type with the given display name
182+
Create session entity type
173183
```
174184
mvn exec:java -DSessionEntityTypeManagementCreate
175185
```
176-
Delete entity type with the given entity type name
186+
Delete session entity type
177187
```
178188
mvn exec:java -DSessionEntityTypeManagementDelete
179189
```

0 commit comments

Comments
 (0)