Class DocumentServiceClient (0.13.4) 

DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for ingesting Document information of the customer's website.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
DocumentServiceTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

DocumentServiceClient

DocumentServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the document service 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 Optional[Union[str,DocumentServiceTransport,Callable[..., DocumentServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the DocumentServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.
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.

batch_get_documents_metadata

batch_get_documents_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.BatchGetDocumentsMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.types.document_service.BatchGetDocumentsMetadataResponse
)

Gets index freshness metadata for xref_Documents. Supported for website search only.

# 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 discoveryengine_v1beta

def sample_batch_get_documents_metadata():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.BatchGetDocumentsMetadataRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.batch_get_documents_metadata(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.BatchGetDocumentsMetadataRequest, dict]

The request object. Request message for DocumentService.BatchGetDocumentsMetadata method.
parent str

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.discoveryengine_v1beta.types.BatchGetDocumentsMetadataResponse Response message for DocumentService.BatchGetDocumentsMetadata method.

branch_path

branch_path(project: str, location: str, data_store: str, branch: str) -> str

Returns a fully-qualified branch string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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 .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
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) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_document

create_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.CreateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    document: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.document.Document
    ] = None,
    document_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document

Creates a xref_Document.

# 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 discoveryengine_v1beta

def sample_create_document():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.CreateDocumentRequest(
        parent="parent_value",
        document_id="document_id_value",
    )

    # Make the request
    response = client.create_document(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.CreateDocumentRequest, dict]

The request object. Request message for DocumentService.CreateDocument method.
parent str

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
document google.cloud.discoveryengine_v1beta.types.Document

Required. The Document to create. This corresponds to the document field on the request instance; if request is provided, this should not be set.
document_id str

Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 https://tools.ietf.org/html/rfc1034__ standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. This corresponds to the document_id field on the request instance; if request is provided, this should not be set.
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.discoveryengine_v1beta.types.Document Document captures all raw metadata information of items to be recommended or searched.

delete_document

delete_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.DeleteDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_Document.

# 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 discoveryengine_v1beta

def sample_delete_document():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.DeleteDocumentRequest(
        name="name_value",
    )

    # Make the request
    client.delete_document(request=request)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.DeleteDocumentRequest, dict]

The request object. Request message for DocumentService.DeleteDocument method.
name str

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned. This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

document_path

document_path(
    project: str, location: str, data_store: str, branch: str, document: str
) -> str

Returns a fully-qualified document string.

fhir_resource_path

fhir_resource_path(
    project: str,
    location: str,
    dataset: str,
    fhir_store: str,
    resource_type: str,
    fhir_resource_id: str,
) -> str

Returns a fully-qualified fhir_resource string.

fhir_store_path

fhir_store_path(project: str, location: str, dataset: str, fhir_store: str) -> str

Returns a fully-qualified fhir_store 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
DocumentServiceClient 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
DocumentServiceClient 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
DocumentServiceClient The constructed client.

get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document

Gets a xref_Document.

# 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 discoveryengine_v1beta

def sample_get_document():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.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.discoveryengine_v1beta.types.GetDocumentRequest, dict]

The request object. Request message for DocumentService.GetDocument method.
name str

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned. This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.discoveryengine_v1beta.types.Document Document captures all raw metadata information of items to be recommended or searched.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 variable 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 api_endpoint and client_cert_source properties may be used in this method.
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: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
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
.operations_pb2.Operation An Operation object.

import_documents

import_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.import_config.ImportDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of multiple xref_Documents. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the xref_Documents to be successfully updated.

# 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 discoveryengine_v1beta

def sample_import_documents():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.ImportDocumentsRequest(
        parent="parent_value",
    )

    # 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.discoveryengine_v1beta.types.ImportDocumentsRequest, dict]

The request object. Request message for Import methods.
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 of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

list_documents

list_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager
)

Gets a list of xref_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 discoveryengine_v1beta

def sample_list_documents():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.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.discoveryengine_v1beta.types.ListDocumentsRequest, dict]

The request object. Request message for DocumentService.ListDocuments method.
parent str

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.discoveryengine_v1beta.services.document_service.pagers.ListDocumentsPager Response message for DocumentService.ListDocuments method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
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
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

parse_branch_path

parse_branch_path(path: str) -> typing.Dict[str, str]

Parses a branch path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

parse_fhir_resource_path

parse_fhir_resource_path(path: str) -> typing.Dict[str, str]

Parses a fhir_resource path into its component segments.

parse_fhir_store_path

parse_fhir_store_path(path: str) -> typing.Dict[str, str]

Parses a fhir_store path into its component segments.

purge_documents

purge_documents(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.purge_config.PurgeDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Permanently deletes all selected xref_Documents in a branch.

This process is asynchronous. Depending on the number of xref_Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some xref_Documents might still be returned by xref_DocumentService.GetDocument or xref_DocumentService.ListDocuments.

To get a list of the xref_Documents to be deleted, set xref_PurgeDocumentsRequest.force to false.

# 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 discoveryengine_v1beta

def sample_purge_documents():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    gcs_source = discoveryengine_v1beta.GcsSource()
    gcs_source.input_uris = ['input_uris_value1', 'input_uris_value2']

    request = discoveryengine_v1beta.PurgeDocumentsRequest(
        gcs_source=gcs_source,
        parent="parent_value",
        filter="filter_value",
    )

    # Make the request
    operation = client.purge_documents(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.PurgeDocumentsRequest, dict]

The request object. Request message for DocumentService.PurgeDocuments method.
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 PurgeDocumentsResponse Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

update_document

update_document(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.document_service.UpdateDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    document: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.document.Document
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.document.Document

Updates a xref_Document.

# 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 discoveryengine_v1beta

def sample_update_document():
    # Create a client
    client = discoveryengine_v1beta.DocumentServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.UpdateDocumentRequest(
    )

    # Make the request
    response = client.update_document(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]

The request object. Request message for DocumentService.UpdateDocument method.
document google.cloud.discoveryengine_v1beta.types.Document

Required. The document to update/create. If the caller does not have permission to update the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned. This corresponds to the document field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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.discoveryengine_v1beta.types.Document Document captures all raw metadata information of items to be recommended or searched.