API documentation for dialogflowcx_v3.types
package.
Classes
AdvancedSettings
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.
Agent
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, [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
AgentValidationResult
The response message for Agents.GetAgentValidationResult.
AudioEncoding
Audio encoding of the audio content sent in the conversational query
request. Refer to the Cloud Speech API
documentation <https://cloud.google.com/speech-to-text/docs/basics>
__
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.
FLACstream encoding supports 16-bit and
24-bit samples, however, not all fields in
STREAMINFOare 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_hertzmust be 8000.
AUDIO_ENCODING_AMR_WB (5):
Adaptive Multi-Rate Wideband codec.
sample_rate_hertzmust be 16000.
AUDIO_ENCODING_OGG_OPUS (6):
Opus encoded audio frames in Ogg container
(
OggOpus https://wiki.xiph.org/OggOpus__).
sample_rate_hertzmust 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_OPUSis
highly preferred over Speex encoding. The
Speex https://speex.org/__ 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 https://tools.ietf.org/html/rfc5574`__. 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
- 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.
AudioInput
Represents the natural speech audio to be processed.
BatchDeleteTestCasesRequest
The request message for TestCases.BatchDeleteTestCases.
BatchRunTestCasesMetadata
Metadata returned for the TestCases.BatchRunTestCases long running operation.
BatchRunTestCasesRequest
The request message for TestCases.BatchRunTestCases.
BatchRunTestCasesResponse
The response message for TestCases.BatchRunTestCases.
CalculateCoverageRequest
The request message for TestCases.CalculateCoverage.
CalculateCoverageResponse
The response message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Changelog
Changelogs represents a change made to a given agent.
CloudConversationDebuggingInfo
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.
CompareVersionsRequest
The request message for Versions.CompareVersions.
CompareVersionsResponse
The response message for Versions.CompareVersions.
ContinuousTestResult
Represents a result from running a test case in an agent environment.
ConversationTurn
One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.
CreateAgentRequest
The request message for Agents.CreateAgent.
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment.
CreateExperimentRequest
The request message for Experiments.CreateExperiment.
CreateFlowRequest
The request message for Flows.CreateFlow.
CreateIntentRequest
The request message for Intents.CreateIntent.
CreatePageRequest
The request message for Pages.CreatePage.
CreateSecuritySettingsRequest
The request message for [SecuritySettings.CreateSecuritySettings][].
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
CreateTestCaseRequest
The request message for TestCases.CreateTestCase.
CreateTransitionRouteGroupRequest
The request message for TransitionRouteGroups.CreateTransitionRouteGroup.
CreateVersionOperationMetadata
Metadata associated with the long running operation for Versions.CreateVersion.
CreateVersionRequest
The request message for Versions.CreateVersion.
CreateWebhookRequest
The request message for Webhooks.CreateWebhook.
DeleteAgentRequest
The request message for Agents.DeleteAgent.
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
DeleteExperimentRequest
The request message for Experiments.DeleteExperiment.
DeleteFlowRequest
The request message for Flows.DeleteFlow.
DeleteIntentRequest
The request message for Intents.DeleteIntent.
DeletePageRequest
The request message for Pages.DeletePage.
DeleteSecuritySettingsRequest
The request message for [SecuritySettings.DeleteSecuritySettings][].
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
DeleteTransitionRouteGroupRequest
The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.
DeleteVersionRequest
The request message for Versions.DeleteVersion.
DeleteWebhookRequest
The request message for Webhooks.DeleteWebhook.
DeployFlowMetadata
Metadata returned for the Environments.DeployFlow long running operation.
DeployFlowRequest
The request message for Environments.DeployFlow.
DeployFlowResponse
The response message for Environments.DeployFlow.
Deployment
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.
DetectIntentRequest
The request to detect user's intent.
DetectIntentResponse
The message returned from the DetectIntent method.
DtmfInput
Represents the input for dtmf event.
EntityType
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, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
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 type.
For more information about entity types, see the Dialogflow
documentation <https://cloud.google.com/dialogflow/docs/entities-overview>
__.
Environment
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.
EventHandler
An event handler specifies an 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EventInput
Represents the event to trigger.
Experiment
Represents an experiment in an environment.
ExportAgentRequest
The request message for Agents.ExportAgent.
ExportAgentResponse
The response message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportFlowRequest
The request message for Flows.ExportFlow.
ExportFlowResponse
The response message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportTestCasesMetadata
Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.
ExportTestCasesRequest
The request message for TestCases.ExportTestCases.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportTestCasesResponse
The response message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Flow
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.
FlowImportStrategy
The flow import strategy used for resource conflict resolution associated with an ImportFlowRequest.
FlowValidationResult
The response message for Flows.GetFlowValidationResult.
Form
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. When form filling is done, the filled parameters will be written to the session.
FulfillIntentRequest
Request of [FulfillIntent][]
FulfillIntentResponse
Response of [FulfillIntent][]
Fulfillment
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 or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
GcsDestination
Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.
GetAgentRequest
The request message for Agents.GetAgent.
GetAgentValidationResultRequest
The request message for Agents.GetAgentValidationResult.
GetChangelogRequest
The request message for Changelogs.GetChangelog.
GetDeploymentRequest
The request message for Deployments.GetDeployment.
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
GetExperimentRequest
The request message for Experiments.GetExperiment.
GetFlowRequest
The response message for Flows.GetFlow.
GetFlowValidationResultRequest
The request message for Flows.GetFlowValidationResult.
GetIntentRequest
The request message for Intents.GetIntent.
GetPageRequest
The request message for Pages.GetPage.
GetSecuritySettingsRequest
The request message for SecuritySettingsService.GetSecuritySettings.
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
GetTestCaseRequest
The request message for TestCases.GetTestCase.
GetTestCaseResultRequest
The request message for TestCases.GetTestCaseResult.
GetTransitionRouteGroupRequest
The request message for TransitionRouteGroups.GetTransitionRouteGroup.
GetVersionRequest
The request message for Versions.GetVersion.
GetWebhookRequest
The request message for Webhooks.GetWebhook.
ImportFlowRequest
The request message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportFlowResponse
The response message for Flows.ImportFlow.
ImportTestCasesMetadata
Metadata returned for the TestCases.ImportTestCases long running operation.
ImportTestCasesRequest
The request message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportTestCasesResponse
The response message for TestCases.ImportTestCases.
InputAudioConfig
Instructs the speech recognizer on how to process the audio content.
Intent
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.
IntentCoverage
Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.
IntentInput
Represents the intent to trigger programmatically rather than as a result of natural language processing.
IntentView
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.
ListAgentsRequest
The request message for Agents.ListAgents.
ListAgentsResponse
The response message for Agents.ListAgents.
ListChangelogsRequest
The request message for Changelogs.ListChangelogs.
ListChangelogsResponse
The response message for Changelogs.ListChangelogs.
ListContinuousTestResultsRequest
The request message for Environments.ListContinuousTestResults.
ListContinuousTestResultsResponse
The response message for [Environments.ListTestCaseResults][].
ListDeploymentsRequest
The request message for Deployments.ListDeployments.
ListDeploymentsResponse
The response message for Deployments.ListDeployments.
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
ListExperimentsRequest
The request message for Experiments.ListExperiments.
ListExperimentsResponse
The response message for Experiments.ListExperiments.
ListFlowsRequest
The request message for Flows.ListFlows.
ListFlowsResponse
The response message for Flows.ListFlows.
ListIntentsRequest
The request message for Intents.ListIntents.
ListIntentsResponse
The response message for Intents.ListIntents.
ListPagesRequest
The request message for Pages.ListPages.
ListPagesResponse
The response message for Pages.ListPages.
ListSecuritySettingsRequest
The request message for [SecuritySettings.ListSecuritySettings][].
ListSecuritySettingsResponse
The response message for [SecuritySettings.ListSecuritySettings][].
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
ListTestCaseResultsRequest
The request message for TestCases.ListTestCaseResults.
ListTestCaseResultsResponse
The response message for TestCases.ListTestCaseResults.
ListTestCasesRequest
The request message for TestCases.ListTestCases.
ListTestCasesResponse
The response message for TestCases.ListTestCases.
ListTransitionRouteGroupsRequest
The request message for TransitionRouteGroups.ListTransitionRouteGroups.
ListTransitionRouteGroupsResponse
The response message for TransitionRouteGroups.ListTransitionRouteGroups.
ListVersionsRequest
The request message for Versions.ListVersions.
ListVersionsResponse
The response message for Versions.ListVersions.
ListWebhooksRequest
The request message for Webhooks.ListWebhooks.
ListWebhooksResponse
The response message for Webhooks.ListWebhooks.
LoadVersionRequest
The request message for Versions.LoadVersion.
LookupEnvironmentHistoryRequest
The request message for Environments.LookupEnvironmentHistory.
LookupEnvironmentHistoryResponse
The response message for Environments.LookupEnvironmentHistory.
Match
Represents one match result of [MatchIntent][].
MatchIntentRequest
Request of [MatchIntent][].
MatchIntentResponse
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
NluSettings
Settings related to NLU.
OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio content.
OutputAudioEncoding
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.
Page
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 <https://cloud.google.com/dialogflow/cx/docs/concept/page>
__.
PageInfo
Represents page information communicated to and from the webhook.
QueryInput
Represents the query input. It can contain one of:
A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QueryParameters
Represents the parameters of a conversational query.
QueryResult
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResourceName
Resource name and display name.
ResponseMessage
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RestoreAgentRequest
The request message for 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RolloutConfig
The configuration for auto rollout.
RolloutState
State of the auto-rollout process.
RunContinuousTestMetadata
Metadata returned for the Environments.RunContinuousTest long running operation.
RunContinuousTestRequest
The request message for Environments.RunContinuousTest.
RunContinuousTestResponse
The response message for Environments.RunContinuousTest.
RunTestCaseMetadata
Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.
RunTestCaseRequest
The request message for TestCases.RunTestCase.
RunTestCaseResponse
The response message for TestCases.RunTestCase.
SecuritySettings
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SentimentAnalysisResult
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.
SessionEntityType
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 <https://cloud.google.com/dialogflow/docs/entities-overview>
__.
SessionInfo
Represents session information communicated to and from the webhook.
SpeechModelVariant
Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
See the Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>
__
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 <https://cloud.google.com/dialogflow/docs/data-logging>`__
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 <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
for details about enhanced models.
USE_ENHANCED (3):
Use an enhanced model variant:
- If an enhanced variant does not exist for the given
<xref uid="google.cloud.dialogflow.cx.v3.InputAudioConfig.model">model</xref>
and request language, Dialogflow falls back to the
standard variant.
The `Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
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 <https://cloud.google.com/dialogflow/docs/data-logging>`__
for how to make your project eligible.
SpeechToTextSettings
Settings related to speech recognition.
SpeechWordInfo
Information for a word recognized by the speech recognizer.
SsmlVoiceGender
Gender of the voice as described in SSML voice
element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>
__.
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.
StartExperimentRequest
The request message for Experiments.StartExperiment.
StopExperimentRequest
The request message for Experiments.StopExperiment.
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config.
If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.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.
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.
StreamingDetectIntentResponse
The top-level message returned from the 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 theStreamingDetectIntentRequest.enable_partial_response
field was false, therecognition_result
field is populated for each of the (N-1) responses. See the StreamingRecognitionResult message for details about the result message sequence.If the
StreamingDetectIntentRequest.enable_partial_response
field was true, thedetect_intent_response
field is populated for each of the (N-1) responses, where 1 <= N <= 4. These responses set the DetectIntentResponse.response_type field toPARTIAL
.
For the final Nth response message, the detect_intent_response
is fully populated, and
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StreamingRecognitionResult
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".
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
TestCase
Represents a test case.
TestCaseError
Error info for importing a test.
TestCaseResult
Represents a result from running a test case in an agent environment.
TestConfig
Represents configurations for a test case.
TestError
Error info for running a test.
TestResult
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.
TestRunDifference
The description of differences between original and replayed agent output.
TextInput
Represents the natural language text to be processed.
TextToSpeechSettings
Settings related to speech synthesizing.
TrainFlowRequest
The request message for Flows.TrainFlow.
TransitionCoverage
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.
TransitionRoute
A transition route specifies a 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TransitionRouteGroup
A TransitionRouteGroup represents a group of
[TransitionRoutes
][google.cloud.dialogflow.cx.v3.TransitionRoute]
to be used by a Page.
TransitionRouteGroupCoverage
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.
UpdateAgentRequest
The request message for Agents.UpdateAgent.
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
UpdateExperimentRequest
The request message for Experiments.UpdateExperiment.
UpdateFlowRequest
The request message for Flows.UpdateFlow.
UpdateIntentRequest
The request message for Intents.UpdateIntent.
UpdatePageRequest
The request message for Pages.UpdatePage.
UpdateSecuritySettingsRequest
The request message for SecuritySettingsService.UpdateSecuritySettings.
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
UpdateTestCaseRequest
The request message for TestCases.UpdateTestCase.
UpdateTransitionRouteGroupRequest
The request message for TransitionRouteGroups.UpdateTransitionRouteGroup.
UpdateVersionRequest
The request message for Versions.UpdateVersion.
UpdateWebhookRequest
The request message for Webhooks.UpdateWebhook.
ValidateAgentRequest
The request message for Agents.ValidateAgent.
ValidateFlowRequest
The request message for Flows.ValidateFlow.
ValidationMessage
Agent/flow validation message.
VariantsHistory
The history of variants update.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Version
Represents a version of a flow.
VersionVariants
A list of flow version variants.
VoiceSelectionParams
Description of which voice to use for speech synthesis.
Webhook
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WebhookRequest
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WebhookResponse
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields