docs: update generated docs (#981)
diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
index 320daad..a29ef23 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
@@ -109,77 +109,80 @@
body: object, The request body.
The object takes the form of:
-{ # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "rawContent": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
- # (at a time picked by the system). If false or unspecified, we don't try
- # to automatically reload the document.
+{ # A knowledge document to be used by a KnowledgeBase.
#
- # Currently you can only enable automatic reload for documents sourced from
- # a public url, see `source` field for the source types.
+ # For more information, see the [knowledge base
+ # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
#
- # Reload status can be tracked in `latest_reload_status`. If a reload
- # fails, we will keep the document unchanged.
- #
- # If a reload fails with internal errors, the system will try to reload the
- # document on the next day.
- # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
- # system will not try to reload the document anymore. You need to manually
- # reload the document successfully by calling `ReloadDocument` and clear the
- # errors.
- "contentUri": "A String", # The URI where the file content is located.
- #
- # For documents stored in Google Cloud Storage, these URIs must have
- # the form `gs://<bucket-name>/<object-name>`.
- #
- # NOTE: External URLs must correspond to public webpages, i.e., they must
- # be indexed by Google Search. In particular, URLs for showing documents in
- # Google Cloud Storage (i.e. the URL in your browser) are not supported.
- # Instead use the `gs://` format URI described above.
- "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
- # This reload may have been triggered automatically or manually
- # and may not have succeeded.
- "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
+ # less; otherwise, the creation request fails.
+ "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
+ # (at a time picked by the system). If false or unspecified, we don't try
+ # to automatically reload the document.
+ #
+ # Currently you can only enable automatic reload for documents sourced from
+ # a public url, see `source` field for the source types.
+ #
+ # Reload status can be tracked in `latest_reload_status`. If a reload
+ # fails, we will keep the document unchanged.
+ #
+ # If a reload fails with internal errors, the system will try to reload the
+ # document on the next day.
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
+ # system will not try to reload the document anymore. You need to manually
+ # reload the document successfully by calling `ReloadDocument` and clear the
+ # errors.
+ "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
+ # This reload may have been triggered automatically or manually
+ # and may not have succeeded.
+ "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "time": "A String", # Output only. The time of a reload attempt.
+ # This reload may have been triggered automatically or manually and may
+ # not have succeeded.
},
- "time": "A String", # Output only. The time of a reload attempt.
- # This reload may have been triggered automatically or manually and may
- # not have succeeded.
- },
- "name": "A String", # Optional. The document resource name.
- # The name must be empty when creating a document.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "content": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- # Note: This field is in the process of being deprecated, please use
- # raw_content instead.
- "mimeType": "A String", # Required. The MIME type of this document.
-}
+ "content": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ # Note: This field is in the process of being deprecated, please use
+ # raw_content instead.
+ "knowledgeTypes": [ # Required. The knowledge type of document content.
+ "A String",
+ ],
+ "contentUri": "A String", # The URI where the file content is located.
+ #
+ # For documents stored in Google Cloud Storage, these URIs must have
+ # the form `gs://<bucket-name>/<object-name>`.
+ #
+ # NOTE: External URLs must correspond to public webpages, i.e., they must
+ # be indexed by Google Search. In particular, URLs for showing documents in
+ # Google Cloud Storage (i.e. the URL in your browser) are not supported.
+ # Instead use the `gs://` format URI described above.
+ "mimeType": "A String", # Required. The MIME type of this document.
+ "name": "A String", # Optional. The document resource name.
+ # The name must be empty when creating a document.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "rawContent": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -194,33 +197,6 @@
"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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
"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
@@ -231,6 +207,33 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -258,33 +261,6 @@
"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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
"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
@@ -295,6 +271,33 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -317,77 +320,80 @@
Returns:
An object of the form:
- { # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "rawContent": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
- # (at a time picked by the system). If false or unspecified, we don't try
- # to automatically reload the document.
+ { # A knowledge document to be used by a KnowledgeBase.
#
- # Currently you can only enable automatic reload for documents sourced from
- # a public url, see `source` field for the source types.
+ # For more information, see the [knowledge base
+ # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
#
- # Reload status can be tracked in `latest_reload_status`. If a reload
- # fails, we will keep the document unchanged.
- #
- # If a reload fails with internal errors, the system will try to reload the
- # document on the next day.
- # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
- # system will not try to reload the document anymore. You need to manually
- # reload the document successfully by calling `ReloadDocument` and clear the
- # errors.
- "contentUri": "A String", # The URI where the file content is located.
- #
- # For documents stored in Google Cloud Storage, these URIs must have
- # the form `gs://<bucket-name>/<object-name>`.
- #
- # NOTE: External URLs must correspond to public webpages, i.e., they must
- # be indexed by Google Search. In particular, URLs for showing documents in
- # Google Cloud Storage (i.e. the URL in your browser) are not supported.
- # Instead use the `gs://` format URI described above.
- "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
- # This reload may have been triggered automatically or manually
- # and may not have succeeded.
- "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
- # 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.
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
+ # less; otherwise, the creation request fails.
+ "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
+ # (at a time picked by the system). If false or unspecified, we don't try
+ # to automatically reload the document.
#
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # Currently you can only enable automatic reload for documents sourced from
+ # a public url, see `source` field for the source types.
+ #
+ # Reload status can be tracked in `latest_reload_status`. If a reload
+ # fails, we will keep the document unchanged.
+ #
+ # If a reload fails with internal errors, the system will try to reload the
+ # document on the next day.
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
+ # system will not try to reload the document anymore. You need to manually
+ # reload the document successfully by calling `ReloadDocument` and clear the
+ # errors.
+ "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
+ # This reload may have been triggered automatically or manually
+ # and may not have succeeded.
+ "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "time": "A String", # Output only. The time of a reload attempt.
+ # This reload may have been triggered automatically or manually and may
+ # not have succeeded.
},
- "time": "A String", # Output only. The time of a reload attempt.
- # This reload may have been triggered automatically or manually and may
- # not have succeeded.
- },
- "name": "A String", # Optional. The document resource name.
- # The name must be empty when creating a document.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "content": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- # Note: This field is in the process of being deprecated, please use
- # raw_content instead.
- "mimeType": "A String", # Required. The MIME type of this document.
- }</pre>
+ "content": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ # Note: This field is in the process of being deprecated, please use
+ # raw_content instead.
+ "knowledgeTypes": [ # Required. The knowledge type of document content.
+ "A String",
+ ],
+ "contentUri": "A String", # The URI where the file content is located.
+ #
+ # For documents stored in Google Cloud Storage, these URIs must have
+ # the form `gs://<bucket-name>/<object-name>`.
+ #
+ # NOTE: External URLs must correspond to public webpages, i.e., they must
+ # be indexed by Google Search. In particular, URLs for showing documents in
+ # Google Cloud Storage (i.e. the URL in your browser) are not supported.
+ # Instead use the `gs://` format URI described above.
+ "mimeType": "A String", # Required. The MIME type of this document.
+ "name": "A String", # Optional. The document resource name.
+ # The name must be empty when creating a document.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "rawContent": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ }</pre>
</div>
<div class="method">
@@ -400,8 +406,8 @@
Args:
parent: string, Required. The knowledge base to list all documents for.
Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
- pageToken: string, Optional. The next_page_token value returned from a previous list request.
- pageSize: integer, Optional. The maximum number of items to return in a single page. By
+ pageToken: string, The next_page_token value returned from a previous list request.
+ pageSize: integer, The maximum number of items to return in a single page. By
default 10 and at most 100.
x__xgafv: string, V1 error format.
Allowed values
@@ -412,81 +418,84 @@
An object of the form:
{ # Response message for Documents.ListDocuments.
- "documents": [ # The list of documents.
- { # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "rawContent": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
- # (at a time picked by the system). If false or unspecified, we don't try
- # to automatically reload the document.
- #
- # Currently you can only enable automatic reload for documents sourced from
- # a public url, see `source` field for the source types.
- #
- # Reload status can be tracked in `latest_reload_status`. If a reload
- # fails, we will keep the document unchanged.
- #
- # If a reload fails with internal errors, the system will try to reload the
- # document on the next day.
- # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
- # system will not try to reload the document anymore. You need to manually
- # reload the document successfully by calling `ReloadDocument` and clear the
- # errors.
- "contentUri": "A String", # The URI where the file content is located.
- #
- # For documents stored in Google Cloud Storage, these URIs must have
- # the form `gs://<bucket-name>/<object-name>`.
- #
- # NOTE: External URLs must correspond to public webpages, i.e., they must
- # be indexed by Google Search. In particular, URLs for showing documents in
- # Google Cloud Storage (i.e. the URL in your browser) are not supported.
- # Instead use the `gs://` format URI described above.
- "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
- # This reload may have been triggered automatically or manually
- # and may not have succeeded.
- "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "time": "A String", # Output only. The time of a reload attempt.
- # This reload may have been triggered automatically or manually and may
- # not have succeeded.
- },
- "name": "A String", # Optional. The document resource name.
- # The name must be empty when creating a document.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "content": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- # Note: This field is in the process of being deprecated, please use
- # raw_content instead.
- "mimeType": "A String", # Required. The MIME type of this document.
- },
- ],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
# more results in the list.
+ "documents": [ # The list of documents.
+ { # A knowledge document to be used by a KnowledgeBase.
+ #
+ # For more information, see the [knowledge base
+ # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
+ #
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
+ # less; otherwise, the creation request fails.
+ "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
+ # (at a time picked by the system). If false or unspecified, we don't try
+ # to automatically reload the document.
+ #
+ # Currently you can only enable automatic reload for documents sourced from
+ # a public url, see `source` field for the source types.
+ #
+ # Reload status can be tracked in `latest_reload_status`. If a reload
+ # fails, we will keep the document unchanged.
+ #
+ # If a reload fails with internal errors, the system will try to reload the
+ # document on the next day.
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
+ # system will not try to reload the document anymore. You need to manually
+ # reload the document successfully by calling `ReloadDocument` and clear the
+ # errors.
+ "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
+ # This reload may have been triggered automatically or manually
+ # and may not have succeeded.
+ "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "time": "A String", # Output only. The time of a reload attempt.
+ # This reload may have been triggered automatically or manually and may
+ # not have succeeded.
+ },
+ "content": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ # Note: This field is in the process of being deprecated, please use
+ # raw_content instead.
+ "knowledgeTypes": [ # Required. The knowledge type of document content.
+ "A String",
+ ],
+ "contentUri": "A String", # The URI where the file content is located.
+ #
+ # For documents stored in Google Cloud Storage, these URIs must have
+ # the form `gs://<bucket-name>/<object-name>`.
+ #
+ # NOTE: External URLs must correspond to public webpages, i.e., they must
+ # be indexed by Google Search. In particular, URLs for showing documents in
+ # Google Cloud Storage (i.e. the URL in your browser) are not supported.
+ # Instead use the `gs://` format URI described above.
+ "mimeType": "A String", # Required. The MIME type of this document.
+ "name": "A String", # Optional. The document resource name.
+ # The name must be empty when creating a document.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "rawContent": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ },
+ ],
}</pre>
</div>
@@ -519,77 +528,80 @@
body: object, The request body.
The object takes the form of:
-{ # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "rawContent": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
- # (at a time picked by the system). If false or unspecified, we don't try
- # to automatically reload the document.
+{ # A knowledge document to be used by a KnowledgeBase.
#
- # Currently you can only enable automatic reload for documents sourced from
- # a public url, see `source` field for the source types.
+ # For more information, see the [knowledge base
+ # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
#
- # Reload status can be tracked in `latest_reload_status`. If a reload
- # fails, we will keep the document unchanged.
- #
- # If a reload fails with internal errors, the system will try to reload the
- # document on the next day.
- # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
- # system will not try to reload the document anymore. You need to manually
- # reload the document successfully by calling `ReloadDocument` and clear the
- # errors.
- "contentUri": "A String", # The URI where the file content is located.
- #
- # For documents stored in Google Cloud Storage, these URIs must have
- # the form `gs://<bucket-name>/<object-name>`.
- #
- # NOTE: External URLs must correspond to public webpages, i.e., they must
- # be indexed by Google Search. In particular, URLs for showing documents in
- # Google Cloud Storage (i.e. the URL in your browser) are not supported.
- # Instead use the `gs://` format URI described above.
- "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
- # This reload may have been triggered automatically or manually
- # and may not have succeeded.
- "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
+ # less; otherwise, the creation request fails.
+ "enableAutoReload": True or False, # Optional. If true, we try to automatically reload the document every day
+ # (at a time picked by the system). If false or unspecified, we don't try
+ # to automatically reload the document.
+ #
+ # Currently you can only enable automatic reload for documents sourced from
+ # a public url, see `source` field for the source types.
+ #
+ # Reload status can be tracked in `latest_reload_status`. If a reload
+ # fails, we will keep the document unchanged.
+ #
+ # If a reload fails with internal errors, the system will try to reload the
+ # document on the next day.
+ # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
+ # system will not try to reload the document anymore. You need to manually
+ # reload the document successfully by calling `ReloadDocument` and clear the
+ # errors.
+ "latestReloadStatus": { # The status of a reload attempt. # Output only. The time and status of the latest reload.
+ # This reload may have been triggered automatically or manually
+ # and may not have succeeded.
+ "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "time": "A String", # Output only. The time of a reload attempt.
+ # This reload may have been triggered automatically or manually and may
+ # not have succeeded.
},
- "time": "A String", # Output only. The time of a reload attempt.
- # This reload may have been triggered automatically or manually and may
- # not have succeeded.
- },
- "name": "A String", # Optional. The document resource name.
- # The name must be empty when creating a document.
- # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
- # ID>/documents/<Document ID>`.
- "content": "A String", # The raw content of the document. This field is only permitted for
- # EXTRACTIVE_QA and FAQ knowledge types.
- # Note: This field is in the process of being deprecated, please use
- # raw_content instead.
- "mimeType": "A String", # Required. The MIME type of this document.
-}
+ "content": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ # Note: This field is in the process of being deprecated, please use
+ # raw_content instead.
+ "knowledgeTypes": [ # Required. The knowledge type of document content.
+ "A String",
+ ],
+ "contentUri": "A String", # The URI where the file content is located.
+ #
+ # For documents stored in Google Cloud Storage, these URIs must have
+ # the form `gs://<bucket-name>/<object-name>`.
+ #
+ # NOTE: External URLs must correspond to public webpages, i.e., they must
+ # be indexed by Google Search. In particular, URLs for showing documents in
+ # Google Cloud Storage (i.e. the URL in your browser) are not supported.
+ # Instead use the `gs://` format URI described above.
+ "mimeType": "A String", # Required. The MIME type of this document.
+ "name": "A String", # Optional. The document resource name.
+ # The name must be empty when creating a document.
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ # ID>/documents/<Document ID>`.
+ "rawContent": "A String", # The raw content of the document. This field is only permitted for
+ # EXTRACTIVE_QA and FAQ knowledge types.
+ }
updateMask: string, Optional. Not specified means `update all`.
Currently, only `display_name` can be updated, an InvalidArgument will be
@@ -607,33 +619,6 @@
"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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
"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
@@ -644,6 +629,33 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -687,33 +699,6 @@
"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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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.
"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
@@ -724,6 +709,33 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>