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.

Types for Google Cloud Dialogflowcx v3 API

class google.cloud.dialogflowcx_v3.types.AdvancedSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level.

Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.

logging_settings

Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings.LoggingSettings

class LoggingSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Define behaviors on logging. .. attribute:: enable_stackdriver_logging

If true, StackDriver logging is currently enabled.

type

bool

enable_interaction_logging

If true, DF Interaction logging is currently enabled.

Type

bool

class google.cloud.dialogflowcx_v3.types.Agent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..

name

The unique identifier of the agent. Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

display_name

Required. The human-readable name of the agent, unique within the location.

Type

str

default_language_code

Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method.

Type

str

supported_language_codes

The list of all languages supported by the agent (except for the default_language_code).

Type

Sequence[str]

time_zone

Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Type

str

description

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Type

str

avatar_uri

The URI of the agent’s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Type

str

speech_to_text_settings

Speech recognition related settings.

Type

google.cloud.dialogflowcx_v3.types.SpeechToTextSettings

start_flow

Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

security_settings

Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Type

str

enable_stackdriver_logging

Indicates if stackdriver logging is enabled for the agent. Please use [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings] instead.

Type

bool

enable_spell_correction

Indicates if automatic spell correction is enabled in detect intent requests.

Type

bool

advanced_settings

Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

class google.cloud.dialogflowcx_v3.types.AgentValidationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

name

The unique identifier of the agent validation result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/validationResult.

Type

str

flow_validation_results

Contains all flow validation results.

Type

Sequence[google.cloud.dialogflowcx_v3.types.FlowValidationResult]

class google.cloud.dialogflowcx_v3.types.AudioEncoding(value)[source]

Bases: proto.enums.Enum

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

AUDIO_ENCODING_AMR = 4
AUDIO_ENCODING_AMR_WB = 5
AUDIO_ENCODING_FLAC = 2
AUDIO_ENCODING_LINEAR_16 = 1
AUDIO_ENCODING_MULAW = 3
AUDIO_ENCODING_OGG_OPUS = 6
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
AUDIO_ENCODING_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.AudioInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the natural speech audio to be processed. .. attribute:: config

Required. Instructs the speech recognizer how to process the speech audio.

type

google.cloud.dialogflowcx_v3.types.InputAudioConfig

audio

The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The [transcribed text][google.cloud.dialogflow.cx.v3.QueryResult.transcript] cannot contain more than 256 bytes.

For non-streaming audio detect intent, both config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.

Type

bytes

class google.cloud.dialogflowcx_v3.types.BatchDeleteTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

parent

Required. The agent to delete test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

names

Required. Format of test case names: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>.

Type

Sequence[str]

class google.cloud.dialogflowcx_v3.types.BatchRunTestCasesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata returned for the [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases] long running operation.

errors

The test errors.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestError]

class google.cloud.dialogflowcx_v3.types.BatchRunTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

parent

Required. Agent name. Format: projects/<Project ID>/locations/<Location ID>/agents/ <AgentID>.

Type

str

environment

Optional. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

test_cases

Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

Type

Sequence[str]

class google.cloud.dialogflowcx_v3.types.BatchRunTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

results

The test case results. The detailed [conversation turns][google.cloud.dialogflow.cx.v3.TestCaseResult.conversation_turns] are empty in this response.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestCaseResult]

class google.cloud.dialogflowcx_v3.types.CalculateCoverageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

agent

Required. The agent to calculate coverage for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

type_

Required. The type of coverage requested.

Type

google.cloud.dialogflowcx_v3.types.CalculateCoverageRequest.CoverageType

class CoverageType(value)[source]

Bases: proto.enums.Enum

The type of coverage score requested.

COVERAGE_TYPE_UNSPECIFIED = 0
INTENT = 1
PAGE_TRANSITION = 2
TRANSITION_ROUTE_GROUP = 3
class google.cloud.dialogflowcx_v3.types.CalculateCoverageResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

agent

The agent to calculate coverage for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

intent_coverage

Intent coverage.

Type

google.cloud.dialogflowcx_v3.types.IntentCoverage

transition_coverage

Transition (excluding transition route groups) coverage.

Type

google.cloud.dialogflowcx_v3.types.TransitionCoverage

route_group_coverage

Transition route group coverage.

Type

google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage

class google.cloud.dialogflowcx_v3.types.ContinuousTestResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a result from running a test case in an agent environment.

name

The resource name for the continuous test result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/continuousTestResults/<ContinuousTestResult ID>.

Type

str

result

The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not.

Type

google.cloud.dialogflowcx_v3.types.ContinuousTestResult.AggregatedTestResult

test_case_results

A list of individual test case results names in this continuous test run.

Type

Sequence[str]

run_time

Time when the continuous testing run starts.

Type

google.protobuf.timestamp_pb2.Timestamp

class AggregatedTestResult(value)[source]

Bases: proto.enums.Enum

The overall result for a continuous test run in an agent environment.

AGGREGATED_TEST_RESULT_UNSPECIFIED = 0
FAILED = 2
PASSED = 1
class google.cloud.dialogflowcx_v3.types.ConversationTurn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

user_input

The user input.

Type

google.cloud.dialogflowcx_v3.types.ConversationTurn.UserInput

virtual_agent_output

The virtual agent output.

Type

google.cloud.dialogflowcx_v3.types.ConversationTurn.VirtualAgentOutput

class UserInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The input from the human user. .. attribute:: input

Supports [text input][google.cloud.dialogflow.cx.v3.QueryInput.text], [event input][google.cloud.dialogflow.cx.v3.QueryInput.event], [dtmf input][google.cloud.dialogflow.cx.v3.QueryInput.dtmf] in the test case.

type

google.cloud.dialogflowcx_v3.types.QueryInput

injected_parameters

Parameters that need to be injected into the conversation during intent detection.

Type

google.protobuf.struct_pb2.Struct

is_webhook_enabled

If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.

Type

bool

enable_sentiment_analysis

Whether sentiment analysis is enabled.

Type

bool

class VirtualAgentOutput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The output from the virtual agent. .. attribute:: session_parameters

The session parameters available to the bot at this point.

type

google.protobuf.struct_pb2.Struct

differences

Output only. If this is part of a [result conversation turn][TestCaseResult.conversation_turns], the list of differences between the original run and the replay for this output, if any.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestRunDifference]

diagnostic_info

Required. Input only. The diagnostic [info][Session.DetectIntentResponse.QueryResult.diagnostic_info] output for the turn. Required to calculate the testing coverage.

Type

google.protobuf.struct_pb2.Struct

triggered_intent

The [Intent][google.cloud.dialogflow.cx.v3.Intent] that triggered the response. Only name and displayName will be set.

Type

google.cloud.dialogflowcx_v3.types.Intent

current_page

The [Page][google.cloud.dialogflow.cx.v3.Page] on which the utterance was spoken. Only name and displayName will be set.

Type

google.cloud.dialogflowcx_v3.types.Page

text_responses

The [text][google.cloud.dialogflow.cx.v3.ResponseMessage.Text] responses from the agent for the turn.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage.Text]

status

Response error from the agent in the test result. If set, other output is empty.

Type

google.rpc.status_pb2.Status

class google.cloud.dialogflowcx_v3.types.CreateAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].

parent

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

Type

str

agent

Required. The agent to create.

Type

google.cloud.dialogflowcx_v3.types.Agent

class google.cloud.dialogflowcx_v3.types.CreateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.CreateEntityType].

parent

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

Type

str

entity_type

Required. The entity type to create.

Type

google.cloud.dialogflowcx_v3.types.EntityType

language_code

The language of the following fields in entity_type:

  • EntityType.entities.value

  • EntityType.entities.synonyms

  • EntityType.excluded_phrases.value

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.CreateEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

parent

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

environment

Required. The environment to create.

Type

google.cloud.dialogflowcx_v3.types.Environment

class google.cloud.dialogflowcx_v3.types.CreateExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3.Experiments.CreateExperiment].

parent

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

experiment

Required. The experiment to create.

Type

google.cloud.dialogflowcx_v3.types.Experiment

class google.cloud.dialogflowcx_v3.types.CreateFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].

parent

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

Type

str

flow

Required. The flow to create.

Type

google.cloud.dialogflowcx_v3.types.Flow

language_code

The language of the following fields in flow:

  • Flow.event_handlers.trigger_fulfillment.messages

  • Flow.event_handlers.trigger_fulfillment.conditional_cases

  • Flow.transition_routes.trigger_fulfillment.messages

  • Flow.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.CreateIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent].

parent

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

Type

str

intent

Required. The intent to create.

Type

google.cloud.dialogflowcx_v3.types.Intent

language_code

The language of the following fields in intent:

  • Intent.training_phrases.parts.text

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.CreatePageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].

parent

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

Type

str

page

Required. The page to create.

Type

google.cloud.dialogflowcx_v3.types.Page

language_code

The language of the following fields in page:

  • Page.entry_fulfillment.messages

  • Page.entry_fulfillment.conditional_cases

  • Page.event_handlers.trigger_fulfillment.messages

  • Page.event_handlers.trigger_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages

Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages

Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases

  • Page.transition_routes.trigger_fulfillment.messages

  • Page.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.CreateSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SecuritySettings.CreateSecuritySettings][]. .. attribute:: parent

Required. The location to create an [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format: projects/<Project ID>/locations/<Location ID>.

type

str

security_settings

Required. The security settings to create.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings

class google.cloud.dialogflowcx_v3.types.CreateSessionEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].

parent

Required. The session to create a session entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

str

session_entity_type

Required. The session entity type to create.

Type

google.cloud.dialogflowcx_v3.types.SessionEntityType

class google.cloud.dialogflowcx_v3.types.CreateTestCaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

parent

Required. The agent to create the test case for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

test_case

Required. The test case to create.

Type

google.cloud.dialogflowcx_v3.types.TestCase

class google.cloud.dialogflowcx_v3.types.CreateTransitionRouteGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].

parent

Required. The flow to create an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

transition_route_group

Required. The transition route group to create.

Type

google.cloud.dialogflowcx_v3.types.TransitionRouteGroup

language_code

The language of the following fields in TransitionRouteGroup:

  • TransitionRouteGroup.transition_routes.trigger_fulfillment.messages

TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.CreateVersionOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata associated with the long running operation for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

version

Name of the created version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.CreateVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

parent

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

version

Required. The version to create.

Type

google.cloud.dialogflowcx_v3.types.Version

class google.cloud.dialogflowcx_v3.types.CreateWebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook].

parent

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

Type

str

webhook

Required. The webhook to create.

Type

google.cloud.dialogflowcx_v3.types.Webhook

class google.cloud.dialogflowcx_v3.types.DeleteAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].

name

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

Type

str

class google.cloud.dialogflowcx_v3.types.DeleteEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.DeleteEntityType].

name

Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Type

str

force

This field has no effect for entity type not being used. For entity types that are used by intents or pages:

  • If force is set to false, an error will be returned with message indicating the referencing resources.

  • If force is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page [parameter][google.cloud.dialogflow.cx.v3.Form.Parameter] of the entity type will be changed to @sys.any’ and intent [parameter][google.cloud.dialogflow.cx.v3.Intent.Parameter] of the entity type will be removed).

Type

bool

class google.cloud.dialogflowcx_v3.types.DeleteEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

name

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.DeleteExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3.Experiments.DeleteExperiment].

name

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.DeleteFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].

name

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

Type

str

force

This field has no effect for flows with no incoming transitions. For flows with incoming transitions:

  • If force is set to false, an error will be returned with message indicating the incoming transitions.

  • If force is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. [Target flow][EventHandler.target_flow] in event handlers or [Target flow][TransitionRoute.target_flow] in transition routes that point to this flow will be cleared).

Type

bool

class google.cloud.dialogflowcx_v3.types.DeleteIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Intents.DeleteIntent][google.cloud.dialogflow.cx.v3.Intents.DeleteIntent].

name

Required. The name of the intent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.DeletePageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].

name

Required. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.

Type

str

force

This field has no effect for pages with no incoming transitions. For pages with incoming transitions:

  • If force is set to false, an error will be returned with message indicating the incoming transitions.

  • If force is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. [Target page][EventHandler.target_page] in event handlers or [Target page][TransitionRoute.target_page] in transition routes that point to this page will be cleared).

Type

bool

class google.cloud.dialogflowcx_v3.types.DeleteSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SecuritySettings.DeleteSecuritySettings][]. .. attribute:: name

Required. The name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

type

str

class google.cloud.dialogflowcx_v3.types.DeleteSessionEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].

name

Required. The name of the session entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

str

class google.cloud.dialogflowcx_v3.types.DeleteTransitionRouteGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].

name

Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>.

Type

str

force

This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page:

  • If force is set to false, an error will be returned with message indicating pages that reference the transition route group.

  • If force is set to true, Dialogflow will remove the transition route group, as well as any reference to it.

Type

bool

class google.cloud.dialogflowcx_v3.types.DeleteVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].

name

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.DeleteWebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Webhooks.DeleteWebhook][google.cloud.dialogflow.cx.v3.Webhooks.DeleteWebhook].

name

Required. The name of the webhook to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Type

str

force

This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups:

  • If force is set to false, an error will be returned with message indicating the referenced resources.

  • If force is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. [Webhook][google.cloud.dialogflow.cx.v3.Fulfillment.webhook] and [tag][google.cloud.dialogflow.cx.v3.Fulfillment.tag]in fulfillments that point to this webhook will be removed).

Type

bool

class google.cloud.dialogflowcx_v3.types.DetectIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to detect user’s intent. .. attribute:: session

Required. The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. It’s up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.

type

str

query_params

The parameters of this query.

Type

google.cloud.dialogflowcx_v3.types.QueryParameters

query_input

Required. The input specification.

Type

google.cloud.dialogflowcx_v3.types.QueryInput

output_audio_config

Instructs the speech synthesizer how to generate the output audio.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioConfig

class google.cloud.dialogflowcx_v3.types.DetectIntentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The message returned from the DetectIntent method. .. attribute:: response_id

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

type

str

query_result

The result of the conversational query.

Type

google.cloud.dialogflowcx_v3.types.QueryResult

output_audio

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the [query_result.response_messages][google.cloud.dialogflow.cx.v3.QueryResult.response_messages] field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

Type

bytes

output_audio_config

The config used by the speech synthesizer to generate the output audio.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioConfig

response_type

Response type.

Type

google.cloud.dialogflowcx_v3.types.DetectIntentResponse.ResponseType

allow_cancellation

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

Type

bool

class ResponseType(value)[source]

Bases: proto.enums.Enum

Represents different DetectIntentResponse types.

FINAL = 2
PARTIAL = 1
RESPONSE_TYPE_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.DtmfInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the input for dtmf event. .. attribute:: digits

The dtmf digits.

type

str

finish_digit

The finish digit (if any).

Type

str

class google.cloud.dialogflowcx_v3.types.EntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, “soft drink”, “soda”, “pop”, and so on.

There are three types of entities:

  • System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.

  • Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.

  • User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.

For more information about entity types, see the Dialogflow documentation.

name

The unique identifier of the entity type. Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Type

str

display_name

Required. The human-readable name of the entity type, unique within the agent.

Type

str

kind

Required. Indicates the kind of entity type.

Type

google.cloud.dialogflowcx_v3.types.EntityType.Kind

auto_expansion_mode

Indicates whether the entity type can be automatically expanded.

Type

google.cloud.dialogflowcx_v3.types.EntityType.AutoExpansionMode

entities

The collection of entity entries associated with the entity type.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EntityType.Entity]

excluded_phrases

Collection of exceptional words and phrases that shouldn’t be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EntityType.ExcludedPhrase]

enable_fuzzy_extraction

Enables fuzzy entity extraction during classification.

Type

bool

redact

Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

Type

bool

class AutoExpansionMode(value)[source]

Bases: proto.enums.Enum

Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).

AUTO_EXPANSION_MODE_DEFAULT = 1
AUTO_EXPANSION_MODE_UNSPECIFIED = 0
class Entity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An entity entry for an associated entity type. .. attribute:: value

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

type

str

synonyms

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

Type

Sequence[str]

class ExcludedPhrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An excluded entity phrase that should not be matched. .. attribute:: value

Required. The word or phrase to be excluded.

type

str

class Kind(value)[source]

Bases: proto.enums.Enum

Represents kinds of entities.

KIND_LIST = 2
KIND_MAP = 1
KIND_REGEXP = 3
KIND_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.

name

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

display_name

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

Type

str

description

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

Type

str

version_configs

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Environment.VersionConfig]

update_time

Output only. Update time of this environment.

Type

google.protobuf.timestamp_pb2.Timestamp

class VersionConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration for the version. .. attribute:: version

Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

type

str

class google.cloud.dialogflowcx_v3.types.EventHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An event handler specifies an [event][google.cloud.dialogflow.cx.v3.EventHandler.event] that can be handled during a session. When the specified event happens, the following actions are taken in order:

  • If there is a [trigger_fulfillment][google.cloud.dialogflow.cx.v3.EventHandler.trigger_fulfillment] associated with the event, it will be called.

  • If there is a [target_page][google.cloud.dialogflow.cx.v3.EventHandler.target_page] associated with the event, the session will transition into the specified page.

  • If there is a [target_flow][google.cloud.dialogflow.cx.v3.EventHandler.target_flow] associated with the event, the session will transition into the specified flow.

name

Output only. The unique identifier of this event handler.

Type

str

event

Required. The name of the event to handle.

Type

str

trigger_fulfillment

The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment

target_page

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Type

str

target_flow

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

Type

str

class google.cloud.dialogflowcx_v3.types.EventInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the event to trigger. .. attribute:: event

Name of the event.

type

str

class google.cloud.dialogflowcx_v3.types.Experiment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents an experiment in an environment. .. attribute:: name

The name of the experiment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>..

type

str

display_name

Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.

Type

str

description

The human-readable description of the experiment.

Type

str

state

The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

Type

google.cloud.dialogflowcx_v3.types.Experiment.State

definition

The definition of the experiment.

Type

google.cloud.dialogflowcx_v3.types.Experiment.Definition

rollout_config

The configuration for auto rollout. If set, there should be exactly two variants in the experiment (control variant being the default version of the flow), the traffic allocation for the non-control variant will gradually increase to 100% when conditions are met, and eventually replace the control variant to become the default version of the flow.

Type

google.cloud.dialogflowcx_v3.types.RolloutConfig

rollout_state

State of the auto rollout process.

Type

google.cloud.dialogflowcx_v3.types.RolloutState

rollout_failure_reason

The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.

Type

str

result

Inference result of the experiment.

Type

google.cloud.dialogflowcx_v3.types.Experiment.Result

create_time

Creation time of this experiment.

Type

google.protobuf.timestamp_pb2.Timestamp

start_time

Start time of this experiment.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

End time of this experiment.

Type

google.protobuf.timestamp_pb2.Timestamp

last_update_time

Last update time of this experiment.

Type

google.protobuf.timestamp_pb2.Timestamp

experiment_length

Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.

Type

google.protobuf.duration_pb2.Duration

variants_history

The history of updates to the experiment variants.

Type

Sequence[google.cloud.dialogflowcx_v3.types.VariantsHistory]

class Definition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Definition of the experiment. .. attribute:: condition

The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. “query_input.language_code=en” See the conditions reference.

type

str

version_variants

The flow versions as the variants of this experiment.

Type

google.cloud.dialogflowcx_v3.types.VersionVariants

class Result(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The inference result which includes an objective metric to optimize and the confidence interval.

version_metrics

Version variants and metrics.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Experiment.Result.VersionMetrics]

last_update_time

The last time the experiment’s stats data was updated. Will have default value if stats have never been computed for this experiment.

Type

google.protobuf.timestamp_pb2.Timestamp

