Types for Dialogflow API Client

class dialogflow_v2beta1.types.Agent

Represents a conversational agent.

parent

Required. The project of this agent. Format: projects/<Project ID>.

display_name

Required. The name of this agent.

default_language_code

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

supported_language_codes

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

time_zone

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

description

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

avatar_uri

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

enable_logging

Optional. Determines whether this agent should log conversation queries.

match_mode

Optional. Determines how intents are detected from user queries.

classification_threshold

Optional. 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 fallback intent is be triggered or, if there are no fallback intents defined, no intent 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.

class dialogflow_v2beta1.types.Any
class dialogflow_v2beta1.types.BatchCreateEntitiesRequest

The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities].

parent

Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

entities

Required. The collection of entities to create.

language_code

Optional. The language of entity synonyms defined in entities. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

class dialogflow_v2beta1.types.BatchDeleteEntitiesRequest

The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntities].

parent

Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

entity_values

Required. The canonical values of the entities to delete. Note that these are not fully-qualified names, i.e. they don’t start with projects/<Project ID>.

language_code

Optional. The language of entity synonyms defined in entities. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

class dialogflow_v2beta1.types.BatchDeleteEntityTypesRequest

The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntityTypes].

parent

Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

entity_type_names

Required. The names entity types to delete. All names must point to the same agent as parent.

class dialogflow_v2beta1.types.BatchDeleteIntentsRequest

The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2beta1.Intents.BatchDeleteIntents].

parent

Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

intents

Required. The collection of intents to delete. Only intent name must be filled in.

class dialogflow_v2beta1.types.BatchUpdateEntitiesRequest

The response message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities].

parent

Required. The name of the entity type to update the entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

entities

Required. The collection of new entities to replace the existing entities.

language_code

Optional. The language of entity synonyms defined in entities. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

update_mask

Optional. The mask to control which fields get updated.

class dialogflow_v2beta1.types.BatchUpdateEntityTypesRequest

The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes].

parent

Required. The name of the agent to update or create entity types in. Format: projects/<Project ID>/agent.

entity_type_batch

Required. The source of the entity type batch. For each entity type in the batch: * If name is specified, we update an existing entity type. * If name is not specified, we create a new entity type.

entity_type_batch_uri

The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with “gs://”.

entity_type_batch_inline

The collection of entity type to update or create.

language_code

Optional. The language of entity synonyms defined in entity_types. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

update_mask

Optional. The mask to control which fields get updated.

class dialogflow_v2beta1.types.BatchUpdateEntityTypesResponse

The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes].

entity_types

The collection of updated or created entity types.

class dialogflow_v2beta1.types.BatchUpdateIntentsRequest

The request message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents].

parent

Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.

intent_batch

Required. The source of the intent batch.

intent_batch_uri

The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with “gs://”.

intent_batch_inline

The collection of intents to update or create.

language_code

Optional. The language of training phrases, parameters and rich messages defined in intents. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

update_mask

Optional. The mask to control which fields get updated.

intent_view

Optional. The resource view to apply to the returned intent.

class dialogflow_v2beta1.types.BatchUpdateIntentsResponse

The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents].

intents

The collection of updated or created intents.

class dialogflow_v2beta1.types.CancelOperationRequest
class dialogflow_v2beta1.types.Context

Represents a context.

name

Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. The Context ID is always converted to lowercase. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

lifespan_count

Optional. The number of conversational query requests after which the context expires. If set to 0 (the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries.

parameters

Optional. The collection of parameters associated with this context. Refer to this doc for syntax.

class dialogflow_v2beta1.types.CreateContextRequest

The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext].

parent

Required. The session to create a context for. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

context

Required. The context to create.

class dialogflow_v2beta1.types.CreateDocumentRequest

Request message for [Documents.CreateDocument][google.cloud.dialogflow.v2beta1.Documents.CreateDocument].

parent

Required. The knoweldge base to create a document for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

document

Required. The document to create.

class dialogflow_v2beta1.types.CreateEntityTypeRequest

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

parent

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

entity_type

Required. The entity type to create.

language_code

Optional. The language of entity synonyms defined in entity_type. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

class dialogflow_v2beta1.types.CreateIntentRequest

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

parent

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

intent

Required. The intent to create.

language_code

Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

intent_view

Optional. The resource view to apply to the returned intent.

class dialogflow_v2beta1.types.CreateKnowledgeBaseRequest

Request message for [KnowledgeBases.CreateKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.CreateKnowledgeBase].

parent

Required. The agent to create a knowledge base for. Format: projects/<Project ID>/agent.

knowledge_base

Required. The knowledge base to create.

class dialogflow_v2beta1.types.CreateSessionEntityTypeRequest

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

parent

Required. The session to create a session entity type for. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

session_entity_type

Required. The session entity type to create.

class dialogflow_v2beta1.types.CustomHttpPattern
class dialogflow_v2beta1.types.DeleteAllContextsRequest

The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts].

parent

Required. The name of the session to delete all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

class dialogflow_v2beta1.types.DeleteContextRequest

The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext].

name

Required. The name of the context to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

class dialogflow_v2beta1.types.DeleteDocumentRequest

Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument].

name

The name of the document to delete. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

class dialogflow_v2beta1.types.DeleteEntityTypeRequest

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

name

Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

class dialogflow_v2beta1.types.DeleteIntentRequest

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

name

Required. The name of the intent to delete. Format: projects/<Project ID>/agent/intents/<Intent ID>.

class dialogflow_v2beta1.types.DeleteKnowledgeBaseRequest

Request message for [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.DeleteKnowledgeBase].

name

Required. The name of the knowledge base to delete. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

force

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

class dialogflow_v2beta1.types.DeleteOperationRequest
class dialogflow_v2beta1.types.DeleteSessionEntityTypeRequest

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

name

Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

class dialogflow_v2beta1.types.DescriptorProto
class ExtensionRange
class ReservedRange
class dialogflow_v2beta1.types.DetectIntentRequest

The request to detect user’s intent.

session

Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we are using “-“. It’s up to the API caller to choose an appropriate Session ID and User Id. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

query_params

Optional. The parameters of this query.

query_input

Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.

output_audio_config

Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

input_audio

Optional. The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

class dialogflow_v2beta1.types.DetectIntentResponse

The message returned from the DetectIntent method.

response_id

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

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

alternative_query_results

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event and this field will contain all results except for the top one which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled this field will be empty at which point those additional results will be surfaced here.

webhook_status

Specifies the status of the webhook request. webhook_status is never populated in webhook requests.

output_audio

The audio data bytes encoded as specified in the request.

output_audio_config

Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled.

class dialogflow_v2beta1.types.Document

A document resource.

name

The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

display_name

Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.

mime_type

Required. The MIME type of this document.

knowledge_types

Required. The knowledge type of document content.

source

Required. The source of this document.

content_uri

The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

content

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

class dialogflow_v2beta1.types.Empty
class dialogflow_v2beta1.types.EntityType

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

name

Required for all methods except create (create populates the name automatically. The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

display_name

Required. The name of the entity.

kind

Required. Indicates the kind of entity type.

auto_expansion_mode

Optional. Indicates whether the entity type can be automatically expanded.

entities

Optional. The collection of entities associated with the entity type.

class Entity

Optional. Represents an entity.

value

Required. For KIND_MAP entity types: A canonical name 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

Required. A collection of synonyms. For KIND_LIST entity types this must contain exactly one synonym equal to value.

class dialogflow_v2beta1.types.EntityTypeBatch

This message is a wrapper around a collection of entity types.

entity_types

A collection of entity types.

class dialogflow_v2beta1.types.EnumDescriptorProto
class EnumReservedRange
class dialogflow_v2beta1.types.EnumOptions
class dialogflow_v2beta1.types.EnumValueDescriptorProto
class dialogflow_v2beta1.types.EnumValueOptions
class dialogflow_v2beta1.types.EventInput

Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: “welcome_event”, parameters: { name: “Sam” } }> can trigger a personalized welcome response. The parameter name may be used by the agent in the response: “Hello #welcome_event.name! What can I do for you today?”.

name

Required. The unique identifier of the event.

parameters

Optional. The collection of parameters associated with the event.

language_code

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

class dialogflow_v2beta1.types.ExportAgentRequest

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

parent

Required. The project that the agent to export is associated with. Format: projects/<Project ID>.

agent_uri

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

class dialogflow_v2beta1.types.ExportAgentResponse

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

agent

Required. The exported agent.

agent_uri

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

agent_content

The exported agent. Example for how to export an agent to a zip file via a command line: .. raw:: html <pre>curl ‘https://dialogflow.googleapis.com/v2beta1/projects/&lt;projec t_name&gt;/agent:export’ -X POST -H ‘Authorization: Bearer ‘$(gcloud auth application-default print-access-token) -H ‘Accept: application/json’ -H ‘Content-Type: application/json’ –compressed –data-binary ‘{}’ | grep agentContent | sed -e ‘s/.*”agentContent”: “([^”]*)”.*//’ | base64 –decode > &lt;agent zip file&gt;</pre>

class dialogflow_v2beta1.types.ExtensionRangeOptions
class dialogflow_v2beta1.types.FieldDescriptorProto
class dialogflow_v2beta1.types.FieldMask
class dialogflow_v2beta1.types.FieldOptions
class dialogflow_v2beta1.types.FileDescriptorProto
class dialogflow_v2beta1.types.FileDescriptorSet
class dialogflow_v2beta1.types.FileOptions
class dialogflow_v2beta1.types.GeneratedCodeInfo
class Annotation
class dialogflow_v2beta1.types.GetAgentRequest

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

parent

Required. The project that the agent to fetch is associated with. Format: projects/<Project ID>.

class dialogflow_v2beta1.types.GetContextRequest

The request message for [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext].

name

Required. The name of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

class dialogflow_v2beta1.types.GetDocumentRequest

Request message for [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument].

name

Required. The name of the document to retrieve. Format projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

class dialogflow_v2beta1.types.GetEntityTypeRequest

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

name

Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

language_code

Optional. The language to retrieve entity synonyms for. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

class dialogflow_v2beta1.types.GetIntentRequest

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

name

Required. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

language_code

Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

intent_view

Optional. The resource view to apply to the returned intent.

class dialogflow_v2beta1.types.GetKnowledgeBaseRequest

Request message for [KnowledgeBase.GetDocument][].

name

Required. The name of the knowledge base to retrieve. Format projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

class dialogflow_v2beta1.types.GetOperationRequest
class dialogflow_v2beta1.types.GetSessionEntityTypeRequest

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

name

Required. The name of the session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

class dialogflow_v2beta1.types.Http
class dialogflow_v2beta1.types.HttpRule
class dialogflow_v2beta1.types.ImportAgentRequest

The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent].

parent

Required. The project that the agent to import is associated with. Format: projects/<Project ID>.

agent

Required. The agent to import.

agent_uri

The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with “gs://”.

agent_content

The agent to import. Example for how to import an agent via the command line: .. raw:: html <pre>curl ‘https:/ /dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&g t;/agent:import -X POST -H ‘Authorization: Bearer ‘$(gcloud auth application-default print-access- token) -H ‘Accept: application/json’ -H ‘Content-Type: application/json’ –compressed –data-binary “{ ‘agentContent’: ‘$(cat &lt;agent zip file&gt; | base64 -w 0)’ }”</pre>

class dialogflow_v2beta1.types.InputAudioConfig

Instructs the speech recognizer how to process the audio content.

audio_encoding

Required. Audio encoding of the audio content to process.

sample_rate_hertz

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

language_code

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

phrase_hints

Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to Cloud Speech API documentation for more details.

model

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

class dialogflow_v2beta1.types.Intent

Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics.

name

Required for all methods except create (create populates the name automatically. The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

display_name

Required. The name of this intent.

webhook_state

Required. Indicates whether webhooks are enabled for the intent.

priority

Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled.

is_fallback

Optional. Indicates whether this is a fallback intent.

ml_enabled

Optional. Indicates whether Machine Learning is enabled for the intent. Note: If ml_enabled setting is set to false, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use ml_disabled field instead. NOTE: If both ml_enabled and ml_disabled are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.

ml_disabled

Optional. Indicates whether Machine Learning is disabled for the intent. Note: If ml_disabled setting is set to true, then this intent is not taken into account during inference in ML ONLY match mode. Also, auto-markup in the UI is turned off.

end_interaction

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

input_context_names

Optional. The list of context names required for this intent to be triggered. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

events

Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent.

training_phrases

Optional. The collection of examples/templates that the agent is trained on.

action

Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.

output_contexts

Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the lifespan_count to 0 will reset the context when the intent is matched. Format: projects/<Project ID>/agent/sessions/-/contexts/<Context ID>.

reset_contexts

Optional. Indicates whether to delete all contexts in the current session when this intent is matched.

parameters

Optional. The collection of parameters associated with the intent.

messages

Optional. The collection of rich messages corresponding to the Response field in the Dialogflow console.

default_response_platforms

Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.

root_followup_intent_name

The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

parent_followup_intent_name

The unique identifier of the parent intent in the chain of followup intents. It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

followup_intent_info

Optional. Collection of information about all followup intents that have name of this intent as a root_name.

class FollowupIntentInfo

Represents a single followup intent in the chain.

followup_intent_name

The unique identifier of the followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

parent_followup_intent_name

The unique identifier of the followup intent parent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

class Message

Corresponds to the Response field in the Dialogflow console.

message

Required. The rich response message.

text

Returns a text response.

image

Displays an image.

quick_replies

Displays quick replies.

card

Displays a card.

payload

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform.

simple_responses

Returns a voice or text-only response for Actions on Google.

basic_card

Displays a basic card for Actions on Google.

suggestions

Displays suggestion chips for Actions on Google.

Displays a link out suggestion chip for Actions on Google.

list_select

Displays a list card for Actions on Google.

carousel_select

Displays a carousel card for Actions on Google.

telephony_play_audio

Plays audio from a file in Telephony Gateway.

telephony_synthesize_speech

Synthesizes speech in Telephony Gateway.

telephony_transfer_call

Transfers the call in Telephony Gateway.

platform

Optional. The platform that this message is intended for.

class BasicCard

The basic card message. Useful for displaying information.

title

Optional. The title of the card.

subtitle

Optional. The subtitle of the card.

formatted_text

Required, unless image is present. The body text of the card.

image

Optional. The image for the card.

buttons

Optional. The collection of card buttons.

class Button

The button object that appears at the bottom of a card.

title

Required. The title of the button.

open_uri_action

Required. Action to take when a user taps on the button.

class OpenUriAction

Opens the given URI.

uri

Required. The HTTP or HTTPS scheme URI.

class Card

The card response message.

title

Optional. The title of the card.

subtitle

Optional. The subtitle of the card.

image_uri

Optional. The public URI to an image file for the card.

buttons

Optional. The collection of card buttons.

class Button

Optional. Contains information about a button.

text

Optional. The text to show on the button.

postback

Optional. The text to send back to the Dialogflow API or a URI to open.

class CarouselSelect

The card for presenting a carousel of options to select from.

items

Required. Carousel items.

class Item

An item in the carousel.

info

Required. Additional info about the option item.

title

Required. Title of the carousel item.

description

Optional. The body text of the card.

image

Optional. The image to display.

class Image

The image response message.

image_uri

Optional. The public URI to an image file.

accessibility_text

A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.

class LinkOutSuggestion

The suggestion chip message that allows the user to jump out to the app or website associated with this agent.

destination_name

Required. The name of the app or site this chip is linking to.

uri

Required. The URI of the app or site to open when the user taps the suggestion chip.

class ListSelect

The card for presenting a list of options to select from.

title

Optional. The overall title of the list.

items

Required. List items.

class Item

An item in the list.

info

Required. Additional information about this option.

title

Required. The title of the list item.

description

Optional. The main text describing the item.

image

Optional. The image to display.

class QuickReplies

The quick replies response message.

title

Optional. The title of the collection of quick replies.

quick_replies

Optional. The collection of quick replies.

class SelectItemInfo

Additional info about the select item for when it is triggered in a dialog.

key

Required. A unique key that will be sent back to the agent if this response is given.

synonyms

Optional. A list of synonyms that can also be used to trigger this item in dialog.

class SimpleResponse

The simple response message containing speech or text.

text_to_speech

One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.

ssml

One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.

display_text

Optional. The text to display.

class SimpleResponses

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse.

simple_responses

Required. The list of simple responses.

class Suggestion

The suggestion chip message that the user can tap to quickly post a reply to the conversation.

title

Required. The text shown the in the suggestion chip.

class Suggestions

The collection of suggestions.

suggestions

Required. The list of suggested replies.

class TelephonyPlayAudio

Plays audio from a file in Telephony Gateway.

audio_uri

Required. URI to a Google Cloud Storage object containing the audio to play, e.g., “gs://bucket/object”. The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the service-<Project Number>@gcp-sa- dialogflow.iam.gserviceaccount.com service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the TelephonySynthesizeSpeech message with SSML.

class TelephonySynthesizeSpeech

Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway.

Telephony Gateway takes the synthesizer settings from DetectIntentResponse.output_audio_config which can either be set at request-level or can come from the agent-level synthesizer config.

source

Required. The source to be synthesized.

text

The raw text to be synthesized.

ssml

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

class TelephonyTransferCall

Transfers the call in Telephony Gateway.

phone_number

Required. The phone number to transfer the call to in E.164 format. We currently only allow transferring to US numbers (+1xxxyyyzzzz).

class Text

The text response message.

text

Optional. The collection of the agent’s responses.

class Parameter

Represents intent parameters.

name

The unique identifier of this parameter.

display_name

Required. The name of the parameter.

value

Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as $parameter_name, - an original parameter value defined as $parameter_name.original, - a parameter value from some context defined as #context_name.parameter_name.

default_value

Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.

entity_type_display_name

Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.

mandatory

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

prompts

Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.

is_list

Optional. Indicates whether the parameter represents a list of values.

class TrainingPhrase

Represents an example or template that the agent is trained on.

name

Required. The unique identifier of this training phrase.

type

Required. The type of the training phrase.

parts

Required. The collection of training phrase parts (can be annotated). Fields: entity_type, alias and user_defined should be populated only for the annotated parts of the training phrase.

times_added_count

Optional. Indicates how many times this example or template was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.

class Part

Represents a part of a training phrase.

text

Required. The text corresponding to the example or template, if there are no annotations. For annotated examples, it is the text for one of the example’s parts.

entity_type

Optional. The entity type name prefixed with @. This field is required for the annotated part of the text and applies only to examples.

alias

Optional. The parameter name for the value extracted from the annotated part of the example.

user_defined

Optional. Indicates whether the text was manually annotated by the developer.

class dialogflow_v2beta1.types.IntentBatch

This message is a wrapper around a collection of intents.

intents

A collection of intents.

class dialogflow_v2beta1.types.KnowledgeAnswers

Represents the result of querying a Knowledge base.

answers

A list of answers from Knowledge Connector.

class Answer

An answer from Knowledge Connector.

source

Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

faq_question

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

answer

The piece of text from the source knowledge base document that answers this conversational query.

match_confidence_level

The system’s confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

match_confidence

The system’s confidence score that this Knowledge answer is a good match for this converstational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement, we may deprecate it in the future. We recommend using match_confidence_level which should be generally more stable.

class dialogflow_v2beta1.types.KnowledgeBase

Represents knowledge base resource.

name

The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

display_name

Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.

class dialogflow_v2beta1.types.KnowledgeOperationMetadata

Metadata in google::longrunning::Operation for Knowledge operations.

state

Required. The current state of this operation.

class dialogflow_v2beta1.types.LatLng
class dialogflow_v2beta1.types.ListContextsRequest

The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].

parent

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListContextsResponse

The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].

contexts

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

next_page_token

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

class dialogflow_v2beta1.types.ListDocumentsRequest

Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].

parent

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListDocumentsResponse

Response message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].

documents

The list of documents.

next_page_token

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

class dialogflow_v2beta1.types.ListEntityTypesRequest

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

parent

Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.

language_code

Optional. The language to list entity synonyms for. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListEntityTypesResponse

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

entity_types

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

next_page_token

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

class dialogflow_v2beta1.types.ListIntentsRequest

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

parent

Required. The agent to list all intents from. Format: projects/<Project ID>/agent.

language_code

Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent before they can be used.

intent_view

Optional. The resource view to apply to the returned intent.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListIntentsResponse

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

intents

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

next_page_token

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

class dialogflow_v2beta1.types.ListKnowledgeBasesRequest

Request message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases].

parent

Required. The agent to list of knowledge bases for. Format: projects/<Project ID>/agent.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListKnowledgeBasesResponse

Response message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases].

knowledge_bases

The list of knowledge bases.

next_page_token

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

class dialogflow_v2beta1.types.ListOperationsRequest
class dialogflow_v2beta1.types.ListOperationsResponse
class dialogflow_v2beta1.types.ListSessionEntityTypesRequest

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

parent

Required. The session to list all session entity types from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.ListSessionEntityTypesResponse

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

session_entity_types

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

next_page_token

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

class dialogflow_v2beta1.types.ListValue
class dialogflow_v2beta1.types.MessageOptions
class dialogflow_v2beta1.types.MethodDescriptorProto
class dialogflow_v2beta1.types.MethodOptions
class dialogflow_v2beta1.types.OneofDescriptorProto
class dialogflow_v2beta1.types.OneofOptions
class dialogflow_v2beta1.types.Operation
class dialogflow_v2beta1.types.OriginalDetectIntentRequest

Represents the contents of the original request that was passed to the [Streaming]DetectIntent call.

source

The source of this request, e.g., google, facebook, slack. It is set by Dialogflow-owned servers.

version

Optional. The version of the protocol used for this request. This field is AoG-specific.

payload

Optional. This field is set to the value of QueryParameters.payload field passed in the request. This field is used for the telephony gateway. It should have a structure similar to this JSON message: .. raw:: html <pre>{ “telephony”: { “caller_id”: “+18558363987” } }</pre> Note: The caller ID field (caller_id) will be in E.164 format and is only supported for Enterprise Edition and not for Standard Edition agents. When the telephony gateway is used with a standard tier agent the caller_id field above will have a value of REDACTED_IN_STANDARD_TIER_AGENT.

class dialogflow_v2beta1.types.OutputAudioConfig

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

audio_encoding

Required. Audio encoding of the synthesized audio content.

sample_rate_hertz

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

synthesize_speech_config

Optional. Configuration of how speech should be synthesized.

class dialogflow_v2beta1.types.QueryInput

Represents the query input. It can contain either:

  1. An audio config which instructs the speech recognizer how to process the speech audio.
  2. A conversational query in the form of text,.
  3. An event that specifies which intent to trigger.
input

Required. The input specification.

audio_config

Instructs the speech recognizer how to process the speech audio.

text

The natural language text to be processed.

event

The event to be processed.

class dialogflow_v2beta1.types.QueryParameters

Represents the parameters of the conversational query.

time_zone

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

geo_location

Optional. The geo location of this conversational query.

contexts

Optional. The collection of contexts to be activated before this query is executed.

reset_contexts

Optional. Specifies whether to delete all contexts in the current session before the new ones are activated.

session_entity_types

Optional. The collection of session entity types to replace or extend developer entities with for this query only. The entity synonyms apply to all languages.

payload

Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.

knowledge_base_names

Optional. KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>. Note: This field is repeated for forward compatibility, currently only the first one is supported, we may return an error if multiple KnowledgeBases are specified.

sentiment_analysis_request_config

Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Enterprise Edition agents.

class dialogflow_v2beta1.types.QueryResult

Represents the result of conversational query or event processing.

query_text

The original conversational query text: - If natural language text was provided as input, query_text contains a copy of the input. - If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, query_text is not set.

language_code

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

speech_recognition_confidence

The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn’t set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.

action

The action name from the matched intent.

parameters

The collection of extracted parameters.

all_required_params_present

This field is set to: - false if the matched intent has required parameters and not all of the required parameter values have been collected. - true if all required parameter values have been collected, or if the matched intent doesn’t contain any required parameters.

fulfillment_text

The text to be pronounced to the user or shown on the screen.

fulfillment_messages

The collection of rich messages to present to the user.

webhook_source

If the query was fulfilled by a webhook call, this field is set to the value of the source field returned in the webhook response.

webhook_payload

If the query was fulfilled by a webhook call, this field is set to the value of the payload field returned in the webhook response.

output_contexts

The collection of output contexts. If applicable, output_contexts.parameters contains entries with name <parameter name>.original containing the original parameter values before the query.

intent

The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name, display_name and webhook_state.

intent_detection_confidence

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list.

diagnostic_info

The free-form diagnostic info. For example, this field could contain webhook call latency.

sentiment_analysis_result

The sentiment analysis result, which depends on the sentiment_analysis_request_config specified in the request.

knowledge_answers

The result from Knowledge Connector (if any), ordered by decreasing KnowledgeAnswers.match_confidence.

class dialogflow_v2beta1.types.RestoreAgentRequest

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

parent

Required. The project that the agent to restore is associated with. Format: projects/<Project ID>.

agent

Required. The agent to restore.

agent_uri

The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with “gs://”.

agent_content

The agent to restore. Example for how to restore an agent via the command line: .. raw:: html <pre>curl ‘https:/ /dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&g t;/agent:restore -X POST -H ‘Authorization: Bearer ‘$(gcloud auth application-default print-access- token) -H ‘Accept: application/json’ -H ‘Content-Type: application/json’ –compressed –data-binary “{ ‘agentContent’: ‘$(cat &lt;agent zip file&gt; | base64 -w 0)’ }”</pre>

class dialogflow_v2beta1.types.SearchAgentsRequest

The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].

parent

Required. The project to list agents from. Format: projects/<Project ID or '-'>.

page_size

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

page_token

Optional. The next_page_token value returned from a previous list request.

class dialogflow_v2beta1.types.SearchAgentsResponse

The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].

agents

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

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

class dialogflow_v2beta1.types.Sentiment

The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.

score

Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).

magnitude

A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).

class dialogflow_v2beta1.types.SentimentAnalysisRequestConfig

Configures the types of sentiment analysis to perform.

analyze_query_text_sentiment

Optional. Instructs the service to perform sentiment analysis on query_text. If not provided, sentiment analysis is not performed on query_text.

class dialogflow_v2beta1.types.SentimentAnalysisResult

The result of sentiment analysis as configured by sentiment_analysis_request_config.

query_text_sentiment

The sentiment analysis result for query_text.

class dialogflow_v2beta1.types.ServiceDescriptorProto
class dialogflow_v2beta1.types.ServiceOptions
class dialogflow_v2beta1.types.SessionEntityType

Represents a session entity type.

Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as “developer entity types”).

Note: session entity types apply to all queries, regardless of the language.

name

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

entity_override_mode

Required. Indicates whether the additional data should override or supplement the developer entity type definition.

entities

Required. The collection of entities associated with this session entity type.

class dialogflow_v2beta1.types.SourceCodeInfo
class Location
class dialogflow_v2beta1.types.Status
class dialogflow_v2beta1.types.StreamingDetectIntentRequest

The top-level message sent by the client to the StreamingDetectIntent method.

Multiple request messages should be sent in order:

  1. The first message must contain session, query_input plus optionally query_params and/or single_utterance. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.
  2. If query_input was set to a streaming input audio config, all subsequent messages must contain only input_audio. Otherwise, finish the request stream.
session

Required. The name of the session the query is sent to. Format of the session name: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we are using “-“. It’s up to the API caller to choose an appropriate Session ID and User Id. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

query_params

Optional. The parameters of this query.

query_input

Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.

single_utterance

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

output_audio_config

Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

input_audio

Optional. The input audio content to be recognized. Must be sent if query_input was set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute.

class dialogflow_v2beta1.types.StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

  1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
  2. The next message contains response_id, query_result, alternative_query_results and optionally webhook_status if a WebHook was called.
  3. If output_audio_config was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain output_audio and output_audio_config.
response_id

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

recognition_result

The result of speech recognition.

query_result

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

alternative_query_results

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event and this field will contain all results except for the top one which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled this field will be empty at which point those additional results will be surfaced here.

webhook_status

Specifies the status of the webhook request.

output_audio

The audio data bytes encoded as specified in the request.

output_audio_config

Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled.

class dialogflow_v2beta1.types.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.

Example:

  1. transcript: “tube”
  2. transcript: “to be a”
  3. transcript: “to be”
  4. transcript: “to be or not to be” is_final: true
  5. transcript: ” that’s”
  6. transcript: ” that is”
  7. recognition_event_type: RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE
  8. transcript: ” that is the question” is_final: true

Only two of the responses contain final results (#4 and #8 indicated by is_final: true). Concatenating these generates the full transcript: “to be or not to be that is the question”.

In each response we populate:

  • for MESSAGE_TYPE_TRANSCRIPT: transcript and possibly is_final.
  • for MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE: only event_type.
message_type

Type of the result message.

transcript

Transcript text representing the words that the user spoke. Populated if and only if event_type = RECOGNITION_EVENT_TRANSCRIPT.

is_final

The default of 0.0 is a sentinel value indicating confidence was not set. If false, the StreamingRecognitionResult represents an interim result that may change. If true, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for event_type = RECOGNITION_EVENT_TRANSCRIPT.

confidence

The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is typically only provided if is_final is true and you should not rely on it being accurate or even set.

class dialogflow_v2beta1.types.Struct
class FieldsEntry
class dialogflow_v2beta1.types.SynthesizeSpeechConfig

Configuration of how speech should be synthesized.

speaking_rate

Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.

pitch

Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.

volume_gain_db

Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there’s usually no effective increase in loudness for any value greater than that.

effects_profile_id

Optional. An identifier which selects ‘audio effects’ profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.

voice

Optional. The desired voice of the synthesized audio.

class dialogflow_v2beta1.types.TextInput

Represents the natural language text to be processed.

text

Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 bytes.

language_code

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

class dialogflow_v2beta1.types.TrainAgentRequest

The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent].

parent

Required. The project that the agent to train is associated with. Format: projects/<Project ID>.

class dialogflow_v2beta1.types.UninterpretedOption
class NamePart
class dialogflow_v2beta1.types.UpdateContextRequest

The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext].

context

Required. The context to update.

update_mask

Optional. The mask to control which fields get updated.

class dialogflow_v2beta1.types.UpdateEntityTypeRequest

The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType].

entity_type

Required. The entity type to update. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

language_code

Optional. The language of entity synonyms defined in entity_type. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

update_mask

Optional. The mask to control which fields get updated.

class dialogflow_v2beta1.types.UpdateIntentRequest

The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent].

intent

Required. The intent to update. Format: projects/<Project ID>/agent/intents/<Intent ID>.

language_code

Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent’s default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

update_mask

Optional. The mask to control which fields get updated.

intent_view

Optional. The resource view to apply to the returned intent.

class dialogflow_v2beta1.types.UpdateSessionEntityTypeRequest

The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.UpdateSessionEntityType].

session_entity_type

Required. The entity type to update. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user.

update_mask

Optional. The mask to control which fields get updated.

class dialogflow_v2beta1.types.Value
class dialogflow_v2beta1.types.VoiceSelectionParams

Description of which voice to use for speech synthesis.

name

Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender.

ssml_gender

Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.

class dialogflow_v2beta1.types.WebhookRequest

The request message for a webhook call.

session

The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: projects/<Project ID>/agent/sessions/<Session ID>.

response_id

The unique identifier of the response. Contains the same value as [Streaming]DetectIntentResponse.response_id.

query_result

The result of the conversational query or event processing. Contains the same value as [Streaming]DetectIntentResponse.query_result.

alternative_query_results

Alternative query results from KnowledgeService.

original_detect_intent_request

Optional. The contents of the original request that was passed to [Streaming]DetectIntent call.

class dialogflow_v2beta1.types.WebhookResponse

The response message for a webhook call.

fulfillment_text

Optional. The text to be shown on the screen. This value is passed directly to QueryResult.fulfillment_text.

fulfillment_messages

Optional. The collection of rich messages to present to the user. This value is passed directly to QueryResult.fulfillment_messages.

source

Optional. This value is passed directly to QueryResult.webhook_source.

payload

Optional. This value is passed directly to QueryResult.webhook_payload. See the related fulfillment_messages[i].payload field, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see Actions on Google Webhook Format .. raw:: html <pre>{ “google”: { “expectUserResponse”: true, “richResponse”: { “items”: [ { “simpleResponse”: { “textToSpeech”: “this is a simple response” } } ] } } }</pre>

output_contexts

Optional. The collection of output contexts. This value is passed directly to QueryResult.output_contexts.

followup_event_input

Optional. Makes the platform immediately invoke another DetectIntent call internally with the specified event as input.

end_interaction

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.