Enumerations

AudioEncoding

constant   static

number

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

Value

AUDIO_ENCODING_UNSPECIFIED

Not specified.

AUDIO_ENCODING_LINEAR_16

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

AUDIO_ENCODING_FLAC

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

AUDIO_ENCODING_MULAW

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

AUDIO_ENCODING_AMR

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

AUDIO_ENCODING_AMR_WB

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

AUDIO_ENCODING_OGG_OPUS

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

AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE

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

AutoExpansionMode

static

number

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

Value

AUTO_EXPANSION_MODE_UNSPECIFIED

Auto expansion disabled for the entity.

AUTO_EXPANSION_MODE_DEFAULT

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

EntityOverrideMode

static

number

The types of modifications for a session entity type.

Value

ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

ENTITY_OVERRIDE_MODE_OVERRIDE

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

ENTITY_OVERRIDE_MODE_SUPPLEMENT

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.

IntentView

constant   static

number

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.

Value

INTENT_VIEW_UNSPECIFIED

Training phrases field is not populated in the response.

INTENT_VIEW_FULL

All fields are populated.

Kind

static

number

Represents kinds of entities.

Value

KIND_UNSPECIFIED

Not specified. This value should be never used.

KIND_MAP

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

KIND_LIST

List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).

KnowledgeType

static

number

The knowledge type of document content.

Value

KNOWLEDGE_TYPE_UNSPECIFIED

The type is unspecified or arbitrary.

FAQ

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

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

MatchConfidenceLevel

static

number

Represents the system's confidence that this knowledge answer is a good match for this conversational query.

Value

MATCH_CONFIDENCE_LEVEL_UNSPECIFIED

Not specified.

LOW

Indicates that the confidence is low.

MEDIUM

Indicates our confidence is medium.

HIGH

Indicates our confidence is high.

MatchMode

static

number

Match mode determines how intents are detected from user queries.

Value

MATCH_MODE_UNSPECIFIED

Not specified.

MATCH_MODE_HYBRID

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

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

MessageType

static

number

Type of the response message.

Value

MESSAGE_TYPE_UNSPECIFIED

Not specified. Should never be used.

TRANSCRIPT

Message contains a (possibly partial) transcript.

END_OF_SINGLE_UTTERANCE

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.

OutputAudioEncoding

constant   static

number

Audio encoding of the output audio format in Text-To-Speech.

Value

OUTPUT_AUDIO_ENCODING_UNSPECIFIED

Not specified.

OUTPUT_AUDIO_ENCODING_LINEAR_16

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

OUTPUT_AUDIO_ENCODING_MP3

MP3 audio.

OUTPUT_AUDIO_ENCODING_OGG_OPUS

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.

Platform

static

number

Represents different platforms that a rich message can be intended for.

Value

PLATFORM_UNSPECIFIED

Not specified.

FACEBOOK

Facebook.

SLACK

Slack.

TELEGRAM

Telegram.

KIK

Kik.

SKYPE

Skype.

LINE

Line.

VIBER

Viber.

ACTIONS_ON_GOOGLE

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

Telephony Gateway.

SpeechModelVariant

constant   static

number

Variant of the specified Speech model to use.

See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.

Value

SPEECH_MODEL_VARIANT_UNSPECIFIED

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

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

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

USE_ENHANCED

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.

SsmlVoiceGender

constant   static

number

Gender of the voice as described in SSML voice element.

Value

SSML_VOICE_GENDER_UNSPECIFIED

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

SSML_VOICE_GENDER_MALE

A male voice.

SSML_VOICE_GENDER_FEMALE

A female voice.

SSML_VOICE_GENDER_NEUTRAL

A gender-neutral voice.

State

static

number

States of the operation.

Value

STATE_UNSPECIFIED

State unspecified.

PENDING

The operation has been created.

RUNNING

The operation is currently running.

DONE

The operation is done, either cancelled or completed.

Type

static

number

Represents different types of training phrases.

Value

TYPE_UNSPECIFIED

Not specified. This value should never be used.

EXAMPLE

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

TEMPLATE

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

WebhookState

static

number

Represents the different states that webhooks can be in.

Value

WEBHOOK_STATE_UNSPECIFIED

Webhook is disabled in the agent and in the intent.

WEBHOOK_STATE_ENABLED

Webhook is enabled in the agent and in the intent.

WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING

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

Properties

AudioEncoding

constant   static

number

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

Value

AUDIO_ENCODING_UNSPECIFIED

Not specified.

AUDIO_ENCODING_LINEAR_16

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

AUDIO_ENCODING_FLAC

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

AUDIO_ENCODING_MULAW

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

AUDIO_ENCODING_AMR

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

AUDIO_ENCODING_AMR_WB

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

AUDIO_ENCODING_OGG_OPUS

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

AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE

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

AutoExpansionMode

static

number

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

Value

AUTO_EXPANSION_MODE_UNSPECIFIED

Auto expansion disabled for the entity.

AUTO_EXPANSION_MODE_DEFAULT

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

EntityOverrideMode

static

number

The types of modifications for a session entity type.

Value

ENTITY_OVERRIDE_MODE_UNSPECIFIED

Not specified. This value should be never used.

ENTITY_OVERRIDE_MODE_OVERRIDE

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

ENTITY_OVERRIDE_MODE_SUPPLEMENT

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.

IntentView

constant   static

number

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.

Value

INTENT_VIEW_UNSPECIFIED

Training phrases field is not populated in the response.

INTENT_VIEW_FULL

