v2beta1

Not specified.

Legacy V1 API.

V2 API.

V2beta1 API.

Not specified.

Uncompressed 16-bit signed little-endian samples (Linear PCM).

FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.

8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.

Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000.

Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000.

Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000.

Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000.

Auto expansion disabled for the entity.

Allows an agent to recognize values that have not been explicitly listed in the entity.

Not specified.

Horizontal layout.

Vertical layout.

Not specified.

120 DP. Note that tall media cannot be used.

232 DP.

Not specified. This value should be never used.

The collection of session entities overrides the collection of entities in the corresponding developer entity type.

The collection of session entities extends the collection of entities in the corresponding developer entity type.

Note: Even in this override mode calls to ListSessionEntityTypes, GetSessionEntityType, CreateSessionEntityType and UpdateSessionEntityType only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the developer entity type and merge.

Not specified.

112 DP.

168 DP.

264 DP. Not available for rich card carousels when the card width is set to small.

Text is aligned to the leading edge of the column.

Text is aligned to the leading edge of the column.

Text is centered in the column.

Text is aligned to the trailing edge of the column.

Fill the gaps between the image and the image container with gray bars.

Fill the gaps between the image and the image container with gray bars.

Fill the gaps between the image and the image container with white bars.

Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to "Zoom Mode" on a widescreen TV when playing a 4:3 video.

Pad the gaps between image and image frame with a blurred copy of the same image.

Training phrases field is not populated in the response.

All fields are populated.

Not specified. This value should be never used.

Map entity types allow mapping of a group of synonyms to a canonical value.

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

Regexp entity types allow to specify regular expressions in entries values.

The type is unspecified or arbitrary.

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.

Documents for which unstructured text is extracted and used for question answering.

Not specified.

Indicates that the confidence is low.

Indicates our confidence is medium.

Indicates our confidence is high.

Not specified.

Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.

Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large developer entities.

Not specified. Should never be used.

Message contains a (possibly partial) transcript.

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.

Not specified.

Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.

MP3 audio at 32kbps.

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.

Not specified.

Facebook.

Slack.

Telegram.

Kik.

Skype.

Line.

Viber.

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

{
  "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"
  }
}

Telephony Gateway.

Google Hangouts.

Unspecified.

Response media type is audio.

Not specified. This value should never be used.

The agent doesn't follow Dialogflow best practicies.

The agent may not behave as expected.

The agent may experience partial failures.

The agent may completely fail.

No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.

Use the best available variant of the Speech model that the caller is eligible for.

Please see the Dialogflow docs for how to make your project eligible for enhanced models.

Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models.

Use an enhanced model variant:

• If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant.

  The Cloud Speech documentation describes which models have enhanced variants.

• If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible.

An unspecified gender, which means that the client doesn't care which gender the selected voice will have.

A male voice.

A female voice.

A gender-neutral voice.

State unspecified.

The operation has been created.

The operation is currently running.

The operation is done, either cancelled or completed.

Not specified.

Thumbnail preview is left-aligned.

Thumbnail preview is right-aligned.

Not specified. This value should never be used.

Standard tier.

Enterprise tier (Essentials).

Enterprise tier (Plus).

Not specified. This value should never be used.

Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.

Templates are not annotated with entity types, but they can contain

Unspecified

Url would be an amp action

URL that points directly to AMP content, or to a canonical URL which refers to AMP content via .

Webhook is disabled in the agent and in the intent.

Webhook is enabled in the agent and in the intent.

Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook.

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

Required. The name of this agent.

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Update method.

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

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

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

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

Optional. Determines whether this agent should log conversation queries.

Optional. Determines how intents are detected from user queries.

The number should be among the values of MatchMode

Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

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

The number should be among the values of ApiVersion

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

The number should be among the values of Tier

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

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

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

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.

The number should be among the values of MatchConfidenceLevel

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is 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. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable.

Optional. The title of the card.

Optional. The subtitle of the card.

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

Optional. The image for the card.

This object should have the same structure as Image

Optional. The collection of card buttons.

This object should have the same structure as Button

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

Required. The entities to create.

