docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
index a55534f..a97a9ae 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified document.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all documents of the knowledge base.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,82 +104,82 @@
only use `projects.knowledgeBases.documents`.
Args:
- parent: string, Required. The knoweldge base to create a document for.
+ parent: string, The knoweldge base to create a document for.
Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
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`.
- "mimeType": "A String", # Required. The MIME type of this document.
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "name": "A String", # 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.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "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.
- "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.
- },
- ],
+ #
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "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.
+ "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.
+ "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.
+ "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).
+ "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.
+ "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.
- },
- "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.
-}
+ "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>`.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -191,7 +191,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -199,37 +208,28 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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.
- "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
+ "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.
+ "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.
+ "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.
},
}</pre>
</div>
@@ -242,7 +242,7 @@
only use `projects.knowledgeBases.documents`.
Args:
- name: string, The name of the document to delete.
+ name: string, Required. The name of the document to delete.
Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
ID>/documents/<Document ID>`. (required)
x__xgafv: string, V1 error format.
@@ -255,7 +255,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -263,37 +272,28 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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.
- "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
+ "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.
+ "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.
+ "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.
},
}</pre>
</div>
@@ -318,80 +318,80 @@
An object of the form:
{ # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "mimeType": "A String", # Required. The MIME type of this document.
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "name": "A String", # 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.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "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`.
+ "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.
+ "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.
+ "contentUri": "A String", # The URI where the file content is located.
#
- # 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.
- "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.
- },
- ],
+ # 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.
+ "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).
+ "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.
+ "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.
- },
- "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.
- }</pre>
+ "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>`.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns the list of all documents of the knowledge base.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
@@ -400,9 +400,9 @@
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
default 10 and at most 100.
- pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -412,81 +412,81 @@
An object of the form:
{ # Response message for Documents.ListDocuments.
- "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.
+ "documents": [ # The list of documents.
{ # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "mimeType": "A String", # Required. The MIME type of this document.
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "name": "A String", # 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.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "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`.
+ "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.
+ "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.
+ "contentUri": "A String", # The URI where the file content is located.
#
- # 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.
- "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.
- },
- ],
+ # 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.
+ "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).
+ "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.
+ "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>`.
},
- "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.
- },
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -499,7 +499,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -512,7 +512,7 @@
only use `projects.knowledgeBases.documents`.
Args:
- name: string, The document resource name.
+ name: 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>`. (required)
@@ -520,76 +520,76 @@
The object takes the form of:
{ # A document resource.
- #
- # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
- # only use `projects.knowledgeBases.documents`.
- "mimeType": "A String", # Required. The MIME type of this document.
- "displayName": "A String", # Required. The display name of the document. The name must be 1024 bytes or
- # less; otherwise, the creation request fails.
- "name": "A String", # 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.
- "knowledgeTypes": [ # Required. The knowledge type of document content.
- "A String",
- ],
- "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.
- "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.
- },
- ],
+ #
+ # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
+ # only use `projects.knowledgeBases.documents`.
+ "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.
+ "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.
+ "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.
+ "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).
+ "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.
+ "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.
- },
- "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.
-}
+ "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>`.
+ }
updateMask: string, Optional. Not specified means `update all`.
Currently, only `display_name` can be updated, an InvalidArgument will be
@@ -604,7 +604,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -612,37 +621,28 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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.
- "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
+ "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.
+ "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.
+ "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.
},
}</pre>
</div>
@@ -658,16 +658,16 @@
only use `projects.knowledgeBases.documents`.
Args:
- name: string, The name of the document to reload.
+ name: string, Required. The name of the document to reload.
Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
ID>/documents/<Document ID>` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for Documents.ReloadDocument.
- "gcsSource": { # Google Cloud Storage location for single input. # Optional. The path for a Cloud Storage source file for reloading document content.
- # If not provided, the Document's existing source will be reloaded.
- "uri": "A String", # Required. The Google Cloud Storage URIs for the inputs. A URI is of the
+ "gcsSource": { # Google Cloud Storage location for single input. # Optional. The path for a Cloud Storage source file for reloading document content.
+ # If not provided, the Document's existing source will be reloaded.
+ "uri": "A String", # Required. The 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.
@@ -684,7 +684,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -692,37 +701,28 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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.
- "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
+ "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.
+ "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.
+ "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.
},
}</pre>
</div>