class ConfidenceInterval(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A confidence interval is a range of possible values for the experiment objective you are trying to measure.

confidence_level

The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.

Type

float

ratio

The percent change between an experiment metric’s value and the value for its control.

Type

float

lower_bound

Lower bound of the interval.

Type

float

upper_bound

Upper bound of the interval.

Type

float

class CountType(value)[source]

Bases: proto.enums.Enum

Types of count-based metric for Dialogflow experiment.

AVERAGE_TURN_COUNT = 3
COUNT_TYPE_UNSPECIFIED = 0
TOTAL_NO_MATCH_COUNT = 1
TOTAL_TURN_COUNT = 2
class Metric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metric and corresponding confidence intervals. .. attribute:: type_

Ratio-based metric type. Only one of type or count_type is specified in each Metric.

type

google.cloud.dialogflowcx_v3.types.Experiment.Result.MetricType

count_type

Count-based metric type. Only one of type or count_type is specified in each Metric.

Type

google.cloud.dialogflowcx_v3.types.Experiment.Result.CountType

ratio

Ratio value of a metric.

Type

float

count

Count value of a metric.

Type

float

confidence_interval

The probability that the treatment is better than all other treatments in the experiment

Type

google.cloud.dialogflowcx_v3.types.Experiment.Result.ConfidenceInterval

class MetricType(value)[source]

Bases: proto.enums.Enum

Types of ratio-based metric for Dialogflow experiment.

ABANDONED_SESSION_RATE = 4
CALLBACK_SESSION_RATE = 3
CONTAINED_SESSION_NO_CALLBACK_RATE = 1
LIVE_AGENT_HANDOFF_RATE = 2
METRIC_UNSPECIFIED = 0
SESSION_END_RATE = 5
class VersionMetrics(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Version variant and associated metrics. .. attribute:: version

The name of the flow [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

type

str

metrics

The metrics and corresponding confidence intervals in the inference result.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Experiment.Result.Metric]

session_count

Number of sessions that were allocated to this version.

Type

int

class State(value)[source]

Bases: proto.enums.Enum

The state of the experiment.

DONE = 3
DRAFT = 1
ROLLOUT_FAILED = 4
RUNNING = 2
STATE_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.ExportAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

name

Required. The name of the agent to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

agent_uri

Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.

Type

str

environment

Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.ExportAgentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

agent_uri

The URI to a file containing the exported agent. This field is populated only if agent_uri is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].

Type

str

agent_content

Uncompressed raw byte content for agent.

Type

bytes

class google.cloud.dialogflowcx_v3.types.ExportFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

name

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

Type

str

flow_uri

Optional. The Google Cloud Storage URI to export the flow to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized flow is returned inline.

Type

str

include_referenced_flows

Optional. Whether to export flows referenced by the specified flow.

Type

bool

class google.cloud.dialogflowcx_v3.types.ExportFlowResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

flow_uri

The URI to a file containing the exported flow. This field is populated only if flow_uri is specified in [ExportFlowRequest][google.cloud.dialogflow.cx.v3.ExportFlowRequest].

Type

str

flow_content

Uncompressed raw byte content for flow.

Type

bytes

class google.cloud.dialogflowcx_v3.types.ExportTestCasesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata returned for the [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases] long running operation.

class google.cloud.dialogflowcx_v3.types.ExportTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

parent

Required. The agent where to export test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

gcs_uri

The Google Cloud Storage URI to export the test cases to. The format of this URI must be gs://<bucket-name>/<object-name>. If unspecified, the serialized test cases is returned inline.

Type

str

data_format

The data format of the exported test cases. If not specified, BLOB is assumed.

Type

google.cloud.dialogflowcx_v3.types.ExportTestCasesRequest.DataFormat

filter

The filter expression used to filter exported test cases, see API Filtering. The expression is case insensitive and supports the following syntax:

name = [OR name = ] …

For example:

  • “name = t1 OR name = t2” matches the test case with the exact resource name “t1” or “t2”.

Type

str

class DataFormat(value)[source]

Bases: proto.enums.Enum

Data format of the exported test cases.

BLOB = 1
DATA_FORMAT_UNSPECIFIED = 0
JSON = 2
class google.cloud.dialogflowcx_v3.types.ExportTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

gcs_uri

The URI to a file containing the exported test cases. This field is populated only if gcs_uri is specified in [ExportTestCasesRequest][google.cloud.dialogflow.cx.v3.ExportTestCasesRequest].

Type

str

content

Uncompressed raw byte content for test cases.

Type

bytes

class google.cloud.dialogflowcx_v3.types.Flow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The unique identifier of the flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

display_name

Required. The human-readable name of the flow.

Type

str

description

The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.

Type

str

transition_routes

A flow’s transition routes serve two purposes:

  • They are responsible for matching the user’s first utterances in the flow.

  • They are inherited by every page’s [transition routes][Page.transition_routes] and can support use cases such as the user saying “help” or “can I talk to a human?”, which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.

TransitionRoutes are evalauted in the following order:

  • TransitionRoutes with intent specified..

  • TransitionRoutes with only condition specified.

TransitionRoutes with intent specified are inherited by pages in the flow.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]

event_handlers

A flow’s event handlers serve two purposes:

  • They are responsible for handling events (e.g. no match, webhook errors) in the flow.

  • They are inherited by every page’s [event handlers][Page.event_handlers], which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.

Unlike [transition_routes][google.cloud.dialogflow.cx.v3.Flow.transition_routes], these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]

transition_route_groups

A flow’s transition route group serve two purposes:

  • They are responsible for matching the user’s first utterances in the flow.

  • They are inherited by every page’s [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow.

Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>.

Type

Sequence[str]

nlu_settings

NLU related settings of the flow.

Type

google.cloud.dialogflowcx_v3.types.NluSettings

class google.cloud.dialogflowcx_v3.types.FlowValidationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

name

The unique identifier of the flow validation result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult.

Type

str

validation_messages

Contains all validation messages.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ValidationMessage]

update_time

Last time the flow was validated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.Form(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a [page][google.cloud.dialogflow.cx.v3.Page]. When form filling is done, the filled parameters will be written to the [session][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

parameters

Parameters to collect from the user.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Form.Parameter]

class Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a form parameter. .. attribute:: display_name

Required. The human-readable name of the parameter, unique within the form.

type

str

required

Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Type

bool

entity_type

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

Type

str

is_list

Indicates whether the parameter represents a list of values.

Type

bool

fill_behavior

Required. Defines fill behavior for the parameter.

Type

google.cloud.dialogflowcx_v3.types.Form.Parameter.FillBehavior

default_value

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

Type

google.protobuf.struct_pb2.Value

redact

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.

Type

bool

class FillBehavior(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration for how the filling of a parameter should be handled.

initial_prompt_fulfillment

Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment

reprompt_event_handlers

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

  • sys.no-match-<N>, where N can be from 1 to 6

  • sys.no-match-default

  • sys.no-input-<N>, where N can be from 1 to 6

  • sys.no-input-default

  • sys.invalid-parameter

initial_prompt_fulfillment provides the first prompt for the parameter.

If the user’s response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user’s response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

If the event handler for the corresponding event can’t be found on the parameter, initial_prompt_fulfillment will be re-prompted.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]

class google.cloud.dialogflowcx_v3.types.FulfillIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request of [FulfillIntent][] .. attribute:: match_intent_request

Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined.

type

google.cloud.dialogflowcx_v3.types.MatchIntentRequest

match

The matched intent/event to fulfill.

Type

google.cloud.dialogflowcx_v3.types.Match

output_audio_config

Instructs the speech synthesizer how to generate output audio.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioConfig

class google.cloud.dialogflowcx_v3.types.FulfillIntentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of [FulfillIntent][] .. attribute:: response_id

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

type

str

query_result

The result of the conversational query.

Type

google.cloud.dialogflowcx_v3.types.QueryResult

output_audio

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the [query_result.response_messages][google.cloud.dialogflow.cx.v3.QueryResult.response_messages] field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

Type

bytes

output_audio_config

The config used by the speech synthesizer to generate the output audio.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioConfig

class google.cloud.dialogflowcx_v3.types.Fulfillment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A fulfillment can do one or more of the following actions at the same time:

  • Generate rich message responses.

  • Set parameter values.

  • Call the webhook.

Fulfillments can be called at various stages in the [Page][google.cloud.dialogflow.cx.v3.Page] or [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest] drives a session to enter a new page, the page’s entry fulfillment can add a static response to the [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse], call the webhook (for example, to load user data from a database), or both.

messages

The list of rich message responses to present to the user.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]

webhook

The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Type

str

return_partial_responses

Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.

Type

bool

tag

The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified.

Type

str

set_parameter_actions

Set parameter values before executing the webhook.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.SetParameterAction]

conditional_cases

Conditional cases for this fulfillment.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases]

class ConditionalCases(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.

cases

A list of cascading if-else conditions.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases.Case]

class Case(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.

condition

The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against [form parameters][Form.parameters] or [session parameters][SessionInfo.parameters].

See the conditions reference.

Type

str

case_content

A list of case content.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases.Case.CaseContent]

class CaseContent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The list of messages or conditional cases to activate for this case.

message

Returned message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage

additional_cases

Additional cases to be evaluated.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases

class SetParameterAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Setting a parameter value. .. attribute:: parameter

Display name of the parameter.

type

str

value

The new value of the parameter. A null value clears the parameter.

Type

google.protobuf.struct_pb2.Value

class google.cloud.dialogflowcx_v3.types.GetAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].

name

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

Type

str

class google.cloud.dialogflowcx_v3.types.GetAgentValidationResultRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

name

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

Type

str

language_code

If not specified, the agent’s default language is used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType].

name

Required. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Type

str

language_code

The language to retrieve the entity type for. The following fields are language dependent:

  • EntityType.entities.value

  • EntityType.entities.synonyms

  • EntityType.excluded_phrases.value

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

name

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3.Experiments.GetExperiment].

name

Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

name

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

Type

str

language_code

The language to retrieve the flow for. The following fields are language dependent:

  • Flow.event_handlers.trigger_fulfillment.messages

  • Flow.event_handlers.trigger_fulfillment.conditional_cases

  • Flow.transition_routes.trigger_fulfillment.messages

  • Flow.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetFlowValidationResultRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

name

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

Type

str

language_code

If not specified, the agent’s default language is used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Intents.GetIntent][google.cloud.dialogflow.cx.v3.Intents.GetIntent].

name

Required. The name of the intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

language_code

The language to retrieve the intent for. The following fields are language dependent:

  • Intent.training_phrases.parts.text

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetPageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].

name

Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Type

str

language_code

The language to retrieve the page for. The following fields are language dependent:

  • Page.entry_fulfillment.messages

  • Page.entry_fulfillment.conditional_cases

  • Page.event_handlers.trigger_fulfillment.messages

  • Page.event_handlers.trigger_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages

Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages

Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases

  • Page.transition_routes.trigger_fulfillment.messages

  • Page.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].

name

Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetSessionEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].

name

Required. The name of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

str

class google.cloud.dialogflowcx_v3.types.GetTestCaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

name

Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetTestCaseResultRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

name

Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetTransitionRouteGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].

name

Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>.

Type

str

language_code

The language to retrieve the transition route group for. The following fields are language dependent:

  • TransitionRouteGroup.transition_routes.trigger_fulfillment.messages

TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.GetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].

name

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetWebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Webhooks.GetWebhook][google.cloud.dialogflow.cx.v3.Webhooks.GetWebhook].

name

Required. The name of the webhook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.ImportFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

parent

Required. The agent to import the flow into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

flow_uri

The Google Cloud Storage URI to import flow from. The format of this URI must be gs://<bucket-name>/<object-name>.

Type

str

flow_content

Uncompressed raw byte content for flow.

Type

bytes

import_option

Flow import mode. If not specified, KEEP is assumed.

Type

google.cloud.dialogflowcx_v3.types.ImportFlowRequest.ImportOption

class ImportOption(value)[source]

Bases: proto.enums.Enum

Import option.

FALLBACK = 2
IMPORT_OPTION_UNSPECIFIED = 0
KEEP = 1
class google.cloud.dialogflowcx_v3.types.ImportFlowResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

flow

The unique identifier of the new flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.ImportTestCasesMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata returned for the [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases] long running operation.

errors

Errors for failed test cases.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestCaseError]

class google.cloud.dialogflowcx_v3.types.ImportTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

parent

Required. The agent to import test cases to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

gcs_uri

The Google Cloud Storage URI to import test cases from. The format of this URI must be gs://<bucket-name>/<object-name>.

Type

str

content

Uncompressed raw byte content for test cases.

Type

bytes

class google.cloud.dialogflowcx_v3.types.ImportTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

names

The unique identifiers of the new test cases. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

Type

Sequence[str]

class google.cloud.dialogflowcx_v3.types.InputAudioConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Instructs the speech recognizer on how to process the audio content.

audio_encoding

Required. Audio encoding of the audio content to process.

Type

google.cloud.dialogflowcx_v3.types.AudioEncoding

sample_rate_hertz

Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

Type

int

enable_word_info

Optional. If true, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult] with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn’t return any word-level information.

Type

bool

phrase_hints

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

Type

Sequence[str]

model

Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details.

Type

str

model_variant

Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

Type

google.cloud.dialogflowcx_v3.types.SpeechModelVariant

single_utterance

Optional. If false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio’s voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.

Type

bool

class google.cloud.dialogflowcx_v3.types.Intent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An intent represents a user’s intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

name

The unique identifier of the intent. Required for the [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent] method. [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

display_name

Required. The human-readable name of the intent, unique within the agent.

Type

str

training_phrases

The collection of training phrases the agent is trained on to identify the intent.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Intent.TrainingPhrase]

parameters

The collection of parameters associated with the intent.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Intent.Parameter]

priority

The priority of this intent. Higher numbers represent higher priorities.

  • If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.

  • If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Type

int

is_fallback

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

Type

bool

labels

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols ‘-’ and ‘_’. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes.

Prefix “sys-” is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include:

  • sys-head

  • sys-contextual The above labels do not require value. “sys-head” means the intent is a head intent. “sys.contextual” means the intent is a contextual intent.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Intent.LabelsEntry]

description

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

Type

str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents an intent parameter. .. attribute:: id

Required. The unique identifier of the parameter. This field is used by [training phrases][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase] to annotate their [parts][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part].

type

str

entity_type

Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

Type

str

is_list

Indicates whether the parameter represents a list of values.

Type

bool

redact

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.

Type

bool

class TrainingPhrase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents an example that the agent is trained on to identify the intent.

id

Output only. The unique identifier of the training phrase.

Type

str

parts

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the [Part.text][google.cloud.dialogflow.cx.v3.Intent.TrainingPhrase.Part.text] field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.

  • Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Intent.TrainingPhrase.Part]

repeat_count

Indicates how many times this example was added to the intent.

Type

int

class Part(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a part of a training phrase. .. attribute:: text

Required. The text for this part.

type

str

parameter_id

The [parameter][google.cloud.dialogflow.cx.v3.Intent.Parameter] used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

Type

str

class google.cloud.dialogflowcx_v3.types.IntentCoverage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent’s test cases.

intents

The list of Intents present in the agent

Type

Sequence[google.cloud.dialogflowcx_v3.types.IntentCoverage.Intent]

coverage_score

The percent of intents in the agent that are covered.

Type

float

class Intent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The agent’s intent. .. attribute:: intent

The intent full resource name

type

str

covered

Whether or not the intent is covered by at least one of the agent’s test cases.

Type

bool

class google.cloud.dialogflowcx_v3.types.IntentInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the intent to trigger programmatically rather than as a result of natural language processing.

intent

Required. The unique identifier of the intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.IntentView(value)[source]

Bases: proto.enums.Enum

Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response.

INTENT_VIEW_FULL = 2
INTENT_VIEW_PARTIAL = 1
INTENT_VIEW_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.ListAgentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

parent

Required. The location to list all agents for. Format: projects/<Project ID>/locations/<Location ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListAgentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

agents

The list of agents. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Agent]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

parent

Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Environments.ListTestCaseResults][]. .. attribute:: continuous_test_results

The list of continuous test results.

type

Sequence[google.cloud.dialogflowcx_v3.types.ContinuousTestResult]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

parent

Required. The agent to list all entity types for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

language_code

The language to list entity types for. The following fields are language dependent:

  • EntityType.entities.value

  • EntityType.entities.synonyms

  • EntityType.excluded_phrases.value

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListEntityTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

entity_types

The list of entity types. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EntityType]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListEnvironmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

parent

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 20 and at most 100.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListEnvironmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

environments

The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn’t the last page.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Environment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListExperimentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

parent

Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 20 and at most 100.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListExperimentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

experiments

The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn’t the last page.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Experiment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListFlowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

parent

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

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

language_code

The language to list flows for. The following fields are language dependent:

  • Flow.event_handlers.trigger_fulfillment.messages

  • Flow.event_handlers.trigger_fulfillment.conditional_cases

  • Flow.transition_routes.trigger_fulfillment.messages

  • Flow.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.ListFlowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

flows

The list of flows. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Flow]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListIntentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

parent

Required. The agent to list all intents for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

language_code

The language to list intents for. The following fields are language dependent:

  • Intent.training_phrases.parts.text

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

intent_view

The resource view to apply to the returned intent.

Type

google.cloud.dialogflowcx_v3.types.IntentView

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListIntentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

intents

The list of intents. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Intent]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListPagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

parent

Required. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

language_code

The language to list pages for. The following fields are language dependent:

  • Page.entry_fulfillment.messages

  • Page.entry_fulfillment.conditional_cases

  • Page.event_handlers.trigger_fulfillment.messages

  • Page.event_handlers.trigger_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages

Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages

Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases

  • Page.transition_routes.trigger_fulfillment.messages

  • Page.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListPagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

pages

The list of pages. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Page]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SecuritySettings.ListSecuritySettings][]. .. attribute:: parent

Required. The location to list all security settings for. Format: projects/<Project ID>/locations/<Location ID>.

type

str

page_size

The maximum number of items to return in a single page. By default 20 and at most 100.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListSecuritySettingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [SecuritySettings.ListSecuritySettings][]. .. attribute:: security_settings

The list of security settings.

type

Sequence[google.cloud.dialogflowcx_v3.types.SecuritySettings]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListSessionEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

parent

Required. The session to list all session entity types from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListSessionEntityTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

session_entity_types

The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.SessionEntityType]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListTestCaseResultsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

parent

Required. The test case to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ testCases/<TestCase ID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

filter

The filter expression used to filter test case results. See API Filtering.

The expression is case insensitive. Only ‘AND’ is supported for logical operators. The supported syntax is listed below in detail:

[AND ] … [AND latest]

The supported fields and operators are: field operator environment =, IN (Use value draft for draft environment) test_time >, <

latest only returns the latest test result in all results for each test case.

Examples:

  • “environment=draft AND latest” matches the latest test result for each test case in the draft environment.

  • “environment IN (e1,e2)” matches any test case results with an environment resource name of either “e1” or “e2”.

  • “test_time > 1602540713” matches any test case results with test time later than a unix timestamp in seconds 1602540713.

Type

str

class google.cloud.dialogflowcx_v3.types.ListTestCaseResultsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

test_case_results

The list of test case results.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestCaseResult]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

parent

Required. The agent to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

view

Specifies whether response should include all fields or just the metadata.

Type

google.cloud.dialogflowcx_v3.types.ListTestCasesRequest.TestCaseView

class TestCaseView(value)[source]

Bases: proto.enums.Enum

Specifies how much test case information to include in the response.

BASIC = 1
FULL = 2
TEST_CASE_VIEW_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.ListTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

test_cases

The list of test cases. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestCase]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListTransitionRouteGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

parent

Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

language_code

The language to list transition route groups for. The following fields are language dependent:

  • TransitionRouteGroup.transition_routes.trigger_fulfillment.messages

TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.ListTransitionRouteGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

transition_route_groups

The list of transition route groups. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn’t the last page.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRouteGroup]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

parent

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 20 and at most 100.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

versions

A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn’t the last page.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Version]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.ListWebhooksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

parent

Required. The agent to list all webhooks for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.ListWebhooksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

webhooks

The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Webhook]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.LoadVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].

name

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Type

str

allow_override_agent_resources

This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow’s behavior. If allow_override_agent_resources is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).

Type

bool

class google.cloud.dialogflowcx_v3.types.LookupEnvironmentHistoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

name

Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

page_size

The maximum number of items to return in a single page. By default 100 and at most 1000.

Type

int

page_token

The next_page_token value returned from a previous list request.

Type

str

class google.cloud.dialogflowcx_v3.types.LookupEnvironmentHistoryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

environments

Represents a list of snapshots for an environment. Time of the snapshots is stored in [update_time][google.cloud.dialogflow.cx.v3.Environment.update_time].

Type

Sequence[google.cloud.dialogflowcx_v3.types.Environment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

property raw_page
class google.cloud.dialogflowcx_v3.types.Match(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents one match result of [MatchIntent][]. .. attribute:: intent

The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for [INTENT][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.

type

google.cloud.dialogflowcx_v3.types.Intent

event

The event that matched the query. Only filled for [EVENT][google.cloud.dialogflow.cx.v3.Match.MatchType] match type.

Type

str

parameters

The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type:

  • If parameter’s entity type is a

composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value:

  • If parameter’s entity type is a

composite entity: map from composite entity property names to property values - Else: parameter value

Type

google.protobuf.struct_pb2.Struct

resolved_input

Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.

Type

str

match_type

Type of this [Match][google.cloud.dialogflow.cx.v3.Match].

Type

google.cloud.dialogflowcx_v3.types.Match.MatchType

confidence

The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.

Type

float

class MatchType(value)[source]

Bases: proto.enums.Enum

Type of a Match.

DIRECT_INTENT = 2
EVENT = 6
INTENT = 1
MATCH_TYPE_UNSPECIFIED = 0
NO_INPUT = 5
NO_MATCH = 4
PARAMETER_FILLING = 3
class google.cloud.dialogflowcx_v3.types.MatchIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request of [MatchIntent][]. .. attribute:: session

Required. The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. It’s up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

For more information, see the sessions guide.

type

str

query_params

The parameters of this query.

Type

google.cloud.dialogflowcx_v3.types.QueryParameters

query_input

Required. The input specification.

Type

google.cloud.dialogflowcx_v3.types.QueryInput

class google.cloud.dialogflowcx_v3.types.MatchIntentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response of [MatchIntent][]. .. attribute:: text

If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.

type

str

trigger_intent

If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

transcript

If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

Type

str

trigger_event

If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain a copy of the event name.

Type

str

matches

Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query.

Type

Sequence[google.cloud.dialogflowcx_v3.types.Match]

current_page

The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to name and display_name.

Type

google.cloud.dialogflowcx_v3.types.Page

class google.cloud.dialogflowcx_v3.types.NluSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Settings related to NLU. .. attribute:: model_type

Indicates the type of NLU model.

type

google.cloud.dialogflowcx_v3.types.NluSettings.ModelType

classification_threshold

To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

Type

float

model_training_mode

Indicates NLU model training mode.

Type

google.cloud.dialogflowcx_v3.types.NluSettings.ModelTrainingMode

class ModelTrainingMode(value)[source]

Bases: proto.enums.Enum

NLU model training mode.

MODEL_TRAINING_MODE_AUTOMATIC = 1
MODEL_TRAINING_MODE_MANUAL = 2
MODEL_TRAINING_MODE_UNSPECIFIED = 0
class ModelType(value)[source]

Bases: proto.enums.Enum

NLU model type.

MODEL_TYPE_ADVANCED = 3
MODEL_TYPE_STANDARD = 1
MODEL_TYPE_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.OutputAudioConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Instructs the speech synthesizer how to generate the output audio content.

audio_encoding

Required. Audio encoding of the synthesized audio content.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioEncoding

sample_rate_hertz

Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice’s natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).

Type

int

synthesize_speech_config

Optional. Configuration of how speech should be synthesized.

Type

google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig

class google.cloud.dialogflowcx_v3.types.OutputAudioEncoding(value)[source]

Bases: proto.enums.Enum

Audio encoding of the output audio format in Text-To-Speech.

OUTPUT_AUDIO_ENCODING_LINEAR_16 = 1
OUTPUT_AUDIO_ENCODING_MP3 = 2
OUTPUT_AUDIO_ENCODING_MP3_64_KBPS = 4
OUTPUT_AUDIO_ENCODING_MULAW = 5
OUTPUT_AUDIO_ENCODING_OGG_OPUS = 3
OUTPUT_AUDIO_ENCODING_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.Page(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the Page guide.

name

The unique identifier of the page. Required for the [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Type

str

display_name

Required. The human-readable name of the page, unique within the agent.

Type

str

entry_fulfillment

The fulfillment to call when the session is entering the page.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment

form

The form associated with the page, used for collecting parameters relevant to the page.

Type

google.cloud.dialogflowcx_v3.types.Form

transition_route_groups

Ordered list of [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page. Transition route groups must be unique within a page.

  • If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page’s transition route -> page’s transition route group -> flow’s transition routes.

  • If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence.

Format:projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>.

Type

Sequence[str]

transition_routes

A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow.

When we are in a certain page, the TransitionRoutes are evalauted in the following order:

  • TransitionRoutes defined in the page with intent specified.

  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with intent specified.

  • TransitionRoutes defined in flow with intent specified.

  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Flow.transition_route_groups] with intent specified.

  • TransitionRoutes defined in the page with only condition specified.

  • TransitionRoutes defined in the [transition route groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups] with only condition specified.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]

event_handlers

Handlers associated with the page to handle events such as webhook errors, no match or no input.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]

class google.cloud.dialogflowcx_v3.types.PageInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents page information communicated to and from the webhook.

current_page

Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The unique identifier of the current page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Type

str

form_info

Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. Information about the form.

Type

google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo

class FormInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents form information. .. attribute:: parameter_info

Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.

type

Sequence[google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo.ParameterInfo]

class ParameterInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents parameter information. .. attribute:: display_name

Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Required for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

type

str

required

Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Type

bool

state

Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Required for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The state of the parameter. This field can be set to [INVALID][google.cloud.dialogflow.cx.v3.PageInfo.FormInfo.ParameterInfo.ParameterState.INVALID] by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

Type

google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo.ParameterInfo.ParameterState

value

Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The value of the parameter. This field can be set by the webhook to change the parameter value.

Type

google.protobuf.struct_pb2.Value

just_collected

Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. Indicates if the parameter value was just collected on the last conversation turn.

Type

bool

class ParameterState(value)[source]

Bases: proto.enums.Enum

Represents the state of a parameter.

EMPTY = 1
FILLED = 3
INVALID = 2
PARAMETER_STATE_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.QueryInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the query input. It can contain one of: 1. A conversational query in the form of text.

  1. An intent query that specifies which intent to trigger.

  2. Natural language speech audio to be processed.

  3. An event to be triggered.

text

The natural language text to be processed.

Type

google.cloud.dialogflowcx_v3.types.TextInput

intent

The intent to be triggered.

Type

google.cloud.dialogflowcx_v3.types.IntentInput

audio

The natural language speech audio to be processed.

Type

google.cloud.dialogflowcx_v3.types.AudioInput

event

The event to be triggered.

Type

google.cloud.dialogflowcx_v3.types.EventInput

dtmf

The DTMF event to be handled.

Type

google.cloud.dialogflowcx_v3.types.DtmfInput

language_code

Required. The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

Type

str

class google.cloud.dialogflowcx_v3.types.QueryParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the parameters of a conversational query. .. attribute:: time_zone

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

type

str

geo_location

The geo location of this conversational query.

Type

google.type.latlng_pb2.LatLng

session_entity_types

Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.

Type

Sequence[google.cloud.dialogflowcx_v3.types.SessionEntityType]

payload

This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form:

{
 "telephony": {
   "caller_id": "+18558363987"
 }
}
Type

google.protobuf.struct_pb2.Struct

parameters

Additional parameters to be put into [session parameters][SessionInfo.parameters]. To remove a parameter from the session, clients should explicitly set the parameter value to null.

You can reference the session parameters in the agent with the following format: $session.params.parameter-id.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string

  • MapKey value: parameter name

  • MapValue type:

    • If parameter’s entity type is a composite entity: map

    • Else: depending on parameter value type, could be one of string, number, boolean, null, list or map

  • MapValue value:

    • If parameter’s entity type is a composite entity: map from composite entity property names to property values

    • Else: parameter value

Type

google.protobuf.struct_pb2.Struct

current_page

The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current page][QueryResult.current_page] in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If current_page is specified, the previous state of the session will be ignored by Dialogflow, including the [previous page][QueryResult.current_page] and the [previous session parameters][QueryResult.parameters]. In most cases, [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page] and [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to direct a session to a specific state.

Type

str

disable_webhook

Whether to disable webhook calls for this request.

Type

bool

analyze_query_text_sentiment

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

Type

bool

webhook_headers

This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google’s specified headers are not allowed. Including: “Host”, “Content- Length”, “Connection”, “From”, “User-Agent”, “Accept-Encoding”, “If-Modified-Since”, “If- None-Match”, “X-Forwarded-For”, etc.

Type

Sequence[google.cloud.dialogflowcx_v3.types.QueryParameters.WebhookHeadersEntry]

flow_versions

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

If version 1 of flow X is included in this list, the traffic of flow X will go through version 1 regardless of the version configuration in the environment. Each flow can have at most one version specified in this list.

Type

Sequence[str]

class WebhookHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.dialogflowcx_v3.types.QueryResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the result of a conversational query. .. attribute:: text

If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.

type

str

trigger_intent

If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

transcript

If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

Type

str

trigger_event

If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.

Type

str

language_code

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

Type

str

parameters

The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string

  • MapKey value: parameter name

  • MapValue type:

    • If parameter’s entity type is a composite entity: map

    • Else: depending on parameter value type, could be one of string, number, boolean, null, list or map

  • MapValue value:

    • If parameter’s entity type is a composite entity: map from composite entity property names to property values

    • Else: parameter value

Type

google.protobuf.struct_pb2.Struct

response_messages

The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]

webhook_statuses

The list of webhook call status in the order of call sequence.

Type

Sequence[google.rpc.status_pb2.Status]

webhook_payloads

The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence. If some webhook call fails or doesn’t return any payload, an empty Struct would be used instead.

Type

Sequence[google.protobuf.struct_pb2.Struct]

current_page

The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to name and display_name.

Type

google.cloud.dialogflowcx_v3.types.Page

intent

The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.

Type

google.cloud.dialogflowcx_v3.types.Intent

intent_detection_confidence

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match] instead.

Type

float

match

Intent match result, could be an intent or an event.

Type

google.cloud.dialogflowcx_v3.types.Match

diagnostic_info

The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct’s fields map can change without notice.

Type

google.protobuf.struct_pb2.Struct

sentiment_analysis_result

The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.

Type

google.cloud.dialogflowcx_v3.types.SentimentAnalysisResult

class google.cloud.dialogflowcx_v3.types.ResourceName(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Resource name and display name. .. attribute:: name

Name.

type

str

display_name

Display name.

Type

str

class google.cloud.dialogflowcx_v3.types.ResponseMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a response message that can be returned by a conversational agent.

Response messages are also used for output audio synthesis. The approach is as follows:

  • If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.

  • If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.

  • Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.

This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

text

Returns a text response.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.Text

payload

Returns a response containing a custom, platform-specific payload.

Type

google.protobuf.struct_pb2.Struct

conversation_success

Indicates that the conversation succeeded.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.ConversationSuccess

output_audio_text

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.OutputAudioText

live_agent_handoff

Hands off conversation to a human agent.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.LiveAgentHandoff

end_interaction

Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user.

It’s guaranteed that there is at most one such message in each response.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.EndInteraction

play_audio

Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio]. However, Dialogflow itself does not try to read or process the URI in any way.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.PlayAudio

mixed_audio

Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio]. This message is generated by Dialogflow only and not supposed to be defined by the user.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio

class ConversationSuccess(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.

Dialogflow only uses this to determine which conversations should be counted as successful and doesn’t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don’t return [ConversationSuccess][google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess].

You may set this, for example:

  • In the [entry_fulfillment][google.cloud.dialogflow.cx.v3.Page.entry_fulfillment] of a [Page][google.cloud.dialogflow.cx.v3.Page] if entering the page indicates that the conversation succeeded.

  • In a webhook response when you determine that you handled the customer issue.

metadata

Custom metadata. Dialogflow doesn’t impose any structure on this.

Type

google.protobuf.struct_pb2.Struct

class EndInteraction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.

class LiveAgentHandoff(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Indicates that the conversation should be handed off to a live agent.

Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.

You may set this, for example:

  • In the [entry_fulfillment][google.cloud.dialogflow.cx.v3.Page.entry_fulfillment] of a [Page][google.cloud.dialogflow.cx.v3.Page] if entering the page indicates something went extremely wrong in the conversation.

  • In a webhook response when you determine that the customer issue can only be handled by a human.

metadata

Custom metadata for your handoff procedure. Dialogflow doesn’t impose any structure on this.

Type

google.protobuf.struct_pb2.Struct

class MixedAudio(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio]. This message is generated by Dialogflow only and not supposed to be defined by the user.

segments

Segments this audio response is composed of.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio.Segment]

class Segment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents one segment of audio. .. attribute:: audio

Raw audio synthesized from the Dialogflow agent’s response using the output config specified in the request.

type

bytes

uri

Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

Type

str

allow_playback_interruption

Output only. Whether the playback of this segment can be interrupted by the end user’s speech and the client should then start the next Dialogflow request.

Type

bool

class OutputAudioText(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.

text

The raw text to be synthesized.

Type

str

ssml

The SSML text to be synthesized. For more information, see SSML.

Type

str

allow_playback_interruption

Output only. Whether the playback of this message can be interrupted by the end user’s speech and the client can then starts the next Dialogflow request.

Type

bool

class PlayAudio(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Specifies an audio clip to be played by the client as part of the response.

audio_uri

Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.

Type

str

allow_playback_interruption

Output only. Whether the playback of this message can be interrupted by the end user’s speech and the client can then starts the next Dialogflow request.

Type

bool

class Text(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The text response message. .. attribute:: text

Required. A collection of text responses.

type

Sequence[str]

allow_playback_interruption

Output only. Whether the playback of this message can be interrupted by the end user’s speech and the client can then starts the next Dialogflow request.

Type

bool

class google.cloud.dialogflowcx_v3.types.RestoreAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].

name

Required. The name of the agent to restore into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

agent_uri

The Google Cloud Storage URI to restore agent from. The format of this URI must be gs://<bucket-name>/<object-name>.

Type

str

agent_content

Uncompressed raw byte content for agent.

Type

bytes

restore_option

Agent restore mode. If not specified, KEEP is assumed.

Type

google.cloud.dialogflowcx_v3.types.RestoreAgentRequest.RestoreOption

class RestoreOption(value)[source]

Bases: proto.enums.Enum

Restore option.

FALLBACK = 2
KEEP = 1
RESTORE_OPTION_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.RolloutConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The configuration for auto rollout. .. attribute:: rollout_steps

Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

type

Sequence[google.cloud.dialogflowcx_v3.types.RolloutConfig.RolloutStep]

rollout_condition

The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. “containment_rate > 60% AND callback_rate < 20%”. See the conditions reference.

Type

str

failure_condition

The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. “containment_rate < 10% OR average_turn_count < 3”. See the conditions reference.

Type

str

class RolloutStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A single rollout step with specified traffic allocation. .. attribute:: display_name

The name of the rollout step;

type

str

traffic_percent

The percentage of traffic allocated to the flow version of this rollout step. (0%, 100%].

Type

int

min_duration

The minimum time that this step should last. Should be longer than 1 hour. If not set, the default minimum duration for each step will be 1 hour.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.dialogflowcx_v3.types.RolloutState(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

State of the auto-rollout process. .. attribute:: step

Display name of the current auto rollout step.

type

str

step_index

Index of the current step in the auto rollout steps list.

Type

int

start_time

Start time of the current step.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.RunContinuousTestMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata returned for the [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest] long running operation.

errors

The test errors.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TestError]

class google.cloud.dialogflowcx_v3.types.RunContinuousTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

environment

Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.RunContinuousTestResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

continuous_test_result

The result for a continuous test run.

Type

google.cloud.dialogflowcx_v3.types.ContinuousTestResult

class google.cloud.dialogflowcx_v3.types.RunTestCaseMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation. This message currently has no fields.

class google.cloud.dialogflowcx_v3.types.RunTestCaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

name

Required. Format of test case name to run: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>.

Type

str

environment

Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.RunTestCaseResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

result

The result.

Type

google.cloud.dialogflowcx_v3.types.TestCaseResult

class google.cloud.dialogflowcx_v3.types.SecuritySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

name

Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Type

str

display_name

Required. The human-readable name of the security settings, unique within the location.

Type

str

redaction_strategy

Strategy that defines how we do redaction.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionStrategy

redaction_scope

Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionScope

inspect_template

DLP inspect template name. Use this template to define inspect base settings.

If empty, we use the default DLP inspect config.

The template name will have one of the following formats: projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/inspectTemplates/<Template ID>

Note: inspect_template must be located in the same region as the SecuritySettings.

Type

str

deidentify_template

DLP deidentify template name. Use this template to define de-identification configuration for the content.

If empty, Dialogflow replaces sensitive info with [redacted] text.

The template name will have one of the following formats: projects/<Project ID>/locations/<Location ID>/deidentifyTemplates/<Template ID> OR organizations/<Organization ID>/locations/<Location ID>/deidentifyTemplates/<Template ID>

Note: deidentify_template must be located in the same region as the SecuritySettings.

Type

str

retention_window_days

Retains data in interaction logging for the specified number of days. This does not apply to Cloud logging, which is owned by the user - not Dialogflow. User must Set a value lower than Dialogflow’s default 30d TTL. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use Dialogflow’s default TTL. Note: Interaction logging is a limited access feature. Talk to your Google representative to check availability for you.

Type

int

purge_data_types

List of types of data to remove when retention settings triggers purge.

Type

Sequence[google.cloud.dialogflowcx_v3.types.SecuritySettings.PurgeDataType]

insights_export_settings

Controls conversation exporting settings to Insights after conversation is completed.

If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter what you configure here.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.InsightsExportSettings

class InsightsExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Settings for exporting conversations to Insights.

enable_insights_export

If enabled, we will automatically exports conversations to Insights and Insights runs its analyzers.

Type

bool

class PurgeDataType(value)[source]

Bases: proto.enums.Enum

Type of data we purge after retention settings triggers purge.

DIALOGFLOW_HISTORY = 1
PURGE_DATA_TYPE_UNSPECIFIED = 0
class RedactionScope(value)[source]

Bases: proto.enums.Enum

Defines what types of data to redact.

REDACTION_SCOPE_UNSPECIFIED = 0
REDACT_DISK_STORAGE = 2
class RedactionStrategy(value)[source]

Bases: proto.enums.Enum

Defines how we redact data.

REDACTION_STRATEGY_UNSPECIFIED = 0
REDACT_WITH_SERVICE = 1
class google.cloud.dialogflowcx_v3.types.SentimentAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user’s attitude as positive, negative, or neutral.

score

Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

Type

float

magnitude

A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).

Type

float

class google.cloud.dialogflowcx_v3.types.SessionEntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.

You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as “custom entity types”).

Note: session entity types apply to all queries, regardless of the language.

For more information about entity types, see the Dialogflow documentation.

name

Required. The unique identifier of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

str

entity_override_mode

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

Type

google.cloud.dialogflowcx_v3.types.SessionEntityType.EntityOverrideMode

entities

Required. The collection of entities to override or supplement the custom entity type.

Type

Sequence[google.cloud.dialogflowcx_v3.types.EntityType.Entity]

class EntityOverrideMode(value)[source]

Bases: proto.enums.Enum

The types of modifications for the session entity type.

ENTITY_OVERRIDE_MODE_OVERRIDE = 1
ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.SessionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents session information communicated to and from the webhook.

session

Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The unique identifier of the [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This field can be used by the webhook to identify a session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID> if environment is specified.

Type

str

parameters

Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters’ display names.

Type

Sequence[google.cloud.dialogflowcx_v3.types.SessionInfo.ParametersEntry]

class ParametersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.dialogflowcx_v3.types.SpeechModelVariant(value)[source]

Bases: proto.enums.Enum

Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

See the Cloud Speech documentation for which models have different variants. For example, the “phone_call” model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.

SPEECH_MODEL_VARIANT_UNSPECIFIED = 0
USE_BEST_AVAILABLE = 1
USE_ENHANCED = 3
USE_STANDARD = 2
class google.cloud.dialogflowcx_v3.types.SpeechToTextSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Settings related to speech recognition. .. attribute:: enable_speech_adaptation

Whether to use speech adaptation for speech recognition.

type

bool

class google.cloud.dialogflowcx_v3.types.SpeechWordInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Information for a word recognized by the speech recognizer. .. attribute:: word

The word this info is for.

type

str

start_offset

Time offset relative to the beginning of the audio that corresponds to the start of the spoken word. This is an experimental feature and the accuracy of the time offset can vary.

Type

google.protobuf.duration_pb2.Duration

end_offset

Time offset relative to the beginning of the audio that corresponds to the end of the spoken word. This is an experimental feature and the accuracy of the time offset can vary.

Type

google.protobuf.duration_pb2.Duration

confidence

The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is not guaranteed to be fully stable over time for the same audio input. Users should also not rely on it to always be provided.

Type

float

class google.cloud.dialogflowcx_v3.types.SsmlVoiceGender(value)[source]

Bases: proto.enums.Enum

Gender of the voice as described in SSML voice element.

SSML_VOICE_GENDER_FEMALE = 2
SSML_VOICE_GENDER_MALE = 1
SSML_VOICE_GENDER_NEUTRAL = 3
SSML_VOICE_GENDER_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.StartExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3.Experiments.StartExperiment].

name

Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.StopExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3.Experiments.StopExperiment].

name

Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.StreamingDetectIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.

Multiple request messages should be sent in order:

  1. The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config].

  2. If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.audio] to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.cx.v3.QueryInput.text].

    However, note that:

    • Dialogflow will bill you for the audio duration so far.

    • Dialogflow discards all Speech recognition results in favor of the input text.

    • Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the request stream.

session

The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. It’s up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

For more information, see the sessions guide.

Note: Always use agent versions for production traffic. See Versions and environments.

Type

str

query_params

The parameters of this query.

Type

google.cloud.dialogflowcx_v3.types.QueryParameters

query_input

Required. The input specification.

Type

google.cloud.dialogflowcx_v3.types.QueryInput

output_audio_config

Instructs the speech synthesizer how to generate the output audio.

Type

google.cloud.dialogflowcx_v3.types.OutputAudioConfig

enable_partial_response

Enable partial detect intent response. If this flag is not enabled, response stream still contains only one final DetectIntentResponse even if some Fulfillments in the agent have been configured to return partial responses.

Type

bool

class google.cloud.dialogflowcx_v3.types.StreamingDetectIntentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

  1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.

  2. If enable_partial_response is true, the following N messages (currently 1 <= N <= 4) contain detect_intent_response. The first (N-1) detect_intent_responses will have response_type set to PARTIAL. The last detect_intent_response has response_type set to FINAL. If response_type is false, response stream only contains the final detect_intent_response.

recognition_result

The result of speech recognition.

Type

google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult

detect_intent_response

The response from detect intent.

Type

google.cloud.dialogflowcx_v3.types.DetectIntentResponse

class google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.

Example:

  1. transcript: “tube”

  2. transcript: “to be a”

  3. transcript: “to be”

  4. transcript: “to be or not to be” is_final: true

  5. transcript: ” that’s”

  6. transcript: ” that is”

  7. message_type: END_OF_SINGLE_UTTERANCE

  8. transcript: ” that is the question” is_final: true

Only two of the responses contain final results (#4 and #8 indicated by is_final: true). Concatenating these generates the full transcript: “to be or not to be that is the question”.

In each response we populate:

  • for TRANSCRIPT: transcript and possibly is_final.

  • for END_OF_SINGLE_UTTERANCE: only message_type.

message_type

Type of the result message.

Type

google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult.MessageType

transcript

Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT.

Type

str

is_final

If false, the StreamingRecognitionResult represents an interim result that may change. If true, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for message_type = TRANSCRIPT.

Type

bool

confidence

The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is typically only provided if is_final is true and you should not rely on it being accurate or even set.

Type

float

stability

An estimate of the likelihood that the speech recognizer will not change its guess about this interim recognition result:

  • If the value is unspecified or 0.0, Dialogflow didn’t compute the stability. In particular, Dialogflow will only provide stability for TRANSCRIPT results with is_final = false.

  • Otherwise, the value is in (0.0, 1.0] where 0.0 means completely unstable and 1.0 means completely stable.

Type

float

speech_word_info

Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult.transcript]. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

Type

Sequence[google.cloud.dialogflowcx_v3.types.SpeechWordInfo]

speech_end_offset

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

Type

google.protobuf.duration_pb2.Duration

language_code

Detected language code for the transcript.

Type

str

class MessageType(value)[source]

Bases: proto.enums.Enum

Type of the response message.

END_OF_SINGLE_UTTERANCE = 2
MESSAGE_TYPE_UNSPECIFIED = 0
TRANSCRIPT = 1
class google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Configuration of how speech should be synthesized. .. attribute:: speaking_rate

Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.

type

float

pitch

Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.

Type

float

volume_gain_db

Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there’s usually no effective increase in loudness for any value greater than that.

Type

float

effects_profile_id

Optional. An identifier which selects ‘audio effects’ profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.

Type

Sequence[str]

voice

Optional. The desired voice of the synthesized audio.

Type

google.cloud.dialogflowcx_v3.types.VoiceSelectionParams

class google.cloud.dialogflowcx_v3.types.TestCase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a test case. .. attribute:: name

The unique identifier of the test case. [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase] will populate the name automatically. Otherwise use format: projects/<Project ID>/locations/<LocationID>/agents/ <AgentID>/testCases/<TestCase ID>.

type

str

tags

Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with “#” and has a limit of 30 characters.

Type

Sequence[str]

display_name

Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.

Type

str

notes

Additional freeform notes about the test case. Limit of 400 characters.

Type

str

test_config

Config for the test case.

Type

google.cloud.dialogflowcx_v3.types.TestConfig

test_case_conversation_turns

The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ConversationTurn]

creation_time

Output only. When the test was created.

Type

google.protobuf.timestamp_pb2.Timestamp

last_test_result

The latest test result.

Type

google.cloud.dialogflowcx_v3.types.TestCaseResult

class google.cloud.dialogflowcx_v3.types.TestCaseError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Error info for importing a test. .. attribute:: test_case

The test case.

type

google.cloud.dialogflowcx_v3.types.TestCase

status

The status associated with the test case.

Type

google.rpc.status_pb2.Status

class google.cloud.dialogflowcx_v3.types.TestCaseResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a result from running a test case in an agent environment.

name

The resource name for the test case result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/ <TestCase ID>/results/<TestCaseResult ID>.

Type

str

environment

Environment where the test was run. If not set, it indicates the draft environment.

Type

str

conversation_turns

The conversation turns uttered during the test case replay in chronological order.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ConversationTurn]

test_result

Whether the test case passed in the agent environment.

Type

google.cloud.dialogflowcx_v3.types.TestResult

test_time

The time that the test was run.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.TestConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents configurations for a test case. .. attribute:: tracking_parameters

Session parameters to be compared when calculating differences.

type

Sequence[str]

flow

Flow name. If not set, default start flow is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.TestError(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Error info for running a test. .. attribute:: test_case

The test case resource name.

type

str

status

The status associated with the test.

Type

google.rpc.status_pb2.Status

test_time

The timestamp when the test was completed.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.TestResult(value)[source]

Bases: proto.enums.Enum

The test result for a test case and an agent environment.

FAILED = 2
PASSED = 1
TEST_RESULT_UNSPECIFIED = 0
class google.cloud.dialogflowcx_v3.types.TestRunDifference(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The description of differences between original and replayed agent output.

type_

The type of diff.

Type

google.cloud.dialogflowcx_v3.types.TestRunDifference.DiffType

description

A description of the diff, showing the actual output vs expected output.

Type

str

class DiffType(value)[source]

Bases: proto.enums.Enum

What part of the message replay differs from the test case.

DIFF_TYPE_UNSPECIFIED = 0
INTENT = 1
PAGE = 2
PARAMETERS = 3
UTTERANCE = 4
class google.cloud.dialogflowcx_v3.types.TextInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents the natural language text to be processed. .. attribute:: text

Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.

type

str

class google.cloud.dialogflowcx_v3.types.TrainFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].

name

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

Type

str

class google.cloud.dialogflowcx_v3.types.TransitionCoverage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Transition coverage represents the percentage of all possible page transitions (page-level transition routes and event handlers, excluding transition route groups) present within any of a parent’s test cases.

transitions

The list of Transitions present in the agent.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionCoverage.Transition]

coverage_score

The percent of transitions in the agent that are covered.

Type

float

class Transition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A transition in a page. .. attribute:: source

The start node of a transition.

type

google.cloud.dialogflowcx_v3.types.TransitionCoverage.TransitionNode

index

The index of a transition in the transition list. Starting from 0.

Type

int

target

The end node of a transition.

Type

google.cloud.dialogflowcx_v3.types.TransitionCoverage.TransitionNode

covered

Whether or not the transition is covered by at least one of the agent’s test cases.

Type

bool

transition_route

Intent route or condition route.

Type

google.cloud.dialogflowcx_v3.types.TransitionRoute

event_handler

Event handler.

Type

google.cloud.dialogflowcx_v3.types.EventHandler

class TransitionNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The source or target of a transition. .. attribute:: page

Indicates a transition to a [Page][google.cloud.dialogflow.cx.v3.Page]. Only some fields such as name and displayname will be set.

type

google.cloud.dialogflowcx_v3.types.Page

flow

Indicates a transition to a [Flow][google.cloud.dialogflow.cx.v3.Flow]. Only some fields such as name and displayname will be set.

Type

google.cloud.dialogflowcx_v3.types.Flow

class google.cloud.dialogflowcx_v3.types.TransitionRoute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A transition route specifies a [intent][google.cloud.dialogflow.cx.v3.Intent] that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

  • If there is a [trigger_fulfillment][google.cloud.dialogflow.cx.v3.TransitionRoute.trigger_fulfillment] associated with the transition, it will be called.

  • If there is a [target_page][google.cloud.dialogflow.cx.v3.TransitionRoute.target_page] associated with the transition, the session will transition into the specified page.

  • If there is a [target_flow][google.cloud.dialogflow.cx.v3.TransitionRoute.target_flow] associated with the transition, the session will transition into the specified flow.

name

Output only. The unique identifier of this transition route.

Type

str

intent

The unique identifier of an [Intent][google.cloud.dialogflow.cx.v3.Intent]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Type

str

condition

The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled.

Type

str

trigger_fulfillment

The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment

target_page

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Type

str

target_flow

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

Type

str

class google.cloud.dialogflowcx_v3.types.TransitionRouteGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

An TransitionRouteGroup represents a group of [TransitionRoutes][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].

name

The unique identifier of the transition route group. [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>.

Type

str

display_name

Required. The human-readable name of the transition route group, unique within the [Agent][google.cloud.dialogflow.cx.v3.Agent]. The display name can be no longer than 30 characters.

Type

str

transition_routes

Transition routes associated with the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]

class google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Transition route group coverage represents the percentage of all possible transition routes present within any of a parent’s test cases. The results are grouped by the transition route group.

coverages

Transition route group coverages.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage.Coverage]

coverage_score

The percent of transition routes in all the transition route groups that are covered.

Type

float

class Coverage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Coverage result message for one transition route group. .. attribute:: route_group

Transition route group metadata. Only name and displayName will be set.

type

google.cloud.dialogflowcx_v3.types.TransitionRouteGroup

transitions

The list of transition routes and coverage in the transition route group.

Type

Sequence[google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage.Coverage.Transition]

coverage_score

The percent of transition routes in the transition route group that are covered.

Type

float

class Transition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A transition coverage in a transition route group. .. attribute:: transition_route

Intent route or condition route.

type

google.cloud.dialogflowcx_v3.types.TransitionRoute

covered

Whether or not the transition route is covered by at least one of the agent’s test cases.

Type

bool

class google.cloud.dialogflowcx_v3.types.UpdateAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].

agent

Required. The agent to update.

Type

google.cloud.dialogflowcx_v3.types.Agent

update_mask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].

entity_type

Required. The entity type to update.

Type

google.cloud.dialogflowcx_v3.types.EntityType

language_code

The language of the following fields in entity_type:

  • EntityType.entities.value

  • EntityType.entities.synonyms

  • EntityType.excluded_phrases.value

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

update_mask

The mask to control which fields get updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateEnvironmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].

environment

Required. The environment to update.

Type

google.cloud.dialogflowcx_v3.types.Environment

update_mask

Required. The mask to control which fields get updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Experiments.UpdateExperiment][google.cloud.dialogflow.cx.v3.Experiments.UpdateExperiment].

experiment

Required. The experiment to update.

Type

google.cloud.dialogflowcx_v3.types.Experiment

update_mask

Required. The mask to control which fields get updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].

flow

Required. The flow to update.

Type

google.cloud.dialogflowcx_v3.types.Flow

update_mask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

language_code

The language of the following fields in flow:

  • Flow.event_handlers.trigger_fulfillment.messages

  • Flow.event_handlers.trigger_fulfillment.conditional_cases

  • Flow.transition_routes.trigger_fulfillment.messages

  • Flow.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.UpdateIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent].

intent

Required. The intent to update.

Type

google.cloud.dialogflowcx_v3.types.Intent

language_code

The language of the following fields in intent:

  • Intent.training_phrases.parts.text

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

update_mask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdatePageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].

page

Required. The page to update.

Type

google.cloud.dialogflowcx_v3.types.Page

language_code

The language of the following fields in page:

  • Page.entry_fulfillment.messages

  • Page.entry_fulfillment.conditional_cases

  • Page.event_handlers.trigger_fulfillment.messages

  • Page.event_handlers.trigger_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages

Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases

  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages

Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases

  • Page.transition_routes.trigger_fulfillment.messages

  • Page.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

update_mask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].

security_settings

Required. [SecuritySettings] object that contains values for each of the fields to update.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings

update_mask

Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateSessionEntityTypeRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].

session_entity_type

Required. The session entity type to update. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default ‘draft’ environment.

Type

google.cloud.dialogflowcx_v3.types.SessionEntityType

update_mask

The mask to control which fields get updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateTestCaseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

test_case

Required. The test case to update.

Type

google.cloud.dialogflowcx_v3.types.TestCase

update_mask

Required. The mask to specify which fields should be updated. The [creationTime][google.cloud.dialogflow.cx.v3.TestCase.creation_time] and [lastTestResult][google.cloud.dialogflow.cx.v3.TestCase.last_test_result] cannot be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateTransitionRouteGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [TransitionRouteGroups.UpdateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.UpdateTransitionRouteGroup].

transition_route_group

Required. The transition route group to update.

Type

google.cloud.dialogflowcx_v3.types.TransitionRouteGroup

update_mask

The mask to control which fields get updated.

Type

google.protobuf.field_mask_pb2.FieldMask

language_code

The language of the following fields in TransitionRouteGroup:

  • TransitionRouteGroup.transition_routes.trigger_fulfillment.messages

TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases

If not specified, the agent’s default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Type

str

class google.cloud.dialogflowcx_v3.types.UpdateVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].

version

Required. The version to update.

Type

google.cloud.dialogflowcx_v3.types.Version

update_mask

Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.UpdateWebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook].

webhook

Required. The webhook to update.

Type

google.cloud.dialogflowcx_v3.types.Webhook

update_mask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.dialogflowcx_v3.types.ValidateAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Agents.ValidateAgent][google.cloud.dialogflow.cx.v3.Agents.ValidateAgent].

name

Required. The agent to validate. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Type

str

language_code

If not specified, the agent’s default language is used.

Type

str

class google.cloud.dialogflowcx_v3.types.ValidateFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request message for [Flows.ValidateFlow][google.cloud.dialogflow.cx.v3.Flows.ValidateFlow].

name

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

Type

str

language_code

If not specified, the agent’s default language is used.

Type

str

class google.cloud.dialogflowcx_v3.types.ValidationMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Agent/flow validation message. .. attribute:: resource_type

The type of the resources where the message is found.

type

google.cloud.dialogflowcx_v3.types.ValidationMessage.ResourceType

resources

The names of the resources where the message is found.

Type

Sequence[str]

resource_names

The resource names of the resources where the message is found.

Type

Sequence[google.cloud.dialogflowcx_v3.types.ResourceName]

severity

Indicates the severity of the message.

Type

google.cloud.dialogflowcx_v3.types.ValidationMessage.Severity

detail

The message detail.

Type

str

class ResourceType(value)[source]

Bases: proto.enums.Enum

Resource types.

AGENT = 1
ENTITY_TYPE = 3
ENTITY_TYPES = 12
FLOW = 5
INTENT = 2
INTENTS = 10
INTENT_PARAMETER = 9
INTENT_TRAINING_PHRASE = 8
INTENT_TRAINING_PHRASES = 11
PAGE = 6
PAGES = 13
RESOURCE_TYPE_UNSPECIFIED = 0
TRANSITION_ROUTE_GROUP = 7
WEBHOOK = 4
class Severity(value)[source]

Bases: proto.enums.Enum

Severity level.

ERROR = 3
INFO = 1
SEVERITY_UNSPECIFIED = 0
WARNING = 2
class google.cloud.dialogflowcx_v3.types.VariantsHistory(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The history of variants update. .. attribute:: version_variants

The flow versions as the variants.

type

google.cloud.dialogflowcx_v3.types.VersionVariants

update_time

Update time of the variants.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a version of a flow. .. attribute:: name

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>. Version ID is a self-increasing number generated by Dialogflow upon version creation.

type

str

display_name

Required. The human-readable name of the version. Limit of 64 characters.

Type

str

description

The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.

Type

str

nlu_settings

Output only. The NLU settings of the flow at version creation.

Type

google.cloud.dialogflowcx_v3.types.NluSettings

create_time

Output only. Create time of the version.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The state of this version. This field is read-only and cannot be set by create and update methods.

Type

google.cloud.dialogflowcx_v3.types.Version.State

class State(value)[source]

Bases: proto.enums.Enum

The state of the version.

FAILED = 3
RUNNING = 1
STATE_UNSPECIFIED = 0
SUCCEEDED = 2
class google.cloud.dialogflowcx_v3.types.VersionVariants(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A list of flow version variants. .. attribute:: variants

A list of flow version variants.

type

Sequence[google.cloud.dialogflowcx_v3.types.VersionVariants.Variant]

class Variant(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A single flow version with specified traffic allocation. .. attribute:: version

The name of the flow version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

type

str

traffic_allocation

Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.

Type

float

is_control_group

Whether the variant is for the control group.

Type

bool

class google.cloud.dialogflowcx_v3.types.VoiceSelectionParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: