DocumentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.services.documents.transports.base.DocumentsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service for managing knowledge Documents.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
DocumentsTransport | The transport used by the client instance. |
Methods
DocumentsClient
DocumentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.services.documents.transports.base.DocumentsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the documents client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, DocumentsTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
cancel_operation
cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_document
create_document(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.CreateDocumentRequest, dict]] = None, *, parent: Optional[str] = None, document: Optional[google.cloud.dialogflow_v2beta1.types.document.Document] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new document.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: xref_KnowledgeOperationMetadataresponse
: xref_Document
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_create_document():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
document = dialogflow_v2beta1.Document()
document.content_uri = "content_uri_value"
document.display_name = "display_name_value"
document.mime_type = "mime_type_value"
document.knowledge_types = "SMART_REPLY"
request = dialogflow_v2beta1.CreateDocumentRequest(
parent="parent_value",
document=document,
)
# Make the request
operation = client.create_document(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.CreateDocumentRequest, dict]
The request object. Request message for Documents.CreateDocument. |
parent |
str
Required. The knowledge base to create a document for. Format: |
document |
google.cloud.dialogflow_v2beta1.types.Document
Required. The document to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Document 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. |
delete_document
delete_document(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.DeleteDocumentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified document.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: xref_KnowledgeOperationMetadataresponse
: AnEmpty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>
__
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_delete_document():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.DeleteDocumentRequest(
name="name_value",
)
# Make the request
operation = client.delete_document(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.DeleteDocumentRequest, dict]
The request object. Request message for Documents.DeleteDocument. |
name |
str
Required. The name of the document to delete. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
document_path
document_path(project: str, knowledge_base: str, document: str)
Returns a fully-qualified document string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DocumentsClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
DocumentsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DocumentsClient | The constructed client. |
get_document
get_document(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.GetDocumentRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified document.
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_get_document():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.GetDocumentRequest(
name="name_value",
)
# Make the request
response = client.get_document(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.GetDocumentRequest, dict]
The request object. Request message for Documents.GetDocument. |
name |
str
Required. The name of the document to retrieve. Format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflow_v2beta1.types.Document | 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. |
get_location
get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Location object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_operation
get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An Operation object. |
import_documents
import_documents(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.ImportDocumentsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: xref_KnowledgeOperationMetadataresponse
: xref_ImportDocumentsResponse
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_import_documents():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
gcs_source = dialogflow_v2beta1.GcsSources()
gcs_source.uris = ['uris_value1', 'uris_value2']
document_template = dialogflow_v2beta1.ImportDocumentTemplate()
document_template.mime_type = "mime_type_value"
document_template.knowledge_types = "SMART_REPLY"
request = dialogflow_v2beta1.ImportDocumentsRequest(
gcs_source=gcs_source,
parent="parent_value",
document_template=document_template,
)
# Make the request
operation = client.import_documents(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.ImportDocumentsRequest, dict]
The request object. Request message for Documents.ImportDocuments. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be ImportDocumentsResponse Response message for Documents.ImportDocuments. |
list_documents
list_documents(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.ListDocumentsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all documents of the knowledge base.
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_list_documents():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.ListDocumentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_documents(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.ListDocumentsRequest, dict]
The request object. Request message for Documents.ListDocuments. |
parent |
str
Required. The knowledge base to list all documents for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflow_v2beta1.services.documents.pagers.ListDocumentsPager | Response message for Documents.ListDocuments. Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for ListLocations method. |
list_operations
list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for ListOperations method. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_document_path
parse_document_path(path: str)
Parses a document path into its component segments.
reload_document
reload_document(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.ReloadDocumentRequest, dict]] = None, *, name: Optional[str] = None, gcs_source: Optional[google.cloud.dialogflow_v2beta1.types.gcs.GcsSource] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Reloads the specified document from its specified source,
content_uri or content. The previously loaded content of the
document will be deleted. Note: Even when the content of the
document has not changed, there still may be side effects
because of internal implementation changes. Note: If the
document source is Google Cloud Storage URI, its metadata will
be replaced with the custom metadata from Google Cloud Storage
if the import_gcs_custom_metadata
field is set to true in
the request.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: xref_KnowledgeOperationMetadataresponse
: xref_Document
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_reload_document():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.ReloadDocumentRequest(
name="name_value",
)
# Make the request
operation = client.reload_document(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.ReloadDocumentRequest, dict]
The request object. Request message for Documents.ReloadDocument. |
name |
str
Required. The name of the document to reload. Format: |
gcs_source |
google.cloud.dialogflow_v2beta1.types.GcsSource
The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Document 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. |
update_document
update_document(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.document.UpdateDocumentRequest, dict]] = None, *, document: Optional[google.cloud.dialogflow_v2beta1.types.document.Document] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified document.
This method is a long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>
__.
The returned Operation
type has the following
method-specific fields:
metadata
: xref_KnowledgeOperationMetadataresponse
: xref_Document
Note: The projects.agent.knowledgeBases.documents
resource
is deprecated; only use projects.knowledgeBases.documents
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflow_v2beta1
def sample_update_document():
# Create a client
client = dialogflow_v2beta1.DocumentsClient()
# Initialize request argument(s)
document = dialogflow_v2beta1.Document()
document.content_uri = "content_uri_value"
document.display_name = "display_name_value"
document.mime_type = "mime_type_value"
document.knowledge_types = "SMART_REPLY"
request = dialogflow_v2beta1.UpdateDocumentRequest(
document=document,
)
# Make the request
operation = client.update_document(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflow_v2beta1.types.UpdateDocumentRequest, dict]
The request object. Request message for Documents.UpdateDocument. |
document |
google.cloud.dialogflow_v2beta1.types.Document
Required. The document to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Optional. Not specified means |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Document 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. |