Class DocumentsAsyncClient (2.13.0)

Service for managing knowledge Documents.

Returns the transport used by the client instance.

Instantiates the documents client.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

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_KnowledgeOperationMetadata
• response: xref_Document

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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)

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_KnowledgeOperationMetadata
• response: An Empty 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.

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)

Returns a fully-qualified document string.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Retrieves the specified document.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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)

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.

Returns an appropriate transport class.

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_KnowledgeOperationMetadata
• response: xref_ImportDocumentsResponse

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_value_1', 'uris_value_2']

    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)

Returns the list of all documents of the knowledge base.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a document path into its component segments.

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_KnowledgeOperationMetadata
• response: xref_Document

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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)

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_KnowledgeOperationMetadata
• response: xref_Document

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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)