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)

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. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged.

DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel.

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

audio_export_gcs_destination

If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels:

• Agent level

• Flow level

Type

google.cloud.dialogflowcx_v3.types.GcsDestination

dtmf_settings

Settings for DTMF. Exposed at the following levels:

• Agent level

• Flow level

• Page level

• Parameter level.

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings.DtmfSettings

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 DtmfSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Define behaviors for DTMF (dual tone multi frequency).

enabled

If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a “3” was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).

Type

bool

max_digits

Max length of DTMF digits.

Type

int

finish_digit

The digit that terminates a DTMF digit sequence.

Type

str

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

Bases: proto.message.Message

Define behaviors on logging.

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)

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], [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] 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

MutableSequence[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

locked

Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

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

git_integration_settings

Git integration settings for this agent.

Type

google.cloud.dialogflowcx_v3.types.Agent.GitIntegrationSettings

text_to_speech_settings

Settings on instructing the speech synthesizer on how to generate the output audio content.

Type

google.cloud.dialogflowcx_v3.types.TextToSpeechSettings

gen_app_builder_settings

Gen App Builder-related agent-level settings.

This field is a member of oneof _gen_app_builder_settings.

Type

google.cloud.dialogflowcx_v3.types.Agent.GenAppBuilderSettings

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

Bases: proto.message.Message

Settings for Gen App Builder.

engine

Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}

Type

str

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

Bases: proto.message.Message

Settings for connecting to Git repository for an agent.

github_settings

GitHub settings.

This field is a member of oneof git_settings.

Type

google.cloud.dialogflowcx_v3.types.Agent.GitIntegrationSettings.GithubSettings

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

Bases: proto.message.Message

Settings of integration with GitHub.

display_name

The unique repository display name for the GitHub repository.

Type

str

repository_uri

The GitHub repository URI related to the agent.

Type

str

tracking_branch

The branch of the GitHub repository tracked for this agent.

Type

str

access_token

The access token used to authenticate the access to the GitHub repository.

Type

str

branches

A list of branches configured to be used from Dialogflow.

Type

MutableSequence[str]

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

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

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

class google.cloud.dialogflowcx_v3.types.AudioEncoding(value)

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.

Values:

AUDIO_ENCODING_UNSPECIFIED (0):

Not specified.

AUDIO_ENCODING_LINEAR_16 (1):

Uncompressed 16-bit signed little-endian samples (Linear PCM).

AUDIO_ENCODING_FLAC (2):

`FLAC <https://xiph.org/flac/documentation.html>`__ (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.

AUDIO_ENCODING_MULAW (3):

8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

AUDIO_ENCODING_AMR (4):

Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.

AUDIO_ENCODING_AMR_WB (5):

Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.

AUDIO_ENCODING_OGG_OPUS (6):

Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.

AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE (7):

Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000.

class google.cloud.dialogflowcx_v3.types.AudioInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the natural speech audio to be processed.

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 2 minutes 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)

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

MutableSequence[str]

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

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

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

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

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

MutableSequence[str]

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

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

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

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

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)

Bases: proto.enums.Enum

The type of coverage score requested.

Values:

COVERAGE_TYPE_UNSPECIFIED (0):

Should never be used.

INTENT (1):

Intent coverage.

PAGE_TRANSITION (2):

Page transition coverage.

TRANSITION_ROUTE_GROUP (3):

Transition route group coverage.

class google.cloud.dialogflowcx_v3.types.CalculateCoverageResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

agent

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

Type

str

intent_coverage

Intent coverage.

This field is a member of oneof coverage_type.

Type

google.cloud.dialogflowcx_v3.types.IntentCoverage

transition_coverage

Transition (excluding transition route groups) coverage.

This field is a member of oneof coverage_type.

Type

google.cloud.dialogflowcx_v3.types.TransitionCoverage

route_group_coverage

Transition route group coverage.

This field is a member of oneof coverage_type.

Type

google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage

class google.cloud.dialogflowcx_v3.types.Changelog(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Changelogs represents a change made to a given agent.

name

The unique identifier of the changelog. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>.

Type

str

user_email

Email address of the authenticated user.

Type

str

display_name

The affected resource display name of the change.

Type

str

action

The action of the change.

Type

str

type_

The affected resource type.

Type

str

resource

The affected resource name of the change.

Type

str

create_time

The timestamp of the change.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.dialogflowcx_v3.types.CloudConversationDebuggingInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Cloud conversation info for easier debugging. It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.

audio_data_chunks

Number of input audio data chunks in streaming requests.

Type

int

result_end_time_offset

Time offset of the end of speech utterance relative to the beginning of the first audio chunk.

Type

google.protobuf.duration_pb2.Duration

first_audio_duration

Duration of first audio chunk.

Type

google.protobuf.duration_pb2.Duration

single_utterance

Whether client used single utterance mode.

Type

bool

speech_partial_results_end_times

Time offsets of the speech partial results relative to the beginning of the stream.

Type

MutableSequence[google.protobuf.duration_pb2.Duration]

speech_final_results_end_times

Time offsets of the speech final results (is_final=true) relative to the beginning of the stream.

Type

MutableSequence[google.protobuf.duration_pb2.Duration]

partial_responses

Total number of partial responses.

Type

int

speaker_id_passive_latency_ms_offset

Time offset of Speaker ID stream close time relative to the Speech stream close time in milliseconds. Only meaningful for conversations involving passive verification.

Type

int

bargein_event_triggered

Whether a barge-in event is triggered in this request.

Type

bool

speech_single_utterance

Whether speech uses single utterance mode.

Type

bool

dtmf_partial_results_times

Time offsets of the DTMF partial results relative to the beginning of the stream.

Type

MutableSequence[google.protobuf.duration_pb2.Duration]

dtmf_final_results_times

Time offsets of the DTMF final results relative to the beginning of the stream.

Type

MutableSequence[google.protobuf.duration_pb2.Duration]

single_utterance_end_time_offset

Time offset of the end-of-single-utterance signal relative to the beginning of the stream.

Type

google.protobuf.duration_pb2.Duration

no_speech_timeout

No speech timeout settings for the stream.

Type

google.protobuf.duration_pb2.Duration

endpointing_timeout

Speech endpointing timeout settings for the stream.

Type

google.protobuf.duration_pb2.Duration

is_input_text

Whether the streaming terminates with an injected text query.

Type

bool

client_half_close_time_offset

Client half close time in terms of input audio duration.

Type

google.protobuf.duration_pb2.Duration

client_half_close_streaming_time_offset

Client half close time in terms of API streaming duration.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.dialogflowcx_v3.types.CompareVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

base_version

Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow.

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

Type

str

target_version

Required. Name of the target flow version to compare with the base version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

Type

str

language_code

The language to compare the flow versions for.

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.CompareVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

base_version_content_json

JSON representation of the base version content.

Type

str

target_version_content_json

JSON representation of the target version content.

Type

str

compare_time

The timestamp when the two version compares.

Type

google.protobuf.timestamp_pb2.Timestamp

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

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

MutableSequence[str]

run_time

Time when the continuous testing run starts.

Type

google.protobuf.timestamp_pb2.Timestamp

class AggregatedTestResult(value)

Bases: proto.enums.Enum

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

Values:

AGGREGATED_TEST_RESULT_UNSPECIFIED (0):

Not specified. Should never be used.

PASSED (1):

All the tests passed.

FAILED (2):

At least one test did not pass.

class google.cloud.dialogflowcx_v3.types.ConversationTurn(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

Bases: proto.message.Message

The input from the human user.

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)

Bases: proto.message.Message

The output from the virtual agent.

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

MutableSequence[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

MutableSequence[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)

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)

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)

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)

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)

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)

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)

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)

Bases: proto.message.Message

The request message for [SecuritySettings.CreateSecuritySettings][].

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)

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)

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)

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> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> for agent-level groups.

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)

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)

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)

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.DataStoreConnection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.

data_store_type

The type of the connected data store.

Type

google.cloud.dialogflowcx_v3.types.DataStoreType

data_store

The full name of the referenced data store. Formats: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store}

Type

str

class google.cloud.dialogflowcx_v3.types.DataStoreType(value)

Bases: proto.enums.Enum

Type of a data store. Determines how search is performed in the data store.

Values:

DATA_STORE_TYPE_UNSPECIFIED (0):

Not specified. This value indicates that the data store type is not specified, so it will not be used during search.

PUBLIC_WEB (1):

A data store that contains public web content.

UNSTRUCTURED (2):

A data store that contains unstructured private data.

STRUCTURED (3):

A data store that contains structured data (for example FAQ).

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

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)

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)

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)

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)

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)

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)

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)

Bases: proto.message.Message

The request message for [SecuritySettings.DeleteSecuritySettings][].

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)

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)

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> or projects/<Project ID>/locations/<Location ID>/agents/<Agent 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)

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)

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.DeployFlowMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata returned for the [Environments.DeployFlow][google.cloud.dialogflow.cx.v3.Environments.DeployFlow] long running operation.

test_errors

Errors of running deployment tests.

Type

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

class google.cloud.dialogflowcx_v3.types.DeployFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

environment

Required. The environment to deploy the flow to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

Type

str

flow_version

Required. The flow version to deploy. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ flows/<Flow ID>/versions/<Version ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.DeployFlowResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

environment

The updated environment where the flow is deployed.

Type

google.cloud.dialogflowcx_v3.types.Environment

deployment

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

Type

str

class google.cloud.dialogflowcx_v3.types.Deployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.

name

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

Type

str

flow_version

The name of the flow version for this deployment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Verion ID>.

Type

str

state

The current state of the deployment.

Type

google.cloud.dialogflowcx_v3.types.Deployment.State

result

Result of the deployment.

Type

google.cloud.dialogflowcx_v3.types.Deployment.Result

start_time

Start time of this deployment.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

End time of this deployment.

Type

google.protobuf.timestamp_pb2.Timestamp

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

Bases: proto.message.Message

Result of the deployment.

deployment_test_results

Results of test cases running before the deployment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

Type

MutableSequence[str]

experiment

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

Type

str

class State(value)

Bases: proto.enums.Enum

The state of the deployment.

Values:

STATE_UNSPECIFIED (0):

State unspecified.

RUNNING (1):

The deployment is running.

SUCCEEDED (2):

The deployment succeeded.

FAILED (3):

The deployment failed.

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

Bases: proto.message.Message

The request to detect user’s intent.

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)

Bases: proto.message.Message

The message returned from the DetectIntent method.

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)

Bases: proto.enums.Enum

Represents different DetectIntentResponse types.

Values:

RESPONSE_TYPE_UNSPECIFIED (0):

Not specified. This should never happen.

PARTIAL (1):

Partial response. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial response. WARNING: partial response is not eligible for barge-in.

FINAL (2):

Final response.

class google.cloud.dialogflowcx_v3.types.DtmfInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the input for dtmf event.

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)

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

MutableSequence[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

MutableSequence[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)

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

Values:

AUTO_EXPANSION_MODE_UNSPECIFIED (0):

Auto expansion disabled for the entity.

AUTO_EXPANSION_MODE_DEFAULT (1):

Allows an agent to recognize values that have not been explicitly listed in the entity.

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

Bases: proto.message.Message

An entity entry for an associated entity type.

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

MutableSequence[str]

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

Bases: proto.message.Message

An excluded entity phrase that should not be matched.

value

Required. The word or phrase to be excluded.

Type

str

class Kind(value)

Bases: proto.enums.Enum

Represents kinds of entities.

Values:

KIND_UNSPECIFIED (0):

Not specified. This value should be never used.

KIND_MAP (1):

Map entity types allow mapping of a group of synonyms to a canonical value.

KIND_LIST (2):

List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).

KIND_REGEXP (3):

Regexp entity types allow to specify regular expressions in entries values.

class google.cloud.dialogflowcx_v3.types.Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

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

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

update_time

Output only. Update time of this environment.

Type

google.protobuf.timestamp_pb2.Timestamp

test_cases_config

The test cases config for continuous tests of this environment.

Type

google.cloud.dialogflowcx_v3.types.Environment.TestCasesConfig

webhook_config

The webhook configuration for this environment.

Type

google.cloud.dialogflowcx_v3.types.Environment.WebhookConfig

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

Bases: proto.message.Message

The configuration for continuous tests.

test_cases

A list of test case names to run. They should be under the same agent. Format of each test case name: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>

Type

MutableSequence[str]

enable_continuous_run

Whether to run test cases in [TestCasesConfig.test_cases][google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig.test_cases] periodically. Default false. If set to true, run once a day.

Type

bool

enable_predeployment_run

Whether to run test cases in [TestCasesConfig.test_cases][google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig.test_cases] before deploying a flow version to the environment. Default false.

Type

bool

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

Bases: proto.message.Message

Configuration for the version.

version

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

Type

str

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

Bases: proto.message.Message

Configuration for webhooks.

webhook_overrides

The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in [generic_web_service][google.cloud.dialogflow.cx.v3.Webhook.generic_web_service] and [service_directory][google.cloud.dialogflow.cx.v3.Webhook.service_directory].

Type

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

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

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

This field is a member of oneof target.

Type

str

target_flow

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

This field is a member of oneof target.

Type

str

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

Bases: proto.message.Message

Represents the event to trigger.

event

Name of the event.

Type

str

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

Bases: proto.message.Message

Represents an experiment in an environment.

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

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

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

Bases: proto.message.Message

Definition of the experiment.

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.

This field is a member of oneof variants.

Type

google.cloud.dialogflowcx_v3.types.VersionVariants

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

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

MutableSequence[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)

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)

Bases: proto.enums.Enum

Types of count-based metric for Dialogflow experiment.

Values:

COUNT_TYPE_UNSPECIFIED (0):

Count type unspecified.

TOTAL_NO_MATCH_COUNT (1):

Total number of occurrences of a ‘NO_MATCH’.

TOTAL_TURN_COUNT (2):

Total number of turn counts.

AVERAGE_TURN_COUNT (3):

Average turn count in a session.

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

Bases: proto.message.Message

Metric and corresponding confidence intervals.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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.

This field is a member of oneof value.

Type

float

count

Count value of a metric.

This field is a member of oneof value.

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)

Bases: proto.enums.Enum

Types of ratio-based metric for Dialogflow experiment.

Values:

METRIC_UNSPECIFIED (0):

Metric unspecified.

CONTAINED_SESSION_NO_CALLBACK_RATE (1):

Percentage of contained sessions without user calling back in 24 hours.

LIVE_AGENT_HANDOFF_RATE (2):

Percentage of sessions that were handed to a human agent.

CALLBACK_SESSION_RATE (3):

Percentage of sessions with the same user calling back.

ABANDONED_SESSION_RATE (4):

Percentage of sessions where user hung up.

SESSION_END_RATE (5):

Percentage of sessions reached Dialogflow ‘END_PAGE’ or ‘END_SESSION’.

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

Bases: proto.message.Message

Version variant and associated metrics.

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

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

session_count

Number of sessions that were allocated to this version.

Type

int

class State(value)

Bases: proto.enums.Enum

The state of the experiment.

Values:

STATE_UNSPECIFIED (0):

State unspecified.

DRAFT (1):

The experiment is created but not started yet.

RUNNING (2):

The experiment is running.

DONE (3):

The experiment is done.

ROLLOUT_FAILED (4):

The experiment with auto-rollout enabled has failed.

class google.cloud.dialogflowcx_v3.types.ExportAgentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Dialogflow performs a write operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

Type

str

data_format

Optional. The data format of the exported agent. If not specified, BLOB is assumed.

Type

google.cloud.dialogflowcx_v3.types.ExportAgentRequest.DataFormat

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

git_destination

Optional. The Git branch to export the agent to.

Type

google.cloud.dialogflowcx_v3.types.ExportAgentRequest.GitDestination

include_bigquery_export_settings

Optional. Whether to include BigQuery Export setting.

Type

bool

class DataFormat(value)

Bases: proto.enums.Enum

Data format of the exported agent.

Values:

DATA_FORMAT_UNSPECIFIED (0):

Unspecified format.

BLOB (1):

Agent content will be exported as raw bytes.

JSON_PACKAGE (4):

Agent content will be exported in JSON Package format.

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

Bases: proto.message.Message

Settings for exporting to a git branch.

tracking_branch

Tracking branch for the git push.

Type

str

commit_message

Commit message for the git push.

Type

str

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

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

agent_uri

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

This field is a member of oneof agent.

Type

str

agent_content

Uncompressed raw byte content for agent. This field is populated if none of agent_uri and git_destination are specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].

This field is a member of oneof agent.

Type

bytes

commit_sha

Commit SHA of the git push. This field is populated if git_destination is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest].

This field is a member of oneof agent.

Type

str

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

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.

Dialogflow performs a write operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

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)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

This field is a member of oneof flow.

Type

str

flow_content

Uncompressed raw byte content for flow.

This field is a member of oneof flow.

Type

bytes

class google.cloud.dialogflowcx_v3.types.ExportIntentsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata returned for the [Intents.ExportIntents][google.cloud.dialogflow.cx.v3.Intents.ExportIntents] long running operation.

class google.cloud.dialogflowcx_v3.types.ExportIntentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

parent

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

Type

str

intents

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

Type

MutableSequence[str]

intents_uri

Optional. The Google Cloud Storage URI to export the intents to. The format of this URI must be gs://<bucket-name>/<object-name>.

Dialogflow performs a write operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof destination.

Type

str

intents_content_inline

Optional. The option to return the serialized intents inline.

This field is a member of oneof destination.

Type

bool

data_format

Optional. The data format of the exported intents. If not specified, BLOB is assumed.

Type

google.cloud.dialogflowcx_v3.types.ExportIntentsRequest.DataFormat

class DataFormat(value)

Bases: proto.enums.Enum

Data format of the exported intents.

Values:

DATA_FORMAT_UNSPECIFIED (0):

Unspecified format. Treated as BLOB.

BLOB (1):

Intents will be exported as raw bytes.

JSON (2):

Intents will be exported in JSON format.

CSV (3):

Intents will be exported in CSV format.

class google.cloud.dialogflowcx_v3.types.ExportIntentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

intents_uri

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

This field is a member of oneof intents.

Type

str

intents_content

Uncompressed byte content for intents. This field is populated only if intents_content_inline is set to true in [ExportIntentsRequest][google.cloud.dialogflow.cx.v3.ExportIntentsRequest].

This field is a member of oneof intents.

Type

google.cloud.dialogflowcx_v3.types.InlineDestination

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

Bases: proto.message.Message

Metadata returned for the [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases] long running operation. This message currently has no fields.

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

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.

Dialogflow performs a write operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof destination.

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)

Bases: proto.enums.Enum

Data format of the exported test cases.

Values:

DATA_FORMAT_UNSPECIFIED (0):

Unspecified format.

BLOB (1):

Raw bytes.

JSON (2):

JSON format.

class google.cloud.dialogflowcx_v3.types.ExportTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

This field is a member of oneof destination.

Type

str

content

Uncompressed raw byte content for test cases.

This field is a member of oneof destination.

Type

bytes

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

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

MutableSequence[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

MutableSequence[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> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<TransitionRouteGroup ID> for agent-level groups.

Type

MutableSequence[str]

nlu_settings

NLU related settings of the flow.

Type

google.cloud.dialogflowcx_v3.types.NluSettings

advanced_settings

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

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

knowledge_connector_settings

Optional. Knowledge connector configuration.

Type

google.cloud.dialogflowcx_v3.types.KnowledgeConnectorSettings

class google.cloud.dialogflowcx_v3.types.FlowImportStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The flow import strategy used for resource conflict resolution associated with an [ImportFlowRequest][google.cloud.dialogflow.cx.v3.ImportFlowRequest].

global_import_strategy

Optional. Import strategy for resource conflict resolution, applied globally throughout the flow. It will be applied for all display name conflicts in the imported content. If not specified, ‘CREATE_NEW’ is assumed.

Type

google.cloud.dialogflowcx_v3.types.ImportStrategy

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

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

MutableSequence[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)

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

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

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

Bases: proto.message.Message

Represents a form parameter.

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

advanced_settings

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

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

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

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

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

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

Bases: proto.message.Message

Request of [FulfillIntent][]

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)

Bases: proto.message.Message

Response of [FulfillIntent][]

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)

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

MutableSequence[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 value of this field will be populated in the [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified.

Type

str

set_parameter_actions

Set parameter values before executing the webhook.

Type

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

conditional_cases

Conditional cases for this fulfillment.

Type

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

advanced_settings

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

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

enable_generative_fallback

If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined [responses][google.cloud.dialogflow.cx.v3.Fulfillment.messages] in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.

Type

bool

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

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

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

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

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

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

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

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

message

Returned message.

This field is a member of oneof cases_or_message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage

additional_cases

Additional cases to be evaluated.

This field is a member of oneof cases_or_message.

Type

google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases

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

Bases: proto.message.Message

Setting a parameter value.

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.GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.

uri

Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: gs://bucket/object-name-or-prefix Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.

Type

str

class google.cloud.dialogflowcx_v3.types.GenerativeSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for Generative AI.

name

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generativeSettings.

Type

str

fallback_settings

Settings for Generative Fallback.

Type

google.cloud.dialogflowcx_v3.types.GenerativeSettings.FallbackSettings

generative_safety_settings

Settings for Generative Safety.

Type

google.cloud.dialogflowcx_v3.types.SafetySettings

knowledge_connector_settings

Settings for knowledge connector.

Type

google.cloud.dialogflowcx_v3.types.GenerativeSettings.KnowledgeConnectorSettings

language_code

Language for this settings.

Type

str

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

Bases: proto.message.Message

Settings for Generative Fallback.

selected_prompt

Display name of the selected prompt.

Type

str

prompt_templates

Stored prompts that can be selected, for example default templates like “conservative” or “chatty”, or user defined ones.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.GenerativeSettings.FallbackSettings.PromptTemplate]

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

Bases: proto.message.Message

Prompt template.

display_name

Prompt name.

Type

str

prompt_text

Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: “Here is a conversation $conversation, a response is: “.

Type

str

frozen

If the flag is true, the prompt is frozen and cannot be modified by users.

Type

bool

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

Bases: proto.message.Message

Settings for knowledge connector. These parameters are used for LLM prompt like “You are . You are a helpful and verbose <agent_identity> at , <business_description>. Your task is to help humans on <agent_scope>”.

business

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

Type

str

agent

Name of the virtual agent. Used for LLM prompt. Can be left empty.

Type

str

agent_identity

Identity of the agent, e.g. “virtual agent”, “AI assistant”.

Type

str

business_description

Company description, used for LLM prompt, e.g. “a family company selling freshly roasted coffee beans”.

Type

str

agent_scope

Agent scope, e.g. “Example company website”, “internal Example company website for employees”, “manual of car owner”.

Type

str

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

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)

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.GetChangelogRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for [Changelogs.GetChangelog][google.cloud.dialogflow.cx.v3.Changelogs.GetChangelog].

name

Required. The name of the changelog to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog ID>.

Type

str

class google.cloud.dialogflowcx_v3.types.GetDeploymentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for [Deployments.GetDeployment][google.cloud.dialogflow.cx.v3.Deployments.GetDeployment].

name

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

Type

str

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

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)

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)

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)

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)

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.GetGenerativeSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [GetGenerativeSettings][google.cloud.dialogflow.cx.v3.Agents.GetGenerativeSettings] RPC.

name

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

Type

str

language_code

Required. Language code of the generative settings.

Type

str

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

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)

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)

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)

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)

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)

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)

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> or projects/<Project ID>/locations/<Location ID>/agents/<Agent 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)

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)

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)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Dialogflow performs a read operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof flow.

Type

str

flow_content

Uncompressed raw byte content for flow.

This field is a member of oneof flow.

Type

bytes

import_option

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

Type

google.cloud.dialogflowcx_v3.types.ImportFlowRequest.ImportOption

flow_import_strategy

Optional. Specifies the import strategy used when resolving resource conflicts.

Type

google.cloud.dialogflowcx_v3.types.FlowImportStrategy

class ImportOption(value)

Bases: proto.enums.Enum

Import option.

Values:

IMPORT_OPTION_UNSPECIFIED (0):

Unspecified. Treated as KEEP.

KEEP (1):

Always respect settings in exported flow content. It may cause a import failure if some settings (e.g. custom NLU) are not supported in the agent to import into.

FALLBACK (2):

Fallback to default settings if some settings are not supported in the agent to import into. E.g. Standard NLU will be used if custom NLU is not available.

class google.cloud.dialogflowcx_v3.types.ImportFlowResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.ImportIntentsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata returned for the [Intents.ImportIntents][google.cloud.dialogflow.cx.v3.Intents.ImportIntents] long running operation.

class google.cloud.dialogflowcx_v3.types.ImportIntentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

parent

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

Type

str

intents_uri

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

Dialogflow performs a read operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof intents.

Type

str

intents_content

Uncompressed byte content of intents.

This field is a member of oneof intents.

Type

google.cloud.dialogflowcx_v3.types.InlineSource

merge_option

Merge option for importing intents. If not specified, REJECT is assumed.

Type

google.cloud.dialogflowcx_v3.types.ImportIntentsRequest.MergeOption

class MergeOption(value)

Bases: proto.enums.Enum

Merge option when display name conflicts exist during import.

Values:

MERGE_OPTION_UNSPECIFIED (0):

Unspecified. Should not be used.

REJECT (1):

DEPRECATED: Please use [REPORT_CONFLICT][ImportIntentsRequest.REPORT_CONFLICT] instead. Fail the request if there are intents whose display names conflict with the display names of intents in the agent.

REPLACE (2):

Replace the original intent in the agent with the new intent when display name conflicts exist.

MERGE (3):

Merge the original intent with the new intent when display name conflicts exist.

RENAME (4):

Create new intents with new display names to differentiate them from the existing intents when display name conflicts exist.

REPORT_CONFLICT (5):

Report conflict information if display names conflict is detected. Otherwise, import intents.

KEEP (6):

Keep the original intent and discard the conflicting new intent when display name conflicts exist.

class google.cloud.dialogflowcx_v3.types.ImportIntentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

intents

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

Type

MutableSequence[str]

conflicting_resources

Info which resources have conflicts when [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] merge_option is set in ImportIntentsRequest.

Type

google.cloud.dialogflowcx_v3.types.ImportIntentsResponse.ConflictingResources

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

Bases: proto.message.Message

Conflicting resources detected during the import process. Only filled when [REPORT_CONFLICT][ImportIntentsResponse.REPORT_CONFLICT] is set in the request and there are conflicts in the display names.

intent_display_names

Display names of conflicting intents.

Type

MutableSequence[str]

entity_display_names

Display names of conflicting entities.

Type

MutableSequence[str]

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

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

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

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

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Dialogflow performs a read operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof source.

Type

str

content

Uncompressed raw byte content for test cases.

This field is a member of oneof source.

Type

bytes

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

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

MutableSequence[str]

class google.cloud.dialogflowcx_v3.types.InlineDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Inline destination for a Dialogflow operation that writes or exports objects (e.g. [intents][google.cloud.dialogflow.cx.v3.Intent]) outside of Dialogflow.

content

Output only. The uncompressed byte content for the objects. Only populated in responses.

Type

bytes

class google.cloud.dialogflowcx_v3.types.InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Inline source for a Dialogflow operation that reads or imports objects (e.g. [intents][google.cloud.dialogflow.cx.v3.Intent]) into Dialogflow.

content

The uncompressed byte content for the objects.

Type

bytes

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

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

MutableSequence[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. If you specify a model, the following models typically have the best performance:

• phone_call (best for Agent Assist and telephony)

• latest_short (best for Dialogflow non-telephony)

• command_and_search (best for very short utterances and commands)

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)

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

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

parameters

The collection of parameters associated with the intent.

Type

MutableSequence[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

MutableMapping[str, str]

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)

Bases: proto.message.Message

Represents an intent parameter.

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)

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

MutableSequence[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)

Bases: proto.message.Message

Represents a part of a training phrase.

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)

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

MutableSequence[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)

Bases: proto.message.Message

The agent’s intent.

intent

The intent full resource name

Type

str

covered

Whether 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)

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)

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.

Values:

INTENT_VIEW_UNSPECIFIED (0):

Not specified. Treated as INTENT_VIEW_FULL.

INTENT_VIEW_PARTIAL (1):

Training phrases field is not populated in the response.

INTENT_VIEW_FULL (2):

All fields are populated.

class google.cloud.dialogflowcx_v3.types.KnowledgeConnectorSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

enabled

Whether Knowledge Connector is enabled or not.

Type

bool

trigger_fulfillment

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

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

This field is a member of oneof target.

Type

str

target_flow

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

This field is a member of oneof target.

Type

str

data_store_connections

Optional. List of related data store connections.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.DataStoreConnection]

class google.cloud.dialogflowcx_v3.types.ListAgentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListChangelogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for [Changelogs.ListChangelogs][google.cloud.dialogflow.cx.v3.Changelogs.ListChangelogs].

parent

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

Type

str

filter

The filter string. Supports filter by user_email, resource, type and create_time. Some examples:

1. By user email: user_email = “someone@google.com”

2. By resource name: resource = “projects/123/locations/global/agents/456/flows/789”

3. By resource display name: display_name = “my agent”

4. By action: action = “Create”

5. By type: type = “flows”

6. By create time. Currently predicates on create_time and create_time_epoch_seconds are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z

7. Combination of above filters: resource = “projects/123/locations/global/agents/456/flows/789” AND user_email = “someone@google.com” AND create_time <= 2017-01-15T01:30:15.01Z

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.ListChangelogsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response message for [Changelogs.ListChangelogs][google.cloud.dialogflow.cx.v3.Changelogs.ListChangelogs].

changelogs

The list of changelogs. There will be a maximum number of items returned based on the page_size field in the request. The changelogs will be ordered by timestamp.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.Changelog]

next_page_token

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

Type

str

class google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

Bases: proto.message.Message

The response message for [Environments.ListTestCaseResults][].

continuous_test_results

The list of continuous test results.

Type

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListDeploymentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for [Deployments.ListDeployments][google.cloud.dialogflow.cx.v3.Deployments.ListDeployments].

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.ListDeploymentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response message for [Deployments.ListDeployments][google.cloud.dialogflow.cx.v3.Deployments.ListDeployments].

deployments

The list of deployments. 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

MutableSequence[google.cloud.dialogflowcx_v3.types.Deployment]

next_page_token

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

Type

str

class google.cloud.dialogflowcx_v3.types.ListEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListEnvironmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListExperimentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListFlowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListIntentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListPagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListSecuritySettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for [SecuritySettings.ListSecuritySettings][].

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)

Bases: proto.message.Message

The response message for [SecuritySettings.ListSecuritySettings][].

security_settings

The list of security settings.

Type

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListSessionEntityTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListTestCaseResultsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListTestCasesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

Bases: proto.enums.Enum

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

Values:

TEST_CASE_VIEW_UNSPECIFIED (0):

The default / unset value. The API will default to the BASIC view.

BASIC (1):

Include basic metadata about the test case, but not the conversation turns. This is the default value.

FULL (2):

Include everything.

class google.cloud.dialogflowcx_v3.types.ListTestCasesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListTransitionRouteGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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> or `projects//locations//agents/.

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.ListWebhooksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.LoadVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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)

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

MutableSequence[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

class google.cloud.dialogflowcx_v3.types.Match(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents one match result of [MatchIntent][].

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. Filled for [EVENT][google.cloud.dialogflow.cx.v3.Match.MatchType], [NO_MATCH][google.cloud.dialogflow.cx.v3.Match.MatchType] and [NO_INPUT][google.cloud.dialogflow.cx.v3.Match.MatchType] match types.

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.

• MapValue value: If parameter’s entity type is a composite entity then use map from composite entity property names to property values, otherwise, use 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)

Bases: proto.enums.Enum

Type of a Match.

Values:

MATCH_TYPE_UNSPECIFIED (0):

Not specified. Should never be used.

INTENT (1):

The query was matched to an intent.

DIRECT_INTENT (2):

The query directly triggered an intent.

PARAMETER_FILLING (3):

The query was used for parameter filling.

NO_MATCH (4):

No match was found for the query.

NO_INPUT (5):

Indicates an empty query.

EVENT (6):

The query directly triggered an event.

class google.cloud.dialogflowcx_v3.types.MatchIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request of [MatchIntent][].

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

persist_parameter_changes

Persist session parameter changes from query_params.

Type

bool

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

Bases: proto.message.Message

Response of [MatchIntent][].

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text

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

This field is a member of oneof query.

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

This field is a member of oneof query.

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.

This field is a member of oneof query.

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.

This field is a member of oneof query.

Type

str

matches

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

Type

MutableSequence[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)

Bases: proto.message.Message

Settings related to NLU.

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)

Bases: proto.enums.Enum

NLU model training mode.

Values:

MODEL_TRAINING_MODE_UNSPECIFIED (0):

Not specified. MODEL_TRAINING_MODE_AUTOMATIC will be used.

MODEL_TRAINING_MODE_AUTOMATIC (1):

NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.

MODEL_TRAINING_MODE_MANUAL (2):

User needs to manually trigger NLU model training. Best for large flows whose models take long time to train.

class ModelType(value)

Bases: proto.enums.Enum

NLU model type.

Values:

MODEL_TYPE_UNSPECIFIED (0):

Not specified. MODEL_TYPE_STANDARD will be used.

MODEL_TYPE_STANDARD (1):

Use standard NLU model.

MODEL_TYPE_ADVANCED (3):

Use advanced NLU model.

class google.cloud.dialogflowcx_v3.types.OutputAudioConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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. If not specified, [Agent.text_to_speech_settings][google.cloud.dialogflow.cx.v3.Agent.text_to_speech_settings] is applied.

Type

google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig

class google.cloud.dialogflowcx_v3.types.OutputAudioEncoding(value)

Bases: proto.enums.Enum

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

Values:

OUTPUT_AUDIO_ENCODING_UNSPECIFIED (0):

Not specified.

OUTPUT_AUDIO_ENCODING_LINEAR_16 (1):

Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.

OUTPUT_AUDIO_ENCODING_MP3 (2):

MP3 audio at 32kbps.

OUTPUT_AUDIO_ENCODING_MP3_64_KBPS (4):

MP3 audio at 64kbps.

OUTPUT_AUDIO_ENCODING_OGG_OPUS (3):

Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.

OUTPUT_AUDIO_ENCODING_MULAW (5):

8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

class google.cloud.dialogflowcx_v3.types.Page(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

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] added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones.

• 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> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/transitionRouteGroups/<TransitionRouteGroup ID> for agent-level groups.

Type

MutableSequence[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

MutableSequence[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

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

advanced_settings

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

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

knowledge_connector_settings

Optional. Knowledge connector configuration.

Type

google.cloud.dialogflowcx_v3.types.KnowledgeConnectorSettings

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

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

display_name

Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The display name of the current page.

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)

Bases: proto.message.Message

Represents form information.

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

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

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

Bases: proto.message.Message

Represents parameter information.

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)

Bases: proto.enums.Enum

Represents the state of a parameter.

Values:

PARAMETER_STATE_UNSPECIFIED (0):

Not specified. This value should be never used.

EMPTY (1):

Indicates that the parameter does not have a value.

INVALID (2):

Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.

FILLED (3):

Indicates that the parameter has a value.

class google.cloud.dialogflowcx_v3.types.QueryInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the query input. It can contain one of:

1. A conversational query in the form of text.

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

3. Natural language speech audio to be processed.

4. An event to be triggered.

5. DTMF digits to invoke an intent and fill in parameter value.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text

The natural language text to be processed.

This field is a member of oneof input.

Type

google.cloud.dialogflowcx_v3.types.TextInput

intent

The intent to be triggered.

This field is a member of oneof input.

Type

google.cloud.dialogflowcx_v3.types.IntentInput

audio

The natural language speech audio to be processed.

This field is a member of oneof input.

Type

google.cloud.dialogflowcx_v3.types.AudioInput

event

The event to be triggered.

This field is a member of oneof input.

Type

google.cloud.dialogflowcx_v3.types.EventInput

dtmf

The DTMF event to be handled.

This field is a member of oneof input.

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)

Bases: proto.message.Message

Represents the parameters of a conversational query.

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

MutableSequence[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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.

• MapValue value: If parameter’s entity type is a composite entity then use map from composite entity property names to property values, otherwise, use 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

MutableMapping[str, str]

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

MutableSequence[str]

channel

The channel which this query is for.

If specified, only the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] associated with the channel will be returned. If no [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] is associated with the channel, it falls back to the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel.

If unspecified, the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel will be returned.

Type

str

session_ttl

Optional. Sets Dialogflow session life time. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.

Type

google.protobuf.duration_pb2.Duration

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)

Bases: proto.message.Message

Represents the result of a conversational query.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text

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

This field is a member of oneof query.

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

This field is a member of oneof query.

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.

This field is a member of oneof query.

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.

This field is a member of oneof query.

Type

str

dtmf

If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain a copy of the [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].

This field is a member of oneof query.

Type

google.cloud.dialogflowcx_v3.types.DtmfInput

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.

• MapValue value: If parameter’s entity type is a composite entity then use map from composite entity property names to property values, otherwise, use 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

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

webhook_statuses

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

Type

MutableSequence[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

MutableSequence[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 fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called “Alternative Matched Intents”, which may aid with debugging. The following describes these intent results:

• The list is empty if no intent was matched to end-user input.

• Only intents that are referenced in the currently active flow are included.

• The matched intent is included.

• Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.

• Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

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

advanced_settings

Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.

Type

google.cloud.dialogflowcx_v3.types.AdvancedSettings

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

Bases: proto.message.Message

Resource name and display name.

name

Name.

Type

str

display_name

Display name.

Type

str

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

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text

Returns a text response.

This field is a member of oneof message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.Text

payload

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

This field is a member of oneof message.

Type

google.protobuf.struct_pb2.Struct

conversation_success

Indicates that the conversation succeeded.

This field is a member of oneof message.

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.

This field is a member of oneof message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.OutputAudioText

live_agent_handoff

Hands off conversation to a human agent.

This field is a member of oneof message.

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.

This field is a member of oneof message.

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.

This field is a member of oneof message.

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.

This field is a member of oneof message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio

telephony_transfer_call

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

This field is a member of oneof message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.TelephonyTransferCall

knowledge_info_card

Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.

This field is a member of oneof message.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.KnowledgeInfoCard

response_type

Response type.

Type

google.cloud.dialogflowcx_v3.types.ResponseMessage.ResponseType

channel

The channel which the response is associated with. Clients can specify the channel via [QueryParameters.channel][google.cloud.dialogflow.cx.v3.QueryParameters.channel], and only associated channel response will be returned.

Type

str

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

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)

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 KnowledgeInfoCard(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card.

Otherwise, the info card response is skipped.

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

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)

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

MutableSequence[google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio.Segment]

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

Bases: proto.message.Message

Represents one segment of audio.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

audio

Raw audio synthesized from the Dialogflow agent’s response using the output config specified in the request.

This field is a member of oneof content.

Type

bytes

uri

Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.

This field is a member of oneof content.

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)

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

text

The raw text to be synthesized.

This field is a member of oneof source.

Type

str

ssml

The SSML text to be synthesized. For more information, see SSML.

This field is a member of oneof source.

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)

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 ResponseType(value)

Bases: proto.enums.Enum

Represents different response types.

Values:

RESPONSE_TYPE_UNSPECIFIED (0):

Not specified.

ENTRY_PROMPT (1):

The response is from an [entry prompt][google.cloud.dialogflow.cx.v3.Page.entry_fulfillment] in the page.

PARAMETER_PROMPT (2):

The response is from [form-filling prompt][google.cloud.dialogflow.cx.v3.Form.Parameter.fill_behavior] in the page.

HANDLER_PROMPT (3):

The response is from a [transition route][google.cloud.dialogflow.cx.v3.TransitionRoute] or an [event handler][EventHandler] in the page or flow or transition route group.

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

Bases: proto.message.Message

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.

phone_number

Transfer the call to a phone number in E.164 format.

This field is a member of oneof endpoint.

Type

str

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

Bases: proto.message.Message

The text response message.

text

Required. A collection of text responses.

Type

MutableSequence[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)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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

Dialogflow performs a read operation for the Cloud Storage object on the caller’s behalf, so your request authentication must have read permissions for the object. For more information, see Dialogflow access control.

This field is a member of oneof agent.

Type

str

agent_content

Uncompressed raw byte content for agent.

This field is a member of oneof agent.

Type

bytes

git_source

Setting for restoring from a git branch

This field is a member of oneof agent.

Type

google.cloud.dialogflowcx_v3.types.RestoreAgentRequest.GitSource

restore_option

Agent restore mode. If not specified, KEEP is assumed.

Type

google.cloud.dialogflowcx_v3.types.RestoreAgentRequest.RestoreOption

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

Bases: proto.message.Message

Settings for restoring from a git branch

tracking_branch

tracking branch for the git pull

Type

str

class RestoreOption(value)

Bases: proto.enums.Enum

Restore option.

Values:

RESTORE_OPTION_UNSPECIFIED (0):

Unspecified. Treated as KEEP.

KEEP (1):

Always respect the settings from the exported agent file. It may cause a restoration failure if some settings (e.g. model type) are not supported in the target agent.

FALLBACK (2):

Fallback to default settings if some settings are not supported in the target agent.

class google.cloud.dialogflowcx_v3.types.RolloutConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The configuration for auto rollout.

rollout_steps

Steps to roll out a flow version. Steps should be sorted by percentage in ascending order.

Type

MutableSequence[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)

Bases: proto.message.Message

A single rollout step with specified traffic allocation.

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)

Bases: proto.message.Message

State of the auto-rollout process.

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)

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

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

class google.cloud.dialogflowcx_v3.types.RunContinuousTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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)

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)

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)

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.SafetySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for Generative Safety.

banned_phrases

Banned phrases for generated text.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.SafetySettings.Phrase]

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

Bases: proto.message.Message

Text input which can be used for prompt or banned phrases.

text

Required. Text input which can be used for prompt or banned phrases.

Type

str

language_code

Required. Language code of the phrase.

Type

str

class google.cloud.dialogflowcx_v3.types.SecuritySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Resource name of the settings. Required for the [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings] method. [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.CreateSecuritySettings] populates the name automatically. 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.

The DLP Inspect Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent’s project.

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.

The DLP De-identify Templates Reader role is needed on the Dialogflow service identity service account (has the form service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com) for your agent’s project.

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 the data for the specified number of days. User must set a value lower than Dialogflow’s default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL.

This field is a member of oneof data_retention.

Type

int

retention_strategy

Specifies the retention behavior defined by [SecuritySettings.RetentionStrategy][google.cloud.dialogflow.cx.v3.SecuritySettings.RetentionStrategy].

This field is a member of oneof data_retention.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.RetentionStrategy

purge_data_types

List of types of data to remove when retention settings triggers purge.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.SecuritySettings.PurgeDataType]

audio_export_settings

Controls audio export settings for post-conversation analytics when ingesting audio to conversations via [Participants.AnalyzeContent][] or [Participants.StreamingAnalyzeContent][].

If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][] is empty, audio export is disabled.

If audio export is enabled, audio is recorded and saved to [audio_export_settings.gcs_bucket][], subject to retention policy of [audio_export_settings.gcs_bucket][].

This setting won’t effect audio input for implicit sessions via [Sessions.DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] or [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent].

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.AudioExportSettings

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 AudioExportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings for exporting audio.

gcs_bucket

Cloud Storage bucket to export audio record to. Setting this field would grant the Storage Object Creator role to the Dialogflow Service Agent. API caller that tries to modify this field should have the permission of storage.buckets.setIamPolicy.

Type

str

audio_export_pattern

Filename pattern for exported audio.

Type

str

enable_audio_redaction

Enable audio redaction if it is true.

Type

bool

audio_format

File format for exported audio file. Currently only in telephony recordings.

Type

google.cloud.dialogflowcx_v3.types.SecuritySettings.AudioExportSettings.AudioFormat

class AudioFormat(value)

Bases: proto.enums.Enum

File format for exported audio file. Currently only in telephony recordings.

Values:

AUDIO_FORMAT_UNSPECIFIED (0):

Unspecified. Do not use.

MULAW (1):

G.711 mu-law PCM with 8kHz sample rate.

MP3 (2):

MP3 file format.

OGG (3):

OGG Vorbis.

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

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)

Bases: proto.enums.Enum

Type of data we purge after retention settings triggers purge.

Values:

PURGE_DATA_TYPE_UNSPECIFIED (0):

Unspecified. Do not use.

DIALOGFLOW_HISTORY (1):

Dialogflow history. This does not include Cloud logging, which is owned by the user - not Dialogflow.

class RedactionScope(value)

Bases: proto.enums.Enum

Defines what types of data to redact.

Values:

REDACTION_SCOPE_UNSPECIFIED (0):

Don’t redact any kind of data.

REDACT_DISK_STORAGE (2):

On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk.

class RedactionStrategy(value)

Bases: proto.enums.Enum

Defines how we redact data.

Values:

REDACTION_STRATEGY_UNSPECIFIED (0):

Do not redact.

REDACT_WITH_SERVICE (1):

Call redaction service to clean up the data to be persisted.

class RetentionStrategy(value)

Bases: proto.enums.Enum

Defines how long we retain persisted data that contains sensitive info.

Values:

RETENTION_STRATEGY_UNSPECIFIED (0):

Retains the persisted data with Dialogflow’s internal default 365d TTLs.

REMOVE_AFTER_CONVERSATION (1):

Removes data when the conversation ends. If there is no [Conversation][] explicitly established, a default conversation ends when the corresponding Dialogflow session ends.

class google.cloud.dialogflowcx_v3.types.SentimentAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

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

class EntityOverrideMode(value)

Bases: proto.enums.Enum

The types of modifications for the session entity type.

Values:

ENTITY_OVERRIDE_MODE_UNSPECIFIED (0):

Not specified. This value should be never used.

ENTITY_OVERRIDE_MODE_OVERRIDE (1):

The collection of session entities overrides the collection of entities in the corresponding custom entity type.

ENTITY_OVERRIDE_MODE_SUPPLEMENT (2):

The collection of session entities extends the collection of entities in the corresponding custom entity type.

Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType] on the custom entity type and merge.

class google.cloud.dialogflowcx_v3.types.SessionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

MutableMapping[str, google.protobuf.struct_pb2.Value]

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

Bases: proto.message.Message

class google.cloud.dialogflowcx_v3.types.SpeechModelVariant(value)

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.

Values:

SPEECH_MODEL_VARIANT_UNSPECIFIED (0):

No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.

USE_BEST_AVAILABLE (1):

Use the best available variant of the [Speech model][InputAudioConfig.model] that the caller is eligible for.

Please see the Dialogflow docs for how to make your project eligible for enhanced models.

USE_STANDARD (2):

Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models.

USE_ENHANCED (3):

Use an enhanced model variant:

• If an enhanced variant does not exist for the given [model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] and request language, Dialogflow falls back to the standard variant.

  The Cloud Speech documentation describes which models have enhanced variants.

• If the API caller isn’t eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible.

class google.cloud.dialogflowcx_v3.types.SpeechToTextSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings related to speech recognition.

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)

Bases: proto.message.Message

Information for a word recognized by the speech recognizer.

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)

Bases: proto.enums.Enum

Gender of the voice as described in SSML voice element.

Values:

SSML_VOICE_GENDER_UNSPECIFIED (0):

An unspecified gender, which means that the client doesn’t care which gender the selected voice will have.

SSML_VOICE_GENDER_MALE (1):

A male voice.

SSML_VOICE_GENDER_FEMALE (2):

A female voice.

SSML_VOICE_GENDER_NEUTRAL (3):

A gender-neutral voice.

class google.cloud.dialogflowcx_v3.types.StartExperimentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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)

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

enable_debugging_info

If true, StreamingDetectIntentResponse.debugging_info will get populated.

Type

bool

class google.cloud.dialogflowcx_v3.types.StreamingDetectIntentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The top-level message returned from the [StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.

Multiple response messages (N) can be returned in order.

The first (N-1) responses set either the recognition_result or detect_intent_response field, depending on the request:

• If the StreamingDetectIntentRequest.query_input.audio field was set, and the StreamingDetectIntentRequest.enable_partial_response field was false, the recognition_result field is populated for each of the (N-1) responses. See the [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult] message for details about the result message sequence.

• If the StreamingDetectIntentRequest.enable_partial_response field was true, the detect_intent_response field is populated for each of the (N-1) responses, where 1 <= N <= 4. These responses set the [DetectIntentResponse.response_type][google.cloud.dialogflow.cx.v3.DetectIntentResponse.response_type] field to PARTIAL.

For the final Nth response message, the detect_intent_response is fully populated, and [DetectIntentResponse.response_type][google.cloud.dialogflow.cx.v3.DetectIntentResponse.response_type] is set to FINAL.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

recognition_result

The result of speech recognition.

This field is a member of oneof response.

Type

google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult

detect_intent_response

The response from detect intent.

This field is a member of oneof response.

Type

google.cloud.dialogflowcx_v3.types.DetectIntentResponse

debugging_info

Debugging info that would get populated when StreamingDetectIntentRequest.enable_debugging_info is set to true.

Type

google.cloud.dialogflowcx_v3.types.CloudConversationDebuggingInfo

class google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.

If StreamingDetectIntentRequest.query_input.audio.config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

Num | transcript              | message_type            | is_final
--- | ----------------------- | ----------------------- | --------
1   | "tube"                  | TRANSCRIPT              | false
2   | "to be a"               | TRANSCRIPT              | false
3   | "to be"                 | TRANSCRIPT              | false
4   | "to be or not to be"    | TRANSCRIPT              | true
5   | "that's"                | TRANSCRIPT              | false
6   | "that is                | TRANSCRIPT              | false
7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
8   | " that is the question" | TRANSCRIPT              | true

Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes “to be or not to be that is the question”.

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

MutableSequence[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)

Bases: proto.enums.Enum

Type of the response message.

Values:

MESSAGE_TYPE_UNSPECIFIED (0):

Not specified. Should never be used.

TRANSCRIPT (1):

Message contains a (possibly partial) transcript.

END_OF_SINGLE_UTTERANCE (2):

Event indicates that the server has detected the end of the user’s speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if [single_utterance][google.cloud.dialogflow.cx.v3.InputAudioConfig.single_utterance] was set to true, and is not used otherwise.

class google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration of how speech should be synthesized.

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

MutableSequence[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)

Bases: proto.message.Message

Represents a test case.

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

MutableSequence[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

MutableSequence[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)

Bases: proto.message.Message

Error info for importing a test.

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)

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

MutableSequence[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)

Bases: proto.message.Message

Represents configurations for a test case.

tracking_parameters

Session parameters to be compared when calculating differences.

Type

MutableSequence[str]

flow

Flow name to start the test case with. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow.

Type

str

page

The [page][google.cloud.dialogflow.cx.v3.Page] to start the test case with. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow.

Type

str

class google.cloud.dialogflowcx_v3.types.TestError(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Error info for running a test.

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)

Bases: proto.enums.Enum

The test result for a test case and an agent environment.

Values:

TEST_RESULT_UNSPECIFIED (0):

Not specified. Should never be used.

PASSED (1):

The test passed.

FAILED (2):

The test did not pass.

class google.cloud.dialogflowcx_v3.types.TestRunDifference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 human readable description of the diff, showing the actual output vs expected output.

Type

str

class DiffType(value)

Bases: proto.enums.Enum

What part of the message replay differs from the test case.

Values:

DIFF_TYPE_UNSPECIFIED (0):

Should never be used.

INTENT (1):

The intent.

PAGE (2):

The page.

PARAMETERS (3):

The parameters.

UTTERANCE (4):

The message utterance.

FLOW (5):

The flow.

class google.cloud.dialogflowcx_v3.types.TextInput(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the natural language text to be processed.

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.TextToSpeechSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Settings related to speech synthesizing.

synthesize_speech_configs

Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig.

These settings affect:

• The phone gateway synthesize configuration set via [Agent.text_to_speech_settings][google.cloud.dialogflow.cx.v3.Agent.text_to_speech_settings].

• How speech is synthesized when invoking [session][google.cloud.dialogflow.cx.v3.Sessions] APIs. [Agent.text_to_speech_settings][google.cloud.dialogflow.cx.v3.Agent.text_to_speech_settings] only applies if [OutputAudioConfig.synthesize_speech_config][google.cloud.dialogflow.cx.v3.OutputAudioConfig.synthesize_speech_config] is not specified.

Type

MutableMapping[str, google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig]

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

Bases: proto.message.Message

class google.cloud.dialogflowcx_v3.types.TrainFlowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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

MutableSequence[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)

Bases: proto.message.Message

A transition in a page.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

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 the transition is covered by at least one of the agent’s test cases.

Type

bool

transition_route

Intent route or condition route.

This field is a member of oneof detail.

Type

google.cloud.dialogflowcx_v3.types.TransitionRoute

event_handler

Event handler.

This field is a member of oneof detail.

Type

google.cloud.dialogflowcx_v3.types.EventHandler

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

Bases: proto.message.Message

The source or target of a transition.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

page

Indicates a transition to a [Page][google.cloud.dialogflow.cx.v3.Page]. Only some fields such as name and displayname will be set.

This field is a member of oneof kind.

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.

This field is a member of oneof kind.

Type

google.cloud.dialogflowcx_v3.types.Flow

class google.cloud.dialogflowcx_v3.types.TransitionRoute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

Output only. The unique identifier of this transition route.

Type

str

description

Optional. The description of the transition route. The maximum length is 500 characters.

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

This field is a member of oneof target.

Type

str

target_flow

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

This field is a member of oneof target.

Type

str

class google.cloud.dialogflowcx_v3.types.TransitionRouteGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A 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 flow. 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

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

class google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

MutableSequence[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)

Bases: proto.message.Message

Coverage result message for one transition route group.

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

MutableSequence[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)

Bases: proto.message.Message

A transition coverage in a transition route group.

transition_route

Intent route or condition route.

Type

google.cloud.dialogflowcx_v3.types.TransitionRoute

covered

Whether 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)

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)

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)

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)

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)

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.UpdateGenerativeSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for [UpdateGenerativeSettings][google.cloud.dialogflow.cx.v3.Agents.UpdateGenerativeSettings] RPC.

generative_settings

Required. Generative settings to update.

Type

google.cloud.dialogflowcx_v3.types.GenerativeSettings

update_mask

Optional. 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.UpdateIntentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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)

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)

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)

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)

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)

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)

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)

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)

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)

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)

Bases: proto.message.Message

Agent/flow validation message.

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

MutableSequence[str]

resource_names

The resource names of the resources where the message is found.

Type

MutableSequence[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)

Bases: proto.enums.Enum

Resource types.

Values:

RESOURCE_TYPE_UNSPECIFIED (0):

Unspecified.

AGENT (1):

Agent.

INTENT (2):

Intent.

INTENT_TRAINING_PHRASE (8):

Intent training phrase.

INTENT_PARAMETER (9):

Intent parameter.

INTENTS (10):

Multiple intents.

INTENT_TRAINING_PHRASES (11):

Multiple training phrases.

ENTITY_TYPE (3):

Entity type.

ENTITY_TYPES (12):

Multiple entity types.

WEBHOOK (4):

Webhook.

FLOW (5):

Flow.

PAGE (6):

Page.

PAGES (13):

Multiple pages.

TRANSITION_ROUTE_GROUP (7):

Transition route group.

AGENT_TRANSITION_ROUTE_GROUP (14):

Agent transition route group.

class Severity(value)

Bases: proto.enums.Enum

Severity level.

Values:

SEVERITY_UNSPECIFIED (0):

Unspecified.

INFO (1):

The agent doesn’t follow Dialogflow best practices.

WARNING (2):

The agent may not behave as expected.

ERROR (3):

The agent may experience failures.

class google.cloud.dialogflowcx_v3.types.VariantsHistory(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The history of variants update.

version_variants

The flow versions as the variants.

This field is a member of oneof 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)

Bases: proto.message.Message

Represents a version of a flow.

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)

Bases: proto.enums.Enum

The state of the version.

Values:

STATE_UNSPECIFIED (0):

Not specified. This value is not used.

RUNNING (1):

Version is not ready to serve (e.g. training is running).

SUCCEEDED (2):

Training has succeeded and this version is ready to serve.

FAILED (3):

Version training failed.

class google.cloud.dialogflowcx_v3.types.VersionVariants(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A list of flow version variants.

variants

A list of flow version variants.

Type

MutableSequence[google.cloud.dialogflowcx_v3.types.VersionVariants.Variant]

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

Bases: proto.message.Message

A single flow version with specified traffic allocation.

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)

Bases: proto.message.Message

Description of which voice to use for speech synthesis.

name

Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [ssml_gender][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.ssml_gender].

For the list of available voices, please refer to Supported voices and languages.

Type

str

ssml_gender

Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [name][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.name]. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.

Type

google.cloud.dialogflowcx_v3.types.SsmlVoiceGender

class google.cloud.dialogflowcx_v3.types.Webhook(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Webhooks host the developer’s business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow’s natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

Type

str

display_name

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

Type

str

generic_web_service

Configuration for a generic web service.

This field is a member of oneof webhook.

Type

google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService

service_directory

Configuration for a Service Directory service.

This field is a member of oneof webhook.

Type

google.cloud.dialogflowcx_v3.types.Webhook.ServiceDirectoryConfig

timeout

Webhook execution timeout. Execution is considered failed if Dialogflow doesn’t receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

Type

google.protobuf.duration_pb2.Duration

disabled

Indicates whether the webhook is disabled.

Type

bool

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

Bases: proto.message.Message

Represents configuration for a generic web service.

uri

Required. The webhook URI for receiving POST requests. It must use https protocol.

Type

str

username

The user name for HTTP Basic authentication.

Type

str

password

The password for HTTP Basic authentication.

Type

str

request_headers

The HTTP request headers to send together with webhook requests.

Type

MutableMapping[str, str]

allowed_ca_certs

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google’s default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with “subject alt name”. For instance a certificate can be self-signed using the following command,

openssl x509 -req -days 200 -in example.com.csr \
  -signkey example.com.key \
  -out example.com.crt \
  -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Type

MutableSequence[bytes]

webhook_type

Optional. Type of the webhook.

Type

google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.WebhookType

http_method

Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.

Type

google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.HttpMethod

request_body

Optional. Defines a custom JSON object as request body to send to flexible webhook.

Type

str

parameter_mapping

Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response

Type

MutableMapping[str, str]

class HttpMethod(value)

Bases: proto.enums.Enum

HTTP method to use when calling webhooks.

Values:

HTTP_METHOD_UNSPECIFIED (0):

HTTP method not specified.

POST (1):

HTTP POST Method.

GET (2):

HTTP GET Method.

HEAD (3):

HTTP HEAD Method.

PUT (4):

HTTP PUT Method.

DELETE (5):

HTTP DELETE Method.

PATCH (6):

HTTP PATCH Method.

OPTIONS (7):

HTTP OPTIONS Method.

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

Bases: proto.message.Message

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

Bases: proto.message.Message

class WebhookType(value)

Bases: proto.enums.Enum

Represents the type of webhook configuration.

Values:

WEBHOOK_TYPE_UNSPECIFIED (0):

Default value. This value is unused.

STANDARD (1):

Represents a standard webhook.

FLEXIBLE (2):

Represents a flexible webhook.

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

Bases: proto.message.Message

Represents configuration for a Service Directory service.

service

Required. The name of Service Directory service. Format: projects/<Project ID>/locations/<Location ID>/namespaces/<Namespace ID>/services/<Service ID>. Location ID of the service directory must be the same as the location of the agent.

Type

str

generic_web_service

Generic Service configuration of this webhook.

Type

google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService

class google.cloud.dialogflowcx_v3.types.WebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.

You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

detect_intent_response_id

Always present. The unique identifier of the [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse] that will be returned to the API caller.

Type

str

text

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

This field is a member of oneof query.

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

This field is a member of oneof query.

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.

This field is a member of oneof query.

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.

This field is a member of oneof query.

Type

str

dtmf_digits

If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain the DTMF digits.

This field is a member of oneof query.

Type

str

language_code

The language code specified in the [original request][QueryInput.language_code].

Type

str

fulfillment_info

Always present. Information about the fulfillment that triggered this webhook call.

Type

google.cloud.dialogflowcx_v3.types.WebhookRequest.FulfillmentInfo

intent_info

Information about the last matched intent.

Type

google.cloud.dialogflowcx_v3.types.WebhookRequest.IntentInfo

page_info

Information about page status.

Type

google.cloud.dialogflowcx_v3.types.PageInfo

session_info

Information about session status.

Type

google.cloud.dialogflowcx_v3.types.SessionInfo

messages

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];

Type

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

payload

Custom data set in [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].

Type

google.protobuf.struct_pb2.Struct

sentiment_analysis_result

The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

Type

google.cloud.dialogflowcx_v3.types.WebhookRequest.SentimentAnalysisResult

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

Bases: proto.message.Message

Represents fulfillment information communicated to the webhook.

tag

Always present. The value of the [Fulfillment.tag][google.cloud.dialogflow.cx.v3.Fulfillment.tag] field will be populated in this field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes.

Type

str

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

Bases: proto.message.Message

Represents intent information communicated to the webhook.

last_matched_intent

Always present. The unique identifier of the last matched [intent][google.cloud.dialogflow.cx.v3.Intent]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Type

str

display_name

Always present. The display name of the last matched [intent][google.cloud.dialogflow.cx.v3.Intent].

Type

str

parameters

Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user’s utterance. All parameters defined in the matched intent that are identified will be surfaced here.

Type

MutableMapping[str, google.cloud.dialogflowcx_v3.types.WebhookRequest.IntentInfo.IntentParameterValue]

confidence

The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).

Type

float

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

Bases: proto.message.Message

Represents a value for an intent parameter.

original_value

Always present. Original text value extracted from user utterance.

Type

str

resolved_value

Always present. Structured value for the parameter extracted from user utterance.

Type

google.protobuf.struct_pb2.Value

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

Bases: proto.message.Message

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

Bases: proto.message.Message

Represents the result of sentiment analysis.

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.WebhookResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response message for a webhook call.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

fulfillment_response

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

Type

google.cloud.dialogflowcx_v3.types.WebhookResponse.FulfillmentResponse

page_info

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

Type

google.cloud.dialogflowcx_v3.types.PageInfo

session_info

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

Type

google.cloud.dialogflowcx_v3.types.SessionInfo

payload

Value to append directly to [QueryResult.webhook_payloads][google.cloud.dialogflow.cx.v3.QueryResult.webhook_payloads].

Type

google.protobuf.struct_pb2.Struct

target_page

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

This field is a member of oneof transition.

Type

str

target_flow

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

This field is a member of oneof transition.

Type

str

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

Bases: proto.message.Message

Represents a fulfillment response to the user.

messages

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

Type

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

merge_behavior

Merge behavior for messages.

Type

google.cloud.dialogflowcx_v3.types.WebhookResponse.FulfillmentResponse.MergeBehavior

class MergeBehavior(value)

Bases: proto.enums.Enum

Defines merge behavior for messages.

Values:

MERGE_BEHAVIOR_UNSPECIFIED (0):

Not specified. APPEND will be used.

APPEND (1):

messages will be appended to the list of messages waiting to be sent to the user.

REPLACE (2):

messages will replace the list of messages waiting to be sent to the user.