chore: regens API reference docs (#889)
diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
index c7a251a..a55534f 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html
@@ -75,7 +75,7 @@
<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html">documents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new document.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -84,32 +84,29 @@
<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, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified document.</p>
<p class="toc_element">
<code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reloads the specified document from its specified source, content_uri or</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.
-Operation <response: Document,
- metadata: KnowledgeOperationMetadata>
-
Args:
parent: string, Required. The knoweldge base to create a document for.
-Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
- body: object, The request body. (required)
+Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A document resource.
@@ -119,15 +116,10 @@
"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.
- "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", # 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
@@ -135,12 +127,58 @@
"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.
+ },
+ ],
+ },
+ "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.
- "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>`.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -153,12 +191,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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
+ # 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
@@ -177,22 +231,6 @@
},
],
},
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
@@ -203,13 +241,10 @@
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.
-Operation <response: google.protobuf.Empty,
- metadata: KnowledgeOperationMetadata>
-
Args:
name: string, The name of the document to delete.
-Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
-ID>/documents/<Document ID>`. (required)
+Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ID>/documents/<Document ID>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -220,12 +255,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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
+ # 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
@@ -244,22 +295,6 @@
},
],
},
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
@@ -272,8 +307,8 @@
Args:
name: string, Required. The name of the document to retrieve.
-Format `projects/<Project ID>/knowledgeBases/<Knowledge Base
-ID>/documents/<Document ID>`. (required)
+Format `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ID>/documents/<Document ID>`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -289,15 +324,10 @@
"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.
- "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", # 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
@@ -305,17 +335,63 @@
"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.
+ },
+ ],
+ },
+ "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.
- "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>`.
+ "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>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=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;
@@ -323,14 +399,14 @@
Args:
parent: string, Required. The knowledge base to list all documents for.
-Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
+Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. (required)
+ 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
2 - v2 error format
- pageSize: integer, Optional. The maximum number of items to return in a single page. By
-default 10 and at most 100.
Returns:
An object of the form:
@@ -346,15 +422,10 @@
"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.
- "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", # 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
@@ -362,12 +433,58 @@
"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.
+ },
+ ],
+ },
+ "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.
- "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>`.
+ "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>
@@ -388,21 +505,18 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified document.
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.
-Operation <response: Document,
- metadata: KnowledgeOperationMetadata>
-
Args:
name: 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>`. (required)
- body: object, The request body. (required)
+Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
+ID>/documents/<Document ID>`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A document resource.
@@ -412,15 +526,10 @@
"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.
- "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", # 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
@@ -428,12 +537,58 @@
"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.
+ },
+ ],
+ },
+ "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.
- "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>`.
+ "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.
}
updateMask: string, Optional. Not specified means `update all`.
@@ -449,12 +604,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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
+ # 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
@@ -473,22 +644,6 @@
},
],
},
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
@@ -502,17 +657,21 @@
Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.
-Operation <response: Document,
- metadata: KnowledgeOperationMetadata>
-
Args:
name: string, The name of the document to reload.
-Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
-ID>/documents/<Document ID>` (required)
+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
+ # form:
+ # gs://bucket/object-prefix-or-name
+ # Whether a prefix or name is used depends on the use case.
+ },
}
x__xgafv: string, V1 error format.
@@ -525,12 +684,28 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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
+ # 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
@@ -549,22 +724,6 @@
},
],
},
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>