All fields are populated.

Kind

static

number

Represents kinds of entities.

Value

KIND_UNSPECIFIED

Not specified. This value should be never used.

KIND_MAP

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

KIND_LIST

List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).

KnowledgeType

static

number

The knowledge type of document content.

Value

KNOWLEDGE_TYPE_UNSPECIFIED

The type is unspecified or arbitrary.

FAQ

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

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

MatchConfidenceLevel

static

number

Represents the system's confidence that this knowledge answer is a good match for this conversational query.

Value

MATCH_CONFIDENCE_LEVEL_UNSPECIFIED

Not specified.

LOW

Indicates that the confidence is low.

MEDIUM

Indicates our confidence is medium.

HIGH

Indicates our confidence is high.

MatchMode

static

number

Match mode determines how intents are detected from user queries.

Value

MATCH_MODE_UNSPECIFIED

Not specified.

MATCH_MODE_HYBRID

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

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

MessageType

static

number

Type of the response message.

Value

MESSAGE_TYPE_UNSPECIFIED

Not specified. Should never be used.

TRANSCRIPT

Message contains a (possibly partial) transcript.

END_OF_SINGLE_UTTERANCE

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.

OutputAudioEncoding

constant   static

number

Audio encoding of the output audio format in Text-To-Speech.

Value

OUTPUT_AUDIO_ENCODING_UNSPECIFIED

Not specified.

OUTPUT_AUDIO_ENCODING_LINEAR_16

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

OUTPUT_AUDIO_ENCODING_MP3

MP3 audio.

OUTPUT_AUDIO_ENCODING_OGG_OPUS

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.

Platform

static

number

Represents different platforms that a rich message can be intended for.

Value

PLATFORM_UNSPECIFIED

Not specified.

FACEBOOK

Facebook.

SLACK

Slack.

TELEGRAM

Telegram.

KIK

Kik.

SKYPE

Skype.

LINE

Line.

VIBER

Viber.

ACTIONS_ON_GOOGLE

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

Telephony Gateway.

SpeechModelVariant

constant   static

number

Variant of the specified Speech model to use.

See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.

Value

SPEECH_MODEL_VARIANT_UNSPECIFIED

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

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

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

USE_ENHANCED

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.

SsmlVoiceGender

constant   static

number

Gender of the voice as described in SSML voice element.

Value

SSML_VOICE_GENDER_UNSPECIFIED

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

SSML_VOICE_GENDER_MALE

A male voice.

SSML_VOICE_GENDER_FEMALE

A female voice.

SSML_VOICE_GENDER_NEUTRAL

A gender-neutral voice.

State

static

number

States of the operation.

Value

STATE_UNSPECIFIED

State unspecified.

PENDING

The operation has been created.

RUNNING

The operation is currently running.

DONE

The operation is done, either cancelled or completed.

Type

static

number

Represents different types of training phrases.

Value

TYPE_UNSPECIFIED

Not specified. This value should never be used.

EXAMPLE

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

TEMPLATE

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

WebhookState

static

number

Represents the different states that webhooks can be in.

Value

WEBHOOK_STATE_UNSPECIFIED

Webhook is disabled in the agent and in the intent.

WEBHOOK_STATE_ENABLED

Webhook is enabled in the agent and in the intent.

WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING

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

Abstract types

Agent

static

Represents a conversational agent.

Properties

Parameter

parent

string

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

displayName

string

Required. The name of this agent.

defaultLanguageCode

string

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.

supportedLanguageCodes

Array of string

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

timeZone

string

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

description

string

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

avatarUri

string

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

enableLogging

boolean

Optional. Determines whether this agent should log conversation queries.

matchMode

number

Optional. Determines how intents are detected from user queries.

The number should be among the values of MatchMode

classificationThreshold

number

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.

See also

google.cloud.dialogflow.v2beta1.Agent definition in proto format

Answer

static

An answer from Knowledge Connector.

Properties

Parameter

source

string

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

faqQuestion

string

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

answer

string

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

matchConfidenceLevel

number

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

matchConfidence

number

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.

See also

google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer definition in proto format

BasicCard

static

The basic card message. Useful for displaying information.

Properties

Parameter

title

string

Optional. The title of the card.

subtitle

string

Optional. The subtitle of the card.

formattedText

string

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

image

Object

Optional. The image for the card.

This object should have the same structure as Image

buttons

Array of Object

Optional. The collection of card buttons.

This object should have the same structure as Button

See also

google.cloud.dialogflow.v2beta1.Intent.Message.BasicCard definition in proto format

BatchCreateEntitiesRequest

static

The request message for EntityTypes.BatchCreateEntities.

Properties

Parameter

parent

string

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

entities

Array of Object

Required. The entities to create.

This object should have the same structure as Entity

languageCode

string

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.

See also

google.cloud.dialogflow.v2beta1.BatchCreateEntitiesRequest definition in proto format

BatchDeleteEntitiesRequest

static

The request message for EntityTypes.BatchDeleteEntities.

Properties

Parameter

parent

string

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

entityValues

Array of string

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

languageCode

string

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.

See also

google.cloud.dialogflow.v2beta1.BatchDeleteEntitiesRequest definition in proto format

BatchDeleteEntityTypesRequest

static

The request message for EntityTypes.BatchDeleteEntityTypes.

Properties

Parameter

parent

string

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

entityTypeNames

Array of string

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

See also

google.cloud.dialogflow.v2beta1.BatchDeleteEntityTypesRequest definition in proto format

BatchDeleteIntentsRequest

static

The request message for Intents.BatchDeleteIntents.

Properties

Parameter

parent

string

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

intents

Array of Object

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

This object should have the same structure as Intent

See also

google.cloud.dialogflow.v2beta1.BatchDeleteIntentsRequest definition in proto format

BatchUpdateEntitiesRequest

static

The request message for EntityTypes.BatchUpdateEntities.

Properties

Parameter

parent

string

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

entities

Array of Object

Required. The entities to update or create.

This object should have the same structure as Entity

languageCode

string

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.

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.BatchUpdateEntitiesRequest definition in proto format

BatchUpdateEntityTypesRequest

static

The request message for EntityTypes.BatchUpdateEntityTypes.

Properties

Parameter

parent

string

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

entityTypeBatchUri

string

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

entityTypeBatchInline

Object

The collection of entity types to update or create.

This object should have the same structure as EntityTypeBatch

languageCode

string

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.

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesRequest definition in proto format

BatchUpdateEntityTypesResponse

static

The response message for EntityTypes.BatchUpdateEntityTypes.

Property

Parameter

entityTypes

Array of Object

The collection of updated or created entity types.

This object should have the same structure as EntityType

See also

google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse definition in proto format

BatchUpdateIntentsRequest

static

The request message for Intents.BatchUpdateIntents.

Properties

Parameter

parent

string

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

intentBatchUri

string

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

intentBatchInline

Object

The collection of intents to update or create.

This object should have the same structure as IntentBatch

languageCode

string

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.

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

intentView

number

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

The number should be among the values of IntentView

See also

google.cloud.dialogflow.v2beta1.BatchUpdateIntentsRequest definition in proto format

BatchUpdateIntentsResponse

static

The response message for Intents.BatchUpdateIntents.

Property

Parameter

intents

Array of Object

The collection of updated or created intents.

This object should have the same structure as Intent

See also

google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse definition in proto format

Button

static

Optional. Contains information about a button.

Properties

Parameter

text

string

Optional. The text to show on the button.

postback

string

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

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Card.Button definition in proto format

Button

static

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

Properties

Parameter

title

string

Required. The title of the button.

openUriAction

Object

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

This object should have the same structure as OpenUriAction

See also

google.cloud.dialogflow.v2beta1.Intent.Message.BasicCard.Button definition in proto format

Card

static

The card response message.

Properties

Parameter

title

string

Optional. The title of the card.

subtitle

string

Optional. The subtitle of the card.

imageUri

string

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

buttons

Array of Object

Optional. The collection of card buttons.

This object should have the same structure as Button

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Card definition in proto format

CarouselSelect

static

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

Property

Parameter

items

Array of Object

Required. Carousel items.

This object should have the same structure as Item

See also

google.cloud.dialogflow.v2beta1.Intent.Message.CarouselSelect definition in proto format

Context

static

Represents a context.

Properties

Parameter

name

string

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.

lifespanCount

number

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

parameters

Object

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

This object should have the same structure as Struct

See also

google.cloud.dialogflow.v2beta1.Context definition in proto format

CreateContextRequest

static

The request message for Contexts.CreateContext.

Properties

Parameter

parent

string

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

context

Object

Required. The context to create.

This object should have the same structure as Context

See also

google.cloud.dialogflow.v2beta1.CreateContextRequest definition in proto format

CreateDocumentRequest

static

Request message for Documents.CreateDocument.

Properties

Parameter

parent

string

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

document

Object

Required. The document to create.

This object should have the same structure as Document

See also

google.cloud.dialogflow.v2beta1.CreateDocumentRequest definition in proto format

CreateEntityTypeRequest

static

The request message for EntityTypes.CreateEntityType.

Properties

Parameter

parent

string

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

entityType

Object

Required. The entity type to create.

This object should have the same structure as EntityType

languageCode

string

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.

See also

google.cloud.dialogflow.v2beta1.CreateEntityTypeRequest definition in proto format

CreateIntentRequest

static

The request message for Intents.CreateIntent.

Properties

Parameter

parent

string

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

intent

Object

Required. The intent to create.

This object should have the same structure as Intent

languageCode

string

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.

intentView

number

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

The number should be among the values of IntentView

See also

google.cloud.dialogflow.v2beta1.CreateIntentRequest definition in proto format

CreateKnowledgeBaseRequest

static

Request message for KnowledgeBases.CreateKnowledgeBase.

Properties

Parameter

parent

string

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

knowledgeBase

Object

Required. The knowledge base to create.

This object should have the same structure as KnowledgeBase

See also

google.cloud.dialogflow.v2beta1.CreateKnowledgeBaseRequest definition in proto format

CreateSessionEntityTypeRequest

static

The request message for SessionEntityTypes.CreateSessionEntityType.

Properties

Parameter

parent

string

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.

sessionEntityType

Object

Required. The session entity type to create.

This object should have the same structure as SessionEntityType

See also

google.cloud.dialogflow.v2beta1.CreateSessionEntityTypeRequest definition in proto format

DeleteAllContextsRequest

static

The request message for Contexts.DeleteAllContexts.

Property

Parameter

parent

string

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.

See also

google.cloud.dialogflow.v2beta1.DeleteAllContextsRequest definition in proto format

DeleteContextRequest

static

The request message for Contexts.DeleteContext.

Property

Parameter

name

string

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.

See also

google.cloud.dialogflow.v2beta1.DeleteContextRequest definition in proto format

DeleteDocumentRequest

static

Request message for Documents.DeleteDocument.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.DeleteDocumentRequest definition in proto format

DeleteEntityTypeRequest

static

The request message for EntityTypes.DeleteEntityType.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.DeleteEntityTypeRequest definition in proto format

DeleteIntentRequest

static

The request message for Intents.DeleteIntent.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.DeleteIntentRequest definition in proto format

DeleteKnowledgeBaseRequest

static

Request message for KnowledgeBases.DeleteKnowledgeBase.

Properties

Parameter

name

string

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

force

boolean

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

See also

google.cloud.dialogflow.v2beta1.DeleteKnowledgeBaseRequest definition in proto format

DeleteSessionEntityTypeRequest

static

The request message for SessionEntityTypes.DeleteSessionEntityType.

Property

Parameter

name

string

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.

See also

google.cloud.dialogflow.v2beta1.DeleteSessionEntityTypeRequest definition in proto format

DetectIntentRequest

static

The request to detect user's intent.

Properties

Parameter

session

string

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.

queryParams

Object

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

queryInput

Object

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

outputAudioConfig

Object

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

inputAudio

string

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.

See also

google.cloud.dialogflow.v2beta1.DetectIntentRequest definition in proto format

DetectIntentResponse

static

The message returned from the DetectIntent method.

Properties

Parameter

responseId

string

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

queryResult

Object

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

alternativeQueryResults

Array of Object

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

webhookStatus

Object

Specifies the status of the webhook request.

This object should have the same structure as Status

outputAudio

string

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.

outputAudioConfig

Object

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

This object should have the same structure as OutputAudioConfig

See also

google.cloud.dialogflow.v2beta1.DetectIntentResponse definition in proto format

Document

static

A document resource.

Note: resource projects.agent.knowledgeBases.documents is deprecated, please use projects.knowledgeBases.documents instead.

Properties

Parameter

name

string

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

displayName

string

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

mimeType

string

Required. The MIME type of this document.

knowledgeTypes

Array of number

Required. The knowledge type of document content.

The number should be among the values of KnowledgeType

contentUri

string

The URI where the file content is located.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

content

string

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.

rawContent

string

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

See also

google.cloud.dialogflow.v2beta1.Document definition in proto format

Entity

static

An entity entry for an associated entity type.

Properties

Parameter

value

string

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

For KIND_MAP entity types:

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

    For KIND_LIST entity types:

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

synonyms

Array of string

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

For KIND_LIST entity types:

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

google.cloud.dialogflow.v2beta1.EntityType.Entity definition in proto format

EntityType

static

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

Properties

Parameter

name

string

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

displayName

string

Required. The name of the entity type.

kind

number

Required. Indicates the kind of entity type.

The number should be among the values of Kind

autoExpansionMode

number

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

The number should be among the values of AutoExpansionMode

entities

Array of Object

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

This object should have the same structure as Entity

See also

google.cloud.dialogflow.v2beta1.EntityType definition in proto format

EntityTypeBatch

static

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

Property

Parameter

entityTypes

Array of Object

A collection of entity types.

This object should have the same structure as EntityType

See also

google.cloud.dialogflow.v2beta1.EntityTypeBatch definition in proto format

EventInput

static

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

Properties

Parameter

name

string

Required. The unique identifier of the event.

parameters

Object

Optional. The collection of parameters associated with the event.

This object should have the same structure as Struct

languageCode

string

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.

See also

google.cloud.dialogflow.v2beta1.EventInput definition in proto format

ExportAgentRequest

static

The request message for Agents.ExportAgent.

Properties

Parameter

parent

string

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

agentUri

string

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

See also

google.cloud.dialogflow.v2beta1.ExportAgentRequest definition in proto format

ExportAgentResponse

static

The response message for Agents.ExportAgent.

Properties

Parameter

agentUri

string

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

agentContent

string

The exported agent.

Example for how to export an agent to a zip file via a command line:

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>

See also

google.cloud.dialogflow.v2beta1.ExportAgentResponse definition in proto format

FollowupIntentInfo

static

Represents a single followup intent in the chain.

Properties

Parameter

followupIntentName

string

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

parentFollowupIntentName

string

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

See also

google.cloud.dialogflow.v2beta1.Intent.FollowupIntentInfo definition in proto format

GetAgentRequest

static

The request message for Agents.GetAgent.

Property

Parameter

parent

string

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

See also

google.cloud.dialogflow.v2beta1.GetAgentRequest definition in proto format

GetContextRequest

static

The request message for Contexts.GetContext.

Property

Parameter

name

string

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.

See also

google.cloud.dialogflow.v2beta1.GetContextRequest definition in proto format

GetDocumentRequest

static

Request message for Documents.GetDocument.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.GetDocumentRequest definition in proto format

GetEntityTypeRequest

static

The request message for EntityTypes.GetEntityType.

Properties

Parameter

name

string

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

languageCode

string

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.

See also

google.cloud.dialogflow.v2beta1.GetEntityTypeRequest definition in proto format

GetIntentRequest

static

The request message for Intents.GetIntent.

Properties

Parameter

name

string

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

languageCode

string

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.

intentView

number

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

The number should be among the values of IntentView

See also

google.cloud.dialogflow.v2beta1.GetIntentRequest definition in proto format

GetKnowledgeBaseRequest

static

Request message for KnowledgeBase.GetDocument.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.GetKnowledgeBaseRequest definition in proto format

GetSessionEntityTypeRequest

static

The request message for SessionEntityTypes.GetSessionEntityType.

Property

Parameter

name

string

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.

See also

google.cloud.dialogflow.v2beta1.GetSessionEntityTypeRequest definition in proto format

Image

static

The image response message.

Properties

Parameter

imageUri

string

Optional. The public URI to an image file.

accessibilityText

string

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

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Image definition in proto format

ImportAgentRequest

static

The request message for Agents.ImportAgent.

Properties

Parameter

parent

string

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

agentUri

string

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

agentContent

string

The agent to import.

Example for how to import an agent via the command line:

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)'
     }"

See also

google.cloud.dialogflow.v2beta1.ImportAgentRequest definition in proto format

InputAudioConfig

static

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

Properties

Parameter

audioEncoding

number

Required. Audio encoding of the audio content to process.

The number should be among the values of AudioEncoding

sampleRateHertz

number

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

languageCode

string

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.

phraseHints

Array of string

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

model

string

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

modelVariant

number

Optional. Which variant of the Speech model to use.

The number should be among the values of SpeechModelVariant

See also

google.cloud.dialogflow.v2beta1.InputAudioConfig definition in proto format

Intent

static

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

Properties

Parameter

name

string

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

displayName

string

Required. The name of this intent.

webhookState

number

Optional. Indicates whether webhooks are enabled for the intent.

The number should be among the values of WebhookState

priority

number

Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000.

Negative numbers mean that the intent is disabled.

isFallback

boolean

Optional. Indicates whether this is a fallback intent.

mlEnabled

boolean

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.

mlDisabled

boolean

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.

endInteraction

boolean

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.

inputContextNames

Array of string

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

events

Array of string

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.

trainingPhrases

Array of Object

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

This object should have the same structure as TrainingPhrase

action

string

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

outputContexts

Array of Object

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

resetContexts

boolean

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

parameters

Array of Object

Optional. The collection of parameters associated with the intent.

This object should have the same structure as Parameter

messages

Array of Object

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

This object should have the same structure as Message

defaultResponsePlatforms

Array of number

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

The number should be among the values of Platform

rootFollowupIntentName

string

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

parentFollowupIntentName

string

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

followupIntentInfo

Array of Object

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

See also

google.cloud.dialogflow.v2beta1.Intent definition in proto format

IntentBatch

static

This message is a wrapper around a collection of intents.

Property

Parameter

intents

Array of Object

A collection of intents.

This object should have the same structure as Intent

See also

google.cloud.dialogflow.v2beta1.IntentBatch definition in proto format

Item

static

An item in the carousel.

Properties

Parameter

info

Object

Required. Additional info about the option item.

This object should have the same structure as SelectItemInfo

title

string

Required. Title of the carousel item.

description

string

Optional. The body text of the card.

image

Object

Optional. The image to display.

This object should have the same structure as Image

See also

google.cloud.dialogflow.v2beta1.Intent.Message.CarouselSelect.Item definition in proto format

Item

static

An item in the list.

Properties

Parameter

info

Object

Required. Additional information about this option.

This object should have the same structure as SelectItemInfo

title

string

Required. The title of the list item.

description

string

Optional. The main text describing the item.

image

Object

Optional. The image to display.

This object should have the same structure as Image

See also

google.cloud.dialogflow.v2beta1.Intent.Message.ListSelect.Item definition in proto format

KnowledgeAnswers

static

Represents the result of querying a Knowledge base.

Property

Parameter

answers

Array of Object

A list of answers from Knowledge Connector.

This object should have the same structure as Answer

See also

google.cloud.dialogflow.v2beta1.KnowledgeAnswers definition in proto format

KnowledgeBase

static

Represents knowledge base resource.

Note: resource projects.agent.knowledgeBases is deprecated, please use projects.knowledgeBases instead.

Properties

Parameter

name

string

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

displayName

string

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

See also

google.cloud.dialogflow.v2beta1.KnowledgeBase definition in proto format

KnowledgeOperationMetadata

static

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

Property

Parameter

state

number

Required. The current state of this operation.

The number should be among the values of State

See also

google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata definition in proto format

LinkOutSuggestion

static

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

Properties

Parameter

destinationName

string

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

uri

string

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

See also

google.cloud.dialogflow.v2beta1.Intent.Message.LinkOutSuggestion definition in proto format

ListContextsRequest

static

The request message for Contexts.ListContexts.

Properties

Parameter

parent

string

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.

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListContextsRequest definition in proto format

ListContextsResponse

static

The response message for Contexts.ListContexts.

Properties

Parameter

contexts

Array of Object

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

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListContextsResponse definition in proto format

ListDocumentsRequest

static

Request message for Documents.ListDocuments.

Properties

Parameter

parent

string

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

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListDocumentsRequest definition in proto format

ListDocumentsResponse

static

Response message for Documents.ListDocuments.

Properties

Parameter

documents

Array of Object

The list of documents.

This object should have the same structure as Document

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListDocumentsResponse definition in proto format

ListEntityTypesRequest

static

The request message for EntityTypes.ListEntityTypes.

Properties

Parameter

parent

string

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

languageCode

string

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.

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListEntityTypesRequest definition in proto format

ListEntityTypesResponse

static

The response message for EntityTypes.ListEntityTypes.

Properties

Parameter

entityTypes

Array of Object

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

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListEntityTypesResponse definition in proto format

ListIntentsRequest

static

The request message for Intents.ListIntents.

Properties

Parameter

parent

string

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

languageCode

string

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.

intentView

number

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

