On January 1, 2020 this library will no longer support Python 2 on the latest released version. Previously released library versions will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Dialogflow API Client

class dialogflow_v2.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 will 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.

api_version

Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

tier

Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

api_version

Field google.cloud.dialogflow.v2.Agent.api_version

avatar_uri

Field google.cloud.dialogflow.v2.Agent.avatar_uri

classification_threshold

Field google.cloud.dialogflow.v2.Agent.classification_threshold

default_language_code

Field google.cloud.dialogflow.v2.Agent.default_language_code

description

Field google.cloud.dialogflow.v2.Agent.description

display_name

Field google.cloud.dialogflow.v2.Agent.display_name

enable_logging

Field google.cloud.dialogflow.v2.Agent.enable_logging

match_mode

Field google.cloud.dialogflow.v2.Agent.match_mode

parent

Field google.cloud.dialogflow.v2.Agent.parent

supported_language_codes

Field google.cloud.dialogflow.v2.Agent.supported_language_codes

tier

Field google.cloud.dialogflow.v2.Agent.tier

time_zone

Field google.cloud.dialogflow.v2.Agent.time_zone

class dialogflow_v2.types.Any
type_url

Field google.protobuf.Any.type_url

value

Field google.protobuf.Any.value

class dialogflow_v2.types.BatchCreateEntitiesRequest

The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2.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 entities to create.

language_code

Optional. The language of entity synonyms defined in entities. 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.

entities

Field google.cloud.dialogflow.v2.BatchCreateEntitiesRequest.entities

language_code

Field google.cloud.dialogflow.v2.BatchCreateEntitiesRequest.language_code

parent

Field google.cloud.dialogflow.v2.BatchCreateEntitiesRequest.parent

class dialogflow_v2.types.BatchDeleteEntitiesRequest

The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2.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 reference 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. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

entity_values

Field google.cloud.dialogflow.v2.BatchDeleteEntitiesRequest.entity_values

language_code

Field google.cloud.dialogflow.v2.BatchDeleteEntitiesRequest.language_code

parent

Field google.cloud.dialogflow.v2.BatchDeleteEntitiesRequest.parent

class dialogflow_v2.types.BatchDeleteEntityTypesRequest

The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2.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.

entity_type_names

Field google.cloud.dialogflow.v2.BatchDeleteEntityTypesRequest.entity_type_names

parent

Field google.cloud.dialogflow.v2.BatchDeleteEntityTypesRequest.parent

class dialogflow_v2.types.BatchDeleteIntentsRequest

The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2.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.

intents

Field google.cloud.dialogflow.v2.BatchDeleteIntentsRequest.intents

parent

Field google.cloud.dialogflow.v2.BatchDeleteIntentsRequest.parent

class dialogflow_v2.types.BatchUpdateEntitiesRequest

The request message for [EntityTypes.BatchUpdateEntities][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntities].

parent

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

entities

Required. The entities to update or create.

language_code

Optional. The language of entity synonyms defined in entities. 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.

update_mask

Optional. The mask to control which fields get updated.

entities

Field google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest.entities

language_code

Field google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest.language_code

parent

Field google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest.parent

update_mask

Field google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest.update_mask

class dialogflow_v2.types.BatchUpdateEntityTypesRequest

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

parent

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

entity_type_batch

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

entity_type_batch_inline

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest.entity_type_batch_inline

entity_type_batch_uri

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest.entity_type_batch_uri

language_code

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest.language_code

parent

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest.parent

update_mask

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest.update_mask

class dialogflow_v2.types.BatchUpdateEntityTypesResponse

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

entity_types

The collection of updated or created entity types.

entity_types

Field google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse.entity_types

class dialogflow_v2.types.BatchUpdateIntentsRequest

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

parent

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

intent_batch

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

intent_batch_inline

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.intent_batch_inline

intent_batch_uri

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.intent_batch_uri

intent_view

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.intent_view

language_code

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.language_code

parent

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.parent

update_mask

Field google.cloud.dialogflow.v2.BatchUpdateIntentsRequest.update_mask

class dialogflow_v2.types.BatchUpdateIntentsResponse

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

intents

The collection of updated or created intents.

intents

Field google.cloud.dialogflow.v2.BatchUpdateIntentsResponse.intents

class dialogflow_v2.types.CancelOperationRequest
name

Field google.longrunning.CancelOperationRequest.name

class dialogflow_v2.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, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we assume default ‘-‘ user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: - __system_counters__ - *_id_dialog_context - *_dialog_params_size

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 20 minutes if there are no matching queries.

parameters

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

lifespan_count

Field google.cloud.dialogflow.v2.Context.lifespan_count

name

Field google.cloud.dialogflow.v2.Context.name

parameters

Field google.cloud.dialogflow.v2.Context.parameters

class dialogflow_v2.types.CreateContextRequest

The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2.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.

context

Field google.cloud.dialogflow.v2.CreateContextRequest.context

parent

Field google.cloud.dialogflow.v2.CreateContextRequest.parent

class dialogflow_v2.types.CreateEntityTypeRequest

The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2.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. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

entity_type

Field google.cloud.dialogflow.v2.CreateEntityTypeRequest.entity_type

language_code

Field google.cloud.dialogflow.v2.CreateEntityTypeRequest.language_code

parent

Field google.cloud.dialogflow.v2.CreateEntityTypeRequest.parent

class dialogflow_v2.types.CreateIntentRequest

The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2.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. Many 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.

intent

Field google.cloud.dialogflow.v2.CreateIntentRequest.intent

intent_view

Field google.cloud.dialogflow.v2.CreateIntentRequest.intent_view

language_code

Field google.cloud.dialogflow.v2.CreateIntentRequest.language_code

parent

Field google.cloud.dialogflow.v2.CreateIntentRequest.parent

class dialogflow_v2.types.CreateSessionEntityTypeRequest

The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2.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.

parent

Field google.cloud.dialogflow.v2.CreateSessionEntityTypeRequest.parent

session_entity_type

Field google.cloud.dialogflow.v2.CreateSessionEntityTypeRequest.session_entity_type

class dialogflow_v2.types.DeleteAgentRequest

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

parent

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

parent

Field google.cloud.dialogflow.v2.DeleteAgentRequest.parent

class dialogflow_v2.types.DeleteAllContextsRequest

The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2.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.

parent

Field google.cloud.dialogflow.v2.DeleteAllContextsRequest.parent

class dialogflow_v2.types.DeleteContextRequest

The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2.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.

name

Field google.cloud.dialogflow.v2.DeleteContextRequest.name

class dialogflow_v2.types.DeleteEntityTypeRequest

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

name

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

name

Field google.cloud.dialogflow.v2.DeleteEntityTypeRequest.name

class dialogflow_v2.types.DeleteIntentRequest

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

name

Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<Project ID>/agent/intents/<Intent ID>.

name

Field google.cloud.dialogflow.v2.DeleteIntentRequest.name

class dialogflow_v2.types.DeleteOperationRequest
name

Field google.longrunning.DeleteOperationRequest.name

class dialogflow_v2.types.DeleteSessionEntityTypeRequest

The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2.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.

name

Field google.cloud.dialogflow.v2.DeleteSessionEntityTypeRequest.name

class dialogflow_v2.types.DetectIntentRequest

Requests and responses for custom methods. 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 number 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

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

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.

output_audio_config_mask

Mask for [output_audio_config][google.cloud.dialogflow.v2.De tectIntentRequest.output_audio_config] indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, [output_audio_config][google.cloud.dialogflow.v2.D etectIntentRequest.output_audio_config] replaces the agent- level config in its entirety.

input_audio

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.

input_audio

Field google.cloud.dialogflow.v2.DetectIntentRequest.input_audio

output_audio_config

Field google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config

output_audio_config_mask

Field google.cloud.dialogflow.v2.DetectIntentRequest.output_audio_config_mask

query_input

Field google.cloud.dialogflow.v2.DetectIntentRequest.query_input

query_params

Field google.cloud.dialogflow.v2.DetectIntentRequest.query_params

session

Field google.cloud.dialogflow.v2.DetectIntentRequest.session

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

webhook_status

Specifies the status of the webhook request.

output_audio

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.fulfillment_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.

output_audio_config

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

output_audio

Field google.cloud.dialogflow.v2.DetectIntentResponse.output_audio

output_audio_config

Field google.cloud.dialogflow.v2.DetectIntentResponse.output_audio_config

query_result

Field google.cloud.dialogflow.v2.DetectIntentResponse.query_result

response_id

Field google.cloud.dialogflow.v2.DetectIntentResponse.response_id

webhook_status

Field google.cloud.dialogflow.v2.DetectIntentResponse.webhook_status

class dialogflow_v2.types.Duration
nanos

Field google.protobuf.Duration.nanos

seconds

Field google.protobuf.Duration.seconds

class dialogflow_v2.types.Empty
class dialogflow_v2.types.EntityType

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

name

The unique identifier of the entity type. Required for [Entity Types.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes .UpdateEntityType] and [EntityTypes.BatchUpdateEntityTypes][go ogle.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes] methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

display_name

Required. The name of the entity type.

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 entity entries associated with the entity type.

enable_fuzzy_extraction

Optional. Enables fuzzy entity extraction during classification.

class Entity

An entity entry for an associated entity type.

value

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: - A reference 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

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.

synonyms

Field google.cloud.dialogflow.v2.EntityType.Entity.synonyms

value

Field google.cloud.dialogflow.v2.EntityType.Entity.value

auto_expansion_mode

Field google.cloud.dialogflow.v2.EntityType.auto_expansion_mode

display_name

Field google.cloud.dialogflow.v2.EntityType.display_name

enable_fuzzy_extraction

Field google.cloud.dialogflow.v2.EntityType.enable_fuzzy_extraction

entities

Field google.cloud.dialogflow.v2.EntityType.entities

kind

Field google.cloud.dialogflow.v2.EntityType.kind

name

Field google.cloud.dialogflow.v2.EntityType.name

class dialogflow_v2.types.EntityTypeBatch

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

entity_types

A collection of entity types.

entity_types

Field google.cloud.dialogflow.v2.EntityTypeBatch.entity_types

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

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.

language_code

Field google.cloud.dialogflow.v2.EventInput.language_code

name

Field google.cloud.dialogflow.v2.EventInput.name

parameters

Field google.cloud.dialogflow.v2.EventInput.parameters

class dialogflow_v2.types.ExportAgentRequest

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

parent

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

agent_uri

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

agent_uri

Field google.cloud.dialogflow.v2.ExportAgentRequest.agent_uri

parent

Field google.cloud.dialogflow.v2.ExportAgentRequest.parent

class dialogflow_v2.types.ExportAgentResponse

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

agent

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

Zip compressed raw byte content for agent.

agent_content

Field google.cloud.dialogflow.v2.ExportAgentResponse.agent_content

agent_uri

Field google.cloud.dialogflow.v2.ExportAgentResponse.agent_uri

class dialogflow_v2.types.FieldMask
paths

Field google.protobuf.FieldMask.paths

class dialogflow_v2.types.GetAgentRequest

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

parent

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

parent

Field google.cloud.dialogflow.v2.GetAgentRequest.parent

class dialogflow_v2.types.GetContextRequest

The request message for [Contexts.GetContext][google.cloud.dialogflow.v2.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.

name

Field google.cloud.dialogflow.v2.GetContextRequest.name

class dialogflow_v2.types.GetEntityTypeRequest

The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2.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. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

language_code

Field google.cloud.dialogflow.v2.GetEntityTypeRequest.language_code

name

Field google.cloud.dialogflow.v2.GetEntityTypeRequest.name

class dialogflow_v2.types.GetIntentRequest

The request message for [Intents.GetIntent][google.cloud.dialogflow.v2.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. Many 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.

intent_view

Field google.cloud.dialogflow.v2.GetIntentRequest.intent_view

language_code

Field google.cloud.dialogflow.v2.GetIntentRequest.language_code

name

Field google.cloud.dialogflow.v2.GetIntentRequest.name

class dialogflow_v2.types.GetOperationRequest
name

Field google.longrunning.GetOperationRequest.name

class dialogflow_v2.types.GetSessionEntityTypeRequest

The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2.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.

name

Field google.cloud.dialogflow.v2.GetSessionEntityTypeRequest.name

class dialogflow_v2.types.GetValidationResultRequest

The request message for [Agents.GetValidationResult][google.cloud.dialogflow.v2.Agents.GetValidationResult].

parent

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

language_code

Optional. The language for which you want a validation result. 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.

language_code

Field google.cloud.dialogflow.v2.GetValidationResultRequest.language_code

parent

Field google.cloud.dialogflow.v2.GetValidationResultRequest.parent

class dialogflow_v2.types.ImportAgentRequest

The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2.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

Zip compressed raw byte content for agent.

agent_content

Field google.cloud.dialogflow.v2.ImportAgentRequest.agent_content

agent_uri

Field google.cloud.dialogflow.v2.ImportAgentRequest.agent_uri

parent

Field google.cloud.dialogflow.v2.ImportAgentRequest.parent

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

enable_word_info

If true, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.v2.SpeechWordInfo] in [StreamingRecognitionResult][google.cloud.dialogflow.v2.Stream ingRecognitionResult] 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

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. This field is deprecated. Please use speech_contexts instead. If you specify both phrase_hints and speech_contexts, Dialogflow will treat the phrase_hints as a single additional SpeechContext.

speech_contexts

Context information to assist speech recognition. See the Cloud Speech documentation for more details.

model

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

Which variant of the [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

single_utterance

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. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.

audio_encoding

Field google.cloud.dialogflow.v2.InputAudioConfig.audio_encoding

enable_word_info

Field google.cloud.dialogflow.v2.InputAudioConfig.enable_word_info

language_code

Field google.cloud.dialogflow.v2.InputAudioConfig.language_code

model

Field google.cloud.dialogflow.v2.InputAudioConfig.model

model_variant

Field google.cloud.dialogflow.v2.InputAudioConfig.model_variant

phrase_hints

Field google.cloud.dialogflow.v2.InputAudioConfig.phrase_hints

sample_rate_hertz

Field google.cloud.dialogflow.v2.InputAudioConfig.sample_rate_hertz

single_utterance

Field google.cloud.dialogflow.v2.InputAudioConfig.single_utterance

speech_contexts

Field google.cloud.dialogflow.v2.InputAudioConfig.speech_contexts

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

The unique identifier of this intent. Required for [Intents.Up dateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent] and [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.In tents.BatchUpdateIntents] methods. Format: projects/<Project ID>/agent/intents/<Intent ID>.

display_name

Required. The name of this intent.

webhook_state

Optional. Indicates whether webhooks are enabled for the intent.

priority

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

Optional. Indicates whether this is a fallback intent.

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.

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. Event names are limited to 150 characters.

training_phrases

Optional. The collection of examples 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 responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

root_followup_intent_name

Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: projects/<Project ID>/agent/intents/<Intent ID>.

parent_followup_intent_name

Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with [CreateIntent] [google.cloud.dialogflow.v2.Intents.CreateIntent] or [BatchUpd ateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateInte nts], in order to make this intent a followup intent. It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

followup_intent_info

Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.

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’s parent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

followup_intent_name

Field google.cloud.dialogflow.v2.Intent.FollowupIntentInfo.followup_intent_name

parent_followup_intent_name

Field google.cloud.dialogflow.v2.Intent.FollowupIntentInfo.parent_followup_intent_name

class Message

Corresponds to the Response field in the Dialogflow console.

message

Required. The rich response message.

text

The text response.

image

The image response.

quick_replies

The quick replies response.

card

The card response.

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

The voice and text-only responses for Actions on Google.

basic_card

The basic card response for Actions on Google.

suggestions

The suggestion chips for Actions on Google.

The link out suggestion chip for Actions on Google.

list_select

The list card response for Actions on Google.

carousel_select

The carousel card response for Actions on Google.

Browse carousel card for Actions on Google.

table_card

Table card for Actions on Google.

media_content

The media content card for Actions on Google.

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.

uri

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button.OpenUriAction.uri

open_uri_action

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button.open_uri_action

title

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button.title

buttons

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.buttons

formatted_text

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.formatted_text

image

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.image

subtitle

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.subtitle

title

Field google.cloud.dialogflow.v2.Intent.Message.BasicCard.title

class BrowseCarouselCard

Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel

items

Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.

image_display_options

Optional. Settings for displaying the image. Applies to every image in [items][google.cloud.dialogflow.v2.Intent.Message.Bro wseCarouselCard.items].

class BrowseCarouselCardItem

Browsing carousel tile

open_uri_action

Required. Action to present to the user.

title

Required. Title of the carousel item. Maximum of two lines of text.

description

Optional. Description of the carousel item. Maximum of four lines of text.

image

Optional. Hero image for the carousel item.

footer

Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.

class OpenUrlAction

Actions on Google action to open a given url.

url

Required. URL

url_type_hint

Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.

url

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.url

url_type_hint

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.url_type_hint

description

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.description

footer

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.footer

image

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.image

open_uri_action

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.open_uri_action

title

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.title

image_display_options

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.image_display_options

items

Field google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.items

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

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.

postback

Field google.cloud.dialogflow.v2.Intent.Message.Card.Button.postback

text

Field google.cloud.dialogflow.v2.Intent.Message.Card.Button.text

buttons

Field google.cloud.dialogflow.v2.Intent.Message.Card.buttons

image_uri

Field google.cloud.dialogflow.v2.Intent.Message.Card.image_uri

subtitle

Field google.cloud.dialogflow.v2.Intent.Message.Card.subtitle

title

Field google.cloud.dialogflow.v2.Intent.Message.Card.title

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.

description

Field google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item.description

image

Field google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item.image

info

Field google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item.info

title

Field google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item.title

items

Field google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.items

class ColumnProperties

Column properties for [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].

header

Required. Column heading.

horizontal_alignment

Optional. Defines text alignment for all cells in this column.

header

Field google.cloud.dialogflow.v2.Intent.Message.ColumnProperties.header

horizontal_alignment

Field google.cloud.dialogflow.v2.Intent.Message.ColumnProperties.horizontal_alignment

class Image

The image response message.

image_uri

Optional. The public URI to an image file.

accessibility_text

Optional. A text description of the image to be used for accessibility, e.g., screen readers.

accessibility_text

Field google.cloud.dialogflow.v2.Intent.Message.Image.accessibility_text

image_uri

Field google.cloud.dialogflow.v2.Intent.Message.Image.image_uri

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.

destination_name

Field google.cloud.dialogflow.v2.Intent.Message.LinkOutSuggestion.destination_name

uri

Field google.cloud.dialogflow.v2.Intent.Message.LinkOutSuggestion.uri

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.

subtitle

Optional. Subtitle of the list.

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.

description

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item.description

image

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item.image

info

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item.info

title

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item.title

items

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.items

subtitle

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.subtitle

title

Field google.cloud.dialogflow.v2.Intent.Message.ListSelect.title

class MediaContent

The media content card for Actions on Google.

media_type

Optional. What type of media is the content (ie “audio”).

media_objects

Required. List of media objects.

class ResponseMediaObject

Response media object for media content card.

name

Required. Name of media card.

description

Optional. Description of media card.

image

Image to show with the media card.

large_image

Optional. Image to display above media content.

icon

Optional. Icon to display above media content.

content_url

Required. Url where the media is stored.

content_url

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject.content_url

description

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject.description

icon

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject.icon

large_image

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject.large_image

name

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject.name

media_objects

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.media_objects

media_type

Field google.cloud.dialogflow.v2.Intent.Message.MediaContent.media_type

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.

quick_replies

Field google.cloud.dialogflow.v2.Intent.Message.QuickReplies.quick_replies

title

Field google.cloud.dialogflow.v2.Intent.Message.QuickReplies.title

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.

key

Field google.cloud.dialogflow.v2.Intent.Message.SelectItemInfo.key

synonyms

Field google.cloud.dialogflow.v2.Intent.Message.SelectItemInfo.synonyms

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.

display_text

Field google.cloud.dialogflow.v2.Intent.Message.SimpleResponse.display_text

ssml

Field google.cloud.dialogflow.v2.Intent.Message.SimpleResponse.ssml

text_to_speech

Field google.cloud.dialogflow.v2.Intent.Message.SimpleResponse.text_to_speech

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.

simple_responses

Field google.cloud.dialogflow.v2.Intent.Message.SimpleResponses.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.

title

Field google.cloud.dialogflow.v2.Intent.Message.Suggestion.title

class Suggestions

The collection of suggestions.

suggestions

Required. The list of suggested replies.

suggestions

Field google.cloud.dialogflow.v2.Intent.Message.Suggestions.suggestions

class TableCard

Table card for Actions on Google.

title

Required. Title of the card.

subtitle

Optional. Subtitle to the title.

image

Optional. Image which should be displayed on the card.

column_properties

Optional. Display properties for the columns in this table.

rows

Optional. Rows in this table of data.

buttons

Optional. List of buttons for the card.

buttons

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.buttons

column_properties

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.column_properties

image

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.image

rows

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.rows

subtitle

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.subtitle

title

Field google.cloud.dialogflow.v2.Intent.Message.TableCard.title

class TableCardCell

Cell of [TableCardRow][google.cloud.dialogflow.v2.Intent.Message.TableCardRow].

text

Required. Text in this cell.

text

Field google.cloud.dialogflow.v2.Intent.Message.TableCardCell.text

class TableCardRow

Row of [TableCard][google.cloud.dialogflow.v2.Intent.Message.TableCard].

cells

Optional. List of cells that make up this row.

divider_after

Optional. Whether to add a visual divider after this row.

cells

Field google.cloud.dialogflow.v2.Intent.Message.TableCardRow.cells

divider_after

Field google.cloud.dialogflow.v2.Intent.Message.TableCardRow.divider_after

class Text

The text response message.

text

Optional. The collection of the agent’s responses.

text

Field google.cloud.dialogflow.v2.Intent.Message.Text.text

basic_card

Field google.cloud.dialogflow.v2.Intent.Message.basic_card

browse_carousel_card

Field google.cloud.dialogflow.v2.Intent.Message.browse_carousel_card

card

Field google.cloud.dialogflow.v2.Intent.Message.card

carousel_select

Field google.cloud.dialogflow.v2.Intent.Message.carousel_select

image

Field google.cloud.dialogflow.v2.Intent.Message.image

link_out_suggestion

Field google.cloud.dialogflow.v2.Intent.Message.link_out_suggestion

list_select

Field google.cloud.dialogflow.v2.Intent.Message.list_select

media_content

Field google.cloud.dialogflow.v2.Intent.Message.media_content

payload

Field google.cloud.dialogflow.v2.Intent.Message.payload

platform

Field google.cloud.dialogflow.v2.Intent.Message.platform

quick_replies

Field google.cloud.dialogflow.v2.Intent.Message.quick_replies

simple_responses

Field google.cloud.dialogflow.v2.Intent.Message.simple_responses

suggestions

Field google.cloud.dialogflow.v2.Intent.Message.suggestions

table_card

Field google.cloud.dialogflow.v2.Intent.Message.table_card

text

Field google.cloud.dialogflow.v2.Intent.Message.text

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 a value for the parameter.

is_list

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

default_value

Field google.cloud.dialogflow.v2.Intent.Parameter.default_value

display_name

Field google.cloud.dialogflow.v2.Intent.Parameter.display_name

entity_type_display_name

Field google.cloud.dialogflow.v2.Intent.Parameter.entity_type_display_name

is_list

Field google.cloud.dialogflow.v2.Intent.Parameter.is_list

mandatory

Field google.cloud.dialogflow.v2.Intent.Parameter.mandatory

name

Field google.cloud.dialogflow.v2.Intent.Parameter.name

prompts

Field google.cloud.dialogflow.v2.Intent.Parameter.prompts

value

Field google.cloud.dialogflow.v2.Intent.Parameter.value

class TrainingPhrase

Represents an example that the agent is trained on.

name

Output only. The unique identifier of this training phrase.

type

Required. The type of the training phrase.

parts

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the [Part.text][google.cloud.dial ogflow.v2.Intent.TrainingPhrase.Part.text] field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

times_added_count

Optional. Indicates how many times this example 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 for this part.

entity_type

Optional. The entity type name prefixed with @. This field is required for annotated parts of the training phrase.

alias

Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.

user_defined

Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.

alias

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part.alias

entity_type

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part.entity_type

text

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part.text

user_defined

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part.user_defined

name

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.name

parts

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.parts

times_added_count

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.times_added_count

type

Field google.cloud.dialogflow.v2.Intent.TrainingPhrase.type

action

Field google.cloud.dialogflow.v2.Intent.action

default_response_platforms

Field google.cloud.dialogflow.v2.Intent.default_response_platforms

display_name

Field google.cloud.dialogflow.v2.Intent.display_name

events

Field google.cloud.dialogflow.v2.Intent.events

followup_intent_info

Field google.cloud.dialogflow.v2.Intent.followup_intent_info

input_context_names

Field google.cloud.dialogflow.v2.Intent.input_context_names

is_fallback

Field google.cloud.dialogflow.v2.Intent.is_fallback

messages

Field google.cloud.dialogflow.v2.Intent.messages

ml_disabled

Field google.cloud.dialogflow.v2.Intent.ml_disabled

name

Field google.cloud.dialogflow.v2.Intent.name

output_contexts

Field google.cloud.dialogflow.v2.Intent.output_contexts

parameters

Field google.cloud.dialogflow.v2.Intent.parameters

parent_followup_intent_name

Field google.cloud.dialogflow.v2.Intent.parent_followup_intent_name

priority

Field google.cloud.dialogflow.v2.Intent.priority

reset_contexts

Field google.cloud.dialogflow.v2.Intent.reset_contexts

root_followup_intent_name

Field google.cloud.dialogflow.v2.Intent.root_followup_intent_name

training_phrases

Field google.cloud.dialogflow.v2.Intent.training_phrases

webhook_state

Field google.cloud.dialogflow.v2.Intent.webhook_state

class dialogflow_v2.types.IntentBatch

This message is a wrapper around a collection of intents.

intents

A collection of intents.

intents

Field google.cloud.dialogflow.v2.IntentBatch.intents

class dialogflow_v2.types.LatLng
latitude

Field google.type.LatLng.latitude

longitude

Field google.type.LatLng.longitude

class dialogflow_v2.types.ListContextsRequest

The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2.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.

page_size

Field google.cloud.dialogflow.v2.ListContextsRequest.page_size

page_token

Field google.cloud.dialogflow.v2.ListContextsRequest.page_token

parent

Field google.cloud.dialogflow.v2.ListContextsRequest.parent

class dialogflow_v2.types.ListContextsResponse

The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2.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.

contexts

Field google.cloud.dialogflow.v2.ListContextsResponse.contexts

next_page_token

Field google.cloud.dialogflow.v2.ListContextsResponse.next_page_token

class dialogflow_v2.types.ListEntityTypesRequest

The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.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. Many 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.

language_code

Field google.cloud.dialogflow.v2.ListEntityTypesRequest.language_code

page_size

Field google.cloud.dialogflow.v2.ListEntityTypesRequest.page_size

page_token

Field google.cloud.dialogflow.v2.ListEntityTypesRequest.page_token

parent

Field google.cloud.dialogflow.v2.ListEntityTypesRequest.parent

class dialogflow_v2.types.ListEntityTypesResponse

The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.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.

entity_types

Field google.cloud.dialogflow.v2.ListEntityTypesResponse.entity_types

next_page_token

Field google.cloud.dialogflow.v2.ListEntityTypesResponse.next_page_token

class dialogflow_v2.types.ListIntentsRequest

The request message for [Intents.ListIntents][google.cloud.dialogflow.v2.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. Many 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.

intent_view

Field google.cloud.dialogflow.v2.ListIntentsRequest.intent_view

language_code

Field google.cloud.dialogflow.v2.ListIntentsRequest.language_code

page_size

Field google.cloud.dialogflow.v2.ListIntentsRequest.page_size

page_token

Field google.cloud.dialogflow.v2.ListIntentsRequest.page_token

parent

Field google.cloud.dialogflow.v2.ListIntentsRequest.parent

class dialogflow_v2.types.ListIntentsResponse

The response message for [Intents.ListIntents][google.cloud.dialogflow.v2.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.

intents

Field google.cloud.dialogflow.v2.ListIntentsResponse.intents

next_page_token

Field google.cloud.dialogflow.v2.ListIntentsResponse.next_page_token

class dialogflow_v2.types.ListOperationsRequest
filter

Field google.longrunning.ListOperationsRequest.filter

name

Field google.longrunning.ListOperationsRequest.name

page_size

Field google.longrunning.ListOperationsRequest.page_size

page_token

Field google.longrunning.ListOperationsRequest.page_token

class dialogflow_v2.types.ListOperationsResponse
next_page_token

Field google.longrunning.ListOperationsResponse.next_page_token

operations

Field google.longrunning.ListOperationsResponse.operations

class dialogflow_v2.types.ListSessionEntityTypesRequest

The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.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.

page_size

Field google.cloud.dialogflow.v2.ListSessionEntityTypesRequest.page_size

page_token

Field google.cloud.dialogflow.v2.ListSessionEntityTypesRequest.page_token

parent

Field google.cloud.dialogflow.v2.ListSessionEntityTypesRequest.parent

class dialogflow_v2.types.ListSessionEntityTypesResponse

The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.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.

next_page_token

Field google.cloud.dialogflow.v2.ListSessionEntityTypesResponse.next_page_token

session_entity_types

Field google.cloud.dialogflow.v2.ListSessionEntityTypesResponse.session_entity_types

class dialogflow_v2.types.ListValue
values

Field google.protobuf.ListValue.values

class dialogflow_v2.types.Operation
deserialize()

Creates new method instance from given serialized data.

done

Field google.longrunning.Operation.done

error

Field google.longrunning.Operation.error

metadata

Field google.longrunning.Operation.metadata

name

Field google.longrunning.Operation.name

response

Field google.longrunning.Operation.response

class dialogflow_v2.types.OperationInfo
metadata_type

Field google.longrunning.OperationInfo.metadata_type

response_type

Field google.longrunning.OperationInfo.response_type

class dialogflow_v2.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 the QueryParameters.payload field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: .. raw:: html <pre>{ “telephony”: { “caller_id”: “+18558363987” } }</pre> Note: The caller ID field (caller_id) will be redacted for Standard Edition agents and populated with the caller ID in E.164 format for Enterprise Edition agents.

payload

Field google.cloud.dialogflow.v2.OriginalDetectIntentRequest.payload

source

Field google.cloud.dialogflow.v2.OriginalDetectIntentRequest.source

version

Field google.cloud.dialogflow.v2.OriginalDetectIntentRequest.version

class dialogflow_v2.types.OutputAudioConfig

Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.

audio_encoding

Required. Audio encoding of the synthesized audio content.

sample_rate_hertz

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

Configuration of how speech should be synthesized.

audio_encoding

Field google.cloud.dialogflow.v2.OutputAudioConfig.audio_encoding

sample_rate_hertz

Field google.cloud.dialogflow.v2.OutputAudioConfig.sample_rate_hertz

synthesize_speech_config

Field google.cloud.dialogflow.v2.OutputAudioConfig.synthesize_speech_config

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

audio_config

Field google.cloud.dialogflow.v2.QueryInput.audio_config

event

Field google.cloud.dialogflow.v2.QueryInput.event

text

Field google.cloud.dialogflow.v2.QueryInput.text

class dialogflow_v2.types.QueryParameters

Represents the parameters of the conversational query.

time_zone

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

geo_location

The geo location of this conversational query.

contexts

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

reset_contexts

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

session_entity_types

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

payload

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

sentiment_analysis_request_config

Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

contexts

Field google.cloud.dialogflow.v2.QueryParameters.contexts

geo_location

Field google.cloud.dialogflow.v2.QueryParameters.geo_location

payload

Field google.cloud.dialogflow.v2.QueryParameters.payload

reset_contexts

Field google.cloud.dialogflow.v2.QueryParameters.reset_contexts

sentiment_analysis_request_config

Field google.cloud.dialogflow.v2.QueryParameters.sentiment_analysis_request_config

session_entity_types

Field google.cloud.dialogflow.v2.QueryParameters.session_entity_types

time_zone

Field google.cloud.dialogflow.v2.QueryParameters.time_zone

class dialogflow_v2.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 automatic spell correction is enabled, query_text will contain the corrected user input.

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. Note: This is a legacy field, fulfillment_messages should be preferred.

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, end_interaction and is_fallback.

intent_detection_confidence

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list.

diagnostic_info

Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors

sentiment_analysis_result

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

action

Field google.cloud.dialogflow.v2.QueryResult.action

all_required_params_present

Field google.cloud.dialogflow.v2.QueryResult.all_required_params_present

diagnostic_info

Field google.cloud.dialogflow.v2.QueryResult.diagnostic_info

fulfillment_messages

Field google.cloud.dialogflow.v2.QueryResult.fulfillment_messages

fulfillment_text

Field google.cloud.dialogflow.v2.QueryResult.fulfillment_text

intent

Field google.cloud.dialogflow.v2.QueryResult.intent

intent_detection_confidence

Field google.cloud.dialogflow.v2.QueryResult.intent_detection_confidence

language_code

Field google.cloud.dialogflow.v2.QueryResult.language_code

output_contexts

Field google.cloud.dialogflow.v2.QueryResult.output_contexts

parameters

Field google.cloud.dialogflow.v2.QueryResult.parameters

query_text

Field google.cloud.dialogflow.v2.QueryResult.query_text

sentiment_analysis_result

Field google.cloud.dialogflow.v2.QueryResult.sentiment_analysis_result

speech_recognition_confidence

Field google.cloud.dialogflow.v2.QueryResult.speech_recognition_confidence

webhook_payload

Field google.cloud.dialogflow.v2.QueryResult.webhook_payload

webhook_source

Field google.cloud.dialogflow.v2.QueryResult.webhook_source

class dialogflow_v2.types.RestoreAgentRequest

The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2.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

Zip compressed raw byte content for agent.

agent_content

Field google.cloud.dialogflow.v2.RestoreAgentRequest.agent_content

agent_uri

Field google.cloud.dialogflow.v2.RestoreAgentRequest.agent_uri

parent

Field google.cloud.dialogflow.v2.RestoreAgentRequest.parent

class dialogflow_v2.types.SearchAgentsRequest

The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2.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

The next_page_token value returned from a previous list request.

page_size

Field google.cloud.dialogflow.v2.SearchAgentsRequest.page_size

page_token

Field google.cloud.dialogflow.v2.SearchAgentsRequest.page_token

parent

Field google.cloud.dialogflow.v2.SearchAgentsRequest.parent

class dialogflow_v2.types.SearchAgentsResponse

The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2.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.

agents

Field google.cloud.dialogflow.v2.SearchAgentsResponse.agents

next_page_token

Field google.cloud.dialogflow.v2.SearchAgentsResponse.next_page_token

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

magnitude

Field google.cloud.dialogflow.v2.Sentiment.magnitude

score

Field google.cloud.dialogflow.v2.Sentiment.score

class dialogflow_v2.types.SentimentAnalysisRequestConfig

Configures the types of sentiment analysis to perform.

analyze_query_text_sentiment

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

analyze_query_text_sentiment

Field google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig.analyze_query_text_sentiment

class dialogflow_v2.types.SentimentAnalysisResult

The result of sentiment analysis as configured by sentiment_analysis_request_config.

query_text_sentiment

The sentiment analysis result for query_text.

query_text_sentiment

Field google.cloud.dialogflow.v2.SentimentAnalysisResult.query_text_sentiment

class dialogflow_v2.types.SessionEntityType

Represents a session entity type.

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

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

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 Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

entity_override_mode

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

entities

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

entities

Field google.cloud.dialogflow.v2.SessionEntityType.entities

entity_override_mode

Field google.cloud.dialogflow.v2.SessionEntityType.entity_override_mode

name

Field google.cloud.dialogflow.v2.SessionEntityType.name

class dialogflow_v2.types.SetAgentRequest

The request message for [Agents.SetAgent][google.cloud.dialogflow.v2.Agents.SetAgent].

agent

Required. The agent to update.

update_mask

Optional. The mask to control which fields get updated.

agent

Field google.cloud.dialogflow.v2.SetAgentRequest.agent

update_mask

Field google.cloud.dialogflow.v2.SetAgentRequest.update_mask

class dialogflow_v2.types.SpeechContext

Hints for the speech recognizer to help with recognition in a specific conversation state.

phrases

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to: * improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent * add additional words to the speech recognizer vocabulary * … See the Cloud Speech documentation for usage limits.

boost

Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

boost

Field google.cloud.dialogflow.v2.SpeechContext.boost

phrases

Field google.cloud.dialogflow.v2.SpeechContext.phrases

class dialogflow_v2.types.SpeechWordInfo

Information for a word recognized by the speech recognizer.

word

The word this info is for.

start_offset

Time offset relative to the beginning of the audio that corresponds to the start of the spoken word. This is an experimental feature and the accuracy of the time offset can vary.

end_offset

Time offset relative to the beginning of the audio that corresponds to the end of the spoken word. This is an experimental feature and the accuracy of the time offset can vary.

confidence

The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be fully stable over time for the same audio input. Users should also not rely on it to always be provided.

confidence

Field google.cloud.dialogflow.v2.SpeechWordInfo.confidence

end_offset

Field google.cloud.dialogflow.v2.SpeechWordInfo.end_offset

start_offset

Field google.cloud.dialogflow.v2.SpeechWordInfo.start_offset

word

Field google.cloud.dialogflow.v2.SpeechWordInfo.word

class dialogflow_v2.types.Status
code

Field google.rpc.Status.code

details

Field google.rpc.Status.details

message

Field google.rpc.Status.message

class dialogflow_v2.types.StreamingDetectIntentRequest

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent] method.

Multiple request messages should be sent in order:

  1. The first message must contain [session][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config]. The message must not contain [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio].

  2. If [query_input][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input] was set to [query_input.audio_config][google.cloud.dialogflow.v2.InputAudioConfig], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio] to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.v2.QueryInput.text].

    However, note that:

    • Dialogflow will bill you for the audio duration so far.

    • Dialogflow discards all Speech recognition results in favor of the input text.

    • Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the request stream.

session

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

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

Please use [InputAudioConfig.single_utterance][google.cloud.d ialogflow.v2.InputAudioConfig.single_utterance] instead. 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

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.

output_audio_config_mask

Mask for [output_audio_config][google.cloud.dialogflow.v2.St reamingDetectIntentRequest.output_audio_config] indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, [output_audio_config][google.cloud.dia logflow.v2.StreamingDetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.

input_audio

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.

input_audio

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.input_audio

output_audio_config

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config

output_audio_config_mask

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.output_audio_config_mask

query_input

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_input

query_params

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.query_params

session

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.session

single_utterance

Field google.cloud.dialogflow.v2.StreamingDetectIntentRequest.single_utterance

class dialogflow_v2.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 and optionally webhook_status if a WebHook was called.

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 result of the conversational query or event processing.

webhook_status

Specifies the status of the webhook request.

output_audio

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.fulfillment_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.

output_audio_config

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

output_audio

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.output_audio

output_audio_config

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.output_audio_config

query_result

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.query_result

recognition_result

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.recognition_result

response_id

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.response_id

webhook_status

Field google.cloud.dialogflow.v2.StreamingDetectIntentResponse.webhook_status

class dialogflow_v2.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. message_type: END_OF_SINGLE_UTTERANCE

  8. transcript: ” that is the question” is_final: true

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

In each response we populate:

  • for TRANSCRIPT: transcript and possibly is_final.

  • for END_OF_SINGLE_UTTERANCE: only message_type.

message_type

Type of the result message.

transcript

Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT.

is_final

If false, the StreamingRecognitionResult represents an interim result that may change. If true, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for message_type = TRANSCRIPT.

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.

speech_word_info

Word-specific information for the words recognized by Speech in [transcript][google.cloud.dialogflow.v2.StreamingRecognitio nResult.transcript]. Populated if and only if message_type = TRANSCRIPT and [InputAudioConfig.enable_word_info] is set.

speech_end_offset

Time offset of the end of this Speech recognition result relative to the beginning of the audio. Only populated for message_type = TRANSCRIPT.

confidence

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.confidence

is_final

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.is_final

message_type

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.message_type

speech_end_offset

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.speech_end_offset

speech_word_info

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.speech_word_info

transcript

Field google.cloud.dialogflow.v2.StreamingRecognitionResult.transcript

class dialogflow_v2.types.Struct
class FieldsEntry
key

Field google.protobuf.Struct.FieldsEntry.key

value

Field google.protobuf.Struct.FieldsEntry.value

fields

Field google.protobuf.Struct.fields

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

effects_profile_id

Field google.cloud.dialogflow.v2.SynthesizeSpeechConfig.effects_profile_id

pitch

Field google.cloud.dialogflow.v2.SynthesizeSpeechConfig.pitch

speaking_rate

Field google.cloud.dialogflow.v2.SynthesizeSpeechConfig.speaking_rate

voice

Field google.cloud.dialogflow.v2.SynthesizeSpeechConfig.voice

volume_gain_db

Field google.cloud.dialogflow.v2.SynthesizeSpeechConfig.volume_gain_db

class dialogflow_v2.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 characters.

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.

language_code

Field google.cloud.dialogflow.v2.TextInput.language_code

text

Field google.cloud.dialogflow.v2.TextInput.text

class dialogflow_v2.types.TrainAgentRequest

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

parent

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

parent

Field google.cloud.dialogflow.v2.TrainAgentRequest.parent

class dialogflow_v2.types.UpdateContextRequest

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

context

Required. The context to update.

update_mask

Optional. The mask to control which fields get updated.

context

Field google.cloud.dialogflow.v2.UpdateContextRequest.context

update_mask

Field google.cloud.dialogflow.v2.UpdateContextRequest.update_mask

class dialogflow_v2.types.UpdateEntityTypeRequest

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

entity_type

Required. The entity type to update.

language_code

Optional. The language of entity synonyms defined in entity_type. 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.

update_mask

Optional. The mask to control which fields get updated.

entity_type

Field google.cloud.dialogflow.v2.UpdateEntityTypeRequest.entity_type

language_code

Field google.cloud.dialogflow.v2.UpdateEntityTypeRequest.language_code

update_mask

Field google.cloud.dialogflow.v2.UpdateEntityTypeRequest.update_mask

class dialogflow_v2.types.UpdateIntentRequest

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

intent

Required. The intent to update.

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

intent

Field google.cloud.dialogflow.v2.UpdateIntentRequest.intent

intent_view

Field google.cloud.dialogflow.v2.UpdateIntentRequest.intent_view

language_code

Field google.cloud.dialogflow.v2.UpdateIntentRequest.language_code

update_mask

Field google.cloud.dialogflow.v2.UpdateIntentRequest.update_mask

class dialogflow_v2.types.UpdateSessionEntityTypeRequest

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

session_entity_type

Required. The session entity type to update.

update_mask

Optional. The mask to control which fields get updated.

session_entity_type

Field google.cloud.dialogflow.v2.UpdateSessionEntityTypeRequest.session_entity_type

update_mask

Field google.cloud.dialogflow.v2.UpdateSessionEntityTypeRequest.update_mask

class dialogflow_v2.types.ValidationError

Represents a single validation error.

severity

The severity of the error.

entries

The names of the entries that the error is associated with. Format: - “projects//agent”, if the error is associated with the entire agent. - “projects//agent/intents/”, if the error is associated with certain intents. - “projects//agent/intents//trainingPhrases/”, if the error is associated with certain intent training phrases. - “projects//agent/intents//parameters/”, if the error is associated with certain intent parameters. - “projects//agent/entities/”, if the error is associated with certain entities.

error_message

The detailed error messsage.

entries

Field google.cloud.dialogflow.v2.ValidationError.entries

error_message

Field google.cloud.dialogflow.v2.ValidationError.error_message

severity

Field google.cloud.dialogflow.v2.ValidationError.severity

class dialogflow_v2.types.ValidationResult

Represents the output of agent validation.

validation_errors

Contains all validation errors.

validation_errors

Field google.cloud.dialogflow.v2.ValidationResult.validation_errors

class dialogflow_v2.types.Value
bool_value

Field google.protobuf.Value.bool_value

list_value

Field google.protobuf.Value.list_value

null_value

Field google.protobuf.Value.null_value

number_value

Field google.protobuf.Value.number_value

string_value

Field google.protobuf.Value.string_value

struct_value

Field google.protobuf.Value.struct_value

class dialogflow_v2.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 [ssml_gender][google.cloud.dialogflow.v2.V oiceSelectionParams.ssml_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][google.cloud.dialogflow.v2.VoiceSelectionParams.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.

name

Field google.cloud.dialogflow.v2.VoiceSelectionParams.name

ssml_gender

Field google.cloud.dialogflow.v2.VoiceSelectionParams.ssml_gender

class dialogflow_v2.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>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/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.

original_detect_intent_request

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

original_detect_intent_request

Field google.cloud.dialogflow.v2.WebhookRequest.original_detect_intent_request

query_result

Field google.cloud.dialogflow.v2.WebhookRequest.query_result

response_id

Field google.cloud.dialogflow.v2.WebhookRequest.response_id

session

Field google.cloud.dialogflow.v2.WebhookRequest.session

class dialogflow_v2.types.WebhookResponse

The response message for a webhook call.

This response is validated by the Dialogflow server. If validation fails, an error will be returned in the [QueryResult.diagnostic_info][google.cloud.dialogflow.v2.QueryResult.diagnostic_info] field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:

  • Use "" for empty strings

  • Use {} or null for empty objects

  • Use [] or null for empty arrays

For more information, see the Protocol Buffers Language Guide.

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. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

session_entity_types

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. Setting the session entity types inside webhook overwrites the session entity types that have been set through DetectIntentRequest.query_params.session_entity_types.

followup_event_input

Field google.cloud.dialogflow.v2.WebhookResponse.followup_event_input

fulfillment_messages

Field google.cloud.dialogflow.v2.WebhookResponse.fulfillment_messages

fulfillment_text

Field google.cloud.dialogflow.v2.WebhookResponse.fulfillment_text

output_contexts

Field google.cloud.dialogflow.v2.WebhookResponse.output_contexts

payload

Field google.cloud.dialogflow.v2.WebhookResponse.payload

session_entity_types

Field google.cloud.dialogflow.v2.WebhookResponse.session_entity_types

source

Field google.cloud.dialogflow.v2.WebhookResponse.source