- 1.36.0 (latest)
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.1
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.0
- 1.14.1
- 1.13.5
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.1
- 1.0.0
- 0.8.2
- 0.7.1
- 0.6.0
- 0.5.0
- 0.4.1
- 0.3.0
- 0.2.0
- 0.1.1
ConversationHistoryClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.conversation_history.transports.base.ConversationHistoryTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.conversation_history.transports.base.ConversationHistoryTransport]]] = 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 managing conversation history.
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 |
ConversationHistoryTransport |
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
ConversationHistoryClient
ConversationHistoryClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.conversation_history.transports.base.ConversationHistoryTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.conversation_history.transports.base.ConversationHistoryTransport]]] = 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 conversation history 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,ConversationHistoryTransport,Callable[..., ConversationHistoryTransport]]]
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 ConversationHistoryTransport 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 |
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 |
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.
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 |
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. |
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, agent: str, conversation: str
) -> str
Returns a fully-qualified conversation string.
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.dialogflowcx_v3beta1.types.conversation_history.DeleteConversationRequest,
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 the specified 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 dialogflowcx_v3beta1
def sample_delete_conversation():
# Create a client
client = dialogflowcx_v3beta1.ConversationHistoryClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.DeleteConversationRequest(
name="name_value",
)
# Make the request
client.delete_conversation(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.DeleteConversationRequest, dict]
The request object. The request message for [Conversations.DeleteConversation][]. |
name |
str
Required. The name of the conversation. 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. |
entity_type_path
entity_type_path(project: str, location: str, agent: str, entity_type: str) -> str
Returns a fully-qualified entity_type string.
environment_path
environment_path(project: str, location: str, agent: str, environment: str) -> str
Returns a fully-qualified environment string.
example_path
example_path(
project: str, location: str, agent: str, playbook: str, example: str
) -> str
Returns a fully-qualified example string.
flow_path
flow_path(project: str, location: str, agent: str, flow: str) -> str
Returns a fully-qualified flow 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 |
ConversationHistoryClient |
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 |
ConversationHistoryClient |
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 |
ConversationHistoryClient |
The constructed client. |
get_conversation
get_conversation(
request: typing.Optional[
typing.Union[
google.cloud.dialogflowcx_v3beta1.types.conversation_history.GetConversationRequest,
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.dialogflowcx_v3beta1.types.conversation_history.Conversation
Retrieves the specified 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 dialogflowcx_v3beta1
def sample_get_conversation():
# Create a client
client = dialogflowcx_v3beta1.ConversationHistoryClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.GetConversationRequest(
name="name_value",
)
# Make the request
response = client.get_conversation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.GetConversationRequest, dict]
The request object. The request message for [Conversations.GetConversation][]. |
name |
str
Required. The name of the conversation. 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.dialogflowcx_v3beta1.types.Conversation |
Represents a conversation. |
get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
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 |
|
Location object. |
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 |
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 |
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. |
intent_path
intent_path(project: str, location: str, agent: str, intent: str) -> str
Returns a fully-qualified intent string.
list_conversations
list_conversations(
request: typing.Optional[
typing.Union[
google.cloud.dialogflowcx_v3beta1.types.conversation_history.ListConversationsRequest,
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.dialogflowcx_v3beta1.services.conversation_history.pagers.ListConversationsPager
)
Returns the list of all conversations.
# 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 dialogflowcx_v3beta1
def sample_list_conversations():
# Create a client
client = dialogflowcx_v3beta1.ConversationHistoryClient()
# Initialize request argument(s)
request = dialogflowcx_v3beta1.ListConversationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_conversations(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dialogflowcx_v3beta1.types.ListConversationsRequest, dict]
The request object. The request message for [Conversations.ListConversations][]. |
parent |
str
Required. The agent to list all conversations for. 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.dialogflowcx_v3beta1.services.conversation_history.pagers.ListConversationsPager |
The response message for [Conversations.ListConversations][]. Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
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 ListLocations method. |
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 |
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. |
page_path
page_path(project: str, location: str, agent: str, flow: str, page: str) -> str
Returns a fully-qualified page string.
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_entity_type_path
parse_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a entity_type path into its component segments.
parse_environment_path
parse_environment_path(path: str) -> typing.Dict[str, str]
Parses a environment path into its component segments.
parse_example_path
parse_example_path(path: str) -> typing.Dict[str, str]
Parses a example path into its component segments.
parse_flow_path
parse_flow_path(path: str) -> typing.Dict[str, str]
Parses a flow path into its component segments.
parse_intent_path
parse_intent_path(path: str) -> typing.Dict[str, str]
Parses a intent path into its component segments.
parse_page_path
parse_page_path(path: str) -> typing.Dict[str, str]
Parses a page path into its component segments.
parse_playbook_path
parse_playbook_path(path: str) -> typing.Dict[str, str]
Parses a playbook path into its component segments.
parse_service_path
parse_service_path(path: str) -> typing.Dict[str, str]
Parses a service path into its component segments.
parse_session_entity_type_path
parse_session_entity_type_path(path: str) -> typing.Dict[str, str]
Parses a session_entity_type path into its component segments.
parse_session_path
parse_session_path(path: str) -> typing.Dict[str, str]
Parses a session path into its component segments.
parse_test_case_path
parse_test_case_path(path: str) -> typing.Dict[str, str]
Parses a test_case path into its component segments.
parse_tool_path
parse_tool_path(path: str) -> typing.Dict[str, str]
Parses a tool path into its component segments.
parse_transition_route_group_path
parse_transition_route_group_path(path: str) -> typing.Dict[str, str]
Parses a transition_route_group path into its component segments.
parse_version_path
parse_version_path(path: str) -> typing.Dict[str, str]
Parses a version path into its component segments.
parse_webhook_path
parse_webhook_path(path: str) -> typing.Dict[str, str]
Parses a webhook path into its component segments.
playbook_path
playbook_path(project: str, location: str, agent: str, playbook: str) -> str
Returns a fully-qualified playbook string.
service_path
service_path(project: str, location: str, namespace: str, service: str) -> str
Returns a fully-qualified service string.
session_entity_type_path
session_entity_type_path(
project: str, location: str, agent: str, session: str, entity_type: str
) -> str
Returns a fully-qualified session_entity_type string.
session_path
session_path(project: str, location: str, agent: str, session: str) -> str
Returns a fully-qualified session string.
test_case_path
test_case_path(project: str, location: str, agent: str, test_case: str) -> str
Returns a fully-qualified test_case string.
tool_path
tool_path(project: str, location: str, agent: str, tool: str) -> str
Returns a fully-qualified tool string.
transition_route_group_path
transition_route_group_path(
project: str, location: str, agent: str, flow: str, transition_route_group: str
) -> str
Returns a fully-qualified transition_route_group string.
version_path
version_path(
project: str, location: str, agent: str, flow: str, version: str
) -> str
Returns a fully-qualified version string.
webhook_path
webhook_path(project: str, location: str, agent: str, webhook: str) -> str
Returns a fully-qualified webhook string.