The number should be among the values of IntentView

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListIntentsRequest definition in proto format

ListIntentsResponse

static

The response message for Intents.ListIntents.

Properties

Parameter

intents

Array of Object

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

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListIntentsResponse definition in proto format

ListKnowledgeBasesRequest

static

Request message for KnowledgeBases.ListKnowledgeBases.

Properties

Parameter

parent

string

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

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListKnowledgeBasesRequest definition in proto format

ListKnowledgeBasesResponse

static

Response message for KnowledgeBases.ListKnowledgeBases.

Properties

Parameter

knowledgeBases

Array of Object

The list of knowledge bases.

This object should have the same structure as KnowledgeBase

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListKnowledgeBasesResponse definition in proto format

ListSelect

static

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

Properties

Parameter

title

string

Optional. The overall title of the list.

items

Array of Object

Required. List items.

This object should have the same structure as Item

See also

google.cloud.dialogflow.v2beta1.Intent.Message.ListSelect definition in proto format

ListSessionEntityTypesRequest

static

The request message for SessionEntityTypes.ListSessionEntityTypes.

Properties

Parameter

parent

string

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.

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListSessionEntityTypesRequest definition in proto format

ListSessionEntityTypesResponse

static

The response message for SessionEntityTypes.ListSessionEntityTypes.

Properties

Parameter

sessionEntityTypes

Array of Object

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

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.ListSessionEntityTypesResponse definition in proto format

Message

static

Corresponds to the Response field in the Dialogflow console.

Properties

Parameter

text

Object

Returns a text response.

This object should have the same structure as Text

image

Object

Displays an image.

This object should have the same structure as Image

quickReplies

Object

Displays quick replies.

This object should have the same structure as QuickReplies

card

Object

Displays a card.

This object should have the same structure as Card

payload

Object

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

simpleResponses

Object

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

This object should have the same structure as SimpleResponses

basicCard

Object

Displays a basic card for Actions on Google.

This object should have the same structure as BasicCard

suggestions

Object

Displays suggestion chips for Actions on Google.

This object should have the same structure as Suggestions

linkOutSuggestion

Object

Displays a link out suggestion chip for Actions on Google.

This object should have the same structure as LinkOutSuggestion

listSelect

Object

Displays a list card for Actions on Google.

This object should have the same structure as ListSelect

carouselSelect

Object

Displays a carousel card for Actions on Google.

This object should have the same structure as CarouselSelect

telephonyPlayAudio

Object

Plays audio from a file in Telephony Gateway.

This object should have the same structure as TelephonyPlayAudio

telephonySynthesizeSpeech

Object

Synthesizes speech in Telephony Gateway.

This object should have the same structure as TelephonySynthesizeSpeech

telephonyTransferCall

Object

Transfers the call in Telephony Gateway.

This object should have the same structure as TelephonyTransferCall

platform

number

Optional. The platform that this message is intended for.

The number should be among the values of Platform

See also

google.cloud.dialogflow.v2beta1.Intent.Message definition in proto format

OpenUriAction

static

Opens the given URI.

Property

Parameter

uri

string

Required. The HTTP or HTTPS scheme URI.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.BasicCard.Button.OpenUriAction definition in proto format

OutputAudioConfig

static

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

Properties

Parameter

audioEncoding

number

Required. Audio encoding of the synthesized audio content.

The number should be among the values of OutputAudioEncoding

sampleRateHertz

number

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

synthesizeSpeechConfig

Object

Optional. Configuration of how speech should be synthesized.

This object should have the same structure as SynthesizeSpeechConfig

See also

google.cloud.dialogflow.v2beta1.OutputAudioConfig definition in proto format

Parameter

static

Represents intent parameters.

Properties

Parameter

name

string

The unique identifier of this parameter.

displayName

string

Required. The name of the parameter.

value

string

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.

defaultValue

string

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.

entityTypeDisplayName

string

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

mandatory

boolean

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

prompts

Array of string

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

isList

boolean

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

See also

google.cloud.dialogflow.v2beta1.Intent.Parameter definition in proto format

Part

static

Represents a part of a training phrase.

Properties

Parameter

text

string

Required. The text for this part.

entityType

string

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

alias

string

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.

userDefined

boolean

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.

See also

google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase.Part definition in proto format

QueryInput

static

Represents the query input. It can contain either:

  1. An audio config which instructs the speech recognizer how to process the speech audio.

  2. A conversational query in the form of text,.

  3. An event that specifies which intent to trigger.

Properties

Parameter

audioConfig

Object

Instructs the speech recognizer how to process the speech audio.

This object should have the same structure as InputAudioConfig

text

Object

The natural language text to be processed.

This object should have the same structure as TextInput

event

Object

The event to be processed.

This object should have the same structure as EventInput

See also

google.cloud.dialogflow.v2beta1.QueryInput definition in proto format

QueryParameters

static

Represents the parameters of the conversational query.

Properties

Parameter

timeZone

string

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.

geoLocation

Object

Optional. The geo location of this conversational query.

This object should have the same structure as LatLng

contexts

Array of Object

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

This object should have the same structure as Context

resetContexts

boolean

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

sessionEntityTypes

Array of Object

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

payload

Object

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

knowledgeBaseNames

Array of string

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

sentimentAnalysisRequestConfig

Object

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

See also

google.cloud.dialogflow.v2beta1.QueryParameters definition in proto format

QueryResult

static

Represents the result of conversational query or event processing.

Properties

Parameter

queryText

string

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.

languageCode

