package google.cloud.dialogflow.v2beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Agents
agent.proto:60Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add [Intents][google.cloud.dialogflow.v2beta1.Intents], [Contexts][google.cloud.dialogflow.v2beta1.Contexts], [Entity Types][google.cloud.dialogflow.v2beta1.EntityTypes], [Webhooks][google.cloud.dialogflow.v2beta1.WebhookRequest], and so on to manage the flow of a conversation and match user input to predefined intents and actions. You can create an agent using both Dialogflow Standard Edition and Dialogflow Enterprise Edition. For details, see [Dialogflow Editions](https://cloud.google.com/dialogflow-enterprise/docs/editions). You can save your agent for backup or versioning by exporting the agent by using the [ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent] method. You can import a saved agent by using the [ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent] method. Dialogflow provides several [prebuilt agents](https://dialogflow.com/docs/prebuilt-agents) for common conversation scenarios such as determining a date and time, converting currency, and so on. For more information about agents, see the [Dialogflow documentation](https://dialogflow.com/docs/agents).
rpc ExportAgent (, )
agent.proto:98Exports the specified agent to a ZIP file. Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
agent.proto:240The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
string parent = 1
Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.
string agent_uri = 2
Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) 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.
rpc GetAgent (, )
agent.proto:62Retrieves the specified agent.
message
agent.proto:201The request message for [Agents.GetAgent][google.cloud.dialogflow.v2beta1.Agents.GetAgent].
string parent = 1
Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.
rpc ImportAgent (, )
agent.proto:114Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
agent.proto:280The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2beta1.Agents.ImportAgent].
string parent = 1
Required. The project that the agent to import is associated with. Format: `projects/<Project ID>`.
oneof agent
Required. The agent to import.
string agent_uri = 2
The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".
bytes agent_content = 3
The agent to import. Example for how to import an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat <agent zip file> | base64 -w 0)' }"</pre>
rpc RestoreAgent (, )
agent.proto:129Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
agent.proto:310The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2beta1.Agents.RestoreAgent].
string parent = 1
Required. The project that the agent to restore is associated with. Format: `projects/<Project ID>`.
oneof agent
Required. The agent to restore.
string agent_uri = 2
The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".
bytes agent_content = 3
The agent to restore. Example for how to restore an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat <agent zip file> | base64 -w 0)' }"</pre>
rpc SearchAgents (, )
agent.proto:75Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
message
agent.proto:208The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
string parent = 1
Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
int32 page_size = 2
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
string page_token = 3
Optional. The next_page_token value returned from a previous list request.
message
agent.proto:222The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2beta1.Agents.SearchAgents].
repeated agents = 1
The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
rpc TrainAgent (, )
agent.proto:86Trains the specified agent. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
agent.proto:233The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent].
string parent = 1
Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.
service Contexts
context.proto:50A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on. You can include contexts as input parameters of a [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) request, or as output contexts included in the returned intent. Contexts expire when an intent is matched, after the number of `DetectIntent` requests specified by the `lifespan_count` parameter, or after 10 minutes if no intents are matched for a `DetectIntent` request. For more information about contexts, see the [Dialogflow documentation](https://dialogflow.com/docs/contexts).
rpc CreateContext (, )
context.proto:72Creates a context.
message
context.proto:180The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2beta1.Contexts.CreateContext].
string parent = 1
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.
optional context = 2
Required. The context to create.
rpc DeleteAllContexts (, )
context.proto:106Deletes all active contexts in the specified session.
message
context.proto:214The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2beta1.Contexts.DeleteAllContexts].
string parent = 1
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.
rpc DeleteContext (, )
context.proto:96Deletes the specified context.
message
context.proto:203The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2beta1.Contexts.DeleteContext].
string name = 1
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.
rpc GetContext (, )
context.proto:62Retrieves the specified context.
message
context.proto:169The request message for [Contexts.GetContext][google.cloud.dialogflow.v2beta1.Contexts.GetContext].
string name = 1
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.
rpc ListContexts (, )
context.proto:52Returns the list of all contexts in the specified session.
message
context.proto:140The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
string parent = 1
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.
int32 page_size = 2
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
string page_token = 3
Optional. The next_page_token value returned from a previous list request.
message
context.proto:158The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2beta1.Contexts.ListContexts].
repeated contexts = 1
The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
rpc UpdateContext (, )
context.proto:84Updates the specified context.
message
context.proto:194The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2beta1.Contexts.UpdateContext].
optional context = 1
Required. The context to update.
optional update_mask = 2
Optional. The mask to control which fields get updated.
service Documents
document.proto:34Manages documents of a knowledge base.
rpc CreateDocument (, )
document.proto:59Creates a new document. Operation <response: [Document][google.cloud.dialogflow.v2beta1.Document], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
message
document.proto:173Request message for [Documents.CreateDocument][google.cloud.dialogflow.v2beta1.Documents.CreateDocument].
string parent = 1
Required. The knoweldge base to create a document for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
optional document = 2
Required. The document to create.
rpc DeleteDocument (, )
document.proto:74Deletes the specified document. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]>
message
document.proto:183Request message for [Documents.DeleteDocument][google.cloud.dialogflow.v2beta1.Documents.DeleteDocument].
string name = 1
The name of the document to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
rpc GetDocument (, )
document.proto:46Retrieves the specified document.
message
document.proto:165Request message for [Documents.GetDocument][google.cloud.dialogflow.v2beta1.Documents.GetDocument].
string name = 1
Required. The name of the document to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
rpc ListDocuments (, )
document.proto:36Returns the list of all documents of the knowledge base.
message
document.proto:141Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].
string parent = 1
Required. The knowledge base to list all documents for. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
int32 page_size = 2
Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
string page_token = 3
Optional. The next_page_token value returned from a previous list request.
message
document.proto:155Response message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].
repeated documents = 1
The list of documents.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
service EntityTypes
entity_type.proto:61Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on. There are three types of entities: * **System** - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the `EntityType` type. * **Developer** - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a `pizza.sauce` entity for red or white pizza sauce, a `pizza.cheese` entity for the different types of cheese on a pizza, a `pizza.topping` entity for different toppings, and so on. A developer entity is represented by the `EntityType` type. * **User** - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityType] type. For more information about entity types, see the [Dialogflow documentation](https://dialogflow.com/docs/entities).
Creates multiple new entities in the specified entity type (extends the existing collection of entries). Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
message
entity_type.proto:360The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities].
string parent = 1
Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
repeated entities = 2
Required. The collection of entities to create.
string language_code = 3
Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
Deletes entities in the specified entity type. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
entity_type.proto:397The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntities].
string parent = 1
Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
repeated string entity_values = 2
Required. The canonical `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`.
string language_code = 3
Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
Deletes entity types in the specified agent. Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
entity_type.proto:349The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchDeleteEntityTypes].
string parent = 1
Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
repeated string entity_type_names = 2
Required. The names entity types to delete. All names must point to the same agent as `parent`.
Updates entities in the specified entity type (replaces the existing collection of entries). Operation <response: [google.protobuf.Empty][google.protobuf.Empty], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
entity_type.proto:377The response message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2beta1.EntityTypes.BatchCreateEntities].
string parent = 1
Required. The name of the entity type to update the entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
repeated entities = 2
Required. The collection of new entities to replace the existing entities.
string language_code = 3
Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
optional update_mask = 4
Optional. The mask to control which fields get updated.
Updates/Creates multiple entity types in the specified agent. Operation <response: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse], metadata: [google.protobuf.Struct][google.protobuf.Struct]>
message
entity_type.proto:310The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes].
string parent = 1
Required. The name of the agent to update or create entity types in. Format: `projects/<Project ID>/agent`.
oneof entity_type_batch
Required. The source of the entity type batch. For each entity type in the batch: * If `name` is specified, we update an existing entity type. * If `name` is not specified, we create a new entity type.
string entity_type_batch_uri = 2
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 = 3
The collection of entity type to update or create.
string language_code = 4
Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
optional update_mask = 5
Optional. The mask to control which fields get updated.
rpc CreateEntityType (, )
entity_type.proto:77Creates an entity type in the specified agent.
message
entity_type.proto:269The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.CreateEntityType].
string parent = 1
Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.
optional entity_type = 2
Required. The entity type to create.
string language_code = 3
Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
rpc DeleteEntityType (, )
entity_type.proto:93Deletes the specified entity type.
message
entity_type.proto:303The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.DeleteEntityType].
string name = 1
Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
rpc GetEntityType (, )
entity_type.proto:70Retrieves the specified entity type.
message
entity_type.proto:255The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType].
string name = 1
Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
string language_code = 2
Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
rpc ListEntityTypes (, )
entity_type.proto:63Returns the list of all entity types in the specified agent.
message
entity_type.proto:223The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes].
string parent = 1
Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.
string language_code = 2
Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
int32 page_size = 3
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
string page_token = 4
Optional. The next_page_token value returned from a previous list request.
message
entity_type.proto:244The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.ListEntityTypes].
repeated entity_types = 1
The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
rpc UpdateEntityType (, )
entity_type.proto:85Updates the specified entity type.
message
entity_type.proto:286The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2beta1.EntityTypes.UpdateEntityType].
optional entity_type = 1
Required. The entity type to update. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
string language_code = 2
Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
optional update_mask = 3
Optional. The mask to control which fields get updated.
service Intents
intent.proto:66An intent represents a mapping between input from a user and an action to be taken by your application. When you pass user input to the [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) method, the Dialogflow API analyzes the input and searches for a matching intent. If no match is found, the Dialogflow API returns a fallback intent (`is_fallback` = true). You can provide additional information for the Dialogflow API to use to match user input to an intent by adding the following to your intent. * **Contexts** - provide additional context for intent analysis. For example, if an intent is related to an object in your application that plays music, you can provide a context to determine when to match the intent if the user input is “turn it off”. You can include a context that matches the intent when there is previous user input of "play music", and not when there is previous user input of "turn on the light". * **Events** - allow for matching an intent by using an event name instead of user input. Your application can provide an event name and related parameters to the Dialogflow API to match an intent. For example, when your application starts, you can send a welcome event with a user name parameter to the Dialogflow API to match an intent with a personalized welcome message for the user. * **Training phrases** - provide examples of user input to train the Dialogflow API agent to better match intents. For more information about intents, see the [Dialogflow documentation](https://dialogflow.com/docs/intents).
rpc BatchDeleteIntents (, )
intent.proto:117Deletes intents in the specified agent. Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
message
intent.proto:862The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2beta1.Intents.BatchDeleteIntents].
string parent = 1
Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.
repeated intents = 2
Required. The collection of intents to delete. Only intent `name` must be filled in.
rpc BatchUpdateIntents (, )
intent.proto:107Updates/Creates multiple intents in the specified agent. Operation <response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]>
message
intent.proto:825The request message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents].
string parent = 1
Required. The name of the agent to update or create intents in. Format: `projects/<Project ID>/agent`.
oneof intent_batch
Required. The source of the intent batch.
string intent_batch_uri = 2
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 = 3
The collection of intents to update or create.
string language_code = 4
Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
optional update_mask = 5
Optional. The mask to control which fields get updated.
IntentView intent_view = 6
Optional. The resource view to apply to the returned intent.
rpc CreateIntent (, )
intent.proto:82Creates an intent in the specified agent.
message
intent.proto:778The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2beta1.Intents.CreateIntent].
string parent = 1
Required. The agent to create a intent for. Format: `projects/<Project ID>/agent`.
optional intent = 2
Required. The intent to create.
string language_code = 3
Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
IntentView intent_view = 4
Optional. The resource view to apply to the returned intent.
rpc DeleteIntent (, )
intent.proto:98Deletes the specified intent.
message
intent.proto:818The request message for [Intents.DeleteIntent][google.cloud.dialogflow.v2beta1.Intents.DeleteIntent].
string name = 1
Required. The name of the intent to delete. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
rpc GetIntent (, )
intent.proto:75Retrieves the specified intent.
message
intent.proto:761The request message for [Intents.GetIntent][google.cloud.dialogflow.v2beta1.Intents.GetIntent].
string name = 1
Required. The name of the intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string language_code = 2
Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
IntentView intent_view = 3
Optional. The resource view to apply to the returned intent.
rpc ListIntents (, )
intent.proto:68Returns the list of all intents in the specified agent.
message
intent.proto:726The request message for [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents].
string parent = 1
Required. The agent to list all intents from. Format: `projects/<Project ID>/agent`.
string language_code = 2
Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
IntentView intent_view = 3
Optional. The resource view to apply to the returned intent.
int32 page_size = 4
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
string page_token = 5
Optional. The next_page_token value returned from a previous list request.
message
intent.proto:750The response message for [Intents.ListIntents][google.cloud.dialogflow.v2beta1.Intents.ListIntents].
repeated intents = 1
The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
rpc UpdateIntent (, )
intent.proto:90Updates the specified intent.
message
intent.proto:798The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2beta1.Intents.UpdateIntent].
optional intent = 1
Required. The intent to update. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string language_code = 2
Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used.
optional update_mask = 3
Optional. The mask to control which fields get updated.
IntentView intent_view = 4
Optional. The resource view to apply to the returned intent.
Manages knowledge bases. Allows users to setup and maintain knowledge bases with their knowledge data.
Creates a knowledge base.
message
knowledge_base.proto:123Request message for [KnowledgeBases.CreateKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.CreateKnowledgeBase].
string parent = 1
Required. The agent to create a knowledge base for. Format: `projects/<Project ID>/agent`.
optional knowledge_base = 2
Required. The knowledge base to create.
Deletes the specified knowledge base.
message
knowledge_base.proto:133Request message for [KnowledgeBases.DeleteKnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBases.DeleteKnowledgeBase].
string name = 1
Required. The name of the knowledge base to delete. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
bool force = 2
Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.
Retrieves the specified knowledge base.
message
knowledge_base.proto:116Request message for [KnowledgeBase.GetDocument][].
string name = 1
Required. The name of the knowledge base to retrieve. Format `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
Returns the list of all knowledge bases of the specified agent.
message
knowledge_base.proto:92Request message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases].
string parent = 1
Required. The agent to list of knowledge bases for. Format: `projects/<Project ID>/agent`.
int32 page_size = 2
Optional. The maximum number of items to return in a single page. By default 10 and at most 100.
string page_token = 3
Optional. The next_page_token value returned from a previous list request.
message
knowledge_base.proto:106Response message for [KnowledgeBases.ListKnowledgeBases][google.cloud.dialogflow.v2beta1.KnowledgeBases.ListKnowledgeBases].
repeated knowledge_bases = 1
The list of knowledge bases.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level. For more information about entity types, see the [Dialogflow documentation](https://dialogflow.com/docs/entities).
Creates a session entity type.
message
session_entity_type.proto:186The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.CreateSessionEntityType].
string parent = 1
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.
optional session_entity_type = 2
Required. The session entity type to create.
Deletes the specified session entity type.
message
session_entity_type.proto:214The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.DeleteSessionEntityType].
string name = 1
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.
Retrieves the specified session entity type.
message
session_entity_type.proto:175The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.GetSessionEntityType].
string name = 1
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.
Returns the list of all session entity types in the specified session.
message
session_entity_type.proto:146The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].
string parent = 1
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.
int32 page_size = 2
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
string page_token = 3
Optional. The next_page_token value returned from a previous list request.
message
session_entity_type.proto:164The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2beta1.SessionEntityTypes.ListSessionEntityTypes].
repeated session_entity_types = 1
The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Updates the specified session entity type.
message
session_entity_type.proto:200The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2beta1.SessionEntityTypes.UpdateSessionEntityType].
optional session_entity_type = 1
Required. The entity type to update. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
optional update_mask = 2
Optional. The mask to control which fields get updated.
service Sessions
session.proto:41A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.v2beta1.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2beta1.Sessions.StreamingDetectIntent]) method to determine user intent and respond.
rpc DetectIntent (, )
session.proto:46Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
message
session.proto:65The request to detect user's intent.
string session = 1
Required. The name of the session this query is sent to. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
optional query_params = 2
Optional. The parameters of this query.
optional query_input = 3
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.
optional output_audio_config = 4
Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
bytes input_audio = 5
Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data.
message
session.proto:102The message returned from the DetectIntent method.
string response_id = 1
The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
optional query_result = 2
The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results.
repeated alternative_query_results = 5
If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing `QueryResult.intent_detection_confidence`. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.
optional webhook_status = 3
Specifies the status of the webhook request. `webhook_status` is never populated in webhook requests.
bytes output_audio = 4
The audio data bytes encoded as specified in the request.
optional output_audio_config = 6
Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled.
rpc StreamingDetectIntent (stream , stream )
session.proto:60Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
message
session.proto:353The top-level message sent by the client to the `StreamingDetectIntent` method. Multiple request messages should be sent in order: 1. The first message must contain `session`, `query_input` plus optionally `query_params` and/or `single_utterance`. If the client wants to receive an audio response, it should also contain `output_audio_config`. The message must not contain `input_audio`. 2. If `query_input` was set to a streaming input audio config, all subsequent messages must contain only `input_audio`. Otherwise, finish the request stream.
string session = 1
Required. The name of the session the query is sent to. Format of the session name: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters.
optional query_params = 2
Optional. The parameters of this query.
optional query_input = 3
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.
bool single_utterance = 4
Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. This setting is ignored when `query_input` is a piece of text or an event.
optional output_audio_config = 5
Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
bytes input_audio = 6
Optional. The input audio content to be recognized. Must be sent if `query_input` was set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute.
message
session.proto:417The top-level message returned from the `StreamingDetectIntent` method. Multiple response messages can be returned in order: 1. If the input was set to streaming audio, the first one or more messages contain `recognition_result`. Each `recognition_result` represents a more complete transcript of what the user said. The last `recognition_result` has `is_final` set to `true`. 2. The next message contains `response_id`, `query_result`, `alternative_query_results` and optionally `webhook_status` if a WebHook was called. 3. If `output_audio_config` was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain `output_audio` and `output_audio_config`.
string response_id = 1
The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
optional recognition_result = 2
The result of speech recognition.
optional query_result = 3
The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results.
repeated alternative_query_results = 7
If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing `QueryResult.intent_detection_confidence`. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.
optional webhook_status = 4
Specifies the status of the webhook request.
bytes output_audio = 5
The audio data bytes encoded as specified in the request.
optional output_audio_config = 6
Instructs the speech synthesizer how to generate the output audio. This field is populated from the agent-level speech synthesizer configuration, if enabled.
message
agent.proto:138Represents a conversational agent.
Used as response type in: Agents.GetAgent
Used as field type in:
string parent = 1
Required. The project of this agent. Format: `projects/<Project ID>`.
string display_name = 2
Required. The name of this agent.
string default_language_code = 3
Required. The default language of the agent as a language tag. See [Language Support](https://dialogflow.com/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
repeated string supported_language_codes = 4
Optional. The list of all languages supported by this agent (except for the `default_language_code`).
string time_zone = 5
Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
string description = 6
Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
string avatar_uri = 7
Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.
bool enable_logging = 8
Optional. Determines whether this agent should log conversation queries.
Agent.MatchMode match_mode = 9
Optional. Determines how intents are detected from user queries.
float classification_threshold = 10
Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent is be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
Match mode determines how intents are detected from user queries.
Used in:
MATCH_MODE_UNSPECIFIED = 0
Not specified.
MATCH_MODE_HYBRID = 1
Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
MATCH_MODE_ML_ONLY = 2
Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large developer entities.
Audio encoding of the audio content sent in the conversational query request. Refer to the [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
Used in:
AUDIO_ENCODING_UNSPECIFIED = 0
Not specified.
AUDIO_ENCODING_LINEAR_16 = 1
Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC = 2
[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.
AUDIO_ENCODING_MULAW = 3
8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR = 4
Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.
AUDIO_ENCODING_AMR_WB = 5
Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.
AUDIO_ENCODING_OGG_OPUS = 6
Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE = 7
Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.
message
entity_type.proto:343The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2beta1.EntityTypes.BatchUpdateEntityTypes].
repeated entity_types = 1
The collection of updated or created entity types.
message
intent.proto:856The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2beta1.Intents.BatchUpdateIntents].
repeated intents = 1
The collection of updated or created intents.
message
context.proto:117Represents a context.
Used as response type in: Contexts.CreateContext, Contexts.GetContext, Contexts.UpdateContext
Used as field type in: , , , , , ,
string name = 1
Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
int32 lifespan_count = 2
Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries.
optional parameters = 3
Optional. The collection of parameters associated with this context. Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for syntax.
message
document.proto:85A document resource.
Used as response type in: Documents.GetDocument
Used as field type in: ,
string name = 1
The document resource name. The name must be empty when creating a document. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
string display_name = 2
Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
string mime_type = 3
Required. The MIME type of this document.
repeated Document.KnowledgeType knowledge_types = 4
Required. The knowledge type of document content.
oneof source
Required. The source of this document.
string content_uri = 5
The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs://<bucket-name>/<object-name>`. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the `gs://` format URI described above.
string content = 6
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
The knowledge type of document content.
Used in:
KNOWLEDGE_TYPE_UNSPECIFIED = 0
The type is unspecified or arbitrary.
FAQ = 1
The document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.
EXTRACTIVE_QA = 2
Documents for which unstructured text is extracted and used for question answering.
message
entity_type.proto:159Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.
Used as response type in: EntityTypes.CreateEntityType, EntityTypes.GetEntityType, EntityTypes.UpdateEntityType
Used as field type in: , , , ,
string name = 1
Required for all methods except `create` (`create` populates the name automatically. The unique identifier of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
string display_name = 2
Required. The name of the entity.
EntityType.Kind kind = 3
Required. Indicates the kind of entity type.
EntityType.AutoExpansionMode auto_expansion_mode = 4
Optional. Indicates whether the entity type can be automatically expanded.
repeated entities = 6
Optional. The collection of entities associated with the entity type.
Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).
Used in:
AUTO_EXPANSION_MODE_UNSPECIFIED = 0
Auto expansion disabled for the entity.
AUTO_EXPANSION_MODE_DEFAULT = 1
Allows an agent to recognize values that have not been explicitly listed in the entity.
message
entity_type.proto:161Optional. Represents an entity.
Used in: , , ,
string value = 1
Required. For `KIND_MAP` entity types: A canonical name to be used in place of synonyms. For `KIND_LIST` entity types: A string that can contain references to other entity types (with or without aliases).
repeated string synonyms = 2
Required. A collection of synonyms. For `KIND_LIST` entity types this must contain exactly one synonym equal to `value`.
Represents kinds of entities.
Used in:
KIND_UNSPECIFIED = 0
Not specified. This value should be never used.
KIND_MAP = 1
Map entity types allow mapping of a group of synonyms to a canonical value.
KIND_LIST = 2
List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
message
entity_type.proto:416This message is a wrapper around a collection of entity types.
Used in:
repeated entity_types = 1
A collection of entity types.
message
session.proto:586Events 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?”`.
Used in: ,
string name = 1
Required. The unique identifier of the event.
optional parameters = 2
Optional. The collection of parameters associated with the event.
string language_code = 3
Required. The language of this query. See [Language Support](https://dialogflow.com/docs/languages) 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.
message
agent.proto:254The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2beta1.Agents.ExportAgent].
oneof agent
Required. The exported agent.
string agent_uri = 1
The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.
bytes agent_content = 2
The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".*/\1/' \ | base64 --decode > <agent zip file></pre>
message
session.proto:528Instructs the speech recognizer how to process the audio content.
Used in:
AudioEncoding audio_encoding = 1
Required. Audio encoding of the audio content to process.
int32 sample_rate_hertz = 2
Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.
string language_code = 3
Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://dialogflow.com/docs/languages) 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.
repeated string phrase_hints = 4
Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.
string model = 7
Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.
message
intent.proto:128Represents 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.
Used as response type in: Intents.CreateIntent, Intents.GetIntent, Intents.UpdateIntent
Used as field type in: , , , , , ,
string name = 1
Required for all methods except `create` (`create` populates the name automatically. The unique identifier of this intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string display_name = 2
Required. The name of this intent.
Intent.WebhookState webhook_state = 6
Required. Indicates whether webhooks are enabled for the intent.
int32 priority = 3
Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled.
bool is_fallback = 4
Optional. Indicates whether this is a fallback intent.
bool ml_enabled = 5
Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.
bool ml_disabled = 19
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.
bool end_interaction = 21
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
repeated string input_context_names = 7
Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`.
repeated string events = 8
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.
repeated training_phrases = 9
Optional. The collection of examples/templates that the agent is trained on.
string action = 10
Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.
repeated output_contexts = 11
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>`.
bool reset_contexts = 12
Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
repeated parameters = 13
Optional. The collection of parameters associated with the intent.
repeated messages = 14
Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.
repeated Intent.Message.Platform default_response_platforms = 15
Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.
string root_followup_intent_name = 16
The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string parent_followup_intent_name = 17
The unique identifier of the parent intent in the chain of followup intents. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
repeated followup_intent_info = 18
Optional. Collection of information about all followup intents that have name of this intent as a root_name.
message
intent.proto:603Represents a single followup intent in the chain.
Used in:
string followup_intent_name = 1
The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
string parent_followup_intent_name = 2
The unique identifier of the followup intent parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
message
intent.proto:224Corresponds to the `Response` field in the Dialogflow console.
Used in: , ,
oneof message
Required. The rich response message.
text = 1
Returns a text response.
image = 2
Displays an image.
quick_replies = 3
Displays quick replies.
card = 4
Displays a card.
payload = 5
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 = 7
Returns a voice or text-only response for Actions on Google.
basic_card = 8
Displays a basic card for Actions on Google.
suggestions = 9
Displays suggestion chips for Actions on Google.
link_out_suggestion = 10
Displays a link out suggestion chip for Actions on Google.
list_select = 11
Displays a list card for Actions on Google.
carousel_select = 12
Displays a carousel card for Actions on Google.
telephony_play_audio = 13
Plays audio from a file in Telephony Gateway.
telephony_synthesize_speech = 14
Synthesizes speech in Telephony Gateway.
telephony_transfer_call = 15
Transfers the call in Telephony Gateway.
Message.Platform platform = 6
Optional. The platform that this message is intended for.
message
intent.proto:300The basic card message. Useful for displaying information.
Used in:
string title = 1
Optional. The title of the card.
string subtitle = 2
Optional. The subtitle of the card.
string formatted_text = 3
Required, unless image is present. The body text of the card.
optional image = 4
Optional. The image for the card.
repeated buttons = 5
Optional. The collection of card buttons.
message
intent.proto:302The button object that appears at the bottom of a card.
Used in:
string title = 1
Required. The title of the button.
optional open_uri_action = 2
Required. Action to take when a user taps on the button.
message
intent.proto:304Opens the given URI.
Used in:
string uri = 1
Required. The HTTP or HTTPS scheme URI.
message
intent.proto:251The card response message.
Used in:
string title = 1
Optional. The title of the card.
string subtitle = 2
Optional. The subtitle of the card.
string image_uri = 3
Optional. The public URI to an image file for the card.
repeated buttons = 4
Optional. The collection of card buttons.
message
intent.proto:253Optional. Contains information about a button.
Used in:
string text = 1
Optional. The text to show on the button.
string postback = 2
Optional. The text to send back to the Dialogflow API or a URI to open.
message
intent.proto:381The card for presenting a carousel of options to select from.
Used in:
repeated items = 1
Required. Carousel items.
message
intent.proto:383An item in the carousel.
Used in:
optional info = 1
Required. Additional info about the option item.
string title = 2
Required. Title of the carousel item.
string description = 3
Optional. The body text of the card.
optional image = 4
Optional. The image to display.
message
intent.proto:232The image response message.
Used in: , , ,
string image_uri = 1
Optional. The public URI to an image file.
string accessibility_text = 2
A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.
message
intent.proto:347The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
Used in:
string destination_name = 1
Required. The name of the app or site this chip is linking to.
string uri = 2
Required. The URI of the app or site to open when the user taps the suggestion chip.
message
intent.proto:357The card for presenting a list of options to select from.
Used in:
string title = 1
Optional. The overall title of the list.
repeated items = 2
Required. List items.
message
intent.proto:359An item in the list.
Used in:
optional info = 1
Required. Additional information about this option.
string title = 2
Required. The title of the list item.
string description = 3
Optional. The main text describing the item.
optional image = 4
Optional. The image to display.
Represents different platforms that a rich message can be intended for.
Used in: ,
PLATFORM_UNSPECIFIED = 0
Not specified.
FACEBOOK = 1
Facebook.
SLACK = 2
Slack.
TELEGRAM = 3
Telegram.
KIK = 4
Kik.
SKYPE = 5
Skype.
LINE = 6
Line.
VIBER = 7
Viber.
ACTIONS_ON_GOOGLE = 8
Actions on Google. When using Actions on Google, you can choose one of the specific Intent.Message types that mention support for Actions on Google, or you can use the advanced Intent.Message.payload field. The payload field provides access to AoG features not available in the specific message types. If using the Intent.Message.payload field, it should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "expectUserResponse": true, "isSsml": false, "noInputPrompts": [], "richResponse": { "items": [ { "simpleResponse": { "displayText": "hi", "textToSpeech": "hello" } } ], "suggestions": [ { "title": "Say this" }, { "title": "or this" } ] }, "systemIntent": { "data": { "@type": "type.googleapis.com/google.actions.v2.OptionValueSpec", "listSelect": { "items": [ { "optionInfo": { "key": "key1", "synonyms": [ "key one" ] }, "title": "must not be empty, but unique" }, { "optionInfo": { "key": "key2", "synonyms": [ "key two" ] }, "title": "must not be empty, but unique" } ] } }, "intent": "actions.intent.OPTION" } }</pre>
TELEPHONY = 10
Telephony Gateway.
message
intent.proto:242The quick replies response message.
Used in:
string title = 1
Optional. The title of the collection of quick replies.
repeated string quick_replies = 2
Optional. The collection of quick replies.
message
intent.proto:403Additional info about the select item for when it is triggered in a dialog.
Used in: ,
string key = 1
Required. A unique key that will be sent back to the agent if this response is given.
repeated string synonyms = 2
Optional. A list of synonyms that can also be used to trigger this item in dialog.
message
intent.proto:276The simple response message containing speech or text.
Used in:
string text_to_speech = 1
One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.
string ssml = 2
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.
string display_text = 3
Optional. The text to display.
message
intent.proto:294The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.
Used in:
repeated simple_responses = 1
Required. The list of simple responses.
message
intent.proto:334The suggestion chip message that the user can tap to quickly post a reply to the conversation.
Used in:
string title = 1
Required. The text shown the in the suggestion chip.
message
intent.proto:340The collection of suggestions.
Used in:
repeated suggestions = 1
Required. The list of suggested replies.
message
intent.proto:414Plays audio from a file in Telephony Gateway.
Used in:
string audio_uri = 1
Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where <Project Number> is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.
message
intent.proto:437Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config.
Used in:
oneof source
Required. The source to be synthesized.
string text = 1
The raw text to be synthesized.
string ssml = 2
The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).
message
intent.proto:450Transfers the call in Telephony Gateway.
Used in:
string phone_number = 1
Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).
message
intent.proto:226The text response message.
Used in:
repeated string text = 1
Optional. The collection of the agent's responses.
message
intent.proto:184Represents intent parameters.
Used in:
string name = 1
The unique identifier of this parameter.
string display_name = 2
Required. The name of the parameter.
string value = 3
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`.
string default_value = 4
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`.
string entity_type_display_name = 5
Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.
bool mandatory = 6
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
repeated string prompts = 7
Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.
bool is_list = 8
Optional. Indicates whether the parameter represents a list of values.
message
intent.proto:130Represents an example or template that the agent is trained on.
Used in:
string name = 1
Required. The unique identifier of this training phrase.
TrainingPhrase.Type type = 2
Required. The type of the training phrase.
repeated parts = 3
Required. The collection of training phrase parts (can be annotated). Fields: `entity_type`, `alias` and `user_defined` should be populated only for the annotated parts of the training phrase.
int32 times_added_count = 4
Optional. Indicates how many times this example or template was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.
message
intent.proto:132Represents a part of a training phrase.
Used in:
string text = 1
Required. The text corresponding to the example or template, if there are no annotations. For annotated examples, it is the text for one of the example's parts.
string entity_type = 2
Optional. The entity type name prefixed with `@`. This field is required for the annotated part of the text and applies only to examples.
string alias = 3
Optional. The parameter name for the value extracted from the annotated part of the example.
bool user_defined = 4
Optional. Indicates whether the text was manually annotated by the developer.
Represents different types of training phrases.
Used in:
TYPE_UNSPECIFIED = 0
Not specified. This value should never be used.
EXAMPLE = 1
Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.
TEMPLATE = 2
Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings.
Represents the different states that webhooks can be in.
Used in:
WEBHOOK_STATE_UNSPECIFIED = 0
Webhook is disabled in the agent and in the intent.
WEBHOOK_STATE_ENABLED = 1
Webhook is enabled in the agent and in the intent.
WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING = 2
Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook.
message
intent.proto:873This message is a wrapper around a collection of intents.
Used in:
repeated intents = 1
A collection of intents.
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.
Used in: , , , ,
INTENT_VIEW_UNSPECIFIED = 0
Training phrases field is not populated in the response.
INTENT_VIEW_FULL = 1
All fields are populated.
message
session.proto:285Represents the result of querying a Knowledge base.
Used in:
repeated answers = 1
A list of answers from Knowledge Connector.
message
session.proto:287An answer from Knowledge Connector.
Used in:
string source = 1
Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
string faq_question = 2
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
string answer = 3
The piece of text from the `source` knowledge base document that answers this conversational query.
Answer.MatchConfidenceLevel match_confidence_level = 4
The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `<query, answer>` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.
float match_confidence = 5
The system's confidence score that this Knowledge answer is a good match for this converstational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement, we may deprecate it in the future. We recommend using `match_confidence_level` which should be generally more stable.
Represents the system's confidence that this knowledge answer is a good match for this conversational query.
Used in:
MATCH_CONFIDENCE_LEVEL_UNSPECIFIED = 0
Not specified.
LOW = 1
Indicates that the confidence is low.
MEDIUM = 2
Indicates our confidence is medium.
HIGH = 3
Indicates our confidence is high.
message
knowledge_base.proto:80Represents knowledge base resource.
Used as response type in: KnowledgeBases.CreateKnowledgeBase, KnowledgeBases.GetKnowledgeBase
Used as field type in: ,
string name = 1
The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
string display_name = 2
Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
message
document.proto:191Metadata in google::longrunning::Operation for Knowledge operations.
KnowledgeOperationMetadata.State state = 1
Required. The current state of this operation.
States of the operation.
Used in:
STATE_UNSPECIFIED = 0
State unspecified.
PENDING = 1
The operation has been created.
RUNNING = 2
The operation is currently running.
DONE = 3
The operation is done, either cancelled or completed.
message
webhook.proto:111Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.
Used in:
string source = 1
The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.
string version = 2
Optional. The version of the protocol used for this request. This field is AoG-specific.
optional payload = 3
Optional. This field is set to the value of `QueryParameters.payload` field passed in the request. This field is used for the telephony gateway. It should have a structure similar to this JSON message: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be in [E.164 format](https://en.wikipedia.org/wiki/E.164) and is only supported for Enterprise Edition and not for Standard Edition agents. When the telephony gateway is used with a standard tier agent the `caller_id` field above will have a value of `REDACTED_IN_STANDARD_TIER_AGENT`.
message
audio_config.proto:77Instructs the speech synthesizer how to generate the output audio content.
Used in: , , ,
OutputAudioEncoding audio_encoding = 1
Required. Audio encoding of the synthesized audio content.
int32 sample_rate_hertz = 2
Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).
optional synthesize_speech_config = 3
Optional. Configuration of how speech should be synthesized.
Audio encoding of the output audio format in Text-To-Speech.
Used in:
OUTPUT_AUDIO_ENCODING_UNSPECIFIED = 0
Not specified.
OUTPUT_AUDIO_ENCODING_LINEAR_16 = 1
Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.
OUTPUT_AUDIO_ENCODING_MP3 = 2
MP3 audio.
OUTPUT_AUDIO_ENCODING_OGG_OPUS = 3
Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.
message
session.proto:186Represents 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.
Used in: ,
oneof input
Required. The input specification.
audio_config = 1
Instructs the speech recognizer how to process the speech audio.
text = 2
The natural language text to be processed.
event = 3
The event to be processed.
message
session.proto:135Represents the parameters of the conversational query.
Used in: ,
string time_zone = 1
Optional. The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.
optional geo_location = 2
Optional. The geo location of this conversational query.
repeated contexts = 3
Optional. The collection of contexts to be activated before this query is executed.
bool reset_contexts = 4
Optional. Specifies whether to delete all contexts in the current session before the new ones are activated.
repeated session_entity_types = 5
Optional. The collection of session entity types to replace or extend developer entities with for this query only. The entity synonyms apply to all languages.
optional payload = 6
Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
repeated string knowledge_base_names = 12
Optional. KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`. Note: This field is `repeated` for forward compatibility, currently only the first one is supported, we may return an error if multiple KnowledgeBases are specified.
optional sentiment_analysis_request_config = 10
Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Enterprise Edition agents.
message
session.proto:201Represents the result of conversational query or event processing.
Used in: , ,
string query_text = 1
The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set.
string language_code = 15
The language that was triggered during intent detection. See [Language Support](https://dialogflow.com/docs/reference/language) for a list of the currently supported language codes.
float speech_recognition_confidence = 2
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.
string action = 3
The action name from the matched intent.
optional parameters = 4
The collection of extracted parameters.
bool all_required_params_present = 5
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.
string fulfillment_text = 6
The text to be pronounced to the user or shown on the screen.
repeated fulfillment_messages = 7
The collection of rich messages to present to the user.
string webhook_source = 8
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.
optional webhook_payload = 9
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.
repeated output_contexts = 10
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.
optional intent = 11
The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`.
float intent_detection_confidence = 12
The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.
optional diagnostic_info = 14
The free-form diagnostic info. For example, this field could contain webhook call latency.
optional sentiment_analysis_result = 17
The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.
optional knowledge_answers = 18
The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.
message
session.proto:617The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.
Used in:
float score = 1
Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
float magnitude = 2
A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).
message
session.proto:601Configures the types of sentiment analysis to perform.
Used in:
bool analyze_query_text_sentiment = 1
Optional. Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`.
message
session.proto:610The result of sentiment analysis as configured by `sentiment_analysis_request_config`.
Used in:
optional query_text_sentiment = 1
The sentiment analysis result for `query_text`.
message
session_entity_type.proto:108Represents a session entity type. Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types"). Note: session entity types apply to all queries, regardless of the language.
Used as response type in: SessionEntityTypes.CreateSessionEntityType, SessionEntityTypes.GetSessionEntityType, SessionEntityTypes.UpdateSessionEntityType
Used as field type in: , , ,
string name = 1
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.
SessionEntityType.EntityOverrideMode entity_override_mode = 2
Required. Indicates whether the additional data should override or supplement the developer entity type definition.
repeated entities = 3
Required. The collection of entities associated with this session entity type.
The types of modifications for a session entity type.
Used in:
ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0
Not specified. This value should be never used.
ENTITY_OVERRIDE_MODE_OVERRIDE = 1
The collection of session entities overrides the collection of entities in the corresponding developer entity type.
ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
The collection of session entities extends the collection of entities in the corresponding developer entity type. Calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` return the full collection of entities from the developer entity type in the agent's default language and the session entity type.
Gender of the voice as described in [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).
Used in:
SSML_VOICE_GENDER_UNSPECIFIED = 0
An unspecified gender, which means that the client doesn't care which gender the selected voice will have.
SSML_VOICE_GENDER_MALE = 1
A male voice.
SSML_VOICE_GENDER_FEMALE = 2
A female voice.
SSML_VOICE_GENDER_NEUTRAL = 3
A gender-neutral voice.
message
session.proto:484Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance. Example: 1. transcript: "tube" 2. transcript: "to be a" 3. transcript: "to be" 4. transcript: "to be or not to be" is_final: true 5. transcript: " that's" 6. transcript: " that is" 7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE` 8. transcript: " that is the question" is_final: true Only two of the responses contain final results (#4 and #8 indicated by `is_final: true`). Concatenating these generates the full transcript: "to be or not to be that is the question". In each response we populate: * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`. * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`.
Used in:
StreamingRecognitionResult.MessageType message_type = 1
Type of the result message.
string transcript = 2
Transcript text representing the words that the user spoke. Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
bool is_final = 3
The default of 0.0 is a sentinel value indicating `confidence` was not set. If `false`, the `StreamingRecognitionResult` represents an interim result that may change. If `true`, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`.
float confidence = 4
The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is typically only provided if `is_final` is true and you should not rely on it being accurate or even set.
Type of the response message.
Used in:
MESSAGE_TYPE_UNSPECIFIED = 0
Not specified. Should never be used.
TRANSCRIPT = 1
Message contains a (possibly partial) transcript.
END_OF_SINGLE_UTTERANCE = 2
Event indicates that the server has detected the end of the user's speech utterance and expects no additional speech. Therefore, the server will not process additional audio (although it may subsequently return additional results). The client should stop sending additional audio data, half-close the gRPC connection, and wait for any additional results until the server closes the gRPC connection. This message is only sent if `single_utterance` was set to `true`, and is not used otherwise.
message
audio_config.proto:45Configuration of how speech should be synthesized.
Used in:
double speaking_rate = 1
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.
double pitch = 2
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.
double volume_gain_db = 3
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.
repeated string effects_profile_id = 5
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.
optional voice = 4
Optional. The desired voice of the synthesized audio.
message
session.proto:569Represents the natural language text to be processed.
Used in:
string text = 1
Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 bytes.
string language_code = 2
Required. The language of this conversational query. See [Language Support](https://dialogflow.com/docs/languages) 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.
message
audio_config.proto:31Description of which voice to use for speech synthesis.
Used in:
string name = 1
Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender.
SsmlVoiceGender ssml_gender = 2
Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
message
webhook.proto:35The request message for a webhook call.
string session = 4
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>`.
string response_id = 1
The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.
optional query_result = 2
The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`.
repeated alternative_query_results = 5
Alternative query results from KnowledgeService.
optional original_detect_intent_request = 3
Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call.
message
webhook.proto:58The response message for a webhook call.
string fulfillment_text = 1
Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`.
repeated fulfillment_messages = 2
Optional. The collection of rich messages to present to the user. This value is passed directly to `QueryResult.fulfillment_messages`.
string source = 3
Optional. This value is passed directly to `QueryResult.webhook_source`.
optional payload = 4
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](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre>
repeated output_contexts = 5
Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`.
optional followup_event_input = 6
Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input.
bool end_interaction = 8
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.