Class ConversationProfilesClient (2.10.0)

ConversationProfilesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport]] = None, client_options: 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 managing ConversationProfiles.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`ConversationProfilesTransport`	The transport used by the client instance.

Methods

ConversationProfilesClient

ConversationProfilesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2.services.conversation_profiles.transports.base.ConversationProfilesTransport]] = None, client_options: 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 conversation profiles 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, ConversationProfilesTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.
`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.

agent_path

agent_path(project: str)

Returns a fully-qualified agent 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.

conversation_model_path

conversation_model_path(project: str, location: str, conversation_model: str)

Returns a fully-qualified conversation_model string.

conversation_profile_path

conversation_profile_path(project: str, conversation_profile: str)

Returns a fully-qualified conversation_profile string.

create_conversation_profile

create_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation_profile.CreateConversationProfileRequest, dict]] = None, *, parent: Optional[str] = None, conversation_profile: Optional[google.cloud.dialogflow_v2.types.conversation_profile.ConversationProfile] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via xref_GetConversationProfile API.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.CreateConversationProfileRequest, dict]` The request object. The request message for ConversationProfiles.CreateConversationProfile.
`parent`	`str` Required. The project to create a conversation profile for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`conversation_profile`	`google.cloud.dialogflow_v2.types.ConversationProfile` Required. The conversation profile to create. This corresponds to the `conversation_profile` 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.dialogflow_v2.types.ConversationProfile`	Defines the services to connect to incoming Dialogflow conversations.

cx_security_settings_path

cx_security_settings_path(project: str, location: str, security_settings: str)

Returns a fully-qualified cx_security_settings string.

delete_conversation_profile

delete_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation_profile.DeleteConversationProfileRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified conversation profile.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.DeleteConversationProfileRequest, dict]` The request object. The request message for ConversationProfiles.DeleteConversationProfile. This operation fails if the conversation profile is still referenced from a phone number.
`name`	`str` Required. The name of the conversation profile to delete. Format: `projects/`. 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, knowledge_base: 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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`ConversationProfilesClient`	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
`ConversationProfilesClient`	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
`ConversationProfilesClient`	The constructed client.

get_conversation_profile

get_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation_profile.GetConversationProfileRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified conversation profile.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.GetConversationProfileRequest, dict]` The request object. The request message for ConversationProfiles.GetConversationProfile.
`name`	`str` Required. The resource name of the conversation profile. Format: `projects/`. 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.dialogflow_v2.types.ConversationProfile`	Defines the services to connect to incoming Dialogflow conversations.

knowledge_base_path

knowledge_base_path(project: str, knowledge_base: str)

Returns a fully-qualified knowledge_base string.

list_conversation_profiles

list_conversation_profiles(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation_profile.ListConversationProfilesRequest, 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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all conversation profiles in the specified project.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.ListConversationProfilesRequest, dict]` The request object. The request message for ConversationProfiles.ListConversationProfiles.
`parent`	`str` Required. The project to list all conversation profiles from. Format: `projects/`. 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.dialogflow_v2.services.conversation_profiles.pagers.ListConversationProfilesPager`	The response message for ConversationProfiles.ListConversationProfiles. Iterating over this object will yield results and resolve additional pages automatically.

parse_agent_path

parse_agent_path(path: str)

Parses a agent 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_conversation_model_path

parse_conversation_model_path(path: str)

Parses a conversation_model path into its component segments.

parse_conversation_profile_path

parse_conversation_profile_path(path: str)

Parses a conversation_profile path into its component segments.

parse_cx_security_settings_path

parse_cx_security_settings_path(path: str)

Parses a cx_security_settings path into its component segments.

parse_document_path

parse_document_path(path: str)

Parses a document path into its component segments.

parse_knowledge_base_path

parse_knowledge_base_path(path: str)

Parses a knowledge_base path into its component segments.

update_conversation_profile

update_conversation_profile(request: Optional[Union[google.cloud.dialogflow_v2.types.conversation_profile.UpdateConversationProfileRequest, dict]] = None, *, conversation_profile: Optional[google.cloud.dialogflow_v2.types.conversation_profile.ConversationProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via xref_GetConversationProfile API.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.UpdateConversationProfileRequest, dict]` The request object. The request message for ConversationProfiles.UpdateConversationProfile.
`conversation_profile`	`google.cloud.dialogflow_v2.types.ConversationProfile` Required. The conversation profile to update. This corresponds to the `conversation_profile` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The mask to control which fields to update. 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.dialogflow_v2.types.ConversationProfile`	Defines the services to connect to incoming Dialogflow conversations.