string

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

speechRecognitionConfidence

number

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

This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.

action

string

The action name from the matched intent.

parameters

Object

The collection of extracted parameters.

This object should have the same structure as Struct

allRequiredParamsPresent

boolean

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.

fulfillmentText

string

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

fulfillmentMessages

Array of Object

The collection of rich messages to present to the user.

This object should have the same structure as Message

webhookSource

string

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.

webhookPayload

Object

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

outputContexts

Array of Object

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

intent

Object

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.

This object should have the same structure as Intent

intentDetectionConfidence

number

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.

diagnosticInfo

Object

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

sentimentAnalysisResult

Object

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

knowledgeAnswers

Object

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

This object should have the same structure as KnowledgeAnswers

See also

google.cloud.dialogflow.v2beta1.QueryResult definition in proto format

QuickReplies

static

The quick replies response message.

Properties

Parameter

title

string

Optional. The title of the collection of quick replies.

quickReplies

Array of string

Optional. The collection of quick replies.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.QuickReplies definition in proto format

ReloadDocumentRequest

static

Request message for Documents.ReloadDocument.

Property

Parameter

name

string

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

See also

google.cloud.dialogflow.v2beta1.ReloadDocumentRequest definition in proto format

RestoreAgentRequest

static

The request message for Agents.RestoreAgent.

Properties

Parameter

parent

string

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

agentUri

string

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

agentContent

string

The agent to restore.

Example for how to restore an agent via the command line:

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)'
     }"

See also

google.cloud.dialogflow.v2beta1.RestoreAgentRequest definition in proto format

SearchAgentsRequest

static

The request message for Agents.SearchAgents.

Properties

Parameter

parent

string

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

pageSize

number

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

pageToken

string

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

See also

google.cloud.dialogflow.v2beta1.SearchAgentsRequest definition in proto format

SearchAgentsResponse

static

The response message for Agents.SearchAgents.

Properties

Parameter

agents

Array of Object

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

nextPageToken

string

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

See also

google.cloud.dialogflow.v2beta1.SearchAgentsResponse definition in proto format

SelectItemInfo

static

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

Properties

Parameter

key

string

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

synonyms

Array of string

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

See also

google.cloud.dialogflow.v2beta1.Intent.Message.SelectItemInfo definition in proto format

Sentiment

static

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

Properties

Parameter

score

number

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

magnitude

number

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

See also

google.cloud.dialogflow.v2beta1.Sentiment definition in proto format

SentimentAnalysisRequestConfig

static

Configures the types of sentiment analysis to perform.

Property

Parameter

analyzeQueryTextSentiment

boolean

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

See also

google.cloud.dialogflow.v2beta1.SentimentAnalysisRequestConfig definition in proto format

SentimentAnalysisResult

static

The result of sentiment analysis as configured by sentiment_analysis_request_config.

Property

Parameter

queryTextSentiment

Object

The sentiment analysis result for query_text.

This object should have the same structure as Sentiment

See also

google.cloud.dialogflow.v2beta1.SentimentAnalysisResult definition in proto format

SessionEntityType

static

Represents a session entity type.

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

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

Properties

Parameter

name

string

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.

entityOverrideMode

number

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

The number should be among the values of EntityOverrideMode

entities

Array of Object

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

This object should have the same structure as Entity

See also

google.cloud.dialogflow.v2beta1.SessionEntityType definition in proto format

SimpleResponse

static

The simple response message containing speech or text.

Properties

Parameter

textToSpeech

string

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

ssml

string

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.

displayText

string

Optional. The text to display.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.SimpleResponse definition in proto format

SimpleResponses

static

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

Property

Parameter

simpleResponses

Array of Object

Required. The list of simple responses.

This object should have the same structure as SimpleResponse

See also

google.cloud.dialogflow.v2beta1.Intent.Message.SimpleResponses definition in proto format

StreamingDetectIntentRequest

static

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

Multiple request messages should be sent in order:

  1. The first message must contain session, query_input plus optionally query_params and/or single_utterance. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.

  2. If query_input was set to a streaming input audio config, all subsequent messages must contain only input_audio. Otherwise, finish the request stream.

Properties

Parameter

session

string

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.

queryParams

Object

Optional. The parameters of this query.

This object should have the same structure as QueryParameters

queryInput

Object

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

singleUtterance

boolean

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.

outputAudioConfig

Object

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

inputAudio

string

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.

See also

google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest definition in proto format

StreamingDetectIntentResponse

static

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

  1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.

  2. The next message contains response_id, query_result, alternative_query_results and optionally webhook_status if a WebHook was called.

  3. If output_audio_config was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain output_audio and output_audio_config.

Properties

Parameter

responseId

string

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

recognitionResult

Object

The result of speech recognition.

This object should have the same structure as StreamingRecognitionResult

queryResult

Object

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

alternativeQueryResults

Array of Object

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

webhookStatus

Object

Specifies the status of the webhook request.

This object should have the same structure as Status

outputAudio

string

The audio data bytes encoded as specified in the request.

outputAudioConfig

Object

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

This object should have the same structure as OutputAudioConfig

See also

google.cloud.dialogflow.v2beta1.StreamingDetectIntentResponse definition in proto format

StreamingRecognitionResult

static

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.

Example:

  1. transcript: "tube"

  2. transcript: "to be a"

  3. transcript: "to be"

  4. transcript: "to be or not to be" is_final: true

  5. transcript: " that's"

  6. transcript: " that is"

  7. message_type: MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE

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

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

In each response we populate:

  • for MESSAGE_TYPE_TRANSCRIPT: transcript and possibly is_final.

  • for MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE: only message_type.

Properties

Parameter

messageType

number

Type of the result message.

The number should be among the values of MessageType

transcript

string

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

isFinal

boolean

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

confidence

number

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.

See also

google.cloud.dialogflow.v2beta1.StreamingRecognitionResult definition in proto format

Suggestion

static

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

Property

Parameter

title

string

Required. The text shown the in the suggestion chip.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Suggestion definition in proto format

Suggestions

static

The collection of suggestions.

Property

Parameter

suggestions

Array of Object

Required. The list of suggested replies.

This object should have the same structure as Suggestion

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Suggestions definition in proto format

SynthesizeSpeechConfig

static

Configuration of how speech should be synthesized.

Properties

Parameter

speakingRate

number

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

pitch

number

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.

volumeGainDb

number

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.

effectsProfileId

Array of string

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

voice

Object

Optional. The desired voice of the synthesized audio.

This object should have the same structure as VoiceSelectionParams

See also

google.cloud.dialogflow.v2beta1.SynthesizeSpeechConfig definition in proto format

TelephonyPlayAudio

static

Plays audio from a file in Telephony Gateway.

Property

Parameter

audioUri

string

Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz.

This object must be readable by the service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API.

For audio from other sources, consider using the TelephonySynthesizeSpeech message with SSML.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.TelephonyPlayAudio definition in proto format

TelephonySynthesizeSpeech

static

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

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

Properties

Parameter

text

string

The raw text to be synthesized.

ssml

string

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

See also

google.cloud.dialogflow.v2beta1.Intent.Message.TelephonySynthesizeSpeech definition in proto format

TelephonyTransferCall

static

Transfers the call in Telephony Gateway.

Property

Parameter

phoneNumber

string

Required. The phone number to transfer the call to in E.164 format.

We currently only allow transferring to US numbers (+1xxxyyyzzzz).

See also

google.cloud.dialogflow.v2beta1.Intent.Message.TelephonyTransferCall definition in proto format

Text

static

The text response message.

Property

Parameter

text

Array of string

Optional. The collection of the agent's responses.

See also

google.cloud.dialogflow.v2beta1.Intent.Message.Text definition in proto format

TextInput

static

Represents the natural language text to be processed.

Properties

Parameter

text

string

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

languageCode

string

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

See also

google.cloud.dialogflow.v2beta1.TextInput definition in proto format

TrainAgentRequest

static

The request message for Agents.TrainAgent.

Property

Parameter

parent

string

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

See also

google.cloud.dialogflow.v2beta1.TrainAgentRequest definition in proto format

TrainingPhrase

static

Represents an example that the agent is trained on.

Properties

Parameter

name

string

Output only. The unique identifier of this training phrase.

type

number

Required. The type of the training phrase.

The number should be among the values of Type

parts

Array of Object

Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase.

Note: The API does not automatically annotate training phrases like the Dialogflow Console does.

Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated.

If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set.

If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways:

  • Part.text is set to a part of the phrase that has no parameters.
  • Part.text is set to a part of the phrase that you want to annotate, and the entity_type, alias, and user_defined fields are all set.

    This object should have the same structure as Part

timesAddedCount

number

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

See also

google.cloud.dialogflow.v2beta1.Intent.TrainingPhrase definition in proto format

UpdateContextRequest

static

The request message for Contexts.UpdateContext.

Properties

Parameter

context

Object

Required. The context to update.

This object should have the same structure as Context

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.UpdateContextRequest definition in proto format

UpdateDocumentRequest

static

Request message for Documents.UpdateDocument.

Properties

Parameter

document

Object

Required. The document to update.

This object should have the same structure as Document

updateMask

Object

Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.UpdateDocumentRequest definition in proto format

UpdateEntityTypeRequest

static

The request message for EntityTypes.UpdateEntityType.

Properties

Parameter

entityType

Object

Required. The entity type to update.

This object should have the same structure as EntityType

languageCode

string

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.

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.UpdateEntityTypeRequest definition in proto format

UpdateIntentRequest

static

The request message for Intents.UpdateIntent.

Properties

Parameter

intent

Object

Required. The intent to update.

This object should have the same structure as Intent

languageCode

string

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.

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

intentView

number

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

The number should be among the values of IntentView

See also

google.cloud.dialogflow.v2beta1.UpdateIntentRequest definition in proto format

UpdateKnowledgeBaseRequest

static

Request message for KnowledgeBases.UpdateKnowledgeBase.

Properties

Parameter

knowledgeBase

Object

Required. The knowledge base to update.

This object should have the same structure as KnowledgeBase

updateMask

Object

Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.UpdateKnowledgeBaseRequest definition in proto format

UpdateSessionEntityTypeRequest

static

The request message for SessionEntityTypes.UpdateSessionEntityType.

Properties

Parameter

sessionEntityType

Object

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.

This object should have the same structure as SessionEntityType

updateMask

Object

Optional. The mask to control which fields get updated.

This object should have the same structure as FieldMask

See also

google.cloud.dialogflow.v2beta1.UpdateSessionEntityTypeRequest definition in proto format

VoiceSelectionParams

static

Description of which voice to use for speech synthesis.

Properties

Parameter

name

string

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.

ssmlGender

number

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.

The number should be among the values of SsmlVoiceGender

See also

google.cloud.dialogflow.v2beta1.VoiceSelectionParams definition in proto format