As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Flows

class google.cloud.dialogflowcx_v3.services.flows.FlowsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].

Instantiates the flows client.

Parameters
  • 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, FlowsTransport]) – 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 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async create_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.CreateFlowRequest] = None, *, parent: Optional[str] = None, flow: Optional[google.cloud.dialogflowcx_v3.types.flow.Flow] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Creates a flow in the specified agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateFlowRequest) – The request object. The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].

  • parent (str) –

    Required. The agent to create a flow for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • flow (google.cloud.dialogflowcx_v3.types.Flow) – Required. The flow to create. This corresponds to the flow 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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

async delete_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.DeleteFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteFlowRequest) – The request object. The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].

  • name (str) –

    Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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.

async export_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ExportFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Exports the specified flow to a binary file. Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ExportFlowResponse The response message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

Return type

google.api_core.operation_async.AsyncOperation

static flow_path(project: str, location: str, agent: str, flow: str)str

Returns a fully-qualified flow string.

static flow_validation_result_path(project: str, location: str, agent: str, flow: str)str

Returns a fully-qualified flow_validation_result string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsAsyncClient

async get_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.GetFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Retrieves the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetFlowRequest) – The request object. The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].

  • name (str) –

    Required. The name of the flow to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

async get_flow_validation_result(request: Optional[google.cloud.dialogflowcx_v3.types.flow.GetFlowValidationResultRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.FlowValidationResult[source]

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetFlowValidationResultRequest) – The request object. The request message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

  • name (str) –

    Required. The flow name. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult.

    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

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Return type

google.cloud.dialogflowcx_v3.types.FlowValidationResult

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async import_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ImportFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Imports the specified flow to the specified agent from a binary file.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ImportFlowResponse The response message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

Return type

google.api_core.operation_async.AsyncOperation

static intent_path(project: str, location: str, agent: str, intent: str)str

Returns a fully-qualified intent string.

async list_flows(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsAsyncPager[source]

Returns the list of all flows in the specified agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListFlowsRequest) – The request object. The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

  • parent (str) –

    Required. The agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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

The response message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsAsyncPager

static page_path(project: str, location: str, agent: str, flow: str, page: str)str

Returns a fully-qualified page string.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_flow_path(path: str)Dict[str, str]

Parses a flow path into its component segments.

static parse_flow_validation_result_path(path: str)Dict[str, str]

Parses a flow_validation_result path into its component segments.

static parse_intent_path(path: str)Dict[str, str]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str]

Parses a page path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str]

Parses a webhook path into its component segments.

async train_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.TrainFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Trains the specified flow. Note that only the flow in ‘draft’ environment is trained.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.TrainFlowRequest) – The request object. The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].

  • name (str) –

    Required. The flow to train. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

static 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.

property transport: google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

FlowsTransport

async update_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.UpdateFlowRequest] = None, *, flow: Optional[google.cloud.dialogflowcx_v3.types.flow.Flow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Updates the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdateFlowRequest) – The request object. The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].

  • flow (google.cloud.dialogflowcx_v3.types.Flow) – Required. The flow to update. This corresponds to the flow 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 get updated. If update_mask is not specified, an error will be returned.

    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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

async validate_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ValidateFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.FlowValidationResult[source]

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

Parameters
Returns

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Return type

google.cloud.dialogflowcx_v3.types.FlowValidationResult

static webhook_path(project: str, location: str, agent: str, webhook: str)str

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.flows.FlowsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport]] = 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>)[source]

Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].

Instantiates the flows client.

Parameters
  • 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, FlowsTransport]) – 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

create_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.CreateFlowRequest] = None, *, parent: Optional[str] = None, flow: Optional[google.cloud.dialogflowcx_v3.types.flow.Flow] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Creates a flow in the specified agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateFlowRequest) – The request object. The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].

  • parent (str) –

    Required. The agent to create a flow for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • flow (google.cloud.dialogflowcx_v3.types.Flow) – Required. The flow to create. This corresponds to the flow 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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

delete_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.DeleteFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteFlowRequest) – The request object. The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].

  • name (str) –

    Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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.

export_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ExportFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Exports the specified flow to a binary file. Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ExportFlowResponse The response message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

Return type

google.api_core.operation.Operation

static flow_path(project: str, location: str, agent: str, flow: str)str[source]

Returns a fully-qualified flow string.

static flow_validation_result_path(project: str, location: str, agent: str, flow: str)str[source]

Returns a fully-qualified flow_validation_result string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

FlowsClient

get_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.GetFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Retrieves the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetFlowRequest) – The request object. The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].

  • name (str) –

    Required. The name of the flow to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

get_flow_validation_result(request: Optional[google.cloud.dialogflowcx_v3.types.flow.GetFlowValidationResultRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.FlowValidationResult[source]

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetFlowValidationResultRequest) – The request object. The request message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

  • name (str) –

    Required. The flow name. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult.

    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

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Return type

google.cloud.dialogflowcx_v3.types.FlowValidationResult

import_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ImportFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Imports the specified flow to the specified agent from a binary file.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ImportFlowResponse The response message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

Return type

google.api_core.operation.Operation

static intent_path(project: str, location: str, agent: str, intent: str)str[source]

Returns a fully-qualified intent string.

list_flows(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsPager[source]

Returns the list of all flows in the specified agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListFlowsRequest) – The request object. The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

  • parent (str) –

    Required. The agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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

The response message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsPager

static page_path(project: str, location: str, agent: str, flow: str, page: str)str[source]

Returns a fully-qualified page string.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_flow_path(path: str)Dict[str, str][source]

Parses a flow path into its component segments.

static parse_flow_validation_result_path(path: str)Dict[str, str][source]

Parses a flow_validation_result path into its component segments.

static parse_intent_path(path: str)Dict[str, str][source]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str][source]

Parses a page path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str][source]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str][source]

Parses a webhook path into its component segments.

train_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.TrainFlowRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Trains the specified flow. Note that only the flow in ‘draft’ environment is trained.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.TrainFlowRequest) – The request object. The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].

  • name (str) –

    Required. The flow to train. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

static transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)str[source]

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.flows.transports.base.FlowsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

FlowsTransport

update_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.UpdateFlowRequest] = None, *, flow: Optional[google.cloud.dialogflowcx_v3.types.flow.Flow] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.Flow[source]

Updates the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdateFlowRequest) – The request object. The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].

  • flow (google.cloud.dialogflowcx_v3.types.Flow) – Required. The flow to update. This corresponds to the flow 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 get updated. If update_mask is not specified, an error will be returned.

    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

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be “consumed”. This means the intent won’t activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Return type

google.cloud.dialogflowcx_v3.types.Flow

validate_flow(request: Optional[google.cloud.dialogflowcx_v3.types.flow.ValidateFlowRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.flow.FlowValidationResult[source]

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

Parameters
Returns

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Return type

google.cloud.dialogflowcx_v3.types.FlowValidationResult

static webhook_path(project: str, location: str, agent: str, webhook: str)str[source]

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.flow.ListFlowsResponse]], request: google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest, response: google.cloud.dialogflowcx_v3.types.flow.ListFlowsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_flows requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListFlowsResponse object, and provides an __aiter__ method to iterate through its flows field.

If there are more pages, the __aiter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.flows.pagers.ListFlowsPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.flow.ListFlowsResponse], request: google.cloud.dialogflowcx_v3.types.flow.ListFlowsRequest, response: google.cloud.dialogflowcx_v3.types.flow.ListFlowsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_flows requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListFlowsResponse object, and provides an __iter__ method to iterate through its flows field.

If there are more pages, the __iter__ method will make additional ListFlows requests and continue to iterate through the flows field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListFlowsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters