Package google.cloud.dialogflow.cx.v3beta1

Index

Agents

Service for managing Agents.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent)

Creates an agent in the specified location.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty)

Deletes the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ExportAgent

rpc ExportAgent(ExportAgentRequest) returns (Operation)

Exports the specified agent to a binary file.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent)

Retrieves the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse)

Returns the list of all agents in the specified location.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

RestoreAgent

rpc RestoreAgent(RestoreAgentRequest) returns (Operation)

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent)

Updates the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

EntityTypes

Service for managing EntityTypes.

CreateEntityType

rpc CreateEntityType(CreateEntityTypeRequest) returns (EntityType)

Creates an entity type in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteEntityType

rpc DeleteEntityType(DeleteEntityTypeRequest) returns (Empty)

Deletes the specified entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetEntityType

rpc GetEntityType(GetEntityTypeRequest) returns (EntityType)

Retrieves the specified entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListEntityTypes

rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse)

Returns the list of all entity types in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateEntityType

rpc UpdateEntityType(UpdateEntityTypeRequest) returns (EntityType)

Updates the specified entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Environments

Service for managing Environments.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

Creates an Environment in the specified Agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteEnvironment

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Empty)

Deletes the specified Environment.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetEnvironment

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

Retrieves the specified Environment.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListEnvironments

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

Returns the list of all environments in the specified Agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

LookupEnvironmentHistory

rpc LookupEnvironmentHistory(LookupEnvironmentHistoryRequest) returns (LookupEnvironmentHistoryResponse)

Looks up the history of the specified Environment.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateEnvironment

rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (Operation)

Updates the specified Environment.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Flows

Service for managing Flows.

CreateFlow

rpc CreateFlow(CreateFlowRequest) returns (Flow)

Creates a flow in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteFlow

rpc DeleteFlow(DeleteFlowRequest) returns (Empty)

Deletes a specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetFlow

rpc GetFlow(GetFlowRequest) returns (Flow)

Retrieves the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListFlows

rpc ListFlows(ListFlowsRequest) returns (ListFlowsResponse)

Returns the list of all flows in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

TrainFlow

rpc TrainFlow(TrainFlowRequest) returns (Operation)

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

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateFlow

rpc UpdateFlow(UpdateFlowRequest) returns (Flow)

Updates the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Intents

Service for managing Intents.

CreateIntent

rpc CreateIntent(CreateIntentRequest) returns (Intent)

Creates an intent in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteIntent

rpc DeleteIntent(DeleteIntentRequest) returns (Empty)

Deletes the specified intent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetIntent

rpc GetIntent(GetIntentRequest) returns (Intent)

Retrieves the specified intent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListIntents

rpc ListIntents(ListIntentsRequest) returns (ListIntentsResponse)

Returns the list of all intents in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateIntent

rpc UpdateIntent(UpdateIntentRequest) returns (Intent)

Updates the specified intent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Pages

Service for managing Pages.

CreatePage

rpc CreatePage(CreatePageRequest) returns (Page)

Creates a page in the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeletePage

rpc DeletePage(DeletePageRequest) returns (Empty)

Deletes the specified page.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetPage

rpc GetPage(GetPageRequest) returns (Page)

Retrieves the specified page.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListPages

rpc ListPages(ListPagesRequest) returns (ListPagesResponse)

Returns the list of all pages in the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdatePage

rpc UpdatePage(UpdatePageRequest) returns (Page)

Updates the specified page.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

SessionEntityTypes

Service for managing SessionEntityTypes.

CreateSessionEntityType

rpc CreateSessionEntityType(CreateSessionEntityTypeRequest) returns (SessionEntityType)

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteSessionEntityType

rpc DeleteSessionEntityType(DeleteSessionEntityTypeRequest) returns (Empty)

Deletes the specified session entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetSessionEntityType

rpc GetSessionEntityType(GetSessionEntityTypeRequest) returns (SessionEntityType)

Retrieves the specified session entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListSessionEntityTypes

rpc ListSessionEntityTypes(ListSessionEntityTypesRequest) returns (ListSessionEntityTypesResponse)

Returns the list of all session entity types in the specified session.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateSessionEntityType

rpc UpdateSessionEntityType(UpdateSessionEntityTypeRequest) returns (SessionEntityType)

Updates the specified session entity type.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Sessions

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.

DetectIntent

rpc DetectIntent(DetectIntentRequest) returns (DetectIntentResponse)

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

FulfillIntent

rpc FulfillIntent(FulfillIntentRequest) returns (FulfillIntentResponse)

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

MatchIntent

rpc MatchIntent(MatchIntentRequest) returns (MatchIntentResponse)

Returns preliminary intent match results, doesn't change the session status.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

StreamingDetectIntent

rpc StreamingDetectIntent(StreamingDetectIntentRequest) returns (StreamingDetectIntentResponse)

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

TransitionRouteGroups

Service for managing TransitionRouteGroups.

CreateTransitionRouteGroup

rpc CreateTransitionRouteGroup(CreateTransitionRouteGroupRequest) returns (TransitionRouteGroup)

Creates an TransitionRouteGroup in the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteTransitionRouteGroup

rpc DeleteTransitionRouteGroup(DeleteTransitionRouteGroupRequest) returns (Empty)

Deletes the specified TransitionRouteGroup.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetTransitionRouteGroup

rpc GetTransitionRouteGroup(GetTransitionRouteGroupRequest) returns (TransitionRouteGroup)

Retrieves the specified TransitionRouteGroup.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListTransitionRouteGroups

rpc ListTransitionRouteGroups(ListTransitionRouteGroupsRequest) returns (ListTransitionRouteGroupsResponse)

Returns the list of all transition route groups in the specified flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateTransitionRouteGroup

rpc UpdateTransitionRouteGroup(UpdateTransitionRouteGroupRequest) returns (TransitionRouteGroup)

Updates the specified TransitionRouteGroup.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Versions

Service for managing Versions.

CreateVersion

rpc CreateVersion(CreateVersionRequest) returns (Operation)

Creates a Version in the specified Flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteVersion

rpc DeleteVersion(DeleteVersionRequest) returns (Empty)

Deletes the specified Version.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetVersion

rpc GetVersion(GetVersionRequest) returns (Version)

Retrieves the specified Version.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListVersions

rpc ListVersions(ListVersionsRequest) returns (ListVersionsResponse)

Returns the list of all versions in the specified Flow.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

LoadVersion

rpc LoadVersion(LoadVersionRequest) returns (Operation)

Loads a specified version to draft version.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateVersion

rpc UpdateVersion(UpdateVersionRequest) returns (Version)

Updates the specified Version.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

Webhooks

Service for managing Webhooks.

CreateWebhook

rpc CreateWebhook(CreateWebhookRequest) returns (Webhook)

Creates a webhook in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DeleteWebhook

rpc DeleteWebhook(DeleteWebhookRequest) returns (Empty)

Deletes the specified webhook.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

GetWebhook

rpc GetWebhook(GetWebhookRequest) returns (Webhook)

Retrieves the specified webhook.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

ListWebhooks

rpc ListWebhooks(ListWebhooksRequest) returns (ListWebhooksResponse)

Returns the list of all webhooks in the specified agent.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

UpdateWebhook

rpc UpdateWebhook(UpdateWebhookRequest) returns (Webhook)

Updates the specified webhook.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

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, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..

Fields
name

string

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

display_name

string

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

default_language_code

string

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

time_zone

string

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

description

string

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

avatar_uri

string

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

speech_to_text_settings

SpeechToTextSettings

Speech recognition related settings.

start_flow

string

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

enable_stackdriver_logging

bool

Indicates if stackdriver logging is enabled for the agent.

enable_spell_correction

bool

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

AudioEncoding

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

Enums
AUDIO_ENCODING_UNSPECIFIED Not specified.
AUDIO_ENCODING_LINEAR_16 Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC FLAC (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 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.
AUDIO_ENCODING_AMR_WB Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.
AUDIO_ENCODING_OGG_OPUS Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE 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.

AudioInput

Represents the natural speech audio to be processed.

Fields
config

InputAudioConfig

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

audio

bytes

The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text 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.

CreateAgentRequest

The request message for Agents.CreateAgent.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.agents.create
agent

Agent

Required. The agent to create.

CreateEntityTypeRequest

The request message for EntityTypes.CreateEntityType.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.entityTypes.create
entity_type

EntityType

Required. The entity type to create.

language_code

string

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.

CreateEnvironmentRequest

The request message for Environments.CreateEnvironment.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.environments.create
environment

Environment

Required. The environment to create.

CreateFlowRequest

The request message for Flows.CreateFlow.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.flows.create
flow

Flow

Required. The flow to create.

language_code

string

The language of the following fields in flow:

  • Flow.event_handlers.trigger_fulfillment.messages
  • Flow.transition_routes.trigger_fulfillment.messages

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.

CreateIntentRequest

The request message for Intents.CreateIntent.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.intents.create
intent

Intent

Required. The intent to create.

language_code

string

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.

CreatePageRequest

The request message for Pages.CreatePage.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.pages.create
page

Page

Required. The page to create.

language_code

string

The language of the following fields in page:

  • Page.entry_fulfillment.messages
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
  • Page.transition_routes.trigger_fulfillment.messages * Page.transition_route_groups.transition_routes.trigger_fulfillment.messages

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.

CreateSessionEntityTypeRequest

The request message for SessionEntityTypes.CreateSessionEntityType.

Fields
parent

string

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.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.sessionEntityTypes.create
session_entity_type

SessionEntityType

Required. The session entity type to create.

CreateTransitionRouteGroupRequest

The request message for TransitionRouteGroups.CreateTransitionRouteGroup.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.transitionRouteGroups.create
transition_route_group

TransitionRouteGroup

Required. The transition route group to create.

language_code

string

The language to list transition route groups for. The field [messages][TransitionRoute.trigger_fulfillment.messages] in TransitionRoute is language dependent.

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.

CreateVersionOperationMetadata

Metadata associated with the long running operation for Versions.CreateVersion.

Fields
version

string

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

CreateVersionRequest

The request message for Versions.CreateVersion.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.versions.create
version

Version

Required. The version to create.

CreateWebhookRequest

The request message for Webhooks.CreateWebhook.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.webhooks.create
webhook

Webhook

Required. The webhook to create.

DeleteAgentRequest

The request message for Agents.DeleteAgent.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.agents.delete

DeleteEntityTypeRequest

The request message for EntityTypes.DeleteEntityType.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.entityTypes.delete
force

bool

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 of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).

DeleteEnvironmentRequest

The request message for Environments.DeleteEnvironment.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.environments.delete

DeleteFlowRequest

The request message for Flows.DeleteFlow.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.flows.delete
force

bool

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

DeleteIntentRequest

The request message for Intents.DeleteIntent.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.intents.delete

DeletePageRequest

The request message for Pages.DeletePage.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.pages.delete
force

bool

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

DeleteSessionEntityTypeRequest

The request message for SessionEntityTypes.DeleteSessionEntityType.

Fields
name

string

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.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.sessionEntityTypes.delete

DeleteTransitionRouteGroupRequest

The request message for TransitionRouteGroups.DeleteTransitionRouteGroup.

Fields
name

string

Required. The name of the TransitionRouteGroup to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.transitionRouteGroups.delete
force

bool

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.

DeleteVersionRequest

The request message for Versions.DeleteVersion.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.versions.delete

DeleteWebhookRequest

The request message for Webhooks.DeleteWebhook.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.webhooks.delete
force

bool

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 and tagin fulfillments that point to this webhook will be removed).

DetectIntentRequest

The request to detect user's intent.

Fields
session

string

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.

Authorization requires the following IAM permission on the specified resource session:

  • dialogflow.sessions.detectIntent
query_params

QueryParameters

The parameters of this query.

query_input

QueryInput

Required. The input specification.

output_audio_config

OutputAudioConfig

Instructs the speech synthesizer how to generate the output audio.

DetectIntentResponse

The message returned from the DetectIntent method.

Fields
response_id

string

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.

query_result

QueryResult

The result of the conversational query.

output_audio

bytes

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

output_audio_config

OutputAudioConfig

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

DtmfInput

Represents the input for dtmf event.

Fields
digits

string

The dtmf digits.

finish_digit

string

The finish digit (if any).

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

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

Fields
name

string

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

display_name

string

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

kind

Kind

Required. Indicates the kind of entity type.

auto_expansion_mode

AutoExpansionMode

Indicates whether the entity type can be automatically expanded.

entities[]

Entity

The collection of entity entries associated with the entity type.

excluded_phrases[]

ExcludedPhrase

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.

enable_fuzzy_extraction

bool

Enables fuzzy entity extraction during classification.

AutoExpansionMode

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

Enums
AUTO_EXPANSION_MODE_UNSPECIFIED Auto expansion disabled for the entity.
AUTO_EXPANSION_MODE_DEFAULT Allows an agent to recognize values that have not been explicitly listed in the entity.

Entity

An entity entry for an associated entity type. Next Id = 8

Fields
value

string

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).
synonyms[]

string

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.

ExcludedPhrase

An excluded entity phrase that should not be matched.

Fields
value

string

Required. The word or phrase to be excluded.

Kind

Represents kinds of entities.

Enums
KIND_UNSPECIFIED Not specified. This value should be never used.
KIND_MAP Map entity types allow mapping of a group of synonyms to a canonical value.
KIND_LIST 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 Regexp entity types allow to specify regular expressions in entries values.

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.

Fields
name

string

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

display_name

string

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

description

string

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

version_configs[]

VersionConfig

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

update_time

Timestamp

Output only. Update time of this environment.

VersionConfig

Configuration for the version.

Fields
version

string

Required. Format: projects//locations//agents//flows//versions/.

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 associated with the event, it will be called.
  • If there is a target_page associated with the event, the session will transition into the specified page.
  • If there is a target_flow associated with the event, the session will transition into the specified flow.
Fields
name

string

Output only. The unique identifier of this event handler.

event

string

Required. The name of the event to handle.

trigger_fulfillment

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.

Union field target. The target to transition to, either a page in the same host flow (the flow that owns this TransitionRoute), or another flow in the same agent. target can be only one of the following:
target_page

string

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

target_flow

string

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

EventInput

Represents the event to trigger.

Fields
event

string

Name of the event.

ExportAgentRequest

The request message for Agents.ExportAgent.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.agents.export
agent_uri

string

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.

ExportAgentResponse

The response message for Agents.ExportAgent.

Fields
Union field agent. The exported agent. agent can be only one of the following:
agent_uri

string

The URI to a file containing the exported agent. This field is populated only if agent_uri is specified in ExportAgentRequest.

agent_content

bytes

Uncompressed raw byte content for agent.

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.

Fields
name

string

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

display_name

string

Required. The human-readable name of the flow.

description

string

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

transition_routes[]

TransitionRoute

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.

event_handlers[]

EventHandler

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, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.

nlu_settings

NluSettings

NLU related settings of the flow.

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.

Fields
parameters[]

Parameter

Parameters to collect from the user.

Parameter

Represents a form parameter.

Fields
display_name

string

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

required

bool

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.

entity_type

string

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.

is_list

bool

Indicates whether the parameter represents a list of values.

fill_behavior

FillBehavior

Required. Defines fill behavior for the parameter.

default_value

Value

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

redact

bool

Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter name in both request and response. The default value is false.

FillBehavior

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

Fields
initial_prompt_fulfillment

Fulfillment

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

reprompt_event_handlers[]

EventHandler

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.

FulfillIntentRequest

Request of [FulfillIntent][]

Fields
match_intent_request

MatchIntentRequest

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

match

Match

The matched intent/event to fulfill.

output_audio_config

OutputAudioConfig

Instructs the speech synthesizer how to generate output audio.

FulfillIntentResponse

Response of [FulfillIntent][]

Fields
response_id

string

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.

query_result

QueryResult

The result of the conversational query.

output_audio

bytes

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

output_audio_config

OutputAudioConfig

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

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.

Fields
messages[]

ResponseMessage

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

webhook

string

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

tag

string

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

set_parameter_actions[]

SetParameterAction

Set parameter values before executing the webhook.

conditional_cases[]

ConditionalCases

Conditional cases for this fulfillment.

ConditionalCases

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

Fields
cases[]

Case

A list of cascading if-else conditions.

Case

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

Fields
condition

string

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.

case_content[]

CaseContent

A list of case content.

CaseContent

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

Fields
Union field cases_or_message. Either a message is returned or additional cases to be evaluated. cases_or_message can be only one of the following:
message

ResponseMessage

Returned message.

additional_cases

ConditionalCases

Additional cases to be evaluated.

SetParameterAction

Setting a parameter value.

Fields
parameter

string

Display name of the parameter.

value

Value

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

GetAgentRequest

The request message for Agents.GetAgent.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.agents.get

GetEntityTypeRequest

The request message for EntityTypes.GetEntityType.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.entityTypes.get
language_code

string

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.

GetEnvironmentRequest

The request message for Environments.GetEnvironment.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.environments.get

GetFlowRequest

The response message for Flows.GetFlow.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.flows.get
language_code

string

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

  • Flow.event_handlers.trigger_fulfillment.messages
  • Flow.transition_routes.trigger_fulfillment.messages

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.

GetIntentRequest

The request message for Intents.GetIntent.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.intents.get
language_code

string

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.

GetPageRequest

The request message for Pages.GetPage.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.pages.get
language_code

string

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

  • Page.entry_fulfillment.messages
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
  • Page.transition_routes.trigger_fulfillment.messages * Page.transition_route_groups.transition_routes.trigger_fulfillment.messages

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.

GetSessionEntityTypeRequest

The request message for SessionEntityTypes.GetSessionEntityType.

Fields
name

string

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.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.sessionEntityTypes.get

GetTransitionRouteGroupRequest

The request message for TransitionRouteGroups.GetTransitionRouteGroup.

Fields
name

string

Required. The name of the TransitionRouteGroup. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.transitionRouteGroups.get
language_code

string

The language to list transition route groups for. The field [messages][TransitionRoute.trigger_fulfillment.messages] in TransitionRoute is language dependent.

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.

GetVersionRequest

The request message for Versions.GetVersion.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.versions.get

GetWebhookRequest

The request message for Webhooks.GetWebhook.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.webhooks.get

InputAudioConfig

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

Fields
audio_encoding

AudioEncoding

Required. Audio encoding of the audio content to process.

sample_rate_hertz

int32

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

enable_word_info

bool

Optional. If true, Dialogflow returns SpeechWordInfo in 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.

phrase_hints[]

string

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.

model

string

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.

model_variant

SpeechModelVariant

Optional. Which variant of the Speech model to use.

single_utterance

bool

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.

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.

Fields
name

string

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

display_name

string

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

training_phrases[]

TrainingPhrase

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

parameters[]

Parameter

The collection of parameters associated with the intent.

priority

int32

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

bool

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.

Parameter

Represents an intent parameter.

Fields
id

string

Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.

entity_type

string

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.

is_list

bool

Indicates whether the parameter represents a list of values.

redact

bool

Indicates whether the parameter content is logged in text and audio. If it is set to true, the parameter content will be replaced to parameter id in both request and response. The default value is false.

TrainingPhrase

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

Fields
id

string

Output only. The unique identifier of the training phrase.

parts[]

Part

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

int32

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

Part

Represents a part of a training phrase.

Fields
text

string

Required. The text for this part.

parameter_id

string

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

IntentInput

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

Fields
intent

string

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

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.

Enums
INTENT_VIEW_UNSPECIFIED Not specified. Treated as INTENT_VIEW_FULL.
INTENT_VIEW_PARTIAL Training phrases field is not populated in the response.
INTENT_VIEW_FULL All fields are populated.

ListAgentsRequest

The request message for Agents.ListAgents.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.agents.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListAgentsResponse

The response message for Agents.ListAgents.

Fields
agents[]

Agent

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

next_page_token

string

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

ListEntityTypesRequest

The request message for EntityTypes.ListEntityTypes.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.entityTypes.list
language_code

string

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.

page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListEntityTypesResponse

The response message for EntityTypes.ListEntityTypes.

Fields
entity_types[]

EntityType

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

next_page_token

string

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

ListEnvironmentsRequest

The request message for Environments.ListEnvironments.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.environments.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListEnvironmentsResponse

The response message for Environments.ListEnvironments.

Fields
environments[]

Environment

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.

next_page_token

string

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

ListFlowsRequest

The request message for Flows.ListFlows.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.flows.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

language_code

string

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

  • Flow.event_handlers.trigger_fulfillment.messages
  • Flow.transition_routes.trigger_fulfillment.messages

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.

ListFlowsResponse

The response message for Flows.ListFlows.

Fields
flows[]

Flow

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

next_page_token

string

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

ListIntentsRequest

The request message for Intents.ListIntents.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.intents.list
language_code

string

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.

intent_view

IntentView

The resource view to apply to the returned intent.

page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListIntentsResponse

The response message for Intents.ListIntents.

Fields
intents[]

Intent

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

next_page_token

string

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

ListPagesRequest

The request message for Pages.ListPages.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.pages.list
language_code

string

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

  • Page.entry_fulfillment.messages
  • Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages
  • Page.form.parameters.fill_behavior.reprompt_event_handlers.messages
  • Page.transition_routes.trigger_fulfillment.messages * Page.transition_route_groups.transition_routes.trigger_fulfillment.messages

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.

page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListPagesResponse

The response message for Pages.ListPages.

Fields
pages[]

Page

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

next_page_token

string

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

ListSessionEntityTypesRequest

The request message for SessionEntityTypes.ListSessionEntityTypes.

Fields
parent

string

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.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.sessionEntityTypes.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListSessionEntityTypesResponse

The response message for SessionEntityTypes.ListSessionEntityTypes.

Fields
session_entity_types[]

SessionEntityType

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

next_page_token

string

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

ListTransitionRouteGroupsRequest

The request message for TransitionRouteGroups.ListTransitionRouteGroups.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.transitionRouteGroups.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

language_code

string

The language to list transition route groups for. The field [messages][TransitionRoute.trigger_fulfillment.messages] in TransitionRoute is language dependent.

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.

ListTransitionRouteGroupsResponse

The response message for TransitionRouteGroups.ListTransitionRouteGroups.

Fields
transition_route_groups[]

TransitionRouteGroup

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.

next_page_token

string

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

ListVersionsRequest

The request message for Versions.ListVersions.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.versions.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListVersionsResponse

The response message for Versions.ListVersions.

Fields
versions[]

Version

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.

next_page_token

string

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

ListWebhooksRequest

The request message for Webhooks.ListWebhooks.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.webhooks.list
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

ListWebhooksResponse

The response message for Webhooks.ListWebhooks.

Fields
webhooks[]

Webhook

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

next_page_token

string

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

LoadVersionRequest

The request message for Versions.LoadVersion.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.versions.update
allow_override_agent_resources

bool

This field is used to prevent accidental overwrite of other agent resources in the draft version, 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).

LookupEnvironmentHistoryRequest

The request message for Environments.LookupEnvironmentHistory.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.environments.lookupHistory
page_size

int32

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

page_token

string

The next_page_token value returned from a previous list request.

LookupEnvironmentHistoryResponse

The response message for Environments.LookupEnvironmentHistory.

Fields
environments[]

Environment

Represents a list of snapshots for an environment. Time of the snapshots is stored in update_time.

next_page_token

string

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

Match

Represents one match result of [MatchIntent][].

Fields
intent

Intent

The 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 match type.

parameters

Struct

The collection of parameters extracted from the query.

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

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type:
    • If parameter's entity type is a composite entity: map
    • Else: string or number, depending on parameter value type
  • MapValue value:
    • If parameter's entity type is a composite entity: map from composite entity property names to property values
    • Else: parameter value
resolved_input

string

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.

match_type

MatchType

Type of this Match.

confidence

float

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.

MatchType

Type of a Match.

Enums
MATCH_TYPE_UNSPECIFIED Not specified. Should never be used.
INTENT The query was matched to an intent.
DIRECT_INTENT The query directly triggered an intent.
PARAMETER_FILLING The query was used for parameter filling.
NO_MATCH No match was found for the query.
NO_INPUT Indicates an empty query.

MatchIntentRequest

Request of [MatchIntent][].

Fields
session

string

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.

Authorization requires the following IAM permission on the specified resource session:

  • dialogflow.sessions.detectIntent
query_params

QueryParameters

The parameters of this query.

query_input

QueryInput

Required. The input specification.

MatchIntentResponse

Response of [MatchIntent][].

Fields
matches[]

Match

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

current_page

Page

The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

Union field query. The original conversational query. query can be only one of the following:
text

string

If natural language text was provided as input, this field will contain a copy of the text.

trigger_intent

string

If an intent was provided as input, this field will contain a copy of the intent identifier.

transcript

string

If natural language speech audio was provided as input, this field will contain the trascript for the audio.

trigger_event

string

If an event was provided as input, this field will contain a copy of the event name.

NluSettings

Settings related to NLU.

Fields
model_type

ModelType

Indicates the type of NLU model.

classification_threshold

float

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.

model_training_mode

ModelTrainingMode

Indicates NLU model training mode.

ModelTrainingMode

NLU model training mode.

Enums
MODEL_TRAINING_MODE_UNSPECIFIED Not specified. MODEL_TRAINING_MODE_AUTOMATIC will be used.
MODEL_TRAINING_MODE_AUTOMATIC 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 User needs to manually trigger NLU model training. Best for large flows whose models take long time to train.

ModelTy