ConversationProfilesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflow_v2beta1.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
Return 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_v2beta1.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>)
Instantiate 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 |
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. |
agent_path
agent_path(project: str)
Return a fully-qualified agent string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return a fully-qualified project string.
conversation_profile_path
conversation_profile_path(project: str, conversation_profile: str)
Return a fully-qualified conversation_profile string.
create_conversation_profile
create_conversation_profile(request: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.CreateConversationProfileRequest] = None, *, parent: Optional[str] = None, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, retry: google.api_core.retry.Retry = <_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 |
google.cloud.dialogflow_v2beta1.types.CreateConversationProfileRequest
The request object. The request message for ConversationProfiles.CreateConversationProfile. |
parent |
str
Required. The project to create a conversation profile for. Format: |
conversation_profile |
google.cloud.dialogflow_v2beta1.types.ConversationProfile
Required. The conversation profile 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.dialogflow_v2beta1.types.ConversationProfile | Defines the services to connect to incoming Dialogflow conversations. |
delete_conversation_profile
delete_conversation_profile(request: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.DeleteConversationProfileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified conversation profile.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.dialogflow_v2beta1.types.DeleteConversationProfileRequest
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: |
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)
Return 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[google.cloud.dialogflow_v2beta1.types.conversation_profile.GetConversationProfileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the specified conversation profile.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.dialogflow_v2beta1.types.GetConversationProfileRequest
The request object. The request message for ConversationProfiles.GetConversationProfile. |
name |
str
Required. The resource name of the conversation profile. 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.dialogflow_v2beta1.types.ConversationProfile | Defines the services to connect to incoming Dialogflow conversations. |
knowledge_base_path
knowledge_base_path(project: str, knowledge_base: str)
Return a fully-qualified knowledge_base string.
list_conversation_profiles
list_conversation_profiles(request: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ListConversationProfilesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_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 |
google.cloud.dialogflow_v2beta1.types.ListConversationProfilesRequest
The request object. The request message for ConversationProfiles.ListConversationProfiles. |
parent |
str
Required. The project to list all conversation profiles from. 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.dialogflow_v2beta1.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)
Parse 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_profile_path
parse_conversation_profile_path(path: str)
Parse a conversation_profile path into its component segments.
parse_document_path
parse_document_path(path: str)
Parse a document path into its component segments.
parse_knowledge_base_path
parse_knowledge_base_path(path: str)
Parse a knowledge_base path into its component segments.
update_conversation_profile
update_conversation_profile(request: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.UpdateConversationProfileRequest] = None, *, conversation_profile: Optional[google.cloud.dialogflow_v2beta1.types.conversation_profile.ConversationProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_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 |
google.cloud.dialogflow_v2beta1.types.UpdateConversationProfileRequest
The request object. The request message for ConversationProfiles.UpdateConversationProfile. |
conversation_profile |
google.cloud.dialogflow_v2beta1.types.ConversationProfile
Required. The conversation profile to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. The mask to control which fields to update. 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.dialogflow_v2beta1.types.ConversationProfile | Defines the services to connect to incoming Dialogflow conversations. |