Console
    Contact Us Start free

    Class DocumentsClient (0.8.0) 

      DocumentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 )

    Manages documents of a knowledge base.

    Methods

    DocumentsClient

      DocumentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 )

    Constructor.

    Parameters
    Name
    Description
    channel
    grpc.Channel

    DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials ; providing both will raise an exception.

    credentials
    google.auth.credentials.Credentials

    The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport ; doing so will raise an exception.

    client_config
    dict

    DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

    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 None , then default info will be used. Generally, you only need to set this if you're developing your own client library.

    client_options
    Union[dict, google.api_core.client_options.ClientOptions]

    Client options used to set user options on the client. API Endpoint should be set through client_options.

    create_document

      create_document 
 ( 
 parent 
 , 
 document 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Creates a new document.

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

    Operation <response: Document , metadata: KnowledgeOperationMetadata >

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    parent = client.knowledge_base_path('[PROJECT]', '[KNOWLEDGE_BASE]')

    TODO: Initialize document :

    document = {}

    response = client.create_document(parent, document)

    def callback(operation_future): ... # Handle result. ... result = operation_future.result()

    response.add_done_callback(callback)

    Handle metadata.

    metadata = response.metadata()

    Parameters
    Name
    Description
    parent
    str

    Required. The knoweldge base to create a document for. Format: projects/ .

    document
    Union[dict, Document ]

    Required. The document to create. If a dict is provided, it must be of the same form as the protobuf message Document

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    delete_document

      delete_document 
 ( 
 name 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Deletes the specified document.

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

    Operation <response: google.protobuf.Empty , metadata: KnowledgeOperationMetadata >

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    name = client.document_path('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]')

    response = client.delete_document(name)

    def callback(operation_future): ... # Handle result. ... result = operation_future.result()

    response.add_done_callback(callback)

    Handle metadata.

    metadata = response.metadata()

    Parameters
    Name
    Description
    name
    str

    The name of the document to delete. Format: projects/ .

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    document_path

      document_path 
 ( 
 project 
 , 
 knowledge_base 
 , 
 document 
 )

    Return a fully-qualified document string.

      from_service_account_file 
 ( 
 filename 
 , 
 * 
 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
    dialogflow_v2beta1.DocumentsClient
    The constructed client.
      from_service_account_json 
 ( 
 filename 
 , 
 * 
 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
    dialogflow_v2beta1.DocumentsClient
    The constructed client.

    get_document

      get_document 
 ( 
 name 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Retrieves the specified document.

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

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    name = client.document_path('[PROJECT]', '[KNOWLEDGE_BASE]', '[DOCUMENT]')

    response = client.get_document(name)

    Parameters
    Name
    Description
    name
    str

    Required. The name of the document to retrieve. Format projects/ .

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    knowledge_base_path

      knowledge_base_path 
 ( 
 project 
 , 
 knowledge_base 
 )

    Return a fully-qualified knowledge_base string.

    list_documents

      list_documents 
 ( 
 parent 
 , 
 page_size 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Returns the list of all documents of the knowledge base.

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

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    parent = client.knowledge_base_path('[PROJECT]', '[KNOWLEDGE_BASE]')

    Iterate over all results

    for element in client.list_documents(parent): ... # process element ... pass

    Alternatively:

    Iterate over results one page at a time

    for page in client.list_documents(parent).pages: ... for element in page: ... # process element ... pass

    Parameters
    Name
    Description
    parent
    str

    Required. The knowledge base to list all documents for. Format: projects/ .

    page_size
    int

    The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    reload_document

      reload_document 
 ( 
 name 
 = 
 None 
 , 
 gcs_source 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    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: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents .

    Operation <response: Document , metadata: KnowledgeOperationMetadata >

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    response = client.reload_document()

    Parameters
    Name
    Description
    name
    str

    The name of the document to reload. Format: projects/

    gcs_source
    Union[dict, GcsSource ]

    The path of gcs source file for reloading document content. If a dict is provided, it must be of the same form as the protobuf message GcsSource

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    update_document

      update_document 
 ( 
 document 
 , 
 update_mask 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Updates the specified document.

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

    Operation <response: Document , metadata: KnowledgeOperationMetadata >

    .. rubric:: Example

    import dialogflow_v2beta1

    client = dialogflow_v2beta1.DocumentsClient()

    TODO: Initialize document :

    document = {}

    response = client.update_document(document)

    def callback(operation_future): ... # Handle result. ... result = operation_future.result()

    response.add_done_callback(callback)

    Handle metadata.

    metadata = response.metadata()

    Parameters
    Name
    Description
    document
    Union[dict, Document ]

    Required. The document to update. If a dict is provided, it must be of the same form as the protobuf message Document

    update_mask
    Union[dict, FieldMask ]

    Optional. Not specified means update all . Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields. If a dict is provided, it must be of the same form as the protobuf message FieldMask

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: