DocumentServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport]] = None, client_options: Optional[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
transport
Returns the transport used by the client instance.
Type | Description |
DocumentServiceTransport | The transport used by the client instance. |
Methods
DocumentServiceClient
DocumentServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.discoveryengine_v1beta.services.document_service.transports.base.DocumentServiceTransport]] = None, client_options: Optional[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.
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, DocumentServiceTransport]
The transport to use. 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. 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 |
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.
branch_path
branch_path(project: str, location: str, data_store: str, branch: str)
Returns a fully-qualified branch string.
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.discoveryengine_v1beta.types.document_service.CreateDocumentRequest, dict]] = None, *, parent: Optional[str] = None, document: Optional[google.cloud.discoveryengine_v1beta.types.document.Document] = None, document_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
document = discoveryengine_v1beta.Document()
document.schema_id = "schema_id_value"
request = discoveryengine_v1beta.CreateDocumentRequest(
parent="parent_value",
document=document,
document_id="document_id_value",
)
# Make the request
response = client.create_document(request=request)
# Handle the response
print(response)
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 |
document |
google.cloud.discoveryengine_v1beta.types.Document
Required. The Document to create. This corresponds to the |
document_id |
str
Required. The ID to use for the Document, which will become 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 |
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. |
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: Optional[Union[google.cloud.discoveryengine_v1beta.types.document_service.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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
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 |
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
)
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
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.
Name | Description |
info |
dict
The service account private key info. |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
DocumentServiceClient | The constructed client. |
get_document
get_document(request: Optional[Union[google.cloud.discoveryengine_v1beta.types.document_service.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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
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 |
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. |
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: 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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets the latest state of a long-running operation.
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. |
Type | Description |
.operations_pb2.Operation | An Operation object. |
import_documents
import_documents(request: Optional[Union[google.cloud.discoveryengine_v1beta.types.import_config.ImportDocumentsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Bulk import of multiple xref_Documents. Request processing may be synchronous. Non-existing items will be 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)
inline_source = discoveryengine_v1beta.InlineSource()
inline_source.documents.schema_id = "schema_id_value"
request = discoveryengine_v1beta.ImportDocumentsRequest(
inline_source=inline_source,
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)
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. |
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: Optional[Union[google.cloud.discoveryengine_v1beta.types.document_service.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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
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 |
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. |
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: 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: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists operations that match the specified filter in the request.
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. |
Type | Description |
.operations_pb2.ListOperationsResponse | Response message for ListOperations method. |
parse_branch_path
parse_branch_path(path: str)
Parses a branch path into its component segments.
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.
update_document
update_document(request: Optional[Union[google.cloud.discoveryengine_v1beta.types.document_service.UpdateDocumentRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
document = discoveryengine_v1beta.Document()
document.schema_id = "schema_id_value"
request = discoveryengine_v1beta.UpdateDocumentRequest(
document=document,
)
# Make the request
response = client.update_document(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.discoveryengine_v1beta.types.UpdateDocumentRequest, dict]
The request object. Request message for DocumentService.UpdateDocument 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. |
Type | Description |
google.cloud.discoveryengine_v1beta.types.Document | Document captures all raw metadata information of items to be recommended or searched. |