ConversationalSearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport] = 'grpc_asyncio', client_options: typing.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 conversational search.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
ConversationalSearchServiceTransport | The transport used by the client instance. |
Methods
ConversationalSearchServiceAsyncClient
ConversationalSearchServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport] = 'grpc_asyncio', client_options: typing.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 conversational search 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 |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
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.
conversation_path
conversation_path(
project: str, location: str, data_store: str, conversation: str
) -> str
Returns a fully-qualified conversation string.
converse_conversation
converse_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ConverseConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
query: typing.Optional[
google.cloud.discoveryengine_v1beta.types.conversation.TextInput
] = None,
retry: typing.Union[
google.api_core.retry.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.conversational_search_service.ConverseConversationResponse
)
Converses a conversation.
# 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
async def sample_converse_conversation():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.ConverseConversationRequest(
name="name_value",
)
# Make the request
response = await client.converse_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.ConverseConversationRequest, dict]]
The request object. Request message for ConversationalSearchService.ConverseConversation method. |
name |
Required. The resource name of the Conversation to get. Format: |
query |
TextInput
Required. Current user input. 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.cloud.discoveryengine_v1beta.types.ConverseConversationResponse | Response message for ConversationalSearchService.ConverseConversation method. |
create_conversation
create_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.CreateConversationRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.types.conversation.Conversation
] = None,
retry: typing.Union[
google.api_core.retry.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.conversation.Conversation
Creates a Conversation.
If the xref_Conversation to create already exists, an ALREADY_EXISTS error is returned.
# 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
async def sample_create_conversation():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.CreateConversationRequest(
parent="parent_value",
)
# Make the request
response = await client.create_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.CreateConversationRequest, dict]]
The request object. Request for CreateConversation method. |
parent |
Required. Full resource name of parent data store. Format: |
conversation |
Conversation
Required. The conversation 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.cloud.discoveryengine_v1beta.types.Conversation | External conversation proto definition. |
data_store_path
data_store_path(project: str, location: str, data_store: str) -> str
Returns a fully-qualified data_store string.
delete_conversation
delete_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.DeleteConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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 Conversation.
If the xref_Conversation to delete does not exist, a NOT_FOUND error is returned.
# 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
async def sample_delete_conversation():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.DeleteConversationRequest(
name="name_value",
)
# Make the request
await client.delete_conversation(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.DeleteConversationRequest, dict]]
The request object. Request for DeleteConversation method. |
name |
Required. The resource name of the Conversation 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. |
document_path
document_path(
project: str, location: str, data_store: str, branch: str, document: str
) -> 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 |
ConversationalSearchServiceAsyncClient | 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 |
ConversationalSearchServiceAsyncClient | 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 |
ConversationalSearchServiceAsyncClient | The constructed client. |
get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.GetConversationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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.conversation.Conversation
Gets a Conversation.
# 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
async def sample_get_conversation():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.GetConversationRequest(
name="name_value",
)
# Make the request
response = await client.get_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.GetConversationRequest, dict]]
The request object. Request for GetConversation method. |
name |
Required. The resource name of the Conversation to get. 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.discoveryengine_v1beta.types.Conversation | External conversation proto definition. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.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 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 |
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.Union[
google.api_core.retry.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 |
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. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.discoveryengine_v1beta.services.conversational_search_service.transports.base.ConversationalSearchServiceTransport
]
)
Returns an appropriate transport class.
list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.ListConversationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.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.conversational_search_service.pagers.ListConversationsAsyncPager
)
Lists all Conversations by their parent xref_DataStore.
# 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
async def sample_list_conversations():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.ListConversationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_conversations(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.ListConversationsRequest, dict]]
The request object. Request for ListConversations method. |
parent |
Required. The data store resource name. 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.discoveryengine_v1beta.services.conversational_search_service.pagers.ListConversationsAsyncPager | Response for ListConversations 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.Union[
google.api_core.retry.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 |
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) -> 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_conversation_path
parse_conversation_path(path: str) -> typing.Dict[str, str]
Parses a conversation path into its component segments.
parse_data_store_path
parse_data_store_path(path: str) -> typing.Dict[str, str]
Parses a data_store 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_serving_config_path
parse_serving_config_path(path: str) -> typing.Dict[str, str]
Parses a serving_config path into its component segments.
serving_config_path
serving_config_path(
project: str, location: str, data_store: str, serving_config: str
) -> str
Returns a fully-qualified serving_config string.
update_conversation
update_conversation(
request: typing.Optional[
typing.Union[
google.cloud.discoveryengine_v1beta.types.conversational_search_service.UpdateConversationRequest,
dict,
]
] = None,
*,
conversation: typing.Optional[
google.cloud.discoveryengine_v1beta.types.conversation.Conversation
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.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.conversation.Conversation
Updates a Conversation.
xref_Conversation action type cannot be changed. If the xref_Conversation to update does not exist, a NOT_FOUND error is returned.
# 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
async def sample_update_conversation():
# Create a client
client = discoveryengine_v1beta.ConversationalSearchServiceAsyncClient()
# Initialize request argument(s)
request = discoveryengine_v1beta.UpdateConversationRequest(
)
# Make the request
response = await client.update_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.discoveryengine_v1beta.types.UpdateConversationRequest, dict]]
The request object. Request for UpdateConversation method. |
conversation |
Conversation
Required. The Conversation to update. This corresponds to the |
update_mask |
Indicates which fields in the provided Conversation to update. The following are NOT supported: - [conversation.name][] If not set or empty, all supported fields are updated. 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.cloud.discoveryengine_v1beta.types.Conversation | External conversation proto definition. |