You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/dialogflow_v2.projects.agent.knowledgeBases.documents.html
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -138,6 +138,7 @@ <h3>Method Details</h3>
138
138
"mimeType": "A String", # Required. The MIME type of this document.
139
139
"name": "A String", # Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.
140
140
"rawContent": "A String", # The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
141
+
"state": "A String", # Output only. The current state of the document.
141
142
}
142
143
143
144
x__xgafv: string, V1 error format.
@@ -243,6 +244,7 @@ <h3>Method Details</h3>
243
244
"mimeType": "A String", # Required. The MIME type of this document.
244
245
"name": "A String", # Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.
245
246
"rawContent": "A String", # The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
247
+
"state": "A String", # Output only. The current state of the document.
246
248
}</pre>
247
249
</div>
248
250
@@ -290,6 +292,7 @@ <h3>Method Details</h3>
290
292
"mimeType": "A String", # Required. The MIME type of this document.
291
293
"name": "A String", # Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.
292
294
"rawContent": "A String", # The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
295
+
"state": "A String", # Output only. The current state of the document.
293
296
},
294
297
],
295
298
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
@@ -344,6 +347,7 @@ <h3>Method Details</h3>
344
347
"mimeType": "A String", # Required. The MIME type of this document.
345
348
"name": "A String", # Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.
346
349
"rawContent": "A String", # The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
350
+
"state": "A String", # Output only. The current state of the document.
347
351
}
348
352
349
353
updateMask: string, Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.
<pclass="firstline">Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportConversationDataOperationMetadata - `response`: ImportConversationDataOperationResponse</p>
<pre>Retrieves the specified conversation dataset.
101
+
102
+
Args:
103
+
name: string, Required. The conversation dataset to retrieve. Format: `projects//locations//conversationDatasets/` (required)
104
+
x__xgafv: string, V1 error format.
105
+
Allowed values
106
+
1 - v1 error format
107
+
2 - v2 error format
108
+
109
+
Returns:
110
+
An object of the form:
111
+
112
+
{ # Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).
113
+
"conversationCount": "A String", # Output only. The number of conversations this conversation dataset contains.
114
+
"conversationInfo": { # Represents metadata of a conversation. # Output only. Metadata set during conversation data import.
115
+
"languageCode": "A String", # Optional. The language code of the conversation data within this dataset. See https://cloud.google.com/apis/design/standard_fields for more information. Supports all UTF-8 languages.
116
+
},
117
+
"createTime": "A String", # Output only. Creation time of this dataset.
118
+
"description": "A String", # Optional. The description of the dataset. Maximum of 10000 bytes.
119
+
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 bytes.
120
+
"inputConfig": { # Represents the configuration of importing a set of conversation files in Google Cloud Storage. # Output only. Input configurations set during conversation data import.
121
+
"gcsSource": { # Google Cloud Storage location for the inputs. # The Cloud Storage URI has the form gs:////agent*.json. Wildcards are allowed and will be expanded into all matched JSON files, which will be read as one conversation per file.
122
+
"uris": [ # Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.
<pre>Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportConversationDataOperationMetadata - `response`: ImportConversationDataOperationResponse
{ # The request message for ConversationDatasets.ImportConversationData.
141
+
"inputConfig": { # Represents the configuration of importing a set of conversation files in Google Cloud Storage. # Required. Configuration describing where to import data from.
142
+
"gcsSource": { # Google Cloud Storage location for the inputs. # The Cloud Storage URI has the form gs:////agent*.json. Wildcards are allowed and will be expanded into all matched JSON files, which will be read as one conversation per file.
143
+
"uris": [ # Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.
144
+
"A String",
145
+
],
146
+
},
147
+
},
148
+
}
149
+
150
+
x__xgafv: string, V1 error format.
151
+
Allowed values
152
+
1 - v1 error format
153
+
2 - v2 error format
154
+
155
+
Returns:
156
+
An object of the form:
157
+
158
+
{ # This resource represents a long-running operation that is the result of a network API call.
159
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
160
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
161
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
162
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
163
+
{
164
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
165
+
},
166
+
],
167
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
168
+
},
169
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
170
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
171
+
},
172
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
173
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
174
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Returns the list of all conversation datasets in the specified project and location.
182
+
183
+
Args:
184
+
parent: string, Required. The project and location name to list all conversation datasets for. Format: `projects//locations/` (required)
185
+
pageSize: integer, Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.
186
+
pageToken: string, Optional. The next_page_token value returned from a previous list request.
187
+
x__xgafv: string, V1 error format.
188
+
Allowed values
189
+
1 - v1 error format
190
+
2 - v2 error format
191
+
192
+
Returns:
193
+
An object of the form:
194
+
195
+
{ # The response message for ConversationDatasets.ListConversationDatasets.
196
+
"conversationDatasets": [ # The list of datasets to return.
197
+
{ # Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).
198
+
"conversationCount": "A String", # Output only. The number of conversations this conversation dataset contains.
199
+
"conversationInfo": { # Represents metadata of a conversation. # Output only. Metadata set during conversation data import.
200
+
"languageCode": "A String", # Optional. The language code of the conversation data within this dataset. See https://cloud.google.com/apis/design/standard_fields for more information. Supports all UTF-8 languages.
201
+
},
202
+
"createTime": "A String", # Output only. Creation time of this dataset.
203
+
"description": "A String", # Optional. The description of the dataset. Maximum of 10000 bytes.
204
+
"displayName": "A String", # Required. The display name of the dataset. Maximum of 64 bytes.
205
+
"inputConfig": { # Represents the configuration of importing a set of conversation files in Google Cloud Storage. # Output only. Input configurations set during conversation data import.
206
+
"gcsSource": { # Google Cloud Storage location for the inputs. # The Cloud Storage URI has the form gs:////agent*.json. Wildcards are allowed and will be expanded into all matched JSON files, which will be read as one conversation per file.
207
+
"uris": [ # Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.
"nextPageToken": "A String", # The token to use to retrieve the next page of results, or empty if there are no more results in the list.
0 commit comments