This object should have the same structure as Entity

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

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

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

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

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

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

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

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

This object should have the same structure as Intent

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

Required. The entities to update or create.

This object should have the same structure as Entity

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

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

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

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://".

The collection of entity types to update or create.

This object should have the same structure as EntityTypeBatch

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

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

The collection of updated or created entity types.

This object should have the same structure as EntityType

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

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://".

The collection of intents to update or create.

This object should have the same structure as IntentBatch

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

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

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

The number should be among the values of IntentView

The collection of updated or created intents.

This object should have the same structure as Intent

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

This object should have the same structure as BrowseCarouselCardItem

Optional. Settings for displaying the image. Applies to every image in items.

The number should be among the values of ImageDisplayOptions

Required. Action to present to the user.

This object should have the same structure as OpenUrlAction

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

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

Optional. Hero image for the carousel item.

This object should have the same structure as Image

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

Optional. The text to show on the button.

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

Required. The title of the button.

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

This object should have the same structure as OpenUriAction

Optional. The title of the card.

Optional. The subtitle of the card.

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

Optional. The collection of card buttons.

This object should have the same structure as Button

Required. Carousel items.

This object should have the same structure as Item

Required. Column heading.

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

The number should be among the values of HorizontalAlignment

Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>.

The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

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

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

This object should have the same structure as Struct

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.

Required. The context to create.

This object should have the same structure as Context

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

Required. The document to create.

This object should have the same structure as Document

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

Required. The entity type to create.

This object should have the same structure as EntityType

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

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

Required. The intent to create.

This object should have the same structure as Intent

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

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

The number should be among the values of IntentView

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

Required. The knowledge base to create.

This object should have the same structure as KnowledgeBase

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.

Required. The session entity type to create.

This object should have the same structure as SessionEntityType

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

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.

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.

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

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

Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

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

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

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.

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

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

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.

This object should have the same structure as QueryInput

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.

This object should have the same structure as OutputAudioConfig

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.

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

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

This object should have the same structure as QueryResult

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.

This object should have the same structure as QueryResult

Specifies the status of the webhook request.

This object should have the same structure as Status

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.fulfillment_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

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

This object should have the same structure as OutputAudioConfig

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

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

Required. The MIME type of this document.

Required. The knowledge type of document content.

The number should be among the values of KnowledgeType

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.

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.

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

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

• A canonical value to be used in place of synonyms.

For KIND_LIST entity types:

• A string that can contain references to other entity types (with or without aliases).

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

• This collection must contain exactly one synonym equal to value.

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

Required. The name of the entity type.

Required. Indicates the kind of entity type.

The number should be among the values of Kind

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

The number should be among the values of AutoExpansionMode

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

This object should have the same structure as Entity

Optional. Enables fuzzy entity extraction during classification.

A collection of entity types.

This object should have the same structure as EntityType

Required. The unique identifier of the event.

Optional. The collection of parameters associated with the event.

This object should have the same structure as Struct

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

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

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

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

Zip compressed raw byte content for agent.

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

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

Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.

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

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.

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

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

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

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

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

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

The number should be among the values of IntentView

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

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.

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

Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

Optional. The public URI to an image file.

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

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

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

Zip compressed raw byte content for agent.

Required. Audio encoding of the audio content to process.

The number should be among the values of AudioEncoding

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

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

Optional. If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

Optional. Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

This object should have the same structure as SpeechContext

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

Optional. Which variant of the Speech model to use.

The number should be among the values of SpeechModelVariant

Optional. If false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.

The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects/<Project ID>/agent/intents/<Intent ID>.

Required. The name of this intent.

Optional. Indicates whether webhooks are enabled for the intent.

The number should be among the values of WebhookState

The priority of this intent. Higher numbers represent higher priorities.

• If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console.
• If the supplied value is negative, the intent is ignored in runtime detect intent requests.

Optional. Indicates whether this is a fallback intent.

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.

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.

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.

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

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.

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

This object should have the same structure as TrainingPhrase

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

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

This object should have the same structure as Context

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

Optional. The collection of parameters associated with the intent.

This object should have the same structure as Parameter

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

This object should have the same structure as Message

Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).

The number should be among the values of Platform

Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output.

Format: projects/<Project ID>/agent/intents/<Intent ID>.

Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent.

It identifies the parent followup intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

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

This object should have the same structure as FollowupIntentInfo

A collection of intents.

This object should have the same structure as Intent

Required. Additional information about this option.

This object should have the same structure as SelectItemInfo

Required. The title of the list item.

Optional. The main text describing the item.

Optional. The image to display.

This object should have the same structure as Image

Required. Additional info about the option item.

This object should have the same structure as SelectItemInfo

Required. Title of the carousel item.

Optional. The body text of the card.

Optional. The image to display.

This object should have the same structure as Image

A list of answers from Knowledge Connector.

This object should have the same structure as Answer

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

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

Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.

Required. The current state of this operation.

The number should be among the values of State

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

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

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.

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

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

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

This object should have the same structure as Context

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

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

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

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

The list of documents.

This object should have the same structure as Document

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

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

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

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

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

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

This object should have the same structure as EntityType

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

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

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

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

The number should be among the values of IntentView

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

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

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

This object should have the same structure as Intent

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

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

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

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

The list of knowledge bases.

This object should have the same structure as KnowledgeBase

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

Optional. The overall title of the list.

Required. List items.

This object should have the same structure as Item

Optional. Subtitle of the list.

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.

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

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

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

This object should have the same structure as SessionEntityType

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

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

The number should be among the values of ResponseMediaType

Required. List of media objects.

This object should have the same structure as ResponseMediaObject

Returns a text response.

This object should have the same structure as Text

Displays an image.

This object should have the same structure as Image

Displays quick replies.

This object should have the same structure as QuickReplies

Displays a card.

This object should have the same structure as Card

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.

This object should have the same structure as Struct

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

This object should have the same structure as SimpleResponses

Displays a basic card for Actions on Google.

This object should have the same structure as BasicCard

Displays suggestion chips for Actions on Google.

This object should have the same structure as Suggestions

Displays a link out suggestion chip for Actions on Google.

This object should have the same structure as LinkOutSuggestion

Displays a list card for Actions on Google.

This object should have the same structure as ListSelect

Displays a carousel card for Actions on Google.

This object should have the same structure as CarouselSelect

Plays audio from a file in Telephony Gateway.

This object should have the same structure as TelephonyPlayAudio

Synthesizes speech in Telephony Gateway.

This object should have the same structure as TelephonySynthesizeSpeech

Transfers the call in Telephony Gateway.

This object should have the same structure as TelephonyTransferCall

Rich Business Messaging (RBM) text response.

RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.

This object should have the same structure as RbmText

Standalone Rich Business Messaging (RBM) rich card response.

This object should have the same structure as RbmStandaloneCard

Rich Business Messaging (RBM) carousel rich card response.

This object should have the same structure as RbmCarouselCard

Browse carousel card for Actions on Google.

This object should have the same structure as BrowseCarouselCard

Table card for Actions on Google.

This object should have the same structure as TableCard

The media content card for Actions on Google.

This object should have the same structure as MediaContent

Optional. The platform that this message is intended for.

The number should be among the values of Platform

Required. The HTTP or HTTPS scheme URI.

Required. URL

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

The number should be among the values of UrlTypeHint

Required. Audio encoding of the synthesized audio content.

The number should be among the values of OutputAudioEncoding

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. Configuration of how speech should be synthesized.

This object should have the same structure as SynthesizeSpeechConfig

The unique identifier of this parameter.

Required. The name of the parameter.

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.

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.

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

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

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

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

Required. The text for this part.

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

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

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

Instructs the speech recognizer how to process the speech audio.

This object should have the same structure as InputAudioConfig

The natural language text to be processed.

This object should have the same structure as TextInput

The event to be processed.

This object should have the same structure as EventInput

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

Optional. The geo location of this conversational query.

This object should have the same structure as LatLng

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

This object should have the same structure as Context

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

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

This object should have the same structure as SessionEntityType

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

This object should have the same structure as Struct

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

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.

This object should have the same structure as SentimentAnalysisRequestConfig

Optional. This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook alone with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.

The original conversational query text:

• If natural language text was provided as input, query_text contains a copy of the input.
• If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked.
• If automatic spell correction is enabled, query_text will contain the corrected user input.

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

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.

The action name from the matched intent.

The collection of extracted parameters.

This object should have the same structure as Struct

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.

The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages should be preferred.

The collection of rich messages to present to the user.

This object should have the same structure as Message

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.

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.

This object should have the same structure as Struct

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.

This object should have the same structure as Context

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

This object should have the same structure as Intent

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

The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice.

This object should have the same structure as Struct

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

This object should have the same structure as SentimentAnalysisResult

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

This object should have the same structure as KnowledgeAnswers

Optional. The title of the collection of quick replies.

Optional. The collection of quick replies.

Optional. Title of the card (at most 200 bytes).

At least one of the title, description or media must be set.

Optional. Description of the card (at most 2000 bytes).

At least one of the title, description or media must be set.

Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.

This object should have the same structure as RbmMedia

Optional. List of suggestions to include in the card.

This object should have the same structure as RbmSuggestion

Required. The width of the cards in the carousel.

The number should be among the values of CardWidth

Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.

This object should have the same structure as RbmCardContent

Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.

Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.

Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. (https://goo.gl/NeFCjz). For a standalone card with horizontal layout, height is not customizable, and this field is ignored.

The number should be among the values of Height

Required. Orientation of the card.

The number should be among the values of CardOrientation

Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.

The number should be among the values of ThumbnailImageAlignment

Required. Card content.

This object should have the same structure as RbmCardContent

Text to display alongside the action.

Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.

Suggested client side action: Dial a phone number

This object should have the same structure as RbmSuggestedActionDial

Suggested client side action: Open a URI on device

This object should have the same structure as RbmSuggestedActionOpenUri

Suggested client side action: Share user location

This object should have the same structure as RbmSuggestedActionShareLocation

Required. The phone number to fill in the default dialer app. This field should be in E.164 format. An example of a correctly formatted phone number: +15556767888.

Required. The uri to open on the user device

Suggested reply text.

Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.

Predefined replies for user to select instead of typing

This object should have the same structure as RbmSuggestedReply

Predefined client side actions that user can choose

This object should have the same structure as RbmSuggestedAction

Required. Text sent and displayed to the user.

Optional. One or more suggestions to show to the user.

This object should have the same structure as RbmSuggestion

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

The path of gcs source file for reloading document content.

This object should have the same structure as GcsSource

Required. Name of media card.

Optional. Description of media card.

Optional. Image to display above media content.

This object should have the same structure as Image

Optional. Icon to display above media content.

This object should have the same structure as Image

Required. Url where the media is stored.

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

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

Zip compressed raw byte content for agent.

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

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

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

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

This object should have the same structure as Agent

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

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

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

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

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

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

The sentiment analysis result for query_text.

This object should have the same structure as Sentiment

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

<Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

The number should be among the values of EntityOverrideMode

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

This object should have the same structure as Entity

Required. The agent to update.

This object should have the same structure as Agent

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

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

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

Optional. The text to display.

Required. The list of simple responses.

This object should have the same structure as SimpleResponse

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

• improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
• add additional words to the speech recognizer vocabulary
• ...

See the Cloud Speech documentation for usage limits.

Optional. Boost for this context compared to other contexts:

• If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases.
• If the boost is unspecified or non-positive, Dialogflow will not apply any boost.

Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

The word this info is for.

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

This object should have the same structure as Duration

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

This object should have the same structure as Duration

The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is not guaranteed to be fully stable over time for the same audio input. Users should also not rely on it to always be provided.

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

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

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.

This object should have the same structure as QueryInput

DEPRECATED. Please use InputAudioConfig.single_utterance instead. 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. 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.

This object should have the same structure as OutputAudioConfig

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.

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

The result of speech recognition.

This object should have the same structure as StreamingRecognitionResult