{ "fullyEncodeReservedExpansion": true, "protocol": "rest", "baseUrl": "https://dialogflow.googleapis.com/", "documentationLink": "https://cloud.google.com/dialogflow/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/dialogflow": { "description": "View, manage and query your Dialogflow agents" } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "basePath": "", "ownerDomain": "google.com", "canonicalName": "Dialogflow", "schemas": { "GoogleLongrunningListOperationsResponse": { "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleLongrunningOperation": { "id": "GoogleLongrunningOperation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleRpcStatus": { "id": "GoogleRpcStatus", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2beta1Fulfillment": { "id": "GoogleCloudDialogflowV2beta1Fulfillment", "description": "By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "type": "string" }, "displayName": { "description": "The human-readable name of the fulfillment, unique within the agent. This field is not used for Fulfillment in an Environment.", "type": "string" }, "genericWebService": { "description": "Configuration for a generic web service.", "$ref": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService" }, "enabled": { "description": "Whether fulfillment is enabled.", "type": "boolean" }, "features": { "description": "The field defines whether the fulfillment is enabled for certain features.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1FulfillmentFeature" } } } }, "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService": { "id": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService", "description": "Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.", "type": "object", "properties": { "uri": { "description": "Required. The fulfillment URI for receiving POST requests. It must use https protocol.", "type": "string" }, "username": { "description": "The user name for HTTP Basic authentication.", "type": "string" }, "password": { "description": "The password for HTTP Basic authentication.", "type": "string" }, "requestHeaders": { "description": "The HTTP request headers to send together with fulfillment requests.", "type": "object", "additionalProperties": { "type": "string" } }, "isCloudFunction": { "description": "Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.", "deprecated": true, "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1FulfillmentFeature": { "id": "GoogleCloudDialogflowV2beta1FulfillmentFeature", "description": "Whether fulfillment is enabled for the specific feature.", "type": "object", "properties": { "type": { "description": "The type of the feature that enabled for fulfillment.", "type": "string", "enumDescriptions": [ "Feature type not specified.", "Fulfillment is enabled for SmallTalk." ], "enum": [ "TYPE_UNSPECIFIED", "SMALLTALK" ] } } }, "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse": { "id": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse", "description": "The response message for Environments.ListEnvironments.", "type": "object", "properties": { "environments": { "description": "The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Environment" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Environment": { "id": "GoogleCloudDialogflowV2beta1Environment", "description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "readOnly": true, "type": "string" }, "description": { "description": "Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, "agentVersion": { "description": "Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "type": "string" }, "state": { "description": "Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", "readOnly": true, "type": "string", "enumDescriptions": [ "Not specified. This value is not used.", "Stopped.", "Loading.", "Running." ], "enum": [ "STATE_UNSPECIFIED", "STOPPED", "LOADING", "RUNNING" ] }, "updateTime": { "description": "Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", "readOnly": true, "type": "string", "format": "google-datetime" }, "textToSpeechSettings": { "description": "Optional. Text to speech settings for this environment.", "$ref": "GoogleCloudDialogflowV2beta1TextToSpeechSettings" }, "fulfillment": { "description": "Optional. The fulfillment settings to use for this environment.", "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" } } }, "GoogleCloudDialogflowV2beta1TextToSpeechSettings": { "id": "GoogleCloudDialogflowV2beta1TextToSpeechSettings", "description": "Instructs the speech synthesizer on how to generate the output audio content.", "type": "object", "properties": { "enableTextToSpeech": { "description": "Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.", "type": "boolean" }, "outputAudioEncoding": { "description": "Required. Audio encoding of the synthesized audio content.", "type": "string", "enumDescriptions": [ "Not specified.", "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "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.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." ], "enum": [ "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", "OUTPUT_AUDIO_ENCODING_LINEAR_16", "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", "OUTPUT_AUDIO_ENCODING_MULAW" ] }, "sampleRateHertz": { "description": "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).", "type": "integer", "format": "int32" }, "synthesizeSpeechConfigs": { "description": "Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig" } } } }, "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig": { "id": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig", "description": "Configuration of how speech should be synthesized.", "type": "object", "properties": { "speakingRate": { "description": "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 \u003c 0.25 or \u003e 4.0 will return an error.", "type": "number", "format": "double" }, "pitch": { "description": "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.", "type": "number", "format": "double" }, "volumeGainDb": { "description": "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.", "type": "number", "format": "double" }, "effectsProfileId": { "description": "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.", "type": "array", "items": { "type": "string" } }, "voice": { "description": "Optional. The desired voice of the synthesized audio.", "$ref": "GoogleCloudDialogflowV2beta1VoiceSelectionParams" } } }, "GoogleCloudDialogflowV2beta1VoiceSelectionParams": { "id": "GoogleCloudDialogflowV2beta1VoiceSelectionParams", "description": "Description of which voice to use for speech synthesis.", "type": "object", "properties": { "name": { "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).", "type": "string" }, "ssmlGender": { "description": "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.", "type": "string", "enumDescriptions": [ "An unspecified gender, which means that the client doesn't care which gender the selected voice will have.", "A male voice.", "A female voice.", "A gender-neutral voice." ], "enum": [ "SSML_VOICE_GENDER_UNSPECIFIED", "SSML_VOICE_GENDER_MALE", "SSML_VOICE_GENDER_FEMALE", "SSML_VOICE_GENDER_NEUTRAL" ] } } }, "GoogleCloudDialogflowV2beta1EnvironmentHistory": { "id": "GoogleCloudDialogflowV2beta1EnvironmentHistory", "description": "The response message for Environments.GetEnvironmentHistory.", "type": "object", "properties": { "parent": { "description": "Output only. The name of the environment this history is for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "readOnly": true, "type": "string" }, "entries": { "description": "Output only. The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry" } }, "nextPageToken": { "description": "Output only. Token to retrieve the next page of results, or empty if there are no more results in the list.", "readOnly": true, "type": "string" } } }, "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry": { "id": "GoogleCloudDialogflowV2beta1EnvironmentHistoryEntry", "description": "Represents an environment history entry.", "type": "object", "properties": { "agentVersion": { "description": "The agent version loaded into this environment history entry.", "type": "string" }, "description": { "description": "The developer-provided description for this environment history entry.", "type": "string" }, "createTime": { "description": "The creation time of this environment history entry.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1Agent": { "id": "GoogleCloudDialogflowV2beta1Agent", "description": "A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). ", "type": "object", "properties": { "parent": { "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", "type": "string" }, "displayName": { "description": "Required. The name of this agent.", "type": "string" }, "defaultLanguageCode": { "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.", "type": "string" }, "supportedLanguageCodes": { "description": "Optional. The list of all languages supported by this agent (except for the `default_language_code`).", "type": "array", "items": { "type": "string" } }, "timeZone": { "description": "Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" }, "description": { "description": "Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, "avatarUri": { "description": "Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", "type": "string" }, "enableLogging": { "description": "Optional. Determines whether this agent should log conversation queries.", "type": "boolean" }, "matchMode": { "description": "Optional. Determines how intents are detected from user queries.", "deprecated": true, "type": "string", "enumDescriptions": [ "Not specified.", "Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.", "Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large custom entities." ], "enum": [ "MATCH_MODE_UNSPECIFIED", "MATCH_MODE_HYBRID", "MATCH_MODE_ML_ONLY" ] }, "classificationThreshold": { "description": "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.", "type": "number", "format": "float" }, "apiVersion": { "description": "Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.", "type": "string", "enumDescriptions": [ "Not specified.", "Legacy V1 API.", "V2 API.", "V2beta1 API." ], "enum": [ "API_VERSION_UNSPECIFIED", "API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1" ] }, "tier": { "description": "Optional. The agent tier. If not specified, TIER_STANDARD is assumed.", "type": "string", "enumDescriptions": [ "Not specified. This value should never be used.", "Trial Edition, previously known as Standard Edition.", "Essentials Edition, previously known as Enterprise Essential Edition.", "Essentials Edition (same as TIER_ENTERPRISE), previously known as Enterprise Plus Edition." ], "enumDeprecated": [ false, false, false, true ], "enum": [ "TIER_UNSPECIFIED", "TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS" ] } } }, "GoogleCloudDialogflowV2beta1SearchAgentsResponse": { "id": "GoogleCloudDialogflowV2beta1SearchAgentsResponse", "description": "The response message for Agents.SearchAgents.", "type": "object", "properties": { "agents": { "description": "The list of agents. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Agent" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1TrainAgentRequest": { "id": "GoogleCloudDialogflowV2beta1TrainAgentRequest", "description": "The request message for Agents.TrainAgent.", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2beta1ExportAgentRequest": { "id": "GoogleCloudDialogflowV2beta1ExportAgentRequest", "description": "The request message for Agents.ExportAgent.", "type": "object", "properties": { "agentUri": { "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ImportAgentRequest": { "id": "GoogleCloudDialogflowV2beta1ImportAgentRequest", "description": "The request message for Agents.ImportAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with \"gs://\". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" }, "agentContent": { "description": "Zip compressed raw byte content for agent.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1RestoreAgentRequest": { "id": "GoogleCloudDialogflowV2beta1RestoreAgentRequest", "description": "The request message for Agents.RestoreAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with \"gs://\". Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", "type": "string" }, "agentContent": { "description": "Zip compressed raw byte content for agent.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1ValidationResult": { "id": "GoogleCloudDialogflowV2beta1ValidationResult", "description": "Represents the output of agent validation.", "type": "object", "properties": { "validationErrors": { "description": "Contains all validation errors.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1ValidationError" } } } }, "GoogleCloudDialogflowV2beta1ValidationError": { "id": "GoogleCloudDialogflowV2beta1ValidationError", "description": "Represents a single validation error.", "type": "object", "properties": { "severity": { "description": "The severity of the error.", "type": "string", "enumDescriptions": [ "Not specified. This value should never be used.", "The agent doesn't follow Dialogflow best practices.", "The agent may not behave as expected.", "The agent may experience partial failures.", "The agent may completely fail." ], "enum": [ "SEVERITY_UNSPECIFIED", "INFO", "WARNING", "ERROR", "CRITICAL" ] }, "entries": { "description": "The names of the entries that the error is associated with. Format: - `projects//agent`, if the error is associated with the entire agent. - `projects//agent/intents/`, if the error is associated with certain intents. - `projects//agent/intents//trainingPhrases/`, if the error is associated with certain intent training phrases. - `projects//agent/intents//parameters/`, if the error is associated with certain intent parameters. - `projects//agent/entities/`, if the error is associated with certain entities.", "type": "array", "items": { "type": "string" } }, "errorMessage": { "description": "The detailed error message.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListContextsResponse": { "id": "GoogleCloudDialogflowV2beta1ListContextsResponse", "description": "The response message for Contexts.ListContexts.", "type": "object", "properties": { "contexts": { "description": "The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Context": { "id": "GoogleCloudDialogflowV2beta1Context", "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "lifespanCount": { "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", "type": "integer", "format": "int32" }, "parameters": { "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowV2beta1ListIntentsResponse": { "id": "GoogleCloudDialogflowV2beta1ListIntentsResponse", "description": "The response message for Intents.ListIntents.", "type": "object", "properties": { "intents": { "description": "The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Intent" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Intent": { "id": "GoogleCloudDialogflowV2beta1Intent", "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "type": "object", "properties": { "name": { "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "type": "string" }, "displayName": { "description": "Required. The name of this intent.", "type": "string" }, "webhookState": { "description": "Optional. Indicates whether webhooks are enabled for the intent.", "type": "string", "enumDescriptions": [ "Webhook is disabled in the agent and in the intent.", "Webhook is enabled in the agent and in the intent.", "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." ], "enum": [ "WEBHOOK_STATE_UNSPECIFIED", "WEBHOOK_STATE_ENABLED", "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" ] }, "priority": { "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", "type": "integer", "format": "int32" }, "isFallback": { "description": "Optional. Indicates whether this is a fallback intent.", "type": "boolean" }, "mlEnabled": { "description": "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.", "deprecated": true, "type": "boolean" }, "mlDisabled": { "description": "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.", "type": "boolean" }, "liveAgentHandoff": { "description": "Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.", "type": "boolean" }, "endInteraction": { "description": "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.", "type": "boolean" }, "inputContextNames": { "description": "Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`", "type": "array", "items": { "type": "string" } }, "events": { "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", "type": "array", "items": { "type": "string" } }, "trainingPhrases": { "description": "Optional. The collection of examples that the agent is trained on.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase" } }, "action": { "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", "type": "string" }, "outputContexts": { "description": "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//agent/sessions/-/contexts/`.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" } }, "resetContexts": { "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", "type": "boolean" }, "parameters": { "description": "Optional. The collection of parameters associated with the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentParameter" } }, "messages": { "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" } }, "defaultResponsePlatforms": { "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not specified.", "Facebook.", "Slack.", "Telegram.", "Kik.", "Skype.", "Line.", "Viber.", "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "Telephony Gateway.", "Google Hangouts." ], "enum": [ "PLATFORM_UNSPECIFIED", "FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "TELEPHONY", "GOOGLE_HANGOUTS" ] } }, "rootFollowupIntentName": { "description": "Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.", "readOnly": true, "type": "string" }, "parentFollowupIntentName": { "description": "Optional. 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//agent/intents/`.", "type": "string" }, "followupIntentInfo": { "description": "Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo" } } } }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", "description": "Represents an example that the agent is trained on.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this training phrase.", "type": "string" }, "type": { "description": "Required. The type of the training phrase.", "type": "string", "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Note: Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases in template mode, they will be removed during training and it can cause a drop in agent performance." ], "enumDeprecated": [ false, false, true ], "enum": [ "TYPE_UNSPECIFIED", "EXAMPLE", "TEMPLATE" ] }, "parts": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart" } }, "timesAddedCount": { "description": "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": { "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart", "description": "Represents a part of a training phrase.", "type": "object", "properties": { "text": { "description": "Required. The text for this part.", "type": "string" }, "entityType": { "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", "type": "string" }, "alias": { "description": "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.", "type": "string" }, "userDefined": { "description": "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.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1IntentParameter": { "id": "GoogleCloudDialogflowV2beta1IntentParameter", "description": "Represents intent parameters.", "type": "object", "properties": { "name": { "description": "The unique identifier of this parameter.", "type": "string" }, "displayName": { "description": "Required. The name of the parameter.", "type": "string" }, "value": { "description": "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`.", "type": "string" }, "defaultValue": { "description": "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`.", "type": "string" }, "entityTypeDisplayName": { "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", "type": "string" }, "mandatory": { "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", "type": "boolean" }, "prompts": { "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", "type": "array", "items": { "type": "string" } }, "isList": { "description": "Optional. Indicates whether the parameter represents a list of values.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1IntentMessage": { "id": "GoogleCloudDialogflowV2beta1IntentMessage", "description": "Corresponds to the `Response` field in the Dialogflow console.", "type": "object", "properties": { "text": { "description": "Returns a text response.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageText" }, "image": { "description": "Displays an image.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "quickReplies": { "description": "Displays quick replies.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies" }, "card": { "description": "Displays a card.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard" }, "payload": { "description": "A custom platform-specific response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "simpleResponses": { "description": "Returns a voice or text-only response for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses" }, "basicCard": { "description": "Displays a basic card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard" }, "suggestions": { "description": "Displays suggestion chips for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions" }, "linkOutSuggestion": { "description": "Displays a link out suggestion chip for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion" }, "listSelect": { "description": "Displays a list card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect" }, "carouselSelect": { "description": "Displays a carousel card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect" }, "telephonyPlayAudio": { "description": "Plays audio from a file in Telephony Gateway.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio" }, "telephonySynthesizeSpeech": { "description": "Synthesizes speech in Telephony Gateway.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech" }, "telephonyTransferCall": { "description": "Transfers the call in Telephony Gateway.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall" }, "rbmText": { "description": "Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmText" }, "rbmStandaloneRichCard": { "description": "Standalone Rich Business Messaging (RBM) rich card response.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard" }, "rbmCarouselRichCard": { "description": "Rich Business Messaging (RBM) carousel rich card response.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard" }, "browseCarouselCard": { "description": "Browse carousel card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard" }, "tableCard": { "description": "Table card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCard" }, "mediaContent": { "description": "The media content card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent" }, "platform": { "description": "Optional. The platform that this message is intended for.", "type": "string", "enumDescriptions": [ "Not specified.", "Facebook.", "Slack.", "Telegram.", "Kik.", "Skype.", "Line.", "Viber.", "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "Telephony Gateway.", "Google Hangouts." ], "enum": [ "PLATFORM_UNSPECIFIED", "FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "TELEPHONY", "GOOGLE_HANGOUTS" ] } } }, "GoogleCloudDialogflowV2beta1IntentMessageText": { "id": "GoogleCloudDialogflowV2beta1IntentMessageText", "description": "The text response message.", "type": "object", "properties": { "text": { "description": "Optional. The collection of the agent's responses.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageImage": { "id": "GoogleCloudDialogflowV2beta1IntentMessageImage", "description": "The image response message.", "type": "object", "properties": { "imageUri": { "description": "Optional. The public URI to an image file.", "type": "string" }, "accessibilityText": { "description": "A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": { "id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies", "description": "The quick replies response message.", "type": "object", "properties": { "title": { "description": "Optional. The title of the collection of quick replies.", "type": "string" }, "quickReplies": { "description": "Optional. The collection of quick replies.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageCard", "description": "The card response message.", "type": "object", "properties": { "title": { "description": "Optional. The title of the card.", "type": "string" }, "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" }, "imageUri": { "description": "Optional. The public URI to an image file for the card.", "type": "string" }, "buttons": { "description": "Optional. The collection of card buttons.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageCardButton": { "id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton", "description": "Optional. Contains information about a button.", "type": "object", "properties": { "text": { "description": "Optional. The text to show on the button.", "type": "string" }, "postback": { "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": { "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses", "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", "type": "object", "properties": { "simpleResponses": { "description": "Required. The list of simple responses.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": { "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse", "description": "The simple response message containing speech or text.", "type": "object", "properties": { "textToSpeech": { "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", "type": "string" }, "ssml": { "description": "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.", "type": "string" }, "displayText": { "description": "Optional. The text to display.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageBasicCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard", "description": "The basic card message. Useful for displaying information.", "type": "object", "properties": { "title": { "description": "Optional. The title of the card.", "type": "string" }, "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" }, "formattedText": { "description": "Required, unless image is present. The body text of the card.", "type": "string" }, "image": { "description": "Optional. The image for the card.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "buttons": { "description": "Optional. The collection of card buttons.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton", "description": "The button object that appears at the bottom of a card.", "type": "object", "properties": { "title": { "description": "Required. The title of the button.", "type": "string" }, "openUriAction": { "description": "Required. Action to take when a user taps on the button.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction" } } }, "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction", "description": "Opens the given URI.", "type": "object", "properties": { "uri": { "description": "Required. The HTTP or HTTPS scheme URI.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageSuggestions": { "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions", "description": "The collection of suggestions.", "type": "object", "properties": { "suggestions": { "description": "Required. The list of suggested replies.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageSuggestion": { "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion", "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", "type": "object", "properties": { "title": { "description": "Required. The text shown the in the suggestion chip.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": { "id": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion", "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", "type": "object", "properties": { "destinationName": { "description": "Required. The name of the app or site this chip is linking to.", "type": "string" }, "uri": { "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageListSelect": { "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect", "description": "The card for presenting a list of options to select from.", "type": "object", "properties": { "title": { "description": "Optional. The overall title of the list.", "type": "string" }, "items": { "description": "Required. List items.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem" } }, "subtitle": { "description": "Optional. Subtitle of the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": { "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem", "description": "An item in the list.", "type": "object", "properties": { "info": { "description": "Required. Additional information about this option.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo" }, "title": { "description": "Required. The title of the list item.", "type": "string" }, "description": { "description": "Optional. The main text describing the item.", "type": "string" }, "image": { "description": "Optional. The image to display.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" } } }, "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": { "id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", "description": "Additional info about the select item for when it is triggered in a dialog.", "type": "object", "properties": { "key": { "description": "Required. A unique key that will be sent back to the agent if this response is given.", "type": "string" }, "synonyms": { "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": { "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect", "description": "The card for presenting a carousel of options to select from.", "type": "object", "properties": { "items": { "description": "Required. Carousel items.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": { "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem", "description": "An item in the carousel.", "type": "object", "properties": { "info": { "description": "Required. Additional info about the option item.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo" }, "title": { "description": "Required. Title of the carousel item.", "type": "string" }, "description": { "description": "Optional. The body text of the card.", "type": "string" }, "image": { "description": "Optional. The image to display.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" } } }, "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio", "description": "Plays audio from a file in Telephony Gateway.", "type": "object", "properties": { "audioUri": { "description": "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-@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.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech", "description": "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.", "type": "object", "properties": { "text": { "description": "The raw text to be synthesized.", "type": "string" }, "ssml": { "description": "The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall", "description": "Transfers the call in Telephony Gateway.", "type": "object", "properties": { "phoneNumber": { "description": "Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmText": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmText", "description": "Rich Business Messaging (RBM) text response with suggestions.", "type": "object", "properties": { "text": { "description": "Required. Text sent and displayed to the user.", "type": "string" }, "rbmSuggestion": { "description": "Optional. One or more suggestions to show to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion", "description": "Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).", "type": "object", "properties": { "reply": { "description": "Predefined replies for user to select instead of typing", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply" }, "action": { "description": "Predefined client side actions that user can choose", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply", "description": "Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.", "type": "object", "properties": { "text": { "description": "Suggested reply text.", "type": "string" }, "postbackData": { "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction", "description": "Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.", "type": "object", "properties": { "text": { "description": "Text to display alongside the action.", "type": "string" }, "postbackData": { "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.", "type": "string" }, "dial": { "description": "Suggested client side action: Dial a phone number", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial" }, "openUrl": { "description": "Suggested client side action: Open a URI on device", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri" }, "shareLocation": { "description": "Suggested client side action: Share user location", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial", "description": "Opens the user's default dialer app with the specified phone number but does not dial automatically.", "type": "object", "properties": { "phoneNumber": { "description": "Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri", "description": "Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.", "type": "object", "properties": { "uri": { "description": "Required. The uri to open on the user device", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation", "description": "Opens the device's location chooser so the user can pick a location to send back to the agent.", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard", "description": "Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.", "type": "object", "properties": { "cardOrientation": { "description": "Required. Orientation of the card.", "type": "string", "enumDescriptions": [ "Not specified.", "Horizontal layout.", "Vertical layout." ], "enum": [ "CARD_ORIENTATION_UNSPECIFIED", "HORIZONTAL", "VERTICAL" ] }, "thumbnailImageAlignment": { "description": "Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.", "type": "string", "enumDescriptions": [ "Not specified.", "Thumbnail preview is left-aligned.", "Thumbnail preview is right-aligned." ], "enum": [ "THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED", "LEFT", "RIGHT" ] }, "cardContent": { "description": "Required. Card content.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent" } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent", "description": "Rich Business Messaging (RBM) Card content", "type": "object", "properties": { "title": { "description": "Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.", "type": "string" }, "description": { "description": "Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.", "type": "string" }, "media": { "description": "Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia" }, "suggestions": { "description": "Optional. List of suggestions to include in the card.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia", "description": "Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm", "type": "object", "properties": { "fileUri": { "description": "Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.", "type": "string" }, "thumbnailUri": { "description": "Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.", "type": "string" }, "height": { "description": "Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.", "type": "string", "enumDescriptions": [ "Not specified.", "112 DP.", "168 DP.", "264 DP. Not available for rich card carousels when the card width is set to small." ], "enum": [ "HEIGHT_UNSPECIFIED", "SHORT", "MEDIUM", "TALL" ] } } }, "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard", "description": "Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.", "type": "object", "properties": { "cardWidth": { "description": "Required. The width of the cards in the carousel.", "type": "string", "enumDescriptions": [ "Not specified.", "120 DP. Note that tall media cannot be used.", "232 DP." ], "enum": [ "CARD_WIDTH_UNSPECIFIED", "SMALL", "MEDIUM" ] }, "cardContents": { "description": "Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard", "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", "type": "object", "properties": { "items": { "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem" } }, "imageDisplayOptions": { "description": "Optional. Settings for displaying the image. Applies to every image in items.", "type": "string", "enumDescriptions": [ "Fill the gaps between the image and the image container with gray bars.", "Fill the gaps between the image and the image container with gray bars.", "Fill the gaps between the image and the image container with white bars.", "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", "Pad the gaps between image and image frame with a blurred copy of the same image." ], "enum": [ "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", "GRAY", "WHITE", "CROPPED", "BLURRED_BACKGROUND" ] } } }, "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem", "description": "Browsing carousel tile", "type": "object", "properties": { "openUriAction": { "description": "Required. Action to present to the user.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction" }, "title": { "description": "Required. Title of the carousel item. Maximum of two lines of text.", "type": "string" }, "description": { "description": "Optional. Description of the carousel item. Maximum of four lines of text.", "type": "string" }, "image": { "description": "Optional. Hero image for the carousel item.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "footer": { "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", "description": "Actions on Google action to open a given url.", "type": "object", "properties": { "url": { "description": "Required. URL", "type": "string" }, "urlTypeHint": { "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", "type": "string", "enumDescriptions": [ "Unspecified", "Url would be an amp action", "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." ], "enum": [ "URL_TYPE_HINT_UNSPECIFIED", "AMP_ACTION", "AMP_CONTENT" ] } } }, "GoogleCloudDialogflowV2beta1IntentMessageTableCard": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCard", "description": "Table card for Actions on Google.", "type": "object", "properties": { "title": { "description": "Required. Title of the card.", "type": "string" }, "subtitle": { "description": "Optional. Subtitle to the title.", "type": "string" }, "image": { "description": "Optional. Image which should be displayed on the card.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "columnProperties": { "description": "Optional. Display properties for the columns in this table.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties" } }, "rows": { "description": "Optional. Rows in this table of data.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow" } }, "buttons": { "description": "Optional. List of buttons for the card.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": { "id": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties", "description": "Column properties for TableCard.", "type": "object", "properties": { "header": { "description": "Required. Column heading.", "type": "string" }, "horizontalAlignment": { "description": "Optional. Defines text alignment for all cells in this column.", "type": "string", "enumDescriptions": [ "Text is aligned to the leading edge of the column.", "Text is aligned to the leading edge of the column.", "Text is centered in the column.", "Text is aligned to the trailing edge of the column." ], "enum": [ "HORIZONTAL_ALIGNMENT_UNSPECIFIED", "LEADING", "CENTER", "TRAILING" ] } } }, "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow", "description": "Row of TableCard.", "type": "object", "properties": { "cells": { "description": "Optional. List of cells that make up this row.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell" } }, "dividerAfter": { "description": "Optional. Whether to add a visual divider after this row.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": { "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell", "description": "Cell of TableCardRow.", "type": "object", "properties": { "text": { "description": "Required. Text in this cell.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentMessageMediaContent": { "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent", "description": "The media content card for Actions on Google.", "type": "object", "properties": { "mediaType": { "description": "Optional. What type of media is the content (ie \"audio\").", "type": "string", "enumDescriptions": [ "Unspecified.", "Response media type is audio." ], "enum": [ "RESPONSE_MEDIA_TYPE_UNSPECIFIED", "AUDIO" ] }, "mediaObjects": { "description": "Required. List of media objects.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject" } } } }, "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": { "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject", "description": "Response media object for media content card.", "type": "object", "properties": { "name": { "description": "Required. Name of media card.", "type": "string" }, "description": { "description": "Optional. Description of media card.", "type": "string" }, "largeImage": { "description": "Optional. Image to display above media content.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "icon": { "description": "Optional. Icon to display above media content.", "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage" }, "contentUrl": { "description": "Required. Url where the media is stored.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": { "id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo", "description": "Represents a single followup intent in the chain.", "type": "object", "properties": { "followupIntentName": { "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", "type": "string" }, "parentFollowupIntentName": { "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest": { "id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest", "description": "The request message for Intents.BatchUpdateIntents.", "type": "object", "properties": { "intentBatchUri": { "description": "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://\".", "type": "string" }, "intentBatchInline": { "description": "The collection of intents to update or create.", "$ref": "GoogleCloudDialogflowV2beta1IntentBatch" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "type": "string", "format": "google-fieldmask" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } } }, "GoogleCloudDialogflowV2beta1IntentBatch": { "id": "GoogleCloudDialogflowV2beta1IntentBatch", "description": "This message is a wrapper around a collection of intents.", "type": "object", "properties": { "intents": { "description": "A collection of intents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Intent" } } } }, "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest": { "id": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest", "description": "The request message for Intents.BatchDeleteIntents.", "type": "object", "properties": { "intents": { "description": "Required. The collection of intents to delete. Only intent `name` must be filled in.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Intent" } } } }, "GoogleCloudDialogflowV2beta1ListEntityTypesResponse": { "id": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse", "description": "The response message for EntityTypes.ListEntityTypes.", "type": "object", "properties": { "entityTypes": { "description": "The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1EntityType": { "id": "GoogleCloudDialogflowV2beta1EntityType", "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "type": "object", "properties": { "name": { "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "type": "string" }, "displayName": { "description": "Required. The name of the entity type.", "type": "string" }, "kind": { "description": "Required. Indicates the kind of entity type.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "Map entity types allow mapping of a group of synonyms to a reference value.", "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", "Regexp entity types allow to specify regular expressions in entries values." ], "enum": [ "KIND_UNSPECIFIED", "KIND_MAP", "KIND_LIST", "KIND_REGEXP" ] }, "autoExpansionMode": { "description": "Optional. Indicates whether the entity type can be automatically expanded.", "type": "string", "enumDescriptions": [ "Auto expansion disabled for the entity.", "Allows an agent to recognize values that have not been explicitly listed in the entity." ], "enum": [ "AUTO_EXPANSION_MODE_UNSPECIFIED", "AUTO_EXPANSION_MODE_DEFAULT" ] }, "entities": { "description": "Optional. The collection of entity entries associated with the entity type.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" } }, "enableFuzzyExtraction": { "description": "Optional. Enables fuzzy entity extraction during classification.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1EntityTypeEntity": { "id": "GoogleCloudDialogflowV2beta1EntityTypeEntity", "description": "An **entity entry** for an associated entity type.", "type": "object", "properties": { "value": { "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", "type": "string" }, "synonyms": { "description": "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`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest", "description": "The request message for EntityTypes.BatchUpdateEntityTypes.", "type": "object", "properties": { "entityTypeBatchUri": { "description": "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://\".", "type": "string" }, "entityTypeBatchInline": { "description": "The collection of entity types to update or create.", "$ref": "GoogleCloudDialogflowV2beta1EntityTypeBatch" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "type": "string", "format": "google-fieldmask" } } }, "GoogleCloudDialogflowV2beta1EntityTypeBatch": { "id": "GoogleCloudDialogflowV2beta1EntityTypeBatch", "description": "This message is a wrapper around a collection of entity types.", "type": "object", "properties": { "entityTypes": { "description": "A collection of entity types.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" } } } }, "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest", "description": "The request message for EntityTypes.BatchDeleteEntityTypes.", "type": "object", "properties": { "entityTypeNames": { "description": "Required. The names entity types to delete. All names must point to the same agent as `parent`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest", "description": "The request message for EntityTypes.BatchCreateEntities.", "type": "object", "properties": { "entities": { "description": "Required. The entities to create.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" } }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "type": "string" } } }, "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest", "description": "The request message for EntityTypes.BatchUpdateEntities.", "type": "object", "properties": { "entities": { "description": "Required. The entities to update or create.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" } }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "type": "string", "format": "google-fieldmask" } } }, "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest", "description": "The request message for EntityTypes.BatchDeleteEntities.", "type": "object", "properties": { "entityValues": { "description": "Required. The reference `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/`.", "type": "array", "items": { "type": "string" } }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": { "id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse", "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.", "type": "object", "properties": { "sessionEntityTypes": { "description": "The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SessionEntityType": { "id": "GoogleCloudDialogflowV2beta1SessionEntityType", "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "type": "string" }, "entityOverrideMode": { "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", "The collection of session entities extends the collection of entities in the corresponding custom 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 custom entity type and merge." ], "enum": [ "ENTITY_OVERRIDE_MODE_UNSPECIFIED", "ENTITY_OVERRIDE_MODE_OVERRIDE", "ENTITY_OVERRIDE_MODE_SUPPLEMENT" ] }, "entities": { "description": "Required. The collection of entities associated with this session entity type.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" } } } }, "GoogleCloudDialogflowV2beta1DetectIntentRequest": { "id": "GoogleCloudDialogflowV2beta1DetectIntentRequest", "description": "The request to detect user's intent.", "type": "object", "properties": { "queryParams": { "description": "The parameters of this query.", "$ref": "GoogleCloudDialogflowV2beta1QueryParameters" }, "queryInput": { "description": "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.", "$ref": "GoogleCloudDialogflowV2beta1QueryInput" }, "outputAudioConfig": { "description": "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.", "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig" }, "outputAudioConfigMask": { "description": "Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.", "type": "string", "format": "google-fieldmask" }, "inputAudio": { "description": "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.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1QueryParameters": { "id": "GoogleCloudDialogflowV2beta1QueryParameters", "description": "Represents the parameters of the conversational query.", "type": "object", "properties": { "timeZone": { "description": "The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.", "type": "string" }, "geoLocation": { "description": "The geo location of this conversational query.", "$ref": "GoogleTypeLatLng" }, "contexts": { "description": "The collection of contexts to be activated before this query is executed.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" } }, "resetContexts": { "description": "Specifies whether to delete all contexts in the current session before the new ones are activated.", "type": "boolean" }, "sessionEntityTypes": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" } }, "payload": { "description": "This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the `WebhookRequest.original_detect_intent_request.payload` field sent to your webhook.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "knowledgeBaseNames": { "description": "KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: `projects//knowledgeBases/`.", "type": "array", "items": { "type": "string" } }, "sentimentAnalysisRequestConfig": { "description": "Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Essentials Edition agents.", "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig" }, "subAgents": { "description": "For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SubAgent" } }, "webhookHeaders": { "description": "This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: \"Host\", \"Content-Length\", \"Connection\", \"From\", \"User-Agent\", \"Accept-Encoding\", \"If-Modified-Since\", \"If-None-Match\", \"X-Forwarded-For\", etc.", "type": "object", "additionalProperties": { "type": "string" } }, "platform": { "description": "The platform of the virtual agent response messages. If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.", "type": "string" } } }, "GoogleTypeLatLng": { "id": "GoogleTypeLatLng", "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.", "type": "object", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number", "format": "double" }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number", "format": "double" } } }, "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig": { "id": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig", "description": "Configures the types of sentiment analysis to perform.", "type": "object", "properties": { "analyzeQueryTextSentiment": { "description": "Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1SubAgent": { "id": "GoogleCloudDialogflowV2beta1SubAgent", "description": "Contains basic configuration for a sub-agent.", "type": "object", "properties": { "project": { "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`.", "type": "string" }, "environment": { "description": "Optional. The unique identifier (`environment name` in dialogflow console) of this sub-agent environment. Assumes draft environment if `environment` is not set.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1QueryInput": { "id": "GoogleCloudDialogflowV2beta1QueryInput", "description": "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.", "type": "object", "properties": { "audioConfig": { "description": "Instructs the speech recognizer how to process the speech audio.", "$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig" }, "text": { "description": "The natural language text to be processed.", "$ref": "GoogleCloudDialogflowV2beta1TextInput" }, "event": { "description": "The event to be processed.", "$ref": "GoogleCloudDialogflowV2beta1EventInput" }, "dtmf": { "description": "The DTMF digits used to invoke intent and fill in parameter value.", "$ref": "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents" } } }, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", "description": "Instructs the speech recognizer on how to process the audio content.", "type": "object", "properties": { "audioEncoding": { "description": "Required. Audio encoding of the audio content to process.", "type": "string", "enumDescriptions": [ "Not specified.", "Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." ], "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "AUDIO_ENCODING_LINEAR_16", "AUDIO_ENCODING_FLAC", "AUDIO_ENCODING_MULAW", "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" ] }, "sampleRateHertz": { "description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "type": "integer", "format": "int32" }, "languageCode": { "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) 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.", "type": "string" }, "enableWordInfo": { "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", "type": "boolean" }, "phraseHints": { "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`]().", "deprecated": true, "type": "array", "items": { "type": "string" } }, "speechContexts": { "description": "Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SpeechContext" } }, "model": { "description": "Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/es/docs/speech-models).", "type": "string" }, "modelVariant": { "description": "Which variant of the Speech model to use.", "type": "string", "enumDescriptions": [ "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) 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](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." ], "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", "USE_STANDARD", "USE_ENHANCED" ] }, "singleUtterance": { "description": "If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.", "type": "boolean" }, "disableNoSpeechRecognizedEvent": { "description": "Only used in Participants.AnalyzeContent and Participants.StreamingAnalyzeContent. If `false` and recognition doesn't return any result, trigger `NO_SPEECH_RECOGNIZED` event to Dialogflow agent.", "type": "boolean" }, "bargeInConfig": { "description": "Configuration of barge-in behavior during the streaming of input audio.", "$ref": "GoogleCloudDialogflowV2beta1BargeInConfig" }, "enableAutomaticPunctuation": { "description": "Enable automatic punctuation option at the speech backend.", "type": "boolean" }, "optOutConformerModelMigration": { "description": "If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow ES Speech model migration](https://cloud.google.com/dialogflow/es/docs/speech-model-migration).", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1SpeechContext": { "id": "GoogleCloudDialogflowV2beta1SpeechContext", "description": "Hints for the speech recognizer to help with recognition in a specific conversation state.", "type": "object", "properties": { "phrases": { "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to: * improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent * add additional words to the speech recognizer vocabulary * ... See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/quotas) for usage limits.", "type": "array", "items": { "type": "string" } }, "boost": { "description": "Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowV2beta1BargeInConfig": { "id": "GoogleCloudDialogflowV2beta1BargeInConfig", "description": "Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio. The flow goes like below: ``` --\u003e Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up.", "type": "object", "properties": { "noBargeInDuration": { "description": "Duration that is not eligible for barge-in at the beginning of the input audio.", "type": "string", "format": "google-duration" }, "totalDuration": { "description": "Total duration for the playback at the beginning of the input audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowV2beta1TextInput": { "id": "GoogleCloudDialogflowV2beta1TextInput", "description": "Represents the natural language text to be processed.", "type": "object", "properties": { "text": { "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions.", "type": "string" }, "languageCode": { "description": "Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) 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.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1EventInput": { "id": "GoogleCloudDialogflowV2beta1EventInput", "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` 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?\"`.", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of the event.", "type": "string" }, "parameters": { "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "languageCode": { "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) 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. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents": { "id": "GoogleCloudDialogflowV2beta1TelephonyDtmfEvents", "description": "A wrapper of repeated TelephonyDtmf digits.", "type": "object", "properties": { "dtmfEvents": { "description": "A sequence of TelephonyDtmf digits.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not specified. This value may be used to indicate an absent digit.", "Number: '1'.", "Number: '2'.", "Number: '3'.", "Number: '4'.", "Number: '5'.", "Number: '6'.", "Number: '7'.", "Number: '8'.", "Number: '9'.", "Number: '0'.", "Letter: 'A'.", "Letter: 'B'.", "Letter: 'C'.", "Letter: 'D'.", "Asterisk/star: '*'.", "Pound/diamond/hash/square/gate/octothorpe: '#'." ], "enum": [ "TELEPHONY_DTMF_UNSPECIFIED", "DTMF_ONE", "DTMF_TWO", "DTMF_THREE", "DTMF_FOUR", "DTMF_FIVE", "DTMF_SIX", "DTMF_SEVEN", "DTMF_EIGHT", "DTMF_NINE", "DTMF_ZERO", "DTMF_A", "DTMF_B", "DTMF_C", "DTMF_D", "DTMF_STAR", "DTMF_POUND" ] } } } }, "GoogleCloudDialogflowV2beta1OutputAudioConfig": { "id": "GoogleCloudDialogflowV2beta1OutputAudioConfig", "description": "Instructs the speech synthesizer how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.", "type": "object", "properties": { "audioEncoding": { "description": "Required. Audio encoding of the synthesized audio content.", "type": "string", "enumDescriptions": [ "Not specified.", "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "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.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." ], "enum": [ "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", "OUTPUT_AUDIO_ENCODING_LINEAR_16", "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", "OUTPUT_AUDIO_ENCODING_MULAW" ] }, "sampleRateHertz": { "description": "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).", "type": "integer", "format": "int32" }, "synthesizeSpeechConfig": { "description": "Configuration of how speech should be synthesized.", "$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig" } } }, "GoogleCloudDialogflowV2beta1DetectIntentResponse": { "id": "GoogleCloudDialogflowV2beta1DetectIntentResponse", "description": "The message returned from the DetectIntent method.", "type": "object", "properties": { "responseId": { "description": "The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.", "type": "string" }, "queryResult": { "description": "The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results.", "$ref": "GoogleCloudDialogflowV2beta1QueryResult" }, "alternativeQueryResults": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1QueryResult" } }, "webhookStatus": { "description": "Specifies the status of the webhook request.", "$ref": "GoogleRpcStatus" }, "outputAudio": { "description": "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. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.", "type": "string", "format": "byte" }, "outputAudioConfig": { "description": "The config used by the speech synthesizer to generate the output audio.", "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig" } } }, "GoogleCloudDialogflowV2beta1QueryResult": { "id": "GoogleCloudDialogflowV2beta1QueryResult", "description": "Represents the result of conversational query or event processing.", "type": "object", "properties": { "queryText": { "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", "type": "string" }, "languageCode": { "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" }, "speechRecognitionConfidence": { "description": "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.", "type": "number", "format": "float" }, "action": { "description": "The action name from the matched intent.", "type": "string" }, "parameters": { "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "allRequiredParamsPresent": { "description": "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.", "type": "boolean" }, "cancelsSlotFilling": { "description": "Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the [cancel slot filling documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).", "type": "boolean" }, "fulfillmentText": { "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", "type": "string" }, "fulfillmentMessages": { "description": "The collection of rich messages to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" } }, "webhookSource": { "description": "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.", "type": "string" }, "webhookPayload": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "outputContexts": { "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" } }, "intent": { "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`.", "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "intentDetectionConfidence": { "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", "type": "number", "format": "float" }, "diagnosticInfo": { "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "sentimentAnalysisResult": { "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.", "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult" }, "knowledgeAnswers": { "description": "The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`.", "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers" } } }, "GoogleCloudDialogflowV2beta1SentimentAnalysisResult": { "id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult", "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", "type": "object", "properties": { "queryTextSentiment": { "description": "The sentiment analysis result for `query_text`.", "$ref": "GoogleCloudDialogflowV2beta1Sentiment" } } }, "GoogleCloudDialogflowV2beta1Sentiment": { "id": "GoogleCloudDialogflowV2beta1Sentiment", "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "type": "object", "properties": { "score": { "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", "type": "number", "format": "float" }, "magnitude": { "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowV2beta1KnowledgeAnswers": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers", "description": "Represents the result of querying a Knowledge base.", "type": "object", "properties": { "answers": { "description": "A list of answers from Knowledge Connector.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer" } } } }, "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer", "description": "An answer from Knowledge Connector.", "type": "object", "properties": { "source": { "description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`.", "type": "string" }, "faqQuestion": { "description": "The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.", "type": "string" }, "answer": { "description": "The piece of text from the `source` knowledge base document that answers this conversational query.", "type": "string" }, "matchConfidenceLevel": { "description": "The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `` 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.", "type": "string", "enumDescriptions": [ "Not specified.", "Indicates that the confidence is low.", "Indicates our confidence is medium.", "Indicates our confidence is high." ], "enum": [ "MATCH_CONFIDENCE_LEVEL_UNSPECIFIED", "LOW", "MEDIUM", "HIGH" ] }, "matchConfidence": { "description": "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.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowV2beta1Participant": { "id": "GoogleCloudDialogflowV2beta1Participant", "description": "Represents a conversation participant (human agent, virtual agent, end-user).", "type": "object", "properties": { "name": { "description": "Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`.", "type": "string" }, "role": { "description": "Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "obfuscatedExternalUserId": { "description": "Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow uses this user id for billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be \u003c= 256 characters.", "type": "string" }, "documentsMetadataFilters": { "description": "Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be ``` documents_metadata_filters { key: \"market\" value: \"US,CA\" } documents_metadata_filters { key: \"user\" value: \"agent\" } ```", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1ListParticipantsResponse": { "id": "GoogleCloudDialogflowV2beta1ListParticipantsResponse", "description": "The response message for Participants.ListParticipants.", "type": "object", "properties": { "participants": { "description": "The list of participants. There is a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Participant" } }, "nextPageToken": { "description": "Token to retrieve the next page of results or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1AnalyzeContentRequest": { "id": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest", "description": "The request message for Participants.AnalyzeContent.", "type": "object", "properties": { "textInput": { "description": "The natural language text to be processed.", "$ref": "GoogleCloudDialogflowV2beta1TextInput" }, "audioInput": { "description": "The natural language speech audio to be processed.", "$ref": "GoogleCloudDialogflowV2beta1AudioInput" }, "eventInput": { "description": "An input event to send to Dialogflow.", "$ref": "GoogleCloudDialogflowV2beta1EventInput" }, "suggestionInput": { "description": "An input representing the selection of a suggestion.", "$ref": "GoogleCloudDialogflowV2beta1SuggestionInput" }, "intentInput": { "description": "The intent to be triggered on V3 agent.", "$ref": "GoogleCloudDialogflowV2beta1IntentInput" }, "replyAudioConfig": { "description": "Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.", "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig" }, "queryParams": { "description": "Parameters for a Dialogflow virtual-agent query.", "$ref": "GoogleCloudDialogflowV2beta1QueryParameters" }, "assistQueryParams": { "description": "Parameters for a human assist query.", "$ref": "GoogleCloudDialogflowV2beta1AssistQueryParameters" }, "cxParameters": { "description": "Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "cxCurrentPage": { "description": "The unique identifier of the CX page to override the `current_page` in the session. Format: `projects//locations//agents//flows//pages/`. If `cx_current_page` is specified, the previous state of the session will be ignored by Dialogflow CX, including the previous page and the previous session parameters. In most cases, `cx_current_page` and `cx_parameters` should be configured together to direct a session to a specific state. Note: this field should only be used if you are connecting to a Dialogflow CX agent.", "type": "string" }, "messageSendTime": { "description": "Optional. The send time of the message from end user or human agent's perspective. It is used for identifying the same message under one participant. Given two messages under the same participant: * If send time are different regardless of whether the content of the messages are exactly the same, the conversation will regard them as two distinct messages sent by the participant. * If send time is the same regardless of whether the content of the messages are exactly the same, the conversation will regard them as same message, and ignore the message received later. If the value is not provided, a new request will always be regarded as a new message without any de-duplication.", "type": "string", "format": "google-datetime" }, "requestId": { "description": "A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1AudioInput": { "id": "GoogleCloudDialogflowV2beta1AudioInput", "description": "Represents the natural language speech audio to be processed.", "type": "object", "properties": { "config": { "description": "Required. Instructs the speech recognizer how to process the speech audio.", "$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig" }, "audio": { "description": "Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1SuggestionInput": { "id": "GoogleCloudDialogflowV2beta1SuggestionInput", "description": "Represents the selection of a suggestion.", "type": "object", "properties": { "answerRecord": { "description": "Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: `projects//locations//answerRecords/` where is an alphanumeric string.", "type": "string" }, "textOverride": { "description": "Optional. If the customer edited the suggestion before using it, include the revised text here.", "$ref": "GoogleCloudDialogflowV2beta1TextInput" }, "parameters": { "description": "In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "intentInput": { "description": "The intent to be triggered on V3 agent.", "$ref": "GoogleCloudDialogflowV2beta1IntentInput" } } }, "GoogleCloudDialogflowV2beta1IntentInput": { "id": "GoogleCloudDialogflowV2beta1IntentInput", "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent.", "type": "object", "properties": { "intent": { "description": "Required. The unique identifier of the intent in V3 agent. Format: `projects//locations//locations//agents//intents/`.", "type": "string" }, "languageCode": { "description": "Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1AssistQueryParameters": { "id": "GoogleCloudDialogflowV2beta1AssistQueryParameters", "description": "Represents the parameters of human assist query.", "type": "object", "properties": { "documentsMetadataFilters": { "description": "Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be ``` documents_metadata_filters { key: \"market\" value: \"US,CA\" } documents_metadata_filters { key: \"user\" value: \"agent\" } ```", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1AnalyzeContentResponse": { "id": "GoogleCloudDialogflowV2beta1AnalyzeContentResponse", "description": "The response message for Participants.AnalyzeContent.", "type": "object", "properties": { "replyText": { "description": "Output only. The output text content. This field is set if the automated agent responded with text to show to the user.", "type": "string" }, "replyAudio": { "description": "Optional. The audio data bytes encoded as specified in the request. This field is set if: - `reply_audio_config` was specified in the request, or - The automated agent responded with audio to play to the user. In such case, `reply_audio.config` contains settings used to synthesize the speech. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.", "$ref": "GoogleCloudDialogflowV2beta1OutputAudio" }, "automatedAgentReply": { "description": "Optional. Only set if a Dialogflow automated agent has responded. Note that: AutomatedAgentReply.detect_intent_response.output_audio and AutomatedAgentReply.detect_intent_response.output_audio_config are always empty, use reply_audio instead.", "$ref": "GoogleCloudDialogflowV2beta1AutomatedAgentReply" }, "message": { "description": "Output only. Message analyzed by CCAI.", "$ref": "GoogleCloudDialogflowV2beta1Message" }, "humanAgentSuggestionResults": { "description": "The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config. Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionResult" } }, "endUserSuggestionResults": { "description": "The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config. Same as human_agent_suggestion_results, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionResult" } }, "dtmfParameters": { "description": "Indicates the parameters of DTMF.", "$ref": "GoogleCloudDialogflowV2beta1DtmfParameters" } } }, "GoogleCloudDialogflowV2beta1OutputAudio": { "id": "GoogleCloudDialogflowV2beta1OutputAudio", "description": "Represents the natural language speech audio to be played to the end user.", "type": "object", "properties": { "config": { "description": "Required. Instructs the speech synthesizer how to generate the speech audio.", "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig" }, "audio": { "description": "Required. The natural language speech audio.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1AutomatedAgentReply": { "id": "GoogleCloudDialogflowV2beta1AutomatedAgentReply", "description": "Represents a response from an automated agent.", "type": "object", "properties": { "detectIntentResponse": { "description": "Response of the Dialogflow Sessions.DetectIntent call.", "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" }, "responseMessages": { "description": "Response messages from the automated agent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" } }, "intent": { "description": "Name of the intent if an intent is matched for the query. For a V2 query, the value format is `projects//locations/ /agent/intents/`. For a V3 query, the value format is `projects//locations/ /agents//intents/`.", "type": "string" }, "event": { "description": "Event name if an event is triggered for the query.", "type": "string" }, "matchConfidence": { "description": "The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.", "type": "number", "format": "float" }, "parameters": { "description": "The collection of current parameters at the time of this response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "cxSessionParameters": { "description": "The collection of current Dialogflow CX agent session parameters at the time of this response. Deprecated: Use `parameters` instead.", "deprecated": true, "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "automatedAgentReplyType": { "description": "AutomatedAgentReply type.", "type": "string", "enumDescriptions": [ "Not specified. This should never happen.", "Partial reply. e.g. Aggregated responses in a `Fulfillment` that enables `return_partial_response` can be returned as partial reply. WARNING: partial reply is not eligible for barge-in.", "Final reply." ], "enum": [ "AUTOMATED_AGENT_REPLY_TYPE_UNSPECIFIED", "PARTIAL", "FINAL" ] }, "allowCancellation": { "description": "Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled.", "type": "boolean" }, "cxCurrentPage": { "description": "The unique identifier of the current Dialogflow CX conversation page. Format: `projects//locations//agents//flows//pages/`.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ResponseMessage": { "id": "GoogleCloudDialogflowV2beta1ResponseMessage", "description": "Response messages from an automated agent.", "type": "object", "properties": { "text": { "description": "Returns a text response.", "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText" }, "payload": { "description": "Returns a response containing a custom, platform-specific payload.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "liveAgentHandoff": { "description": "Hands off conversation to a live agent.", "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff" }, "endInteraction": { "description": "A signal that indicates the interaction with the Dialogflow agent has ended.", "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction" }, "mixedAudio": { "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.", "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio" }, "telephonyTransferCall": { "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.", "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall" } } }, "GoogleCloudDialogflowV2beta1ResponseMessageText": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", "description": "The text response message.", "type": "object", "properties": { "text": { "description": "A collection of text responses.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "type": "object", "properties": { "metadata": { "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", "description": "Indicates that interaction with the Dialogflow agent has ended.", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", "type": "object", "properties": { "segments": { "description": "Segments this audio response is composed of.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" } } } }, "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", "description": "Represents one segment of audio.", "type": "object", "properties": { "audio": { "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", "type": "string", "format": "byte" }, "uri": { "description": "Client-specific URI that points to an audio clip accessible to the client.", "type": "string" }, "allowPlaybackInterruption": { "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", "type": "object", "properties": { "phoneNumber": { "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", "type": "string" }, "sipUri": { "description": "Transfer the call to a SIP endpoint.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Message": { "id": "GoogleCloudDialogflowV2beta1Message", "description": "Represents a message posted into a conversation.", "type": "object", "properties": { "name": { "description": "Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "content": { "description": "Required. The message content.", "type": "string" }, "languageCode": { "description": "Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "participant": { "description": "Output only. The participant that sends this message.", "readOnly": true, "type": "string" }, "participantRole": { "description": "Output only. The role of the participant.", "readOnly": true, "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "createTime": { "description": "Output only. The time when the message was created in Contact Center AI.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sendTime": { "description": "Optional. The time when the message was sent.", "type": "string", "format": "google-datetime" }, "messageAnnotation": { "description": "Output only. The annotation for the message.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1MessageAnnotation" }, "sentimentAnalysis": { "description": "Output only. The sentiment analysis result for the message.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult" } } }, "GoogleCloudDialogflowV2beta1MessageAnnotation": { "id": "GoogleCloudDialogflowV2beta1MessageAnnotation", "description": "Represents the result of annotation for the message.", "type": "object", "properties": { "parts": { "description": "Optional. The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text].", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1AnnotatedMessagePart" } }, "containEntities": { "description": "Required. Indicates whether the text message contains entities.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1AnnotatedMessagePart": { "id": "GoogleCloudDialogflowV2beta1AnnotatedMessagePart", "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "type": "object", "properties": { "text": { "description": "Required. A part of a message possibly annotated with an entity.", "type": "string" }, "entityType": { "description": "Optional. The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.", "type": "string" }, "formattedValue": { "description": "Optional. The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { \"amount\": 5, \"currency\": \"USD\" } ", "type": "any" } } }, "GoogleCloudDialogflowV2beta1SuggestionResult": { "id": "GoogleCloudDialogflowV2beta1SuggestionResult", "description": "One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.", "type": "object", "properties": { "error": { "description": "Error status if the request failed.", "$ref": "GoogleRpcStatus" }, "suggestArticlesResponse": { "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.", "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse" }, "suggestFaqAnswersResponse": { "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER.", "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse" }, "suggestSmartRepliesResponse": { "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY.", "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse" }, "suggestDialogflowAssistsResponse": { "description": "SuggestDialogflowAssistsResponse if request is for DIALOGFLOW_ASSIST.", "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse" }, "suggestEntityExtractionResponse": { "description": "SuggestDialogflowAssistsResponse if request is for ENTITY_EXTRACTION.", "$ref": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse" } } }, "GoogleCloudDialogflowV2beta1SuggestArticlesResponse": { "id": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse", "description": "The response message for Participants.SuggestArticles.", "type": "object", "properties": { "articleAnswers": { "description": "Output only. Articles ordered by score in descending order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1ArticleAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesResponse.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1ArticleAnswer": { "id": "GoogleCloudDialogflowV2beta1ArticleAnswer", "description": "Represents article answer.", "type": "object", "properties": { "title": { "description": "The article title.", "type": "string" }, "uri": { "description": "The article URI.", "type": "string" }, "snippets": { "description": "Output only. Article snippets.", "type": "array", "items": { "type": "string" } }, "metadata": { "description": "A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse": { "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse", "description": "The request message for Participants.SuggestFaqAnswers.", "type": "object", "properties": { "faqAnswers": { "description": "Output only. Answers extracted from FAQ documents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1FaqAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1FaqAnswer": { "id": "GoogleCloudDialogflowV2beta1FaqAnswer", "description": "Represents answer from \"frequently asked questions\".", "type": "object", "properties": { "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "confidence": { "description": "The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "source": { "description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.", "type": "string" }, "metadata": { "description": "A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse": { "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse", "description": "The response message for Participants.SuggestSmartReplies.", "type": "object", "properties": { "smartReplyAnswers": { "description": "Output only. Multiple reply options provided by smart reply service. The order is based on the rank of the model prediction. The maximum number of the returned replies is set in SmartReplyConfig.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SmartReplyAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1SmartReplyAnswer": { "id": "GoogleCloudDialogflowV2beta1SmartReplyAnswer", "description": "Represents a smart reply answer.", "type": "object", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "confidence": { "description": "Smart reply confidence. The system's confidence score that this reply is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse": { "id": "GoogleCloudDialogflowV2beta1SuggestDialogflowAssistsResponse", "description": "The response message for Participants.SuggestDialogflowAssists.", "type": "object", "properties": { "dialogflowAssistAnswers": { "description": "Output only. Multiple reply options provided by Dialogflow assist service. The order is based on the rank of the model prediction.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to suggest answer. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestDialogflowAssistsRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer": { "id": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", "description": "Represents a Dialogflow assist answer.", "type": "object", "properties": { "queryResult": { "description": "Result from v2 agent.", "$ref": "GoogleCloudDialogflowV2beta1QueryResult" }, "intentSuggestion": { "description": "An intent suggestion generated from conversation.", "$ref": "GoogleCloudDialogflowV2beta1IntentSuggestion" }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1IntentSuggestion": { "id": "GoogleCloudDialogflowV2beta1IntentSuggestion", "description": "Represents an intent suggestion.", "type": "object", "properties": { "displayName": { "description": "The display name of the intent.", "type": "string" }, "intentV2": { "description": "The unique identifier of this intent. Format: `projects//locations//agent/intents/`.", "type": "string" }, "description": { "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1DtmfParameters": { "id": "GoogleCloudDialogflowV2beta1DtmfParameters", "description": "The message in the response that indicates the parameters of DTMF.", "type": "object", "properties": { "acceptsDtmfInput": { "description": "Indicates whether DTMF input can be handled in the next request.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1SuggestArticlesRequest": { "id": "GoogleCloudDialogflowV2beta1SuggestArticlesRequest", "description": "The request message for Participants.SuggestArticles.", "type": "object", "properties": { "latestMessage": { "description": "Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. By default 20 and at most 50.", "type": "integer", "format": "int32" }, "assistQueryParams": { "description": "Optional. Parameters for a human assist query.", "$ref": "GoogleCloudDialogflowV2beta1AssistQueryParameters" } } }, "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest": { "id": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest", "description": "The request message for Participants.SuggestFaqAnswers.", "type": "object", "properties": { "latestMessage": { "description": "Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.", "type": "integer", "format": "int32" }, "assistQueryParams": { "description": "Optional. Parameters for a human assist query.", "$ref": "GoogleCloudDialogflowV2beta1AssistQueryParameters" } } }, "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest": { "id": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest", "description": "The request message for Participants.SuggestSmartReplies.", "type": "object", "properties": { "currentTextInput": { "description": "The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message.", "$ref": "GoogleCloudDialogflowV2beta1TextInput" }, "latestMessage": { "description": "The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1ListSuggestionsResponse": { "id": "GoogleCloudDialogflowV2beta1ListSuggestionsResponse", "deprecated": true, "description": "The response message for Participants.ListSuggestions.", "type": "object", "properties": { "suggestions": { "description": "Required. The list of suggestions. There will be a maximum number of items returned based on the page_size field in the request. `suggestions` is sorted by `create_time` in descending order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Suggestion" } }, "nextPageToken": { "description": "Optional. Token to retrieve the next page of results or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Suggestion": { "id": "GoogleCloudDialogflowV2beta1Suggestion", "deprecated": true, "description": "Represents a suggestion for a human agent.", "type": "object", "properties": { "name": { "description": "Output only. The name of this suggestion. Format: `projects//locations//conversations//participants/*/suggestions/`.", "type": "string" }, "articles": { "description": "Output only. Articles ordered by score in descending order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionArticle" } }, "faqAnswers": { "description": "Output only. Answers extracted from FAQ documents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer" } }, "createTime": { "description": "Output only. The time the suggestion was created.", "type": "string", "format": "google-datetime" }, "latestMessage": { "description": "Output only. Latest message used as context to compile this suggestion. Format: `projects//locations//conversations//messages/`.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestionArticle": { "id": "GoogleCloudDialogflowV2beta1SuggestionArticle", "description": "Represents suggested article.", "type": "object", "properties": { "title": { "description": "Output only. The article title.", "type": "string" }, "uri": { "description": "Output only. The article URI.", "type": "string" }, "snippets": { "description": "Output only. Article snippets.", "type": "array", "items": { "type": "string" } }, "metadata": { "description": "Output only. A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "Output only. The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer": { "id": "GoogleCloudDialogflowV2beta1SuggestionFaqAnswer", "description": "Represents suggested answer from \"frequently asked questions\".", "type": "object", "properties": { "answer": { "description": "Output only. The piece of text from the `source` knowledge base document.", "type": "string" }, "confidence": { "description": "The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "question": { "description": "Output only. The corresponding FAQ question.", "type": "string" }, "source": { "description": "Output only. Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.", "type": "string" }, "metadata": { "description": "Output only. A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "Output only. The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2beta1CompileSuggestionRequest": { "id": "GoogleCloudDialogflowV2beta1CompileSuggestionRequest", "deprecated": true, "description": "The request message for Participants.CompileSuggestion.", "type": "object", "properties": { "latestMessage": { "description": "Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. If zero or less than zero, 20 is used.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1CompileSuggestionResponse": { "id": "GoogleCloudDialogflowV2beta1CompileSuggestionResponse", "deprecated": true, "description": "The response message for Participants.CompileSuggestion.", "type": "object", "properties": { "suggestion": { "description": "The compiled suggestion.", "$ref": "GoogleCloudDialogflowV2beta1Suggestion" }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the CompileSuggestionRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1AnswerRecord": { "id": "GoogleCloudDialogflowV2beta1AnswerRecord", "description": "Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes: - human agent assistant article suggestion - human agent assistant faq article It doesn't include: - `DetectIntent` intent matching - `DetectIntent` knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is: 1. For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers. 2. The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method to send feedback about a specific answer that they believe is wrong.", "type": "object", "properties": { "name": { "description": "The unique identifier of this answer record. Required for AnswerRecords.UpdateAnswerRecord method. Format: `projects//locations//answerRecords/`.", "type": "string" }, "answerFeedback": { "description": "Optional. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer.", "$ref": "GoogleCloudDialogflowV2beta1AnswerFeedback" }, "agentAssistantRecord": { "description": "Output only. The record for human agent assistant.", "$ref": "GoogleCloudDialogflowV2beta1AgentAssistantRecord" } } }, "GoogleCloudDialogflowV2beta1AnswerFeedback": { "id": "GoogleCloudDialogflowV2beta1AnswerFeedback", "description": "Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.", "type": "object", "properties": { "correctnessLevel": { "description": "The correctness level of the specific answer.", "type": "string", "enumDescriptions": [ "Correctness level unspecified.", "Answer is totally wrong.", "Answer is partially correct.", "Answer is fully correct." ], "enum": [ "CORRECTNESS_LEVEL_UNSPECIFIED", "NOT_CORRECT", "PARTIALLY_CORRECT", "FULLY_CORRECT" ] }, "agentAssistantDetailFeedback": { "description": "Optional. Detail feedback of agent assistant suggestions.", "$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedback" }, "clicked": { "description": "Indicates whether the answer/item was clicked by the human agent or not. Default to false. For knowledge search, the answer record is considered to be clicked if the answer was copied or any URI was clicked.", "type": "boolean" }, "clickTime": { "description": "Time when the answer/item was clicked.", "type": "string", "format": "google-datetime" }, "displayed": { "description": "Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.", "type": "boolean" }, "displayTime": { "description": "Time when the answer/item was displayed.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1AgentAssistantFeedback": { "id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedback", "description": "Detail feedback of Agent Assistant result.", "type": "object", "properties": { "answerRelevance": { "description": "Optional. Whether or not the suggested answer is relevant. For example: * Query: \"Can I change my mailing address?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * answer_relevance: AnswerRelevance.IRRELEVANT", "type": "string", "enumDescriptions": [ "Answer relevance unspecified.", "Answer is irrelevant to query.", "Answer is relevant to query." ], "enum": [ "ANSWER_RELEVANCE_UNSPECIFIED", "IRRELEVANT", "RELEVANT" ] }, "documentCorrectness": { "description": "Optional. Whether or not the information in the document is correct. For example: * Query: \"Can I return the package in 2 days once received?\" * Suggested document says: \"Items must be returned/exchanged within 60 days of the purchase date.\" * Ground truth: \"No return or exchange is allowed.\" * [document_correctness]: INCORRECT", "type": "string", "enumDescriptions": [ "Document correctness unspecified.", "Information in document is incorrect.", "Information in document is correct." ], "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", "INCORRECT", "CORRECT" ] }, "documentEfficiency": { "description": "Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.", "type": "string", "enumDescriptions": [ "Document efficiency unspecified.", "Document is inefficient.", "Document is efficient." ], "enum": [ "DOCUMENT_EFFICIENCY_UNSPECIFIED", "INEFFICIENT", "EFFICIENT" ] }, "summarizationFeedback": { "description": "Feedback for conversation summarization.", "$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackSummarizationFeedback" }, "knowledgeSearchFeedback": { "description": "Optional. Feedback for knowledge search.", "$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback" } } }, "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackSummarizationFeedback": { "id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackSummarizationFeedback", "description": "Feedback for conversation summarization.", "type": "object", "properties": { "startTimestamp": { "description": "Timestamp when composing of the summary starts.", "type": "string", "format": "google-datetime" }, "submitTimestamp": { "description": "Timestamp when the summary was submitted.", "type": "string", "format": "google-datetime" }, "summaryText": { "description": "Text of actual submitted summary.", "type": "string" }, "textSections": { "description": "Optional. Actual text sections of submitted summary.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback": { "id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeSearchFeedback", "description": "Feedback for knowledge search.", "type": "object", "properties": { "answerCopied": { "description": "Whether the answer was copied by the human agent or not. If the value is set to be true, AnswerFeedback.clicked will be updated to be true.", "type": "boolean" }, "clickedUris": { "description": "The URIs clicked by the human agent. The value is appended for each UpdateAnswerRecordRequest. If the value is not empty, AnswerFeedback.clicked will be updated to be true.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1AgentAssistantRecord": { "id": "GoogleCloudDialogflowV2beta1AgentAssistantRecord", "description": "Represents a record of a human agent assistant answer.", "type": "object", "properties": { "articleSuggestionAnswer": { "description": "Output only. The article suggestion answer.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1ArticleAnswer" }, "faqAnswer": { "description": "Output only. The FAQ answer.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1FaqAnswer" }, "dialogflowAssistAnswer": { "description": "Output only. The Dialogflow assist answer.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer" } } }, "GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse": { "id": "GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse", "description": "Response message for AnswerRecords.ListAnswerRecords.", "type": "object", "properties": { "answerRecords": { "description": "The list of answer records.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" } }, "nextPageToken": { "description": "A token to retrieve next page of results. Or empty if there are no more results. Pass this value in the ListAnswerRecordsRequest.page_token field in the subsequent call to `ListAnswerRecords` method to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListDocumentsResponse": { "id": "GoogleCloudDialogflowV2beta1ListDocumentsResponse", "description": "Response message for Documents.ListDocuments.", "type": "object", "properties": { "documents": { "description": "The list of documents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Document" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Document": { "id": "GoogleCloudDialogflowV2beta1Document", "description": "A knowledge document to be used by a KnowledgeBase. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", "type": "object", "properties": { "name": { "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.", "type": "string" }, "displayName": { "description": "Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.", "type": "string" }, "mimeType": { "description": "Required. The MIME type of this document.", "type": "string" }, "knowledgeTypes": { "description": "Required. The knowledge type of document content.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "The type is unspecified or arbitrary.", "The document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.", "Documents for which unstructured text is extracted and used for question answering.", "The entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.", "The document contains agent-facing Smart Reply entries.", "The legacy enum for agent-facing smart reply feature." ], "enum": [ "KNOWLEDGE_TYPE_UNSPECIFIED", "FAQ", "EXTRACTIVE_QA", "ARTICLE_SUGGESTION", "AGENT_FACING_SMART_REPLY", "SMART_REPLY" ] } }, "contentUri": { "description": "The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs:///`. 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.", "type": "string" }, "content": { "description": "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.", "deprecated": true, "type": "string" }, "rawContent": { "description": "The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.", "type": "string", "format": "byte" }, "enableAutoReload": { "description": "Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see `source` field for the source types. Reload status can be tracked in `latest_reload_status`. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling `ReloadDocument` and clear the errors.", "type": "boolean" }, "latestReloadStatus": { "description": "Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1DocumentReloadStatus" }, "metadata": { "description": "Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a `key` or a `value` of the metadata is 1024 bytes.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "description": "Output only. The current state of the document.", "readOnly": true, "type": "string", "enumDescriptions": [ "The document state is unspecified.", "The document creation is in progress.", "The document is active and ready to use.", "The document updation is in progress.", "The document is reloading.", "The document deletion is in progress." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "RELOADING", "DELETING" ] } } }, "GoogleCloudDialogflowV2beta1DocumentReloadStatus": { "id": "GoogleCloudDialogflowV2beta1DocumentReloadStatus", "description": "The status of a reload attempt.", "type": "object", "properties": { "time": { "description": "Output only. The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.", "type": "string", "format": "google-datetime" }, "status": { "description": "Output only. The status of a reload attempt or the initial load.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDialogflowV2beta1ImportDocumentsRequest": { "id": "GoogleCloudDialogflowV2beta1ImportDocumentsRequest", "description": "Request message for Documents.ImportDocuments.", "type": "object", "properties": { "gcsSource": { "description": "Optional. The Google Cloud Storage location for the documents. The path can include a wildcard. These URIs may have the forms `gs:///`. `gs:////*.`.", "$ref": "GoogleCloudDialogflowV2beta1GcsSources" }, "documentTemplate": { "description": "Required. Document template used for importing all the documents.", "$ref": "GoogleCloudDialogflowV2beta1ImportDocumentTemplate" }, "importGcsCustomMetadata": { "description": "Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1GcsSources": { "id": "GoogleCloudDialogflowV2beta1GcsSources", "description": "Google Cloud Storage locations for the inputs.", "type": "object", "properties": { "uris": { "description": "Required. Google Cloud Storage URIs for the inputs. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1ImportDocumentTemplate": { "id": "GoogleCloudDialogflowV2beta1ImportDocumentTemplate", "description": "The template used for importing documents.", "type": "object", "properties": { "mimeType": { "description": "Required. The MIME type of the document.", "type": "string" }, "knowledgeTypes": { "description": "Required. The knowledge type of document content.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "The type is unspecified or arbitrary.", "The document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.", "Documents for which unstructured text is extracted and used for question answering.", "The entire document content as a whole can be used for query results. Only for Contact Center Solutions on Dialogflow.", "The document contains agent-facing Smart Reply entries.", "The legacy enum for agent-facing smart reply feature." ], "enum": [ "KNOWLEDGE_TYPE_UNSPECIFIED", "FAQ", "EXTRACTIVE_QA", "ARTICLE_SUGGESTION", "AGENT_FACING_SMART_REPLY", "SMART_REPLY" ] } }, "metadata": { "description": "Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a `key` or a `value` of the metadata is 1024 bytes.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1ReloadDocumentRequest": { "id": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest", "description": "Request message for Documents.ReloadDocument.", "type": "object", "properties": { "gcsSource": { "description": "The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded.", "$ref": "GoogleCloudDialogflowV2beta1GcsSource" }, "importGcsCustomMetadata": { "description": "Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1GcsSource": { "id": "GoogleCloudDialogflowV2beta1GcsSource", "description": "Google Cloud Storage location for single input.", "type": "object", "properties": { "uri": { "description": "Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse": { "id": "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse", "description": "The response message for ConversationProfiles.ListConversationProfiles.", "type": "object", "properties": { "conversationProfiles": { "description": "The list of project conversation profiles. There is a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ConversationProfile": { "id": "GoogleCloudDialogflowV2beta1ConversationProfile", "description": "Defines the services to connect to incoming Dialogflow conversations.", "type": "object", "properties": { "name": { "description": "The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`.", "type": "string" }, "displayName": { "description": "Required. Human readable name for this profile. Max length 1024 bytes.", "type": "string" }, "createTime": { "description": "Output only. Create time of the conversation profile.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Update time of the conversation profile.", "readOnly": true, "type": "string", "format": "google-datetime" }, "automatedAgentConfig": { "description": "Configuration for an automated agent to use with this profile.", "$ref": "GoogleCloudDialogflowV2beta1AutomatedAgentConfig" }, "humanAgentAssistantConfig": { "description": "Configuration for agent assistance to use with this profile.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig" }, "humanAgentHandoffConfig": { "description": "Configuration for connecting to a live agent. Currently, this feature is not general available, please contact Google to get access.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfig" }, "notificationConfig": { "description": "Configuration for publishing conversation lifecycle events.", "$ref": "GoogleCloudDialogflowV2beta1NotificationConfig" }, "loggingConfig": { "description": "Configuration for logging conversation lifecycle events.", "$ref": "GoogleCloudDialogflowV2beta1LoggingConfig" }, "newMessageEventNotificationConfig": { "description": "Configuration for publishing new message events. Event will be sent in format of ConversationEvent", "$ref": "GoogleCloudDialogflowV2beta1NotificationConfig" }, "sttConfig": { "description": "Settings for speech transcription.", "$ref": "GoogleCloudDialogflowV2beta1SpeechToTextConfig" }, "languageCode": { "description": "Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-us languages. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "timeZone": { "description": "The time zone of this conversational profile from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. Defaults to America/New_York.", "type": "string" }, "securitySettings": { "description": "Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.", "type": "string" }, "ttsConfig": { "description": "Configuration for Text-to-Speech synthesization. Used by Phone Gateway to specify synthesization options. If agent defines synthesization options as well, agent settings overrides the option here.", "$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig" } } }, "GoogleCloudDialogflowV2beta1AutomatedAgentConfig": { "id": "GoogleCloudDialogflowV2beta1AutomatedAgentConfig", "description": "Defines the Automated Agent to connect to a conversation.", "type": "object", "properties": { "agent": { "description": "Required. ID of the Dialogflow agent environment to use. This project needs to either be the same project as the conversation or you need to grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API Service Agent` role in this project. - For ES agents, use format: `projects//locations//agent/environments/`. If environment is not specified, the default `draft` environment is used. Refer to [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2beta1#google.cloud.dialogflow.v2beta1.DetectIntentRequest) for more details. - For CX agents, use format `projects//locations//agents//environments/`. If environment is not specified, the default `draft` environment is used.", "type": "string" }, "sessionTtl": { "description": "Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig", "description": "Defines the Human Agent Assistant to connect to a conversation.", "type": "object", "properties": { "notificationConfig": { "description": "Pub/Sub topic on which to publish new agent assistant events.", "$ref": "GoogleCloudDialogflowV2beta1NotificationConfig" }, "humanAgentSuggestionConfig": { "description": "Configuration for agent assistance of human agent participant.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig" }, "endUserSuggestionConfig": { "description": "Configuration for agent assistance of end user participant. Currently, this feature is not general available, please contact Google to get access.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig" }, "messageAnalysisConfig": { "description": "Configuration for message analysis.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigMessageAnalysisConfig" } } }, "GoogleCloudDialogflowV2beta1NotificationConfig": { "id": "GoogleCloudDialogflowV2beta1NotificationConfig", "description": "Defines notification behavior.", "type": "object", "properties": { "topic": { "description": "Name of the Pub/Sub topic to publish conversation events like CONVERSATION_STARTED as serialized ConversationEvent protos. For telephony integration to receive notification, make sure either this topic is in the same project as the conversation or you grant `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service Agent` role in the topic project. For chat integration to receive notification, make sure API caller has been granted the `Dialogflow Service Agent` role for the topic. Format: `projects//locations//topics/`.", "type": "string" }, "messageFormat": { "description": "Format of message.", "type": "string", "enumDescriptions": [ "If it is unspecified, PROTO will be used.", "Pub/Sub message will be serialized proto.", "Pub/Sub message will be json." ], "enum": [ "MESSAGE_FORMAT_UNSPECIFIED", "PROTO", "JSON" ] } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig", "description": "Detail human agent assistant config.", "type": "object", "properties": { "featureConfigs": { "description": "Configuration of different suggestion features. One feature can have only one config.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfig" } }, "groupSuggestionResponses": { "description": "If `group_suggestion_responses` is false, and there are multiple `feature_configs` in `event based suggestion` or StreamingAnalyzeContent, we will try to deliver suggestions to customers as soon as we get new suggestion. Different type of suggestions based on the same context will be in separate Pub/Sub event or `StreamingAnalyzeContentResponse`. If `group_suggestion_responses` set to true. All the suggestions to the same participant based on the same context will be grouped into a single Pub/Sub event or StreamingAnalyzeContentResponse.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfig", "description": "Config for suggestion features.", "type": "object", "properties": { "suggestionFeature": { "description": "The suggestion feature.", "$ref": "GoogleCloudDialogflowV2beta1SuggestionFeature" }, "enableEventBasedSuggestion": { "description": "Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, ENTITY_EXTRACTION, KNOWLEDGE_ASSIST.", "type": "boolean" }, "disableAgentQueryLogging": { "description": "Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH.", "type": "boolean" }, "enableConversationAugmentedQuery": { "description": "Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.", "type": "boolean" }, "suggestionTriggerSettings": { "description": "Settings of suggestion trigger. Currently, only ARTICLE_SUGGESTION, FAQ, and DIALOGFLOW_ASSIST will use this field.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionTriggerSettings" }, "queryConfig": { "description": "Configs of query.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig" }, "conversationModelConfig": { "description": "Configs of custom conversation model.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationModelConfig" }, "conversationProcessConfig": { "description": "Configs for processing conversation.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationProcessConfig" } } }, "GoogleCloudDialogflowV2beta1SuggestionFeature": { "id": "GoogleCloudDialogflowV2beta1SuggestionFeature", "description": "The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "type": "object", "properties": { "type": { "description": "Type of Human Agent Assistant API feature to request.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", "KNOWLEDGE_SEARCH" ] } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionTriggerSettings": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionTriggerSettings", "description": "Settings of suggestion trigger.", "type": "object", "properties": { "noSmallTalk": { "description": "Do not trigger if last utterance is small talk.", "type": "boolean" }, "onlyEndUser": { "description": "Only trigger suggestion if participant role of last utterance is END_USER.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfig", "description": "Config for suggestion query.", "type": "object", "properties": { "knowledgeBaseQuerySource": { "description": "Query from knowledgebase. It is used by: ARTICLE_SUGGESTION, FAQ.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource" }, "documentQuerySource": { "description": "Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource" }, "dialogflowQuerySource": { "description": "Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource" }, "maxResults": { "description": "Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.", "type": "integer", "format": "int32" }, "confidenceThreshold": { "description": "Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it is default to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.", "type": "number", "format": "float" }, "contextFilterSettings": { "description": "Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings" }, "sections": { "description": "Optional. The customized sections chosen to return when requesting a summary of a conversation.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigSections" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigKnowledgeBaseQuerySource", "description": "Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.", "type": "object", "properties": { "knowledgeBases": { "description": "Required. Knowledge bases to query. Format: `projects//locations//knowledgeBases/`. Currently, only one knowledge base is supported.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDocumentQuerySource", "description": "Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.", "type": "object", "properties": { "documents": { "description": "Required. Knowledge documents to query from. Format: `projects//locations//knowledgeBases//documents/`. Currently, only one document is supported.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource", "description": "Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.", "type": "object", "properties": { "agent": { "description": "Required. The name of a dialogflow virtual agent used for end user side intent detection and suggestion. Format: `projects//locations//agent`. When multiple agents are allowed in the same Dialogflow project.", "type": "string" }, "humanAgentSideConfig": { "description": "The Dialogflow assist configuration for human agent.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySourceHumanAgentSideConfig", "description": "The configuration used for human agent side Dialogflow assist suggestion.", "type": "object", "properties": { "agent": { "description": "Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: `projects//locations//agent`.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings", "description": "Settings that determine how to filter recent conversation context when generating suggestions.", "type": "object", "properties": { "dropHandoffMessages": { "description": "If set to true, the last message from virtual agent (hand off message) and the message before it (trigger message of hand off) are dropped.", "type": "boolean" }, "dropVirtualAgentMessages": { "description": "If set to true, all messages from virtual agent are dropped.", "type": "boolean" }, "dropIvrMessages": { "description": "If set to true, all messages from ivr stage are dropped.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigSections": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigSections", "description": "Custom sections to return when requesting a summary of a conversation. This is only supported when `baseline_model_version` == '2.0'. Supported features: CONVERSATION_SUMMARIZATION, CONVERSATION_SUMMARIZATION_VOICE.", "type": "object", "properties": { "sectionTypes": { "description": "The selected sections chosen to return when requesting a summary of a conversation. A duplicate selected section will be treated as a single selected section. If section types are not provided, the default will be {SITUATION, ACTION, RESULT}.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Undefined section type, does not return anything.", "What the customer needs help with or has question about. Section name: \"situation\".", "What the agent does to help the customer. Section name: \"action\".", "Result of the customer service. A single word describing the result of the conversation. Section name: \"resolution\".", "Reason for cancellation if the customer requests for a cancellation. \"N/A\" otherwise. Section name: \"reason_for_cancellation\".", "\"Unsatisfied\" or \"Satisfied\" depending on the customer's feelings at the end of the conversation. Section name: \"customer_satisfaction\".", "Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by \"entities/\"." ], "enum": [ "SECTION_TYPE_UNSPECIFIED", "SITUATION", "ACTION", "RESOLUTION", "REASON_FOR_CANCELLATION", "CUSTOMER_SATISFACTION", "ENTITIES" ] } } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationModelConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationModelConfig", "description": "Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.", "type": "object", "properties": { "model": { "description": "Conversation model resource name. Format: `projects//conversationModels/`.", "type": "string" }, "baselineModelVersion": { "description": "Version of current baseline model. It will be ignored if model is set. Valid versions are: Article Suggestion baseline model: - 0.9 - 1.0 (default) Summarization baseline model: - 1.0", "type": "string" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationProcessConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigConversationProcessConfig", "description": "Config to process conversation.", "type": "object", "properties": { "recentSentencesCount": { "description": "Number of recent non-small-talk sentences to use as context for article and FAQ suggestion", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigMessageAnalysisConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigMessageAnalysisConfig", "description": "Configuration for analyses to run on each conversation message.", "type": "object", "properties": { "enableEntityExtraction": { "description": "Enable entity extraction in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Currently, this feature is not general available, please contact Google to get access.", "type": "boolean" }, "enableSentimentAnalysis": { "description": "Enable sentiment analysis in conversation messages on [agent assist stage](https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages). If unspecified, defaults to false. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral: https://cloud.google.com/natural-language/docs/basics#sentiment_analysis For Participants.StreamingAnalyzeContent method, result will be in StreamingAnalyzeContentResponse.message.SentimentAnalysisResult. For Participants.AnalyzeContent method, result will be in AnalyzeContentResponse.message.SentimentAnalysisResult For Conversations.ListMessages method, result will be in ListMessagesResponse.messages.SentimentAnalysisResult If Pub/Sub notification is configured, result will be in ConversationEvent.new_message_payload.SentimentAnalysisResult.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfig", "description": "Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access.", "type": "object", "properties": { "livePersonConfig": { "description": "Uses LivePerson (https://www.liveperson.com).", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigLivePersonConfig" }, "salesforceLiveAgentConfig": { "description": "Uses Salesforce Live Agent.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigSalesforceLiveAgentConfig" } } }, "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigLivePersonConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigLivePersonConfig", "description": "Configuration specific to LivePerson (https://www.liveperson.com).", "type": "object", "properties": { "accountNumber": { "description": "Required. Account number of the LivePerson account to connect. This is the account number you input at the login page.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigSalesforceLiveAgentConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentHandoffConfigSalesforceLiveAgentConfig", "description": "Configuration specific to Salesforce Live Agent.", "type": "object", "properties": { "organizationId": { "description": "Required. The organization ID of the Salesforce account.", "type": "string" }, "deploymentId": { "description": "Required. Live Agent deployment ID.", "type": "string" }, "buttonId": { "description": "Required. Live Agent chat button ID.", "type": "string" }, "endpointDomain": { "description": "Required. Domain of the Live Agent endpoint for this agent. You can find the endpoint URL in the `Live Agent settings` page. For example if URL has the form https://d.la4-c2-phx.salesforceliveagent.com/..., you should fill in d.la4-c2-phx.salesforceliveagent.com.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1LoggingConfig": { "id": "GoogleCloudDialogflowV2beta1LoggingConfig", "description": "Defines logging behavior for conversation lifecycle events.", "type": "object", "properties": { "enableStackdriverLogging": { "description": "Whether to log conversation events like CONVERSATION_STARTED to Stackdriver in the conversation project as JSON format ConversationEvent protos.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1SpeechToTextConfig": { "id": "GoogleCloudDialogflowV2beta1SpeechToTextConfig", "description": "Configures speech transcription for ConversationProfile.", "type": "object", "properties": { "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "type": "string", "enumDescriptions": [ "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) 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](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." ], "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", "USE_STANDARD", "USE_ENHANCED" ] }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, "useTimeoutBasedEndpointing": { "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", "type": "boolean" } } }, "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest": { "id": "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest", "description": "The request message for ConversationProfiles.SetSuggestionFeature.", "type": "object", "properties": { "participantRole": { "description": "Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureConfig": { "description": "Required. The suggestion feature config to add or update.", "$ref": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionFeatureConfig" } } }, "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest": { "id": "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest", "description": "The request message for ConversationProfiles.ClearFeature.", "type": "object", "properties": { "participantRole": { "description": "Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureType": { "description": "Required. The type of the suggestion feature to remove.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", "KNOWLEDGE_SEARCH" ] } } }, "GoogleCloudDialogflowV2beta1Conversation": { "id": "GoogleCloudDialogflowV2beta1Conversation", "description": "Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this conversation. Format: `projects//locations//conversations/`.", "readOnly": true, "type": "string" }, "lifecycleState": { "description": "Output only. The current state of the Conversation.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unknown.", "Conversation is currently open for media analysis.", "Conversation has been completed." ], "enum": [ "LIFECYCLE_STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED" ] }, "conversationProfile": { "description": "Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.", "type": "string" }, "phoneNumber": { "description": "Output only. Required if the conversation is to be connected over telephony.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2beta1ConversationPhoneNumber" }, "conversationStage": { "description": "The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.", "type": "string", "enumDescriptions": [ "Unknown. Should never be used after a conversation is successfully created.", "The conversation should return virtual agent responses into the conversation.", "The conversation should not provide responses, just listen and provide suggestions." ], "enum": [ "CONVERSATION_STAGE_UNSPECIFIED", "VIRTUAL_AGENT_STAGE", "HUMAN_ASSIST_STAGE" ] }, "startTime": { "description": "Output only. The time the conversation was started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the conversation was finished.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1ConversationPhoneNumber": { "id": "GoogleCloudDialogflowV2beta1ConversationPhoneNumber", "description": "Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.", "type": "object", "properties": { "phoneNumber": { "description": "Output only. The phone number to connect to this conversation.", "readOnly": true, "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListConversationsResponse": { "id": "GoogleCloudDialogflowV2beta1ListConversationsResponse", "description": "The response message for Conversations.ListConversations.", "type": "object", "properties": { "conversations": { "description": "The list of conversations. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1CompleteConversationRequest": { "id": "GoogleCloudDialogflowV2beta1CompleteConversationRequest", "description": "The request message for Conversations.CompleteConversation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest": { "id": "GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest", "description": "The request message for Conversations.BatchCreateMessagesRequest.", "type": "object", "properties": { "requests": { "description": "Required. A maximum of 300 messages can be created in a batch. CreateMessageRequest.message.send_time is required. All created messages will have identical Message.create_time.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1CreateMessageRequest" } } } }, "GoogleCloudDialogflowV2beta1CreateMessageRequest": { "id": "GoogleCloudDialogflowV2beta1CreateMessageRequest", "description": "The request message to create one Message. Currently it is only used in BatchCreateMessagesRequest.", "type": "object", "properties": { "parent": { "description": "Required. Resource identifier of the conversation to create message. Format: `projects//locations//conversations/`.", "type": "string" }, "message": { "description": "Required. The message to create. Message.participant is required.", "$ref": "GoogleCloudDialogflowV2beta1Message" } } }, "GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse": { "id": "GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse", "description": "The request message for Conversations.BatchCreateMessagesResponse.", "type": "object", "properties": { "messages": { "description": "Messages created.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Message" } } } }, "GoogleCloudDialogflowV2beta1ListMessagesResponse": { "id": "GoogleCloudDialogflowV2beta1ListMessagesResponse", "description": "The response message for Conversations.ListMessages.", "type": "object", "properties": { "messages": { "description": "Required. The list of messages. There will be a maximum number of items returned based on the page_size field in the request. `messages` is sorted by `create_time` in descending order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Message" } }, "nextPageToken": { "description": "Optional. Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest": { "id": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest", "description": "The request message for Conversations.SuggestConversationSummary.", "type": "object", "properties": { "latestMessage": { "description": "The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.", "type": "integer", "format": "int32" }, "assistQueryParams": { "description": "Parameters for a human assist query. Only used for POC/demo purpose.", "$ref": "GoogleCloudDialogflowV2beta1AssistQueryParameters" } } }, "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse": { "id": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse", "description": "The response message for Conversations.SuggestConversationSummary.", "type": "object", "properties": { "summary": { "description": "Generated summary.", "$ref": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponseSummary" }, "latestMessage": { "description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including last_conversation_message used to compile the suggestion. It may be smaller than the SuggestSummaryRequest.context_size field in the request if there weren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponseSummary": { "id": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponseSummary", "description": "Generated summary for a conversation.", "type": "object", "properties": { "text": { "description": "The summary content that is concatenated into one string.", "type": "string" }, "textSections": { "description": "The summary content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of the answer record. Format: \"projects//answerRecords/\"", "type": "string" }, "baselineModelVersion": { "description": "The baseline model version used to generate this summary. It is empty if a baseline model was not used to generate this summary.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest": { "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest", "description": "The request message for Conversations.GenerateStatelessSummary.", "type": "object", "properties": { "statelessConversation": { "description": "Required. The conversation to suggest a summary for.", "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequestMinimalConversation" }, "conversationProfile": { "description": "Required. A ConversationProfile containing information required for Summary generation. Required fields: {language_code, security_settings} Optional fields: {agent_assistant_config}", "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "latestMessage": { "description": "The name of the latest conversation message used as context for generating a Summary. If empty, the latest message of the conversation will be used. The format is specific to the user and the names of the messages provided.", "type": "string" }, "maxContextSize": { "description": "Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequestMinimalConversation": { "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequestMinimalConversation", "description": "The minimum amount of information required to generate a Summary without having a Conversation resource created.", "type": "object", "properties": { "messages": { "description": "Required. The messages that the Summary will be generated from. It is expected that this message content is already redacted and does not contain any PII. Required fields: {content, language_code, participant, participant_role} Optional fields: {send_time} If send_time is not provided, then the messages must be provided in chronological order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Message" } } } }, "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse": { "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse", "description": "The response message for Conversations.GenerateStatelessSummary.", "type": "object", "properties": { "summary": { "description": "Generated summary.", "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponseSummary" }, "latestMessage": { "description": "The name of the latest conversation message used as context for compiling suggestion. The format is specific to the user and the names of the messages provided.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including last_conversation_message used to compile the suggestion. It may be smaller than the GenerateStatelessSummaryRequest.context_size field in the request if there weren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponseSummary": { "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponseSummary", "description": "Generated summary for a conversation.", "type": "object", "properties": { "text": { "description": "The summary content that is concatenated into one string.", "type": "string" }, "textSections": { "description": "The summary content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.", "type": "object", "additionalProperties": { "type": "string" } }, "baselineModelVersion": { "description": "The baseline model version used to generate this summary. It is empty if a baseline model was not used to generate this summary.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest", "description": "The request message for Conversations.SearchKnowledge.", "type": "object", "properties": { "parent": { "description": "The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`.", "type": "string" }, "query": { "description": "Required. The natural language text query for knowledge search.", "$ref": "GoogleCloudDialogflowV2beta1TextInput" }, "conversationProfile": { "description": "Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`.", "type": "string" }, "sessionId": { "description": "The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", "type": "string" }, "conversation": { "description": "The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`.", "type": "string" }, "latestMessage": { "description": "The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse", "description": "The response message for Conversations.SearchKnowledge.", "type": "object", "properties": { "answers": { "description": "Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer" } }, "rewrittenQuery": { "description": "The rewritten query used to search knowledge.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer", "description": "Represents a SearchKnowledge answer.", "type": "object", "properties": { "answer": { "description": "The piece of text from the knowledge base documents that answers the search query", "type": "string" }, "answerType": { "description": "The type of the answer.", "type": "string", "enumDescriptions": [ "The answer has a unspecified type.", "The answer is from FAQ documents.", "The answer is from generative model.", "The answer is from intent matching." ], "enum": [ "ANSWER_TYPE_UNSPECIFIED", "FAQ", "GENERATIVE", "INTENT" ] }, "answerSources": { "description": "All sources used to generate the answer.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource" } }, "answerRecord": { "description": "The name of the answer record. Format: `projects//locations//answer Records/`", "type": "string" } } }, "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource", "description": "The sources of the answers.", "type": "object", "properties": { "title": { "description": "The title of the article.", "type": "string" }, "uri": { "description": "The URI of the article.", "type": "string" }, "snippet": { "description": "The relevant snippet of the article.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse": { "id": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse", "description": "Response message for KnowledgeBases.ListKnowledgeBases.", "type": "object", "properties": { "knowledgeBases": { "description": "The list of knowledge bases.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1KnowledgeBase": { "id": "GoogleCloudDialogflowV2beta1KnowledgeBase", "description": "A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", "type": "object", "properties": { "name": { "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.", "type": "string" }, "displayName": { "description": "Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.", "type": "string" }, "languageCode": { "description": "Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1ListVersionsResponse": { "id": "GoogleCloudDialogflowV2beta1ListVersionsResponse", "description": "The response message for Versions.ListVersions.", "type": "object", "properties": { "versions": { "description": "The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Version" } }, "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1Version": { "id": "GoogleCloudDialogflowV2beta1Version", "description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "readOnly": true, "type": "string" }, "description": { "description": "Optional. The developer-provided description of this version.", "type": "string" }, "versionNumber": { "description": "Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods.", "readOnly": true, "type": "integer", "format": "int32" }, "createTime": { "description": "Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods.", "readOnly": true, "type": "string", "format": "google-datetime" }, "status": { "description": "Output only. The status of this version. This field is read-only and cannot be set by create and update methods.", "readOnly": true, "type": "string", "enumDescriptions": [ "Not specified. This value is not used.", "Version is not ready to serve (e.g. training is in progress).", "Version is ready to serve.", "Version training failed." ], "enum": [ "VERSION_STATUS_UNSPECIFIED", "IN_PROGRESS", "READY", "FAILED" ] } } }, "GoogleCloudLocationListLocationsResponse": { "id": "GoogleCloudLocationListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleCloudLocationLocation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleCloudLocationLocation": { "id": "GoogleCloudLocationLocation", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "type": "object", "properties": { "version": { "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3ExportAgentResponse": { "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", "description": "The response message for Agents.ExportAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" }, "agentContent": { "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "type": "string", "format": "byte" }, "commitSha": { "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } } }, "GoogleCloudDialogflowCxV3ExportFlowResponse": { "id": "GoogleCloudDialogflowCxV3ExportFlowResponse", "description": "The response message for Flows.ExportFlow.", "type": "object", "properties": { "flowUri": { "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", "type": "string" }, "flowContent": { "description": "Uncompressed raw byte content for flow.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3ExportIntentsMetadata": { "id": "GoogleCloudDialogflowCxV3ExportIntentsMetadata", "description": "Metadata returned for the Intents.ExportIntents long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ExportIntentsResponse": { "id": "GoogleCloudDialogflowCxV3ExportIntentsResponse", "description": "The response message for Intents.ExportIntents.", "type": "object", "properties": { "intentsUri": { "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", "type": "string" }, "intentsContent": { "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest.", "$ref": "GoogleCloudDialogflowCxV3InlineDestination" } } }, "GoogleCloudDialogflowCxV3InlineDestination": { "id": "GoogleCloudDialogflowCxV3InlineDestination", "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", "type": "object", "properties": { "content": { "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", "readOnly": true, "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3ImportFlowResponse": { "id": "GoogleCloudDialogflowCxV3ImportFlowResponse", "description": "The response message for Flows.ImportFlow.", "type": "object", "properties": { "flow": { "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": { "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata", "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ImportEntityTypesResponse": { "id": "GoogleCloudDialogflowCxV3ImportEntityTypesResponse", "description": "The response message for EntityTypes.ImportEntityTypes.", "type": "object", "properties": { "entityTypes": { "description": "The unique identifier of the imported entity types. Format: `projects//locations//agents//entity_types/`.", "type": "array", "items": { "type": "string" } }, "conflictingResources": { "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportEntityTypesRequest.", "$ref": "GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources" } } }, "GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources": { "id": "GoogleCloudDialogflowCxV3ImportEntityTypesResponseConflictingResources", "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", "type": "object", "properties": { "entityTypeDisplayNames": { "description": "Display names of conflicting entity types.", "type": "array", "items": { "type": "string" } }, "entityDisplayNames": { "description": "Display names of conflicting entities.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3ExportEntityTypesMetadata": { "id": "GoogleCloudDialogflowCxV3ExportEntityTypesMetadata", "description": "Metadata returned for the EntityTypes.ExportEntityTypes long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ExportEntityTypesResponse": { "id": "GoogleCloudDialogflowCxV3ExportEntityTypesResponse", "description": "The response message for EntityTypes.ExportEntityTypes.", "type": "object", "properties": { "entityTypesUri": { "description": "The URI to a file containing the exported entity types. This field is populated only if `entity_types_uri` is specified in ExportEntityTypesRequest.", "type": "string" }, "entityTypesContent": { "description": "Uncompressed byte content for entity types. This field is populated only if `entity_types_content_inline` is set to true in ExportEntityTypesRequest.", "$ref": "GoogleCloudDialogflowCxV3InlineDestination" } } }, "GoogleCloudDialogflowCxV3ImportIntentsMetadata": { "id": "GoogleCloudDialogflowCxV3ImportIntentsMetadata", "description": "Metadata returned for the Intents.ImportIntents long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ImportIntentsResponse": { "id": "GoogleCloudDialogflowCxV3ImportIntentsResponse", "description": "The response message for Intents.ImportIntents.", "type": "object", "properties": { "intents": { "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", "type": "array", "items": { "type": "string" } }, "conflictingResources": { "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest.", "$ref": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources" } } }, "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources": { "id": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", "type": "object", "properties": { "intentDisplayNames": { "description": "Display names of conflicting intents.", "type": "array", "items": { "type": "string" } }, "entityDisplayNames": { "description": "Display names of conflicting entities.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3WebhookRequest": { "id": "GoogleCloudDialogflowCxV3WebhookRequest", "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "type": "object", "properties": { "detectIntentResponseId": { "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", "type": "string" }, "text": { "description": "If natural language text was provided as input, this field will contain a copy of the text.", "type": "string" }, "triggerIntent": { "description": "If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`.", "type": "string" }, "transcript": { "description": "If natural language speech audio was provided as input, this field will contain the transcript for the audio.", "type": "string" }, "triggerEvent": { "description": "If an event was provided as input, this field will contain the name of the event.", "type": "string" }, "dtmfDigits": { "description": "If DTMF was provided as input, this field will contain the DTMF digits.", "type": "string" }, "languageCode": { "description": "The language code specified in the original request.", "type": "string" }, "fulfillmentInfo": { "description": "Always present. Information about the fulfillment that triggered this webhook call.", "$ref": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo" }, "intentInfo": { "description": "Information about the last matched intent.", "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo" }, "pageInfo": { "description": "Information about page status.", "$ref": "GoogleCloudDialogflowCxV3PageInfo" }, "sessionInfo": { "description": "Information about session status.", "$ref": "GoogleCloudDialogflowCxV3SessionInfo" }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" } }, "payload": { "description": "Custom data set in QueryParameters.payload.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "sentimentAnalysisResult": { "description": "The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.", "$ref": "GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult" }, "languageInfo": { "description": "Information about the language of the request.", "$ref": "GoogleCloudDialogflowCxV3LanguageInfo" } } }, "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo": { "id": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo", "description": "Represents fulfillment information communicated to the webhook.", "type": "object", "properties": { "tag": { "description": "Always present. The value of the Fulfillment.tag field will be populated in this field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes.", "type": "string" } } }, "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo": { "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", "description": "Represents intent information communicated to the webhook.", "type": "object", "properties": { "lastMatchedIntent": { "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", "type": "string" }, "displayName": { "description": "Always present. The display name of the last matched intent.", "type": "string" }, "parameters": { "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue" } }, "confidence": { "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue": { "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue", "description": "Represents a value for an intent parameter.", "type": "object", "properties": { "originalValue": { "description": "Always present. Original text value extracted from user utterance.", "type": "string" }, "resolvedValue": { "description": "Always present. Structured value for the parameter extracted from user utterance.", "type": "any" } } }, "GoogleCloudDialogflowCxV3PageInfo": { "id": "GoogleCloudDialogflowCxV3PageInfo", "description": "Represents page information communicated to and from the webhook.", "type": "object", "properties": { "currentPage": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "displayName": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.", "type": "string" }, "formInfo": { "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form.", "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfo" } } }, "GoogleCloudDialogflowCxV3PageInfoFormInfo": { "id": "GoogleCloudDialogflowCxV3PageInfoFormInfo", "description": "Represents form information.", "type": "object", "properties": { "parameterInfo": { "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo" } } } }, "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo": { "id": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo", "description": "Represents parameter information.", "type": "object", "properties": { "displayName": { "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", "type": "string" }, "required": { "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", "type": "boolean" }, "state": { "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "Indicates that the parameter does not have a value.", "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", "Indicates that the parameter has a value." ], "enum": [ "PARAMETER_STATE_UNSPECIFIED", "EMPTY", "INVALID", "FILLED" ] }, "value": { "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", "type": "any" }, "justCollected": { "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3SessionInfo": { "id": "GoogleCloudDialogflowCxV3SessionInfo", "description": "Represents session information communicated to and from the webhook.", "type": "object", "properties": { "session": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", "type": "string" }, "parameters": { "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", "type": "object", "additionalProperties": { "type": "any" } } } }, "GoogleCloudDialogflowCxV3ResponseMessage": { "id": "GoogleCloudDialogflowCxV3ResponseMessage", "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "type": "object", "properties": { "text": { "description": "Returns a text response.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText" }, "payload": { "description": "Returns a response containing a custom, platform-specific payload.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "conversationSuccess": { "description": "Indicates that the conversation succeeded.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess" }, "outputAudioText": { "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText" }, "liveAgentHandoff": { "description": "Hands off conversation to a human agent.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff" }, "endInteraction": { "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", "readOnly": true, "$ref": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction" }, "playAudio": { "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio" }, "mixedAudio": { "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", "readOnly": true, "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio" }, "telephonyTransferCall": { "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall" }, "knowledgeInfoCard": { "description": "Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard" }, "responseType": { "description": "Response type.", "type": "string", "enumDescriptions": [ "Not specified.", "The response is from an entry prompt in the page.", "The response is from form-filling prompt in the page.", "The response is from a transition route or an event handler in the page or flow or transition route group." ], "enum": [ "RESPONSE_TYPE_UNSPECIFIED", "ENTRY_PROMPT", "PARAMETER_PROMPT", "HANDLER_PROMPT" ] }, "channel": { "description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.", "type": "string" } } }, "GoogleCloudDialogflowCxV3ResponseMessageText": { "id": "GoogleCloudDialogflowCxV3ResponseMessageText", "description": "The text response message.", "type": "object", "properties": { "text": { "description": "Required. A collection of text responses.", "type": "array", "items": { "type": "string" } }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess": { "id": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess", "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", "type": "object", "properties": { "metadata": { "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText": { "id": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText", "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", "type": "object", "properties": { "text": { "description": "The raw text to be synthesized.", "type": "string" }, "ssml": { "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff": { "id": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff", "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "type": "object", "properties": { "metadata": { "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction": { "id": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction", "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio": { "id": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", "description": "Specifies an audio clip to be played by the client as part of the response.", "type": "object", "properties": { "audioUri": { "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio": { "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio", "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", "type": "object", "properties": { "segments": { "description": "Segments this audio response is composed of.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment" } } } }, "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment": { "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment", "description": "Represents one segment of audio.", "type": "object", "properties": { "audio": { "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", "type": "string", "format": "byte" }, "uri": { "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall": { "id": "GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall", "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", "type": "object", "properties": { "phoneNumber": { "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", "type": "string" } } }, "GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard": { "id": "GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard", "description": "Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult": { "id": "GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult", "description": "Represents the result of sentiment analysis.", "type": "object", "properties": { "score": { "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", "type": "number", "format": "float" }, "magnitude": { "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3LanguageInfo": { "id": "GoogleCloudDialogflowCxV3LanguageInfo", "description": "Represents the language information of the request.", "type": "object", "properties": { "inputLanguageCode": { "description": "The language code specified in the original request.", "type": "string" }, "resolvedLanguageCode": { "description": "The language code detected for this request based on the user conversation.", "type": "string" }, "confidenceScore": { "description": "The confidence score of the detected language between 0 and 1.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3WebhookResponse": { "id": "GoogleCloudDialogflowCxV3WebhookResponse", "description": "The response message for a webhook call.", "type": "object", "properties": { "fulfillmentResponse": { "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.", "$ref": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse" }, "pageInfo": { "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.", "$ref": "GoogleCloudDialogflowCxV3PageInfo" }, "sessionInfo": { "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.", "$ref": "GoogleCloudDialogflowCxV3SessionInfo" }, "payload": { "description": "Value to append directly to QueryResult.webhook_payloads.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse": { "id": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse", "description": "Represents a fulfillment response to the user.", "type": "object", "properties": { "messages": { "description": "The list of rich message responses to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" } }, "mergeBehavior": { "description": "Merge behavior for `messages`.", "type": "string", "enumDescriptions": [ "Not specified. `APPEND` will be used.", "`messages` will be appended to the list of messages waiting to be sent to the user.", "`messages` will replace the list of messages waiting to be sent to the user." ], "enum": [ "MERGE_BEHAVIOR_UNSPECIFIED", "APPEND", "REPLACE" ] } } }, "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata", "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", "type": "object", "properties": { "errors": { "description": "The test errors.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestError" } } } }, "GoogleCloudDialogflowCxV3TestError": { "id": "GoogleCloudDialogflowCxV3TestError", "description": "Error info for running a test.", "type": "object", "properties": { "testCase": { "description": "The test case resource name.", "type": "string" }, "status": { "description": "The status associated with the test.", "$ref": "GoogleRpcStatus" }, "testTime": { "description": "The timestamp when the test was completed.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse", "description": "The response message for TestCases.BatchRunTestCases.", "type": "object", "properties": { "results": { "description": "The test case results. The detailed conversation turns are empty in this response.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" } } } }, "GoogleCloudDialogflowCxV3TestCaseResult": { "id": "GoogleCloudDialogflowCxV3TestCaseResult", "description": "Represents a result from running a test case in an agent environment.", "type": "object", "properties": { "name": { "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", "type": "string" }, "environment": { "description": "Environment where the test was run. If not set, it indicates the draft environment.", "type": "string" }, "conversationTurns": { "description": "The conversation turns uttered during the test case replay in chronological order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" } }, "testResult": { "description": "Whether the test case passed in the agent environment.", "type": "string", "enumDescriptions": [ "Not specified. Should never be used.", "The test passed.", "The test did not pass." ], "enum": [ "TEST_RESULT_UNSPECIFIED", "PASSED", "FAILED" ] }, "testTime": { "description": "The time that the test was run.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3ConversationTurn": { "id": "GoogleCloudDialogflowCxV3ConversationTurn", "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", "type": "object", "properties": { "userInput": { "description": "The user input.", "$ref": "GoogleCloudDialogflowCxV3ConversationTurnUserInput" }, "virtualAgentOutput": { "description": "The virtual agent output.", "$ref": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput" } } }, "GoogleCloudDialogflowCxV3ConversationTurnUserInput": { "id": "GoogleCloudDialogflowCxV3ConversationTurnUserInput", "description": "The input from the human user.", "type": "object", "properties": { "input": { "description": "Supports text input, event input, dtmf input in the test case.", "$ref": "GoogleCloudDialogflowCxV3QueryInput" }, "injectedParameters": { "description": "Parameters that need to be injected into the conversation during intent detection.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "isWebhookEnabled": { "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", "type": "boolean" }, "enableSentimentAnalysis": { "description": "Whether sentiment analysis is enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3QueryInput": { "id": "GoogleCloudDialogflowCxV3QueryInput", "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client.", "type": "object", "properties": { "text": { "description": "The natural language text to be processed.", "$ref": "GoogleCloudDialogflowCxV3TextInput" }, "intent": { "description": "The intent to be triggered.", "$ref": "GoogleCloudDialogflowCxV3IntentInput" }, "audio": { "description": "The natural language speech audio to be processed.", "$ref": "GoogleCloudDialogflowCxV3AudioInput" }, "event": { "description": "The event to be triggered.", "$ref": "GoogleCloudDialogflowCxV3EventInput" }, "dtmf": { "description": "The DTMF event to be handled.", "$ref": "GoogleCloudDialogflowCxV3DtmfInput" }, "languageCode": { "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) 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.", "type": "string" } } }, "GoogleCloudDialogflowCxV3TextInput": { "id": "GoogleCloudDialogflowCxV3TextInput", "description": "Represents the natural language text to be processed.", "type": "object", "properties": { "text": { "description": "Required. The UTF-8 encoded natural language text to be processed.", "type": "string" } } }, "GoogleCloudDialogflowCxV3IntentInput": { "id": "GoogleCloudDialogflowCxV3IntentInput", "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", "type": "object", "properties": { "intent": { "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3AudioInput": { "id": "GoogleCloudDialogflowCxV3AudioInput", "description": "Represents the natural speech audio to be processed.", "type": "object", "properties": { "config": { "description": "Required. Instructs the speech recognizer how to process the speech audio.", "$ref": "GoogleCloudDialogflowCxV3InputAudioConfig" }, "audio": { "description": "The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3InputAudioConfig": { "id": "GoogleCloudDialogflowCxV3InputAudioConfig", "description": "Instructs the speech recognizer on how to process the audio content.", "type": "object", "properties": { "audioEncoding": { "description": "Required. Audio encoding of the audio content to process.", "type": "string", "enumDescriptions": [ "Not specified.", "Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." ], "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "AUDIO_ENCODING_LINEAR_16", "AUDIO_ENCODING_FLAC", "AUDIO_ENCODING_MULAW", "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" ] }, "sampleRateHertz": { "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "type": "integer", "format": "int32" }, "enableWordInfo": { "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", "type": "boolean" }, "phraseHints": { "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", "type": "array", "items": { "type": "string" } }, "model": { "description": "Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", "type": "string" }, "modelVariant": { "description": "Optional. Which variant of the Speech model to use.", "type": "string", "enumDescriptions": [ "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", "Use the best available variant of the Speech model that the caller is eligible for.", "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants." ], "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", "USE_STANDARD", "USE_ENHANCED" ] }, "singleUtterance": { "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", "type": "boolean" }, "bargeInConfig": { "description": "Configuration of barge-in behavior during the streaming of input audio.", "$ref": "GoogleCloudDialogflowCxV3BargeInConfig" }, "optOutConformerModelMigration": { "description": "If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3BargeInConfig": { "id": "GoogleCloudDialogflowCxV3BargeInConfig", "description": "Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up.", "type": "object", "properties": { "noBargeInDuration": { "description": "Duration that is not eligible for barge-in at the beginning of the input audio.", "type": "string", "format": "google-duration" }, "totalDuration": { "description": "Total duration for the playback at the beginning of the input audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowCxV3EventInput": { "id": "GoogleCloudDialogflowCxV3EventInput", "description": "Represents the event to trigger.", "type": "object", "properties": { "event": { "description": "Name of the event.", "type": "string" } } }, "GoogleCloudDialogflowCxV3DtmfInput": { "id": "GoogleCloudDialogflowCxV3DtmfInput", "description": "Represents the input for dtmf event.", "type": "object", "properties": { "digits": { "description": "The dtmf digits.", "type": "string" }, "finishDigit": { "description": "The finish digit (if any).", "type": "string" } } }, "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput": { "id": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput", "description": "The output from the virtual agent.", "type": "object", "properties": { "sessionParameters": { "description": "The session parameters available to the bot at this point.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "differences": { "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestRunDifference" } }, "diagnosticInfo": { "description": "Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "triggeredIntent": { "description": "The Intent that triggered the response. Only name and displayName will be set.", "$ref": "GoogleCloudDialogflowCxV3Intent" }, "currentPage": { "description": "The Page on which the utterance was spoken. Only name and displayName will be set.", "$ref": "GoogleCloudDialogflowCxV3Page" }, "textResponses": { "description": "The text responses from the agent for the turn.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText" } }, "status": { "description": "Response error from the agent in the test result. If set, other output is empty.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDialogflowCxV3TestRunDifference": { "id": "GoogleCloudDialogflowCxV3TestRunDifference", "description": "The description of differences between original and replayed agent output.", "type": "object", "properties": { "type": { "description": "The type of diff.", "type": "string", "enumDescriptions": [ "Should never be used.", "The intent.", "The page.", "The parameters.", "The message utterance.", "The flow." ], "enum": [ "DIFF_TYPE_UNSPECIFIED", "INTENT", "PAGE", "PARAMETERS", "UTTERANCE", "FLOW" ] }, "description": { "description": "A human readable description of the diff, showing the actual output vs expected output.", "type": "string" } } }, "GoogleCloudDialogflowCxV3Intent": { "id": "GoogleCloudDialogflowCxV3Intent", "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", "type": "object", "properties": { "name": { "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the intent, unique within the agent.", "type": "string" }, "trainingPhrases": { "description": "The collection of training phrases the agent is trained on to identify the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrase" } }, "parameters": { "description": "The collection of parameters associated with the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3IntentParameter" } }, "priority": { "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", "type": "integer", "format": "int32" }, "isFallback": { "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", "type": "boolean" }, "labels": { "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" } } }, "GoogleCloudDialogflowCxV3IntentTrainingPhrase": { "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrase", "description": "Represents an example that the agent is trained on to identify the intent.", "type": "object", "properties": { "id": { "description": "Output only. The unique identifier of the training phrase.", "type": "string" }, "parts": { "description": "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 `parameter_id` field is set.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart" } }, "repeatCount": { "description": "Indicates how many times this example was added to the intent.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart": { "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart", "description": "Represents a part of a training phrase.", "type": "object", "properties": { "text": { "description": "Required. The text for this part.", "type": "string" }, "parameterId": { "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", "type": "string" } } }, "GoogleCloudDialogflowCxV3IntentParameter": { "id": "GoogleCloudDialogflowCxV3IntentParameter", "description": "Represents an intent parameter.", "type": "object", "properties": { "id": { "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", "type": "string" }, "entityType": { "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", "type": "string" }, "isList": { "description": "Indicates whether the parameter represents a list of values.", "type": "boolean" }, "redact": { "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3Page": { "id": "GoogleCloudDialogflowCxV3Page", "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", "type": "object", "properties": { "name": { "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the page, unique within the flow.", "type": "string" }, "description": { "description": "The description of the page. The maximum length is 500 characters.", "type": "string" }, "entryFulfillment": { "description": "The fulfillment to call when the session is entering the page.", "$ref": "GoogleCloudDialogflowCxV3Fulfillment" }, "form": { "description": "The form associated with the page, used for collecting parameters relevant to the page.", "$ref": "GoogleCloudDialogflowCxV3Form" }, "transitionRouteGroups": { "description": "Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -\u003e page's transition route group -\u003e flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", "type": "array", "items": { "type": "string" } }, "transitionRoutes": { "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" } }, "eventHandlers": { "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3EventHandler" } }, "advancedSettings": { "description": "Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettings" }, "knowledgeConnectorSettings": { "description": "Optional. Knowledge connector configuration.", "$ref": "GoogleCloudDialogflowCxV3KnowledgeConnectorSettings" } } }, "GoogleCloudDialogflowCxV3Fulfillment": { "id": "GoogleCloudDialogflowCxV3Fulfillment", "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", "type": "object", "properties": { "messages": { "description": "The list of rich message responses to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" } }, "webhook": { "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", "type": "string" }, "returnPartialResponses": { "description": "Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.", "type": "boolean" }, "tag": { "description": "The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.", "type": "string" }, "setParameterActions": { "description": "Set parameter values before executing the webhook.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction" } }, "conditionalCases": { "description": "Conditional cases for this fulfillment.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases" } }, "advancedSettings": { "description": "Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettings" }, "enableGenerativeFallback": { "description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": { "id": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction", "description": "Setting a parameter value.", "type": "object", "properties": { "parameter": { "description": "Display name of the parameter.", "type": "string" }, "value": { "description": "The new value of the parameter. A null value clears the parameter.", "type": "any" } } }, "GoogleCloudDialogflowCxV3FulfillmentConditionalCases": { "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases", "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", "type": "object", "properties": { "cases": { "description": "A list of cascading if-else conditions.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase" } } } }, "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase": { "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase", "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", "type": "object", "properties": { "condition": { "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", "type": "string" }, "caseContent": { "description": "A list of case content.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent" } } } }, "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent": { "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent", "description": "The list of messages or conditional cases to activate for this case.", "type": "object", "properties": { "message": { "description": "Returned message.", "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" }, "additionalCases": { "description": "Additional cases to be evaluated.", "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases" } } }, "GoogleCloudDialogflowCxV3AdvancedSettings": { "id": "GoogleCloudDialogflowCxV3AdvancedSettings", "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-\u003eFlow-\u003ePage-\u003eFulfillment/Parameter.", "type": "object", "properties": { "audioExportGcsDestination": { "description": "If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level", "$ref": "GoogleCloudDialogflowCxV3GcsDestination" }, "speechSettings": { "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings" }, "dtmfSettings": { "description": "Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings" }, "loggingSettings": { "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings" } } }, "GoogleCloudDialogflowCxV3GcsDestination": { "id": "GoogleCloudDialogflowCxV3GcsDestination", "description": "Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.", "type": "object", "properties": { "uri": { "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.", "type": "string" } } }, "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": { "id": "GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings", "description": "Define behaviors of speech to text detection.", "type": "object", "properties": { "endpointerSensitivity": { "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", "type": "integer", "format": "int32" }, "noSpeechTimeout": { "description": "Timeout before detecting no speech.", "type": "string", "format": "google-duration" }, "useTimeoutBasedEndpointing": { "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", "type": "boolean" }, "models": { "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings": { "id": "GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings", "description": "Define behaviors for DTMF (dual tone multi frequency).", "type": "object", "properties": { "enabled": { "description": "If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a \"3\" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).", "type": "boolean" }, "maxDigits": { "description": "Max length of DTMF digits.", "type": "integer", "format": "int32" }, "finishDigit": { "description": "The digit that terminates a DTMF digit sequence.", "type": "string" }, "interdigitTimeoutDuration": { "description": "Interdigit timeout setting for matching dtmf input to regex.", "type": "string", "format": "google-duration" }, "endpointingTimeoutDuration": { "description": "Endpoint timeout setting for matching dtmf input to regex.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings": { "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "description": "Define behaviors on logging.", "type": "object", "properties": { "enableStackdriverLogging": { "description": "If true, StackDriver logging is currently enabled.", "type": "boolean" }, "enableInteractionLogging": { "description": "If true, DF Interaction logging is currently enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3Form": { "id": "GoogleCloudDialogflowCxV3Form", "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", "type": "object", "properties": { "parameters": { "description": "Parameters to collect from the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3FormParameter" } } } }, "GoogleCloudDialogflowCxV3FormParameter": { "id": "GoogleCloudDialogflowCxV3FormParameter", "description": "Represents a form parameter.", "type": "object", "properties": { "displayName": { "description": "Required. The human-readable name of the parameter, unique within the form.", "type": "string" }, "required": { "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", "type": "boolean" }, "entityType": { "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", "type": "string" }, "isList": { "description": "Indicates whether the parameter represents a list of values.", "type": "boolean" }, "fillBehavior": { "description": "Required. Defines fill behavior for the parameter.", "$ref": "GoogleCloudDialogflowCxV3FormParameterFillBehavior" }, "defaultValue": { "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", "type": "any" }, "redact": { "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", "type": "boolean" }, "advancedSettings": { "description": "Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3AdvancedSettings" } } }, "GoogleCloudDialogflowCxV3FormParameterFillBehavior": { "id": "GoogleCloudDialogflowCxV3FormParameterFillBehavior", "description": "Configuration for how the filling of a parameter should be handled.", "type": "object", "properties": { "initialPromptFulfillment": { "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.", "$ref": "GoogleCloudDialogflowCxV3Fulfillment" }, "repromptEventHandlers": { "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3EventHandler" } } } }, "GoogleCloudDialogflowCxV3EventHandler": { "id": "GoogleCloudDialogflowCxV3EventHandler", "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this event handler.", "readOnly": true, "type": "string" }, "event": { "description": "Required. The name of the event to handle.", "type": "string" }, "triggerFulfillment": { "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.", "$ref": "GoogleCloudDialogflowCxV3Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3TransitionRoute": { "id": "GoogleCloudDialogflowCxV3TransitionRoute", "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this transition route.", "readOnly": true, "type": "string" }, "description": { "description": "Optional. The description of the transition route. The maximum length is 500 characters.", "type": "string" }, "intent": { "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", "type": "string" }, "condition": { "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", "type": "string" }, "triggerFulfillment": { "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.", "$ref": "GoogleCloudDialogflowCxV3Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3KnowledgeConnectorSettings": { "id": "GoogleCloudDialogflowCxV3KnowledgeConnectorSettings", "description": "The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.", "type": "object", "properties": { "enabled": { "description": "Whether Knowledge Connector is enabled or not.", "type": "boolean" }, "triggerFulfillment": { "description": "The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.", "$ref": "GoogleCloudDialogflowCxV3Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" }, "dataStoreConnections": { "description": "Optional. List of related data store connections.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3DataStoreConnection" } } } }, "GoogleCloudDialogflowCxV3DataStoreConnection": { "id": "GoogleCloudDialogflowCxV3DataStoreConnection", "description": "A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.", "type": "object", "properties": { "dataStoreType": { "description": "The type of the connected data store.", "type": "string", "enumDescriptions": [ "Not specified. This value indicates that the data store type is not specified, so it will not be used during search.", "A data store that contains public web content.", "A data store that contains unstructured private data.", "A data store that contains structured data (for example FAQ)." ], "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "PUBLIC_WEB", "UNSTRUCTURED", "STRUCTURED" ] }, "dataStore": { "description": "The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`", "type": "string" } } }, "GoogleCloudDialogflowCxV3RunTestCaseMetadata": { "id": "GoogleCloudDialogflowCxV3RunTestCaseMetadata", "description": "Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3RunTestCaseResponse": { "id": "GoogleCloudDialogflowCxV3RunTestCaseResponse", "description": "The response message for TestCases.RunTestCase.", "type": "object", "properties": { "result": { "description": "The result.", "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" } } }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3ExportTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3ExportTestCasesResponse", "description": "The response message for TestCases.ExportTestCases.", "type": "object", "properties": { "gcsUri": { "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", "type": "string" }, "content": { "description": "Uncompressed raw byte content for test cases.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "type": "object", "properties": { "errors": { "description": "Errors for failed test cases.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestCaseError" } } } }, "GoogleCloudDialogflowCxV3TestCaseError": { "id": "GoogleCloudDialogflowCxV3TestCaseError", "description": "Error info for importing a test.", "type": "object", "properties": { "testCase": { "description": "The test case.", "$ref": "GoogleCloudDialogflowCxV3TestCase" }, "status": { "description": "The status associated with the test case.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDialogflowCxV3TestCase": { "id": "GoogleCloudDialogflowCxV3TestCase", "description": "Represents a test case.", "type": "object", "properties": { "name": { "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", "type": "string" }, "tags": { "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", "type": "array", "items": { "type": "string" } }, "displayName": { "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", "type": "string" }, "notes": { "description": "Additional freeform notes about the test case. Limit of 400 characters.", "type": "string" }, "testConfig": { "description": "Config for the test case.", "$ref": "GoogleCloudDialogflowCxV3TestConfig" }, "testCaseConversationTurns": { "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" } }, "creationTime": { "description": "Output only. When the test was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastTestResult": { "description": "The latest test result.", "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" } } }, "GoogleCloudDialogflowCxV3TestConfig": { "id": "GoogleCloudDialogflowCxV3TestConfig", "description": "Represents configurations for a test case.", "type": "object", "properties": { "trackingParameters": { "description": "Session parameters to be compared when calculating differences.", "type": "array", "items": { "type": "string" } }, "flow": { "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", "type": "string" } } }, "GoogleCloudDialogflowCxV3ImportTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3ImportTestCasesResponse", "description": "The response message for TestCases.ImportTestCases.", "type": "object", "properties": { "names": { "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3ImportDocumentsResponse": { "id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", "description": "Response message for Documents.ImportDocuments.", "type": "object", "properties": { "warnings": { "description": "Includes details about skipped documents or any other warnings.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", "description": "Metadata for CreateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "type": "object", "properties": { "state": { "description": "Required. Output only. The current state of this operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ] } } }, "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", "description": "Metadata for DeleteDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { "id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", "description": "Metadata for ImportDocuments operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", "description": "Metadata for ReloadDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", "description": "Metadata for UpdateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3RunContinuousTestMetadata": { "id": "GoogleCloudDialogflowCxV3RunContinuousTestMetadata", "description": "Metadata returned for the Environments.RunContinuousTest long running operation.", "type": "object", "properties": { "errors": { "description": "The test errors.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestError" } } } }, "GoogleCloudDialogflowCxV3RunContinuousTestResponse": { "id": "GoogleCloudDialogflowCxV3RunContinuousTestResponse", "description": "The response message for Environments.RunContinuousTest.", "type": "object", "properties": { "continuousTestResult": { "description": "The result for a continuous test run.", "$ref": "GoogleCloudDialogflowCxV3ContinuousTestResult" } } }, "GoogleCloudDialogflowCxV3ContinuousTestResult": { "id": "GoogleCloudDialogflowCxV3ContinuousTestResult", "description": "Represents a result from running a test case in an agent environment.", "type": "object", "properties": { "name": { "description": "The resource name for the continuous test result. Format: `projects//locations//agents//environments//continuousTestResults/`.", "type": "string" }, "result": { "description": "The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not.", "type": "string", "enumDescriptions": [ "Not specified. Should never be used.", "All the tests passed.", "At least one test did not pass." ], "enum": [ "AGGREGATED_TEST_RESULT_UNSPECIFIED", "PASSED", "FAILED" ] }, "testCaseResults": { "description": "A list of individual test case results names in this continuous test run.", "type": "array", "items": { "type": "string" } }, "runTime": { "description": "Time when the continuous testing run starts.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3DeployFlowMetadata": { "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata", "description": "Metadata returned for the Environments.DeployFlow long running operation.", "type": "object", "properties": { "testErrors": { "description": "Errors of running deployment tests.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3TestError" } } } }, "GoogleCloudDialogflowCxV3DeployFlowResponse": { "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "description": "The response message for Environments.DeployFlow.", "type": "object", "properties": { "environment": { "description": "The updated environment where the flow is deployed.", "$ref": "GoogleCloudDialogflowCxV3Environment" }, "deployment": { "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3Environment": { "id": "GoogleCloudDialogflowCxV3Environment", "description": "Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.", "type": "object", "properties": { "name": { "description": "The name of the environment. Format: `projects//locations//agents//environments/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.", "type": "string" }, "description": { "description": "The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, "versionConfigs": { "description": "A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3EnvironmentVersionConfig" } }, "updateTime": { "description": "Output only. Update time of this environment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "testCasesConfig": { "description": "The test cases config for continuous tests of this environment.", "$ref": "GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig" }, "webhookConfig": { "description": "The webhook configuration for this environment.", "$ref": "GoogleCloudDialogflowCxV3EnvironmentWebhookConfig" } } }, "GoogleCloudDialogflowCxV3EnvironmentVersionConfig": { "id": "GoogleCloudDialogflowCxV3EnvironmentVersionConfig", "description": "Configuration for the version.", "type": "object", "properties": { "version": { "description": "Required. Format: projects//locations//agents//flows//versions/.", "type": "string" } } }, "GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig": { "id": "GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig", "description": "The configuration for continuous tests.", "type": "object", "properties": { "testCases": { "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", "type": "array", "items": { "type": "string" } }, "enableContinuousRun": { "description": "Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.", "type": "boolean" }, "enablePredeploymentRun": { "description": "Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3EnvironmentWebhookConfig": { "id": "GoogleCloudDialogflowCxV3EnvironmentWebhookConfig", "description": "Configuration for webhooks.", "type": "object", "properties": { "webhookOverrides": { "description": "The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3Webhook" } } } }, "GoogleCloudDialogflowCxV3Webhook": { "id": "GoogleCloudDialogflowCxV3Webhook", "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "type": "object", "properties": { "name": { "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the webhook, unique within the agent.", "type": "string" }, "genericWebService": { "description": "Configuration for a generic web service.", "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebService" }, "serviceDirectory": { "description": "Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.", "$ref": "GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig" }, "timeout": { "description": "Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.", "type": "string", "format": "google-duration" }, "disabled": { "description": "Indicates whether the webhook is disabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3WebhookGenericWebService": { "id": "GoogleCloudDialogflowCxV3WebhookGenericWebService", "description": "Represents configuration for a generic web service.", "type": "object", "properties": { "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" }, "username": { "description": "The user name for HTTP Basic authentication.", "deprecated": true, "type": "string" }, "password": { "description": "The password for HTTP Basic authentication.", "deprecated": true, "type": "string" }, "requestHeaders": { "description": "The HTTP request headers to send together with webhook requests.", "type": "object", "additionalProperties": { "type": "string" } }, "allowedCaCerts": { "description": "Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile \u003c(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "type": "array", "items": { "type": "string", "format": "byte" } }, "oauthConfig": { "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.", "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig" }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "type": "string", "enumDescriptions": [ "Service agent auth type unspecified. Default to ID_TOKEN.", "No token used.", "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." ], "enum": [ "SERVICE_AGENT_AUTH_UNSPECIFIED", "NONE", "ID_TOKEN", "ACCESS_TOKEN" ] }, "webhookType": { "description": "Optional. Type of the webhook.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Represents a standard webhook.", "Represents a flexible webhook." ], "enum": [ "WEBHOOK_TYPE_UNSPECIFIED", "STANDARD", "FLEXIBLE" ] }, "httpMethod": { "description": "Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.", "type": "string", "enumDescriptions": [ "HTTP method not specified.", "HTTP POST Method.", "HTTP GET Method.", "HTTP HEAD Method.", "HTTP PUT Method.", "HTTP DELETE Method.", "HTTP PATCH Method.", "HTTP OPTIONS Method." ], "enum": [ "HTTP_METHOD_UNSPECIFIED", "POST", "GET", "HEAD", "PUT", "DELETE", "PATCH", "OPTIONS" ] }, "requestBody": { "description": "Optional. Defines a custom JSON object as request body to send to flexible webhook.", "type": "string" }, "parameterMapping": { "description": "Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": { "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig", "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", "type": "object", "properties": { "clientId": { "description": "Required. The client ID provided by the 3rd party platform.", "type": "string" }, "clientSecret": { "description": "Required. The client secret provided by the 3rd party platform.", "type": "string" }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig": { "id": "GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig", "description": "Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service.", "type": "object", "properties": { "service": { "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.", "type": "string" }, "genericWebService": { "description": "Generic Service configuration of this webhook.", "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebService" } } }, "GoogleCloudDialogflowCxV3ConversationSignals": { "id": "GoogleCloudDialogflowCxV3ConversationSignals", "description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.", "type": "object", "properties": { "turnSignals": { "description": "Required. Turn signals for the current turn.", "$ref": "GoogleCloudDialogflowCxV3TurnSignals" } } }, "GoogleCloudDialogflowCxV3TurnSignals": { "id": "GoogleCloudDialogflowCxV3TurnSignals", "description": "Collection of all signals that were extracted for a single turn of the conversation.", "type": "object", "properties": { "noMatch": { "description": "Whether NLU predicted NO_MATCH.", "type": "boolean" }, "noUserInput": { "description": "Whether user provided no input.", "type": "boolean" }, "dtmfUsed": { "description": "Whether user was using DTMF input.", "type": "boolean" }, "userEscalated": { "description": "Whether user was specifically asking for a live agent.", "type": "boolean" }, "agentEscalated": { "description": "Whether agent responded with LiveAgentHandoff fulfillment.", "type": "boolean" }, "reachedEndPage": { "description": "Whether turn resulted in End Session page.", "type": "boolean" }, "webhookStatuses": { "description": "Human-readable statuses of the webhooks triggered during this turn.", "type": "array", "items": { "type": "string" } }, "failureReasons": { "description": "Failure reasons of the turn.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Failure reason is not assigned.", "Whether NLU failed to recognize user intent.", "Whether webhook failed during the turn." ], "enum": [ "FAILURE_REASON_UNSPECIFIED", "FAILED_INTENT", "FAILED_WEBHOOK" ] } }, "sentimentScore": { "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" }, "sentimentMagnitude": { "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "type": "object", "properties": { "version": { "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ExportAgentResponse": { "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", "description": "The response message for Agents.ExportAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated if `agent_uri` is specified in ExportAgentRequest.", "type": "string" }, "agentContent": { "description": "Uncompressed raw byte content for agent. This field is populated if none of `agent_uri` and `git_destination` are specified in ExportAgentRequest.", "type": "string", "format": "byte" }, "commitSha": { "description": "Commit SHA of the git push. This field is populated if `git_destination` is specified in ExportAgentRequest.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ExportFlowResponse": { "id": "GoogleCloudDialogflowCxV3beta1ExportFlowResponse", "description": "The response message for Flows.ExportFlow.", "type": "object", "properties": { "flowUri": { "description": "The URI to a file containing the exported flow. This field is populated only if `flow_uri` is specified in ExportFlowRequest.", "type": "string" }, "flowContent": { "description": "Uncompressed raw byte content for flow.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata", "description": "Metadata returned for the Intents.ExportIntents long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse": { "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse", "description": "The response message for Intents.ExportIntents.", "type": "object", "properties": { "intentsUri": { "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", "type": "string" }, "intentsContent": { "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest.", "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination" } } }, "GoogleCloudDialogflowCxV3beta1InlineDestination": { "id": "GoogleCloudDialogflowCxV3beta1InlineDestination", "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", "type": "object", "properties": { "content": { "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", "readOnly": true, "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3beta1ImportFlowResponse": { "id": "GoogleCloudDialogflowCxV3beta1ImportFlowResponse", "description": "The response message for Flows.ImportFlow.", "type": "object", "properties": { "flow": { "description": "The unique identifier of the new flow. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse": { "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponse", "description": "The response message for EntityTypes.ImportEntityTypes.", "type": "object", "properties": { "entityTypes": { "description": "The unique identifier of the imported entity types. Format: `projects//locations//agents//entity_types/`.", "type": "array", "items": { "type": "string" } }, "conflictingResources": { "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportEntityTypesRequest.", "$ref": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources" } } }, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources": { "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesResponseConflictingResources", "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", "type": "object", "properties": { "entityTypeDisplayNames": { "description": "Display names of conflicting entity types.", "type": "array", "items": { "type": "string" } }, "entityDisplayNames": { "description": "Display names of conflicting entities.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ExportEntityTypesMetadata", "description": "Metadata returned for the EntityTypes.ExportEntityTypes long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse": { "id": "GoogleCloudDialogflowCxV3beta1ExportEntityTypesResponse", "description": "The response message for EntityTypes.ExportEntityTypes.", "type": "object", "properties": { "entityTypesUri": { "description": "The URI to a file containing the exported entity types. This field is populated only if `entity_types_uri` is specified in ExportEntityTypesRequest.", "type": "string" }, "entityTypesContent": { "description": "Uncompressed byte content for entity types. This field is populated only if `entity_types_content_inline` is set to true in ExportEntityTypesRequest.", "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination" } } }, "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata", "description": "Metadata returned for the Intents.ImportIntents long running operation.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse": { "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse", "description": "The response message for Intents.ImportIntents.", "type": "object", "properties": { "intents": { "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", "type": "array", "items": { "type": "string" } }, "conflictingResources": { "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest.", "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources" } } }, "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources": { "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", "type": "object", "properties": { "intentDisplayNames": { "description": "Display names of conflicting intents.", "type": "array", "items": { "type": "string" } }, "entityDisplayNames": { "description": "Display names of conflicting entities.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "type": "object", "properties": { "detectIntentResponseId": { "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", "type": "string" }, "text": { "description": "If natural language text was provided as input, this field will contain a copy of the text.", "type": "string" }, "triggerIntent": { "description": "If an intent was provided as input, this field will contain a copy of the intent identifier. Format: `projects//locations//agents//intents/`.", "type": "string" }, "transcript": { "description": "If natural language speech audio was provided as input, this field will contain the transcript for the audio.", "type": "string" }, "triggerEvent": { "description": "If an event was provided as input, this field will contain the name of the event.", "type": "string" }, "dtmfDigits": { "description": "If DTMF was provided as input, this field will contain the DTMF digits.", "type": "string" }, "languageCode": { "description": "The language code specified in the original request.", "type": "string" }, "fulfillmentInfo": { "description": "Always present. Information about the fulfillment that triggered this webhook call.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo" }, "intentInfo": { "description": "Information about the last matched intent.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo" }, "pageInfo": { "description": "Information about page status.", "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo" }, "sessionInfo": { "description": "Information about session status.", "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo" }, "messages": { "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" } }, "payload": { "description": "Custom data set in QueryParameters.payload.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "sentimentAnalysisResult": { "description": "The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult" }, "languageInfo": { "description": "Information about the language of the request.", "$ref": "GoogleCloudDialogflowCxV3beta1LanguageInfo" } } }, "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": { "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo", "description": "Represents fulfillment information communicated to the webhook.", "type": "object", "properties": { "tag": { "description": "Always present. The value of the Fulfillment.tag field will be populated in this field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": { "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "description": "Represents intent information communicated to the webhook.", "type": "object", "properties": { "lastMatchedIntent": { "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", "type": "string" }, "displayName": { "description": "Always present. The display name of the last matched intent.", "type": "string" }, "parameters": { "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue" } }, "confidence": { "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": { "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue", "description": "Represents a value for an intent parameter.", "type": "object", "properties": { "originalValue": { "description": "Always present. Original text value extracted from user utterance.", "type": "string" }, "resolvedValue": { "description": "Always present. Structured value for the parameter extracted from user utterance.", "type": "any" } } }, "GoogleCloudDialogflowCxV3beta1PageInfo": { "id": "GoogleCloudDialogflowCxV3beta1PageInfo", "description": "Represents page information communicated to and from the webhook.", "type": "object", "properties": { "currentPage": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "displayName": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.", "type": "string" }, "formInfo": { "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form.", "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo" } } }, "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": { "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo", "description": "Represents form information.", "type": "object", "properties": { "parameterInfo": { "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo" } } } }, "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": { "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo", "description": "Represents parameter information.", "type": "object", "properties": { "displayName": { "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", "type": "string" }, "required": { "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", "type": "boolean" }, "state": { "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "Indicates that the parameter does not have a value.", "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", "Indicates that the parameter has a value." ], "enum": [ "PARAMETER_STATE_UNSPECIFIED", "EMPTY", "INVALID", "FILLED" ] }, "value": { "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", "type": "any" }, "justCollected": { "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1SessionInfo": { "id": "GoogleCloudDialogflowCxV3beta1SessionInfo", "description": "Represents session information communicated to and from the webhook.", "type": "object", "properties": { "session": { "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", "type": "string" }, "parameters": { "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", "type": "object", "additionalProperties": { "type": "any" } } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessage": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "type": "object", "properties": { "text": { "description": "Returns a text response.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText" }, "payload": { "description": "Returns a response containing a custom, platform-specific payload.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "conversationSuccess": { "description": "Indicates that the conversation succeeded.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess" }, "outputAudioText": { "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText" }, "liveAgentHandoff": { "description": "Hands off conversation to a human agent.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff" }, "endInteraction": { "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", "readOnly": true, "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction" }, "playAudio": { "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio" }, "mixedAudio": { "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", "readOnly": true, "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio" }, "telephonyTransferCall": { "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall" }, "knowledgeInfoCard": { "description": "Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard" }, "channel": { "description": "The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageText": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", "description": "The text response message.", "type": "object", "properties": { "text": { "description": "Required. A collection of text responses.", "type": "array", "items": { "type": "string" } }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess", "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", "type": "object", "properties": { "metadata": { "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText", "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", "type": "object", "properties": { "text": { "description": "The raw text to be synthesized.", "type": "string" }, "ssml": { "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff", "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", "type": "object", "properties": { "metadata": { "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction", "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio", "description": "Specifies an audio clip to be played by the client as part of the response.", "type": "object", "properties": { "audioUri": { "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio", "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", "type": "object", "properties": { "segments": { "description": "Segments this audio response is composed of.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment" } } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment", "description": "Represents one segment of audio.", "type": "object", "properties": { "audio": { "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", "type": "string", "format": "byte" }, "uri": { "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", "type": "string" }, "allowPlaybackInterruption": { "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", "readOnly": true, "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall", "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", "type": "object", "properties": { "phoneNumber": { "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard": { "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard", "description": "Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult": { "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult", "description": "Represents the result of sentiment analysis.", "type": "object", "properties": { "score": { "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", "type": "number", "format": "float" }, "magnitude": { "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3beta1LanguageInfo": { "id": "GoogleCloudDialogflowCxV3beta1LanguageInfo", "description": "Represents the language information of the request.", "type": "object", "properties": { "inputLanguageCode": { "description": "The language code specified in the original request.", "type": "string" }, "resolvedLanguageCode": { "description": "The language code detected for this request based on the user conversation.", "type": "string" }, "confidenceScore": { "description": "The confidence score of the detected language between 0 and 1.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowCxV3beta1WebhookResponse": { "id": "GoogleCloudDialogflowCxV3beta1WebhookResponse", "description": "The response message for a webhook call.", "type": "object", "properties": { "fulfillmentResponse": { "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse" }, "pageInfo": { "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.", "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo" }, "sessionInfo": { "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.", "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo" }, "payload": { "description": "Value to append directly to QueryResult.webhook_payloads.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": { "id": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse", "description": "Represents a fulfillment response to the user.", "type": "object", "properties": { "messages": { "description": "The list of rich message responses to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" } }, "mergeBehavior": { "description": "Merge behavior for `messages`.", "type": "string", "enumDescriptions": [ "Not specified. `APPEND` will be used.", "`messages` will be appended to the list of messages waiting to be sent to the user.", "`messages` will replace the list of messages waiting to be sent to the user." ], "enum": [ "MERGE_BEHAVIOR_UNSPECIFIED", "APPEND", "REPLACE" ] } } }, "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata", "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", "type": "object", "properties": { "errors": { "description": "The test errors.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestError" } } } }, "GoogleCloudDialogflowCxV3beta1TestError": { "id": "GoogleCloudDialogflowCxV3beta1TestError", "description": "Error info for running a test.", "type": "object", "properties": { "testCase": { "description": "The test case resource name.", "type": "string" }, "status": { "description": "The status associated with the test.", "$ref": "GoogleRpcStatus" }, "testTime": { "description": "The timestamp when the test was completed.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse", "description": "The response message for TestCases.BatchRunTestCases.", "type": "object", "properties": { "results": { "description": "The test case results. The detailed conversation turns are empty in this response.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult" } } } }, "GoogleCloudDialogflowCxV3beta1TestCaseResult": { "id": "GoogleCloudDialogflowCxV3beta1TestCaseResult", "description": "Represents a result from running a test case in an agent environment.", "type": "object", "properties": { "name": { "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", "type": "string" }, "environment": { "description": "Environment where the test was run. If not set, it indicates the draft environment.", "type": "string" }, "conversationTurns": { "description": "The conversation turns uttered during the test case replay in chronological order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" } }, "testResult": { "description": "Whether the test case passed in the agent environment.", "type": "string", "enumDescriptions": [ "Not specified. Should never be used.", "The test passed.", "The test did not pass." ], "enum": [ "TEST_RESULT_UNSPECIFIED", "PASSED", "FAILED" ] }, "testTime": { "description": "The time that the test was run.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3beta1ConversationTurn": { "id": "GoogleCloudDialogflowCxV3beta1ConversationTurn", "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", "type": "object", "properties": { "userInput": { "description": "The user input.", "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput" }, "virtualAgentOutput": { "description": "The virtual agent output.", "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput" } } }, "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput": { "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput", "description": "The input from the human user.", "type": "object", "properties": { "input": { "description": "Supports text input, event input, dtmf input in the test case.", "$ref": "GoogleCloudDialogflowCxV3beta1QueryInput" }, "injectedParameters": { "description": "Parameters that need to be injected into the conversation during intent detection.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "isWebhookEnabled": { "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", "type": "boolean" }, "enableSentimentAnalysis": { "description": "Whether sentiment analysis is enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1QueryInput": { "id": "GoogleCloudDialogflowCxV3beta1QueryInput", "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value. 6. The results of a tool executed by the client.", "type": "object", "properties": { "text": { "description": "The natural language text to be processed.", "$ref": "GoogleCloudDialogflowCxV3beta1TextInput" }, "intent": { "description": "The intent to be triggered.", "$ref": "GoogleCloudDialogflowCxV3beta1IntentInput" }, "audio": { "description": "The natural language speech audio to be processed.", "$ref": "GoogleCloudDialogflowCxV3beta1AudioInput" }, "event": { "description": "The event to be triggered.", "$ref": "GoogleCloudDialogflowCxV3beta1EventInput" }, "dtmf": { "description": "The DTMF event to be handled.", "$ref": "GoogleCloudDialogflowCxV3beta1DtmfInput" }, "languageCode": { "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) 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.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1TextInput": { "id": "GoogleCloudDialogflowCxV3beta1TextInput", "description": "Represents the natural language text to be processed.", "type": "object", "properties": { "text": { "description": "Required. The UTF-8 encoded natural language text to be processed.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1IntentInput": { "id": "GoogleCloudDialogflowCxV3beta1IntentInput", "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", "type": "object", "properties": { "intent": { "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1AudioInput": { "id": "GoogleCloudDialogflowCxV3beta1AudioInput", "description": "Represents the natural speech audio to be processed.", "type": "object", "properties": { "config": { "description": "Required. Instructs the speech recognizer how to process the speech audio.", "$ref": "GoogleCloudDialogflowCxV3beta1InputAudioConfig" }, "audio": { "description": "The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", "description": "Instructs the speech recognizer on how to process the audio content.", "type": "object", "properties": { "audioEncoding": { "description": "Required. Audio encoding of the audio content to process.", "type": "string", "enumDescriptions": [ "Not specified.", "Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." ], "enum": [ "AUDIO_ENCODING_UNSPECIFIED", "AUDIO_ENCODING_LINEAR_16", "AUDIO_ENCODING_FLAC", "AUDIO_ENCODING_MULAW", "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" ] }, "sampleRateHertz": { "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", "type": "integer", "format": "int32" }, "enableWordInfo": { "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", "type": "boolean" }, "phraseHints": { "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", "type": "array", "items": { "type": "string" } }, "model": { "description": "Optional. Which Speech model to select for the given request. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", "type": "string" }, "modelVariant": { "description": "Optional. Which variant of the Speech model to use.", "type": "string", "enumDescriptions": [ "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", "Use the best available variant of the Speech model that the caller is eligible for.", "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants." ], "enum": [ "SPEECH_MODEL_VARIANT_UNSPECIFIED", "USE_BEST_AVAILABLE", "USE_STANDARD", "USE_ENHANCED" ] }, "singleUtterance": { "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", "type": "boolean" }, "bargeInConfig": { "description": "Configuration of barge-in behavior during the streaming of input audio.", "$ref": "GoogleCloudDialogflowCxV3beta1BargeInConfig" }, "optOutConformerModelMigration": { "description": "If `true`, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June 2024. Please refer to [Dialogflow CX Speech model migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1BargeInConfig": { "id": "GoogleCloudDialogflowCxV3beta1BargeInConfig", "description": "Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up.", "type": "object", "properties": { "noBargeInDuration": { "description": "Duration that is not eligible for barge-in at the beginning of the input audio.", "type": "string", "format": "google-duration" }, "totalDuration": { "description": "Total duration for the playback at the beginning of the input audio.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowCxV3beta1EventInput": { "id": "GoogleCloudDialogflowCxV3beta1EventInput", "description": "Represents the event to trigger.", "type": "object", "properties": { "event": { "description": "Name of the event.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1DtmfInput": { "id": "GoogleCloudDialogflowCxV3beta1DtmfInput", "description": "Represents the input for dtmf event.", "type": "object", "properties": { "digits": { "description": "The dtmf digits.", "type": "string" }, "finishDigit": { "description": "The finish digit (if any).", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput": { "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput", "description": "The output from the virtual agent.", "type": "object", "properties": { "sessionParameters": { "description": "The session parameters available to the bot at this point.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "differences": { "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestRunDifference" } }, "diagnosticInfo": { "description": "Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "triggeredIntent": { "description": "The Intent that triggered the response. Only name and displayName will be set.", "$ref": "GoogleCloudDialogflowCxV3beta1Intent" }, "currentPage": { "description": "The Page on which the utterance was spoken. Only name and displayName will be set.", "$ref": "GoogleCloudDialogflowCxV3beta1Page" }, "textResponses": { "description": "The text responses from the agent for the turn.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText" } }, "status": { "description": "Response error from the agent in the test result. If set, other output is empty.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDialogflowCxV3beta1TestRunDifference": { "id": "GoogleCloudDialogflowCxV3beta1TestRunDifference", "description": "The description of differences between original and replayed agent output.", "type": "object", "properties": { "type": { "description": "The type of diff.", "type": "string", "enumDescriptions": [ "Should never be used.", "The intent.", "The page.", "The parameters.", "The message utterance.", "The flow." ], "enum": [ "DIFF_TYPE_UNSPECIFIED", "INTENT", "PAGE", "PARAMETERS", "UTTERANCE", "FLOW" ] }, "description": { "description": "A human readable description of the diff, showing the actual output vs expected output.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1Intent": { "id": "GoogleCloudDialogflowCxV3beta1Intent", "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", "type": "object", "properties": { "name": { "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the intent, unique within the agent.", "type": "string" }, "trainingPhrases": { "description": "The collection of training phrases the agent is trained on to identify the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase" } }, "parameters": { "description": "The collection of parameters associated with the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1IntentParameter" } }, "priority": { "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", "type": "integer", "format": "int32" }, "isFallback": { "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", "type": "boolean" }, "labels": { "description": "The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase": { "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase", "description": "Represents an example that the agent is trained on to identify the intent.", "type": "object", "properties": { "id": { "description": "Output only. The unique identifier of the training phrase.", "type": "string" }, "parts": { "description": "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 `parameter_id` field is set.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart" } }, "repeatCount": { "description": "Indicates how many times this example was added to the intent.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart": { "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart", "description": "Represents a part of a training phrase.", "type": "object", "properties": { "text": { "description": "Required. The text for this part.", "type": "string" }, "parameterId": { "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1IntentParameter": { "id": "GoogleCloudDialogflowCxV3beta1IntentParameter", "description": "Represents an intent parameter.", "type": "object", "properties": { "id": { "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", "type": "string" }, "entityType": { "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", "type": "string" }, "isList": { "description": "Indicates whether the parameter represents a list of values.", "type": "boolean" }, "redact": { "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1Page": { "id": "GoogleCloudDialogflowCxV3beta1Page", "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", "type": "object", "properties": { "name": { "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the page, unique within the flow.", "type": "string" }, "description": { "description": "The description of the page. The maximum length is 500 characters.", "type": "string" }, "entryFulfillment": { "description": "The fulfillment to call when the session is entering the page.", "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment" }, "form": { "description": "The form associated with the page, used for collecting parameters relevant to the page.", "$ref": "GoogleCloudDialogflowCxV3beta1Form" }, "transitionRouteGroups": { "description": "Ordered list of `TransitionRouteGroups` added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -\u003e page's transition route group -\u003e flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", "type": "array", "items": { "type": "string" } }, "transitionRoutes": { "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" } }, "eventHandlers": { "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" } }, "advancedSettings": { "description": "Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettings" }, "knowledgeConnectorSettings": { "description": "Optional. Knowledge connector configuration.", "$ref": "GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings" } } }, "GoogleCloudDialogflowCxV3beta1Fulfillment": { "id": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", "type": "object", "properties": { "messages": { "description": "The list of rich message responses to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" } }, "webhook": { "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", "type": "string" }, "returnPartialResponses": { "description": "Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.", "type": "boolean" }, "tag": { "description": "The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.", "type": "string" }, "setParameterActions": { "description": "Set parameter values before executing the webhook.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction" } }, "conditionalCases": { "description": "Conditional cases for this fulfillment.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases" } }, "advancedSettings": { "description": "Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettings" }, "enableGenerativeFallback": { "description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction": { "id": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction", "description": "Setting a parameter value.", "type": "object", "properties": { "parameter": { "description": "Display name of the parameter.", "type": "string" }, "value": { "description": "The new value of the parameter. A null value clears the parameter.", "type": "any" } } }, "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases": { "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases", "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", "type": "object", "properties": { "cases": { "description": "A list of cascading if-else conditions.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase" } } } }, "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase": { "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase", "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", "type": "object", "properties": { "condition": { "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", "type": "string" }, "caseContent": { "description": "A list of case content.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent" } } } }, "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent": { "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent", "description": "The list of messages or conditional cases to activate for this case.", "type": "object", "properties": { "message": { "description": "Returned message.", "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" }, "additionalCases": { "description": "Additional cases to be evaluated.", "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases" } } }, "GoogleCloudDialogflowCxV3beta1AdvancedSettings": { "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettings", "description": "Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-\u003eFlow-\u003ePage-\u003eFulfillment/Parameter.", "type": "object", "properties": { "audioExportGcsDestination": { "description": "If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level", "$ref": "GoogleCloudDialogflowCxV3beta1GcsDestination" }, "speechSettings": { "description": "Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings" }, "dtmfSettings": { "description": "Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings" }, "loggingSettings": { "description": "Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings" } } }, "GoogleCloudDialogflowCxV3beta1GcsDestination": { "id": "GoogleCloudDialogflowCxV3beta1GcsDestination", "description": "Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.", "type": "object", "properties": { "uri": { "description": "Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings": { "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsSpeechSettings", "description": "Define behaviors of speech to text detection.", "type": "object", "properties": { "endpointerSensitivity": { "description": "Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.", "type": "integer", "format": "int32" }, "noSpeechTimeout": { "description": "Timeout before detecting no speech.", "type": "string", "format": "google-duration" }, "useTimeoutBasedEndpointing": { "description": "Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.", "type": "boolean" }, "models": { "description": "Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings": { "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings", "description": "Define behaviors for DTMF (dual tone multi frequency).", "type": "object", "properties": { "enabled": { "description": "If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a \"3\" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).", "type": "boolean" }, "maxDigits": { "description": "Max length of DTMF digits.", "type": "integer", "format": "int32" }, "finishDigit": { "description": "The digit that terminates a DTMF digit sequence.", "type": "string" }, "interdigitTimeoutDuration": { "description": "Interdigit timeout setting for matching dtmf input to regex.", "type": "string", "format": "google-duration" }, "endpointingTimeoutDuration": { "description": "Endpoint timeout setting for matching dtmf input to regex.", "type": "string", "format": "google-duration" } } }, "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings": { "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "description": "Define behaviors on logging.", "type": "object", "properties": { "enableStackdriverLogging": { "description": "If true, StackDriver logging is currently enabled.", "type": "boolean" }, "enableInteractionLogging": { "description": "If true, DF Interaction logging is currently enabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1Form": { "id": "GoogleCloudDialogflowCxV3beta1Form", "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", "type": "object", "properties": { "parameters": { "description": "Parameters to collect from the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1FormParameter" } } } }, "GoogleCloudDialogflowCxV3beta1FormParameter": { "id": "GoogleCloudDialogflowCxV3beta1FormParameter", "description": "Represents a form parameter.", "type": "object", "properties": { "displayName": { "description": "Required. The human-readable name of the parameter, unique within the form.", "type": "string" }, "required": { "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", "type": "boolean" }, "entityType": { "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", "type": "string" }, "isList": { "description": "Indicates whether the parameter represents a list of values.", "type": "boolean" }, "fillBehavior": { "description": "Required. Defines fill behavior for the parameter.", "$ref": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior" }, "defaultValue": { "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", "type": "any" }, "redact": { "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", "type": "boolean" }, "advancedSettings": { "description": "Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.", "$ref": "GoogleCloudDialogflowCxV3beta1AdvancedSettings" } } }, "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior": { "id": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior", "description": "Configuration for how the filling of a parameter should be handled.", "type": "object", "properties": { "initialPromptFulfillment": { "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.", "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment" }, "repromptEventHandlers": { "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" } } } }, "GoogleCloudDialogflowCxV3beta1EventHandler": { "id": "GoogleCloudDialogflowCxV3beta1EventHandler", "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this event handler.", "readOnly": true, "type": "string" }, "event": { "description": "Required. The name of the event to handle.", "type": "string" }, "triggerFulfillment": { "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.", "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1TransitionRoute": { "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this transition route.", "readOnly": true, "type": "string" }, "description": { "description": "Optional. The description of the transition route. The maximum length is 500 characters.", "type": "string" }, "intent": { "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", "type": "string" }, "condition": { "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", "type": "string" }, "triggerFulfillment": { "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first.", "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings": { "id": "GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings", "description": "The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.", "type": "object", "properties": { "enabled": { "description": "Whether Knowledge Connector is enabled or not.", "type": "boolean" }, "triggerFulfillment": { "description": "The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter `$request.knowledge.answers` (contains up to the 5 highest confidence answers) and `$request.knowledge.questions` (contains the corresponding questions) to construct the fulfillment.", "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment" }, "targetPage": { "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, "targetFlow": { "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", "type": "string" }, "dataStoreConnections": { "description": "Optional. List of related data store connections.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnection" } } } }, "GoogleCloudDialogflowCxV3beta1DataStoreConnection": { "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnection", "description": "A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.", "type": "object", "properties": { "dataStoreType": { "description": "The type of the connected data store.", "type": "string", "enumDescriptions": [ "Not specified. This value indicates that the data store type is not specified, so it will not be used during search.", "A data store that contains public web content.", "A data store that contains unstructured private data.", "A data store that contains structured data (for example FAQ)." ], "enum": [ "DATA_STORE_TYPE_UNSPECIFIED", "PUBLIC_WEB", "UNSTRUCTURED", "STRUCTURED" ] }, "dataStore": { "description": "The full name of the referenced data store. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}`", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata": { "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata", "description": "Metadata returned for the TestCases.RunTestCase long running operation. This message currently has no fields.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse": { "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse", "description": "The response message for TestCases.RunTestCase.", "type": "object", "properties": { "result": { "description": "The result.", "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult" } } }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "type": "object", "properties": {} }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse", "description": "The response message for TestCases.ExportTestCases.", "type": "object", "properties": { "gcsUri": { "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", "type": "string" }, "content": { "description": "Uncompressed raw byte content for test cases.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "type": "object", "properties": { "errors": { "description": "Errors for failed test cases.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseError" } } } }, "GoogleCloudDialogflowCxV3beta1TestCaseError": { "id": "GoogleCloudDialogflowCxV3beta1TestCaseError", "description": "Error info for importing a test.", "type": "object", "properties": { "testCase": { "description": "The test case.", "$ref": "GoogleCloudDialogflowCxV3beta1TestCase" }, "status": { "description": "The status associated with the test case.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDialogflowCxV3beta1TestCase": { "id": "GoogleCloudDialogflowCxV3beta1TestCase", "description": "Represents a test case.", "type": "object", "properties": { "name": { "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", "type": "string" }, "tags": { "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", "type": "array", "items": { "type": "string" } }, "displayName": { "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", "type": "string" }, "notes": { "description": "Additional freeform notes about the test case. Limit of 400 characters.", "type": "string" }, "testConfig": { "description": "Config for the test case.", "$ref": "GoogleCloudDialogflowCxV3beta1TestConfig" }, "testCaseConversationTurns": { "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" } }, "creationTime": { "description": "Output only. When the test was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lastTestResult": { "description": "The latest test result.", "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult" } } }, "GoogleCloudDialogflowCxV3beta1TestConfig": { "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "description": "Represents configurations for a test case.", "type": "object", "properties": { "trackingParameters": { "description": "Session parameters to be compared when calculating differences.", "type": "array", "items": { "type": "string" } }, "flow": { "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse": { "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse", "description": "The response message for TestCases.ImportTestCases.", "type": "object", "properties": { "names": { "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", "description": "Response message for Documents.ImportDocuments.", "type": "object", "properties": { "warnings": { "description": "Includes details about skipped documents or any other warnings.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", "description": "Metadata for CreateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "type": "object", "properties": { "state": { "description": "Required. Output only. The current state of this operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ] } } }, "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", "description": "Metadata for DeleteDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", "description": "Metadata for ImportDocuments operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", "description": "Metadata for ReloadDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", "description": "Metadata for UpdateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata": { "id": "GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata", "description": "Metadata returned for the Environments.RunContinuousTest long running operation.", "type": "object", "properties": { "errors": { "description": "The test errors.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestError" } } } }, "GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse": { "id": "GoogleCloudDialogflowCxV3beta1RunContinuousTestResponse", "description": "The response message for Environments.RunContinuousTest.", "type": "object", "properties": { "continuousTestResult": { "description": "The result for a continuous test run.", "$ref": "GoogleCloudDialogflowCxV3beta1ContinuousTestResult" } } }, "GoogleCloudDialogflowCxV3beta1ContinuousTestResult": { "id": "GoogleCloudDialogflowCxV3beta1ContinuousTestResult", "description": "Represents a result from running a test case in an agent environment.", "type": "object", "properties": { "name": { "description": "The resource name for the continuous test result. Format: `projects//locations//agents//environments//continuousTestResults/`.", "type": "string" }, "result": { "description": "The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not.", "type": "string", "enumDescriptions": [ "Not specified. Should never be used.", "All the tests passed.", "At least one test did not pass." ], "enum": [ "AGGREGATED_TEST_RESULT_UNSPECIFIED", "PASSED", "FAILED" ] }, "testCaseResults": { "description": "A list of individual test case results names in this continuous test run.", "type": "array", "items": { "type": "string" } }, "runTime": { "description": "Time when the continuous testing run starts.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": { "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata", "description": "Metadata returned for the Environments.DeployFlow long running operation.", "type": "object", "properties": { "testErrors": { "description": "Errors of running deployment tests.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1TestError" } } } }, "GoogleCloudDialogflowCxV3beta1DeployFlowResponse": { "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "description": "The response message for Environments.DeployFlow.", "type": "object", "properties": { "environment": { "description": "The updated environment where the flow is deployed.", "$ref": "GoogleCloudDialogflowCxV3beta1Environment" }, "deployment": { "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1Environment": { "id": "GoogleCloudDialogflowCxV3beta1Environment", "description": "Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.", "type": "object", "properties": { "name": { "description": "The name of the environment. Format: `projects//locations//agents//environments/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.", "type": "string" }, "description": { "description": "The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.", "type": "string" }, "versionConfigs": { "description": "A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig" } }, "updateTime": { "description": "Output only. Update time of this environment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "testCasesConfig": { "description": "The test cases config for continuous tests of this environment.", "$ref": "GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig" }, "webhookConfig": { "description": "The webhook configuration for this environment.", "$ref": "GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig" } } }, "GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig": { "id": "GoogleCloudDialogflowCxV3beta1EnvironmentVersionConfig", "description": "Configuration for the version.", "type": "object", "properties": { "version": { "description": "Required. Format: projects//locations//agents//flows//versions/.", "type": "string" } } }, "GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig": { "id": "GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig", "description": "The configuration for continuous tests.", "type": "object", "properties": { "testCases": { "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", "type": "array", "items": { "type": "string" } }, "enableContinuousRun": { "description": "Whether to run test cases in TestCasesConfig.test_cases periodically. Default false. If set to true, run once a day.", "type": "boolean" }, "enablePredeploymentRun": { "description": "Whether to run test cases in TestCasesConfig.test_cases before deploying a flow version to the environment. Default false.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig": { "id": "GoogleCloudDialogflowCxV3beta1EnvironmentWebhookConfig", "description": "Configuration for webhooks.", "type": "object", "properties": { "webhookOverrides": { "description": "The list of webhooks to override for the agent environment. The webhook must exist in the agent. You can override fields in `generic_web_service` and `service_directory`.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowCxV3beta1Webhook" } } } }, "GoogleCloudDialogflowCxV3beta1Webhook": { "id": "GoogleCloudDialogflowCxV3beta1Webhook", "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "type": "object", "properties": { "name": { "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", "type": "string" }, "displayName": { "description": "Required. The human-readable name of the webhook, unique within the agent.", "type": "string" }, "genericWebService": { "description": "Configuration for a generic web service.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebService" }, "serviceDirectory": { "description": "Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig" }, "timeout": { "description": "Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.", "type": "string", "format": "google-duration" }, "disabled": { "description": "Indicates whether the webhook is disabled.", "type": "boolean" } } }, "GoogleCloudDialogflowCxV3beta1WebhookGenericWebService": { "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebService", "description": "Represents configuration for a generic web service.", "type": "object", "properties": { "uri": { "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", "type": "string" }, "username": { "description": "The user name for HTTP Basic authentication.", "deprecated": true, "type": "string" }, "password": { "description": "The password for HTTP Basic authentication.", "deprecated": true, "type": "string" }, "requestHeaders": { "description": "The HTTP request headers to send together with webhook requests.", "type": "object", "additionalProperties": { "type": "string" } }, "allowedCaCerts": { "description": "Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile \u003c(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "type": "array", "items": { "type": "string", "format": "byte" } }, "oauthConfig": { "description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig" }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "type": "string", "enumDescriptions": [ "Service agent auth type unspecified. Default to ID_TOKEN.", "No token used.", "Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", "Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." ], "enum": [ "SERVICE_AGENT_AUTH_UNSPECIFIED", "NONE", "ID_TOKEN", "ACCESS_TOKEN" ] }, "webhookType": { "description": "Optional. Type of the webhook.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Represents a standard webhook.", "Represents a flexible webhook." ], "enum": [ "WEBHOOK_TYPE_UNSPECIFIED", "STANDARD", "FLEXIBLE" ] }, "httpMethod": { "description": "Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.", "type": "string", "enumDescriptions": [ "HTTP method not specified.", "HTTP POST Method.", "HTTP GET Method.", "HTTP HEAD Method.", "HTTP PUT Method.", "HTTP DELETE Method.", "HTTP PATCH Method.", "HTTP OPTIONS Method." ], "enum": [ "HTTP_METHOD_UNSPECIFIED", "POST", "GET", "HEAD", "PUT", "DELETE", "PATCH", "OPTIONS" ] }, "requestBody": { "description": "Optional. Defines a custom JSON object as request body to send to flexible webhook.", "type": "string" }, "parameterMapping": { "description": "Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters. - Key: session parameter name - Value: field path in the webhook response", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": { "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig", "description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.", "type": "object", "properties": { "clientId": { "description": "Required. The client ID provided by the 3rd party platform.", "type": "string" }, "clientSecret": { "description": "Required. The client secret provided by the 3rd party platform.", "type": "string" }, "tokenEndpoint": { "description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.", "type": "string" }, "scopes": { "description": "Optional. The OAuth scopes to grant.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig": { "id": "GoogleCloudDialogflowCxV3beta1WebhookServiceDirectoryConfig", "description": "Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service.", "type": "object", "properties": { "service": { "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.", "type": "string" }, "genericWebService": { "description": "Generic Service configuration of this webhook.", "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebService" } } }, "GoogleCloudDialogflowCxV3beta1ConversationSignals": { "id": "GoogleCloudDialogflowCxV3beta1ConversationSignals", "description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.", "type": "object", "properties": { "turnSignals": { "description": "Required. Turn signals for the current turn.", "$ref": "GoogleCloudDialogflowCxV3beta1TurnSignals" } } }, "GoogleCloudDialogflowCxV3beta1TurnSignals": { "id": "GoogleCloudDialogflowCxV3beta1TurnSignals", "description": "Collection of all signals that were extracted for a single turn of the conversation.", "type": "object", "properties": { "noMatch": { "description": "Whether NLU predicted NO_MATCH.", "type": "boolean" }, "noUserInput": { "description": "Whether user provided no input.", "type": "boolean" }, "dtmfUsed": { "description": "Whether user was using DTMF input.", "type": "boolean" }, "userEscalated": { "description": "Whether user was specifically asking for a live agent.", "type": "boolean" }, "agentEscalated": { "description": "Whether agent responded with LiveAgentHandoff fulfillment.", "type": "boolean" }, "reachedEndPage": { "description": "Whether turn resulted in End Session page.", "type": "boolean" }, "webhookStatuses": { "description": "Human-readable statuses of the webhooks triggered during this turn.", "type": "array", "items": { "type": "string" } }, "failureReasons": { "description": "Failure reasons of the turn.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Failure reason is not assigned.", "Whether NLU failed to recognize user intent.", "Whether webhook failed during the turn." ], "enum": [ "FAILURE_REASON_UNSPECIFIED", "FAILED_INTENT", "FAILED_WEBHOOK" ] } }, "sentimentScore": { "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" }, "sentimentMagnitude": { "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": { "id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse", "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", "type": "object", "properties": { "entityTypes": { "description": "The collection of updated or created entity types.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2EntityType" } } } }, "GoogleCloudDialogflowV2EntityType": { "id": "GoogleCloudDialogflowV2EntityType", "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "type": "object", "properties": { "name": { "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.", "type": "string" }, "displayName": { "description": "Required. The name of the entity type.", "type": "string" }, "kind": { "description": "Required. Indicates the kind of entity type.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "Map entity types allow mapping of a group of synonyms to a reference value.", "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", "Regexp entity types allow to specify regular expressions in entries values." ], "enum": [ "KIND_UNSPECIFIED", "KIND_MAP", "KIND_LIST", "KIND_REGEXP" ] }, "autoExpansionMode": { "description": "Optional. Indicates whether the entity type can be automatically expanded.", "type": "string", "enumDescriptions": [ "Auto expansion disabled for the entity.", "Allows an agent to recognize values that have not been explicitly listed in the entity." ], "enum": [ "AUTO_EXPANSION_MODE_UNSPECIFIED", "AUTO_EXPANSION_MODE_DEFAULT" ] }, "entities": { "description": "Optional. The collection of entity entries associated with the entity type.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" } }, "enableFuzzyExtraction": { "description": "Optional. Enables fuzzy entity extraction during classification.", "type": "boolean" } } }, "GoogleCloudDialogflowV2EntityTypeEntity": { "id": "GoogleCloudDialogflowV2EntityTypeEntity", "description": "An **entity entry** for an associated entity type.", "type": "object", "properties": { "value": { "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", "type": "string" }, "synonyms": { "description": "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`.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2BatchUpdateIntentsResponse": { "id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse", "description": "The response message for Intents.BatchUpdateIntents.", "type": "object", "properties": { "intents": { "description": "The collection of updated or created intents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2Intent" } } } }, "GoogleCloudDialogflowV2Intent": { "id": "GoogleCloudDialogflowV2Intent", "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "type": "object", "properties": { "name": { "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.", "type": "string" }, "displayName": { "description": "Required. The name of this intent.", "type": "string" }, "webhookState": { "description": "Optional. Indicates whether webhooks are enabled for the intent.", "type": "string", "enumDescriptions": [ "Webhook is disabled in the agent and in the intent.", "Webhook is enabled in the agent and in the intent.", "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." ], "enum": [ "WEBHOOK_STATE_UNSPECIFIED", "WEBHOOK_STATE_ENABLED", "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" ] }, "priority": { "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", "type": "integer", "format": "int32" }, "isFallback": { "description": "Optional. Indicates whether this is a fallback intent.", "type": "boolean" }, "mlDisabled": { "description": "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.", "type": "boolean" }, "liveAgentHandoff": { "description": "Optional. Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.", "type": "boolean" }, "endInteraction": { "description": "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.", "type": "boolean" }, "inputContextNames": { "description": "Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`.", "type": "array", "items": { "type": "string" } }, "events": { "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", "type": "array", "items": { "type": "string" } }, "trainingPhrases": { "description": "Optional. The collection of examples that the agent is trained on.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase" } }, "action": { "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", "type": "string" }, "outputContexts": { "description": "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//agent/sessions/-/contexts/`.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2Context" } }, "resetContexts": { "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", "type": "boolean" }, "parameters": { "description": "Optional. The collection of parameters associated with the intent.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentParameter" } }, "messages": { "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessage" } }, "defaultResponsePlatforms": { "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default platform.", "Facebook.", "Slack.", "Telegram.", "Kik.", "Skype.", "Line.", "Viber.", "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "Google Hangouts." ], "enum": [ "PLATFORM_UNSPECIFIED", "FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS" ] } }, "rootFollowupIntentName": { "description": "Output only. 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//agent/intents/`.", "readOnly": true, "type": "string" }, "parentFollowupIntentName": { "description": "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//agent/intents/`.", "type": "string" }, "followupIntentInfo": { "description": "Output only. 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.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo" } } } }, "GoogleCloudDialogflowV2IntentTrainingPhrase": { "id": "GoogleCloudDialogflowV2IntentTrainingPhrase", "description": "Represents an example that the agent is trained on.", "type": "object", "properties": { "name": { "description": "Output only. The unique identifier of this training phrase.", "type": "string" }, "type": { "description": "Required. The type of the training phrase.", "type": "string", "enumDescriptions": [ "Not specified. This value should never be used.", "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work." ], "enumDeprecated": [ false, false, true ], "enum": [ "TYPE_UNSPECIFIED", "EXAMPLE", "TEMPLATE" ] }, "parts": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart" } }, "timesAddedCount": { "description": "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.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2IntentTrainingPhrasePart": { "id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart", "description": "Represents a part of a training phrase.", "type": "object", "properties": { "text": { "description": "Required. The text for this part.", "type": "string" }, "entityType": { "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", "type": "string" }, "alias": { "description": "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.", "type": "string" }, "userDefined": { "description": "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.", "type": "boolean" } } }, "GoogleCloudDialogflowV2Context": { "id": "GoogleCloudDialogflowV2Context", "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "type": "string" }, "lifespanCount": { "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", "type": "integer", "format": "int32" }, "parameters": { "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowV2IntentParameter": { "id": "GoogleCloudDialogflowV2IntentParameter", "description": "Represents intent parameters.", "type": "object", "properties": { "name": { "description": "The unique identifier of this parameter.", "type": "string" }, "displayName": { "description": "Required. The name of the parameter.", "type": "string" }, "value": { "description": "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`.", "type": "string" }, "defaultValue": { "description": "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`.", "type": "string" }, "entityTypeDisplayName": { "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", "type": "string" }, "mandatory": { "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", "type": "boolean" }, "prompts": { "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", "type": "array", "items": { "type": "string" } }, "isList": { "description": "Optional. Indicates whether the parameter represents a list of values.", "type": "boolean" } } }, "GoogleCloudDialogflowV2IntentMessage": { "id": "GoogleCloudDialogflowV2IntentMessage", "description": "A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).", "type": "object", "properties": { "text": { "description": "The text response.", "$ref": "GoogleCloudDialogflowV2IntentMessageText" }, "image": { "description": "The image response.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "quickReplies": { "description": "The quick replies response.", "$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies" }, "card": { "description": "The card response.", "$ref": "GoogleCloudDialogflowV2IntentMessageCard" }, "payload": { "description": "A custom platform-specific response.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "simpleResponses": { "description": "The voice and text-only responses for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses" }, "basicCard": { "description": "The basic card response for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard" }, "suggestions": { "description": "The suggestion chips for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions" }, "linkOutSuggestion": { "description": "The link out suggestion chip for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion" }, "listSelect": { "description": "The list card response for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageListSelect" }, "carouselSelect": { "description": "The carousel card response for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect" }, "browseCarouselCard": { "description": "Browse carousel card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard" }, "tableCard": { "description": "Table card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageTableCard" }, "mediaContent": { "description": "The media content card for Actions on Google.", "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContent" }, "platform": { "description": "Optional. The platform that this message is intended for.", "type": "string", "enumDescriptions": [ "Default platform.", "Facebook.", "Slack.", "Telegram.", "Kik.", "Skype.", "Line.", "Viber.", "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "Google Hangouts." ], "enum": [ "PLATFORM_UNSPECIFIED", "FACEBOOK", "SLACK", "TELEGRAM", "KIK", "SKYPE", "LINE", "VIBER", "ACTIONS_ON_GOOGLE", "GOOGLE_HANGOUTS" ] } } }, "GoogleCloudDialogflowV2IntentMessageText": { "id": "GoogleCloudDialogflowV2IntentMessageText", "description": "The text response message.", "type": "object", "properties": { "text": { "description": "Optional. The collection of the agent's responses.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2IntentMessageImage": { "id": "GoogleCloudDialogflowV2IntentMessageImage", "description": "The image response message.", "type": "object", "properties": { "imageUri": { "description": "Optional. The public URI to an image file.", "type": "string" }, "accessibilityText": { "description": "Optional. A text description of the image to be used for accessibility, e.g., screen readers.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageQuickReplies": { "id": "GoogleCloudDialogflowV2IntentMessageQuickReplies", "description": "The quick replies response message.", "type": "object", "properties": { "title": { "description": "Optional. The title of the collection of quick replies.", "type": "string" }, "quickReplies": { "description": "Optional. The collection of quick replies.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2IntentMessageCard": { "id": "GoogleCloudDialogflowV2IntentMessageCard", "description": "The card response message.", "type": "object", "properties": { "title": { "description": "Optional. The title of the card.", "type": "string" }, "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" }, "imageUri": { "description": "Optional. The public URI to an image file for the card.", "type": "string" }, "buttons": { "description": "Optional. The collection of card buttons.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageCardButton" } } } }, "GoogleCloudDialogflowV2IntentMessageCardButton": { "id": "GoogleCloudDialogflowV2IntentMessageCardButton", "description": "Contains information about a button.", "type": "object", "properties": { "text": { "description": "Optional. The text to show on the button.", "type": "string" }, "postback": { "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageSimpleResponses": { "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses", "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", "type": "object", "properties": { "simpleResponses": { "description": "Required. The list of simple responses.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse" } } } }, "GoogleCloudDialogflowV2IntentMessageSimpleResponse": { "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse", "description": "The simple response message containing speech or text.", "type": "object", "properties": { "textToSpeech": { "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", "type": "string" }, "ssml": { "description": "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.", "type": "string" }, "displayText": { "description": "Optional. The text to display.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageBasicCard": { "id": "GoogleCloudDialogflowV2IntentMessageBasicCard", "description": "The basic card message. Useful for displaying information.", "type": "object", "properties": { "title": { "description": "Optional. The title of the card.", "type": "string" }, "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" }, "formattedText": { "description": "Required, unless image is present. The body text of the card.", "type": "string" }, "image": { "description": "Optional. The image for the card.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "buttons": { "description": "Optional. The collection of card buttons.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" } } } }, "GoogleCloudDialogflowV2IntentMessageBasicCardButton": { "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton", "description": "The button object that appears at the bottom of a card.", "type": "object", "properties": { "title": { "description": "Required. The title of the button.", "type": "string" }, "openUriAction": { "description": "Required. Action to take when a user taps on the button.", "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction" } } }, "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": { "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction", "description": "Opens the given URI.", "type": "object", "properties": { "uri": { "description": "Required. The HTTP or HTTPS scheme URI.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageSuggestions": { "id": "GoogleCloudDialogflowV2IntentMessageSuggestions", "description": "The collection of suggestions.", "type": "object", "properties": { "suggestions": { "description": "Required. The list of suggested replies.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion" } } } }, "GoogleCloudDialogflowV2IntentMessageSuggestion": { "id": "GoogleCloudDialogflowV2IntentMessageSuggestion", "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", "type": "object", "properties": { "title": { "description": "Required. The text shown the in the suggestion chip.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": { "id": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion", "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", "type": "object", "properties": { "destinationName": { "description": "Required. The name of the app or site this chip is linking to.", "type": "string" }, "uri": { "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageListSelect": { "id": "GoogleCloudDialogflowV2IntentMessageListSelect", "description": "The card for presenting a list of options to select from.", "type": "object", "properties": { "title": { "description": "Optional. The overall title of the list.", "type": "string" }, "items": { "description": "Required. List items.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem" } }, "subtitle": { "description": "Optional. Subtitle of the list.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageListSelectItem": { "id": "GoogleCloudDialogflowV2IntentMessageListSelectItem", "description": "An item in the list.", "type": "object", "properties": { "info": { "description": "Required. Additional information about this option.", "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo" }, "title": { "description": "Required. The title of the list item.", "type": "string" }, "description": { "description": "Optional. The main text describing the item.", "type": "string" }, "image": { "description": "Optional. The image to display.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" } } }, "GoogleCloudDialogflowV2IntentMessageSelectItemInfo": { "id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", "description": "Additional info about the select item for when it is triggered in a dialog.", "type": "object", "properties": { "key": { "description": "Required. A unique key that will be sent back to the agent if this response is given.", "type": "string" }, "synonyms": { "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDialogflowV2IntentMessageCarouselSelect": { "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect", "description": "The card for presenting a carousel of options to select from.", "type": "object", "properties": { "items": { "description": "Required. Carousel items.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem" } } } }, "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": { "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem", "description": "An item in the carousel.", "type": "object", "properties": { "info": { "description": "Required. Additional info about the option item.", "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo" }, "title": { "description": "Required. Title of the carousel item.", "type": "string" }, "description": { "description": "Optional. The body text of the card.", "type": "string" }, "image": { "description": "Optional. The image to display.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" } } }, "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": { "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard", "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", "type": "object", "properties": { "items": { "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem" } }, "imageDisplayOptions": { "description": "Optional. Settings for displaying the image. Applies to every image in items.", "type": "string", "enumDescriptions": [ "Fill the gaps between the image and the image container with gray bars.", "Fill the gaps between the image and the image container with gray bars.", "Fill the gaps between the image and the image container with white bars.", "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", "Pad the gaps between image and image frame with a blurred copy of the same image." ], "enum": [ "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", "GRAY", "WHITE", "CROPPED", "BLURRED_BACKGROUND" ] } } }, "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem", "description": "Browsing carousel tile", "type": "object", "properties": { "openUriAction": { "description": "Required. Action to present to the user.", "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction" }, "title": { "description": "Required. Title of the carousel item. Maximum of two lines of text.", "type": "string" }, "description": { "description": "Optional. Description of the carousel item. Maximum of four lines of text.", "type": "string" }, "image": { "description": "Optional. Hero image for the carousel item.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "footer": { "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", "description": "Actions on Google action to open a given url.", "type": "object", "properties": { "url": { "description": "Required. URL", "type": "string" }, "urlTypeHint": { "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", "type": "string", "enumDescriptions": [ "Unspecified", "Url would be an amp action", "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." ], "enum": [ "URL_TYPE_HINT_UNSPECIFIED", "AMP_ACTION", "AMP_CONTENT" ] } } }, "GoogleCloudDialogflowV2IntentMessageTableCard": { "id": "GoogleCloudDialogflowV2IntentMessageTableCard", "description": "Table card for Actions on Google.", "type": "object", "properties": { "title": { "description": "Required. Title of the card.", "type": "string" }, "subtitle": { "description": "Optional. Subtitle to the title.", "type": "string" }, "image": { "description": "Optional. Image which should be displayed on the card.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "columnProperties": { "description": "Optional. Display properties for the columns in this table.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageColumnProperties" } }, "rows": { "description": "Optional. Rows in this table of data.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardRow" } }, "buttons": { "description": "Optional. List of buttons for the card.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" } } } }, "GoogleCloudDialogflowV2IntentMessageColumnProperties": { "id": "GoogleCloudDialogflowV2IntentMessageColumnProperties", "description": "Column properties for TableCard.", "type": "object", "properties": { "header": { "description": "Required. Column heading.", "type": "string" }, "horizontalAlignment": { "description": "Optional. Defines text alignment for all cells in this column.", "type": "string", "enumDescriptions": [ "Text is aligned to the leading edge of the column.", "Text is aligned to the leading edge of the column.", "Text is centered in the column.", "Text is aligned to the trailing edge of the column." ], "enum": [ "HORIZONTAL_ALIGNMENT_UNSPECIFIED", "LEADING", "CENTER", "TRAILING" ] } } }, "GoogleCloudDialogflowV2IntentMessageTableCardRow": { "id": "GoogleCloudDialogflowV2IntentMessageTableCardRow", "description": "Row of TableCard.", "type": "object", "properties": { "cells": { "description": "Optional. List of cells that make up this row.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardCell" } }, "dividerAfter": { "description": "Optional. Whether to add a visual divider after this row.", "type": "boolean" } } }, "GoogleCloudDialogflowV2IntentMessageTableCardCell": { "id": "GoogleCloudDialogflowV2IntentMessageTableCardCell", "description": "Cell of TableCardRow.", "type": "object", "properties": { "text": { "description": "Required. Text in this cell.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentMessageMediaContent": { "id": "GoogleCloudDialogflowV2IntentMessageMediaContent", "description": "The media content card for Actions on Google.", "type": "object", "properties": { "mediaType": { "description": "Optional. What type of media is the content (ie \"audio\").", "type": "string", "enumDescriptions": [ "Unspecified.", "Response media type is audio." ], "enum": [ "RESPONSE_MEDIA_TYPE_UNSPECIFIED", "AUDIO" ] }, "mediaObjects": { "description": "Required. List of media objects.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject" } } } }, "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": { "id": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject", "description": "Response media object for media content card.", "type": "object", "properties": { "name": { "description": "Required. Name of media card.", "type": "string" }, "description": { "description": "Optional. Description of media card.", "type": "string" }, "largeImage": { "description": "Optional. Image to display above media content.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "icon": { "description": "Optional. Icon to display above media content.", "$ref": "GoogleCloudDialogflowV2IntentMessageImage" }, "contentUrl": { "description": "Required. Url where the media is stored.", "type": "string" } } }, "GoogleCloudDialogflowV2IntentFollowupIntentInfo": { "id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo", "description": "Represents a single followup intent in the chain.", "type": "object", "properties": { "followupIntentName": { "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", "type": "string" }, "parentFollowupIntentName": { "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", "type": "string" } } }, "GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata": { "id": "GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata", "description": "Metadata for a ConversationProfile.ClearSuggestionFeatureConfig operation.", "type": "object", "properties": { "conversationProfile": { "description": "The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`", "type": "string" }, "participantRole": { "description": "Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureType": { "description": "Required. The type of the suggestion feature to remove.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "KNOWLEDGE_SEARCH" ] }, "createTime": { "description": "Timestamp whe the request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2ConversationEvent": { "id": "GoogleCloudDialogflowV2ConversationEvent", "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.", "type": "object", "properties": { "conversation": { "description": "The unique identifier of the conversation this notification refers to. Format: `projects//conversations/`.", "type": "string" }, "type": { "description": "The type of the event that this notification refers to.", "type": "string", "enumDescriptions": [ "Type not set.", "A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API.", "An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.", "An existing conversation has received notification from Dialogflow that human intervention is required.", "An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config", "Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error." ], "enum": [ "TYPE_UNSPECIFIED", "CONVERSATION_STARTED", "CONVERSATION_FINISHED", "HUMAN_INTERVENTION_NEEDED", "NEW_MESSAGE", "UNRECOVERABLE_ERROR" ] }, "errorStatus": { "description": "More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.", "$ref": "GoogleRpcStatus" }, "newMessagePayload": { "description": "Payload of NEW_MESSAGE event.", "$ref": "GoogleCloudDialogflowV2Message" } } }, "GoogleCloudDialogflowV2Message": { "id": "GoogleCloudDialogflowV2Message", "description": "Represents a message posted into a conversation.", "type": "object", "properties": { "name": { "description": "Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "content": { "description": "Required. The message content.", "type": "string" }, "languageCode": { "description": "Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "participant": { "description": "Output only. The participant that sends this message.", "readOnly": true, "type": "string" }, "participantRole": { "description": "Output only. The role of the participant.", "readOnly": true, "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "createTime": { "description": "Output only. The time when the message was created in Contact Center AI.", "readOnly": true, "type": "string", "format": "google-datetime" }, "sendTime": { "description": "Optional. The time when the message was sent.", "type": "string", "format": "google-datetime" }, "messageAnnotation": { "description": "Output only. The annotation for the message.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2MessageAnnotation" }, "sentimentAnalysis": { "description": "Output only. The sentiment analysis result for the message.", "readOnly": true, "$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult" } } }, "GoogleCloudDialogflowV2MessageAnnotation": { "id": "GoogleCloudDialogflowV2MessageAnnotation", "description": "Represents the result of annotation for the message.", "type": "object", "properties": { "parts": { "description": "The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text].", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2AnnotatedMessagePart" } }, "containEntities": { "description": "Indicates whether the text message contains entities.", "type": "boolean" } } }, "GoogleCloudDialogflowV2AnnotatedMessagePart": { "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", "type": "object", "properties": { "text": { "description": "A part of a message possibly annotated with an entity.", "type": "string" }, "entityType": { "description": "The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.", "type": "string" }, "formattedValue": { "description": "The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { \"amount\": 5, \"currency\": \"USD\" } ", "type": "any" } } }, "GoogleCloudDialogflowV2SentimentAnalysisResult": { "id": "GoogleCloudDialogflowV2SentimentAnalysisResult", "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", "type": "object", "properties": { "queryTextSentiment": { "description": "The sentiment analysis result for `query_text`.", "$ref": "GoogleCloudDialogflowV2Sentiment" } } }, "GoogleCloudDialogflowV2Sentiment": { "id": "GoogleCloudDialogflowV2Sentiment", "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "type": "object", "properties": { "score": { "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", "type": "number", "format": "float" }, "magnitude": { "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", "type": "number", "format": "float" } } }, "GoogleCloudDialogflowV2ExportAgentResponse": { "id": "GoogleCloudDialogflowV2ExportAgentResponse", "description": "The response message for Agents.ExportAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", "type": "string" }, "agentContent": { "description": "Zip compressed raw byte content for agent.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", "description": "Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation this notification refers to. Format: `projects//conversations/`.", "type": "string" }, "participant": { "description": "The participant that the suggestion is compiled for. Format: `projects//conversations//participants/`. It will not be set in legacy workflow.", "type": "string" }, "suggestionResults": { "description": "The suggestion results payload that this notification refers to.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2SuggestionResult" } } } }, "GoogleCloudDialogflowV2SuggestionResult": { "id": "GoogleCloudDialogflowV2SuggestionResult", "description": "One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.", "type": "object", "properties": { "error": { "description": "Error status if the request failed.", "$ref": "GoogleRpcStatus" }, "suggestArticlesResponse": { "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION.", "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse" }, "suggestFaqAnswersResponse": { "description": "SuggestFaqAnswersResponse if request is for FAQ_ANSWER.", "$ref": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse" }, "suggestSmartRepliesResponse": { "description": "SuggestSmartRepliesResponse if request is for SMART_REPLY.", "$ref": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse" } } }, "GoogleCloudDialogflowV2SuggestArticlesResponse": { "id": "GoogleCloudDialogflowV2SuggestArticlesResponse", "description": "The response message for Participants.SuggestArticles.", "type": "object", "properties": { "articleAnswers": { "description": "Articles ordered by score in descending order.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2ArticleAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestArticlesRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2ArticleAnswer": { "id": "GoogleCloudDialogflowV2ArticleAnswer", "description": "Represents article answer.", "type": "object", "properties": { "title": { "description": "The article title.", "type": "string" }, "uri": { "description": "The article URI.", "type": "string" }, "snippets": { "description": "Article snippets.", "type": "array", "items": { "type": "string" } }, "confidence": { "description": "Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "metadata": { "description": "A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2SuggestFaqAnswersResponse": { "id": "GoogleCloudDialogflowV2SuggestFaqAnswersResponse", "description": "The request message for Participants.SuggestFaqAnswers.", "type": "object", "properties": { "faqAnswers": { "description": "Answers extracted from FAQ documents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2FaqAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestFaqAnswersRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2FaqAnswer": { "id": "GoogleCloudDialogflowV2FaqAnswer", "description": "Represents answer from \"frequently asked questions\".", "type": "object", "properties": { "answer": { "description": "The piece of text from the `source` knowledge base document.", "type": "string" }, "confidence": { "description": "The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "question": { "description": "The corresponding FAQ question.", "type": "string" }, "source": { "description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.", "type": "string" }, "metadata": { "description": "A map that contains metadata about the answer and the document from which it originates.", "type": "object", "additionalProperties": { "type": "string" } }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2SuggestSmartRepliesResponse": { "id": "GoogleCloudDialogflowV2SuggestSmartRepliesResponse", "description": "The response message for Participants.SuggestSmartReplies.", "type": "object", "properties": { "smartReplyAnswers": { "description": "Output only. Multiple reply options provided by smart reply service. The order is based on the rank of the model prediction. The maximum number of the returned replies is set in SmartReplyConfig.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2SmartReplyAnswer" } }, "latestMessage": { "description": "The name of the latest conversation message used to compile suggestion for. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "contextSize": { "description": "Number of messages prior to and including latest_message to compile the suggestion. It may be smaller than the SuggestSmartRepliesRequest.context_size field in the request if there aren't that many messages in the conversation.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2SmartReplyAnswer": { "id": "GoogleCloudDialogflowV2SmartReplyAnswer", "description": "Represents a smart reply answer.", "type": "object", "properties": { "reply": { "description": "The content of the reply.", "type": "string" }, "confidence": { "description": "Smart reply confidence. The system's confidence score that this reply is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).", "type": "number", "format": "float" }, "answerRecord": { "description": "The name of answer record, in the format of \"projects//locations//answerRecords/\"", "type": "string" } } }, "GoogleCloudDialogflowV2ImportDocumentsResponse": { "id": "GoogleCloudDialogflowV2ImportDocumentsResponse", "description": "Response message for Documents.ImportDocuments.", "type": "object", "properties": { "warnings": { "description": "Includes details about skipped documents or any other warnings.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "type": "object", "properties": { "state": { "description": "Output only. The current state of this operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ] }, "knowledgeBase": { "description": "The name of the knowledge base interacted with during the operation.", "type": "string" }, "exportOperationMetadata": { "description": "Metadata for the Export Data Operation such as the destination of export.", "$ref": "GoogleCloudDialogflowV2ExportOperationMetadata" } } }, "GoogleCloudDialogflowV2ExportOperationMetadata": { "id": "GoogleCloudDialogflowV2ExportOperationMetadata", "description": "Metadata related to the Export Data Operations (e.g. ExportDocument).", "type": "object", "properties": { "exportedGcsDestination": { "description": "Cloud Storage file path of the exported data.", "$ref": "GoogleCloudDialogflowV2GcsDestination" } } }, "GoogleCloudDialogflowV2GcsDestination": { "id": "GoogleCloudDialogflowV2GcsDestination", "description": "Google Cloud Storage location for the output.", "type": "object", "properties": { "uri": { "description": "The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } } }, "GoogleCloudDialogflowV2OriginalDetectIntentRequest": { "id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest", "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", "type": "object", "properties": { "source": { "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", "type": "string" }, "version": { "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", "type": "string" }, "payload": { "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata": { "id": "GoogleCloudDialogflowV2SetSuggestionFeatureConfigOperationMetadata", "description": "Metadata for a ConversationProfile.SetSuggestionFeatureConfig operation.", "type": "object", "properties": { "conversationProfile": { "description": "The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`", "type": "string" }, "participantRole": { "description": "Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureType": { "description": "Required. The type of the suggestion feature to add or update.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model for chat.", "Run smart reply model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "KNOWLEDGE_SEARCH" ] }, "createTime": { "description": "Timestamp whe the request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2WebhookRequest": { "id": "GoogleCloudDialogflowV2WebhookRequest", "description": "The request message for a webhook call.", "type": "object", "properties": { "session": { "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`.", "type": "string" }, "responseId": { "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", "type": "string" }, "queryResult": { "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`.", "$ref": "GoogleCloudDialogflowV2QueryResult" }, "originalDetectIntentRequest": { "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call.", "$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest" } } }, "GoogleCloudDialogflowV2QueryResult": { "id": "GoogleCloudDialogflowV2QueryResult", "description": "Represents the result of conversational query or event processing.", "type": "object", "properties": { "queryText": { "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", "type": "string" }, "languageCode": { "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" }, "speechRecognitionConfidence": { "description": "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.", "type": "number", "format": "float" }, "action": { "description": "The action name from the matched intent.", "type": "string" }, "parameters": { "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "allRequiredParamsPresent": { "description": "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.", "type": "boolean" }, "cancelsSlotFilling": { "description": "Indicates whether the conversational query triggers a cancellation for slot filling. For more information, see the [cancel slot filling documentation](https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#cancel).", "type": "boolean" }, "fulfillmentText": { "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", "type": "string" }, "fulfillmentMessages": { "description": "The collection of rich messages to present to the user.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessage" } }, "webhookSource": { "description": "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.", "type": "string" }, "webhookPayload": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "outputContexts": { "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2Context" } }, "intent": { "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`.", "$ref": "GoogleCloudDialogflowV2Intent" }, "intentDetectionConfidence": { "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", "type": "number", "format": "float" }, "diagnosticInfo": { "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "sentimentAnalysisResult": { "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request.", "$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult" } } }, "GoogleCloudDialogflowV2WebhookResponse": { "id": "GoogleCloudDialogflowV2WebhookResponse", "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", "type": "object", "properties": { "fulfillmentText": { "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "fulfillmentMessages": { "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2IntentMessage" } }, "source": { "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", "type": "string" }, "payload": { "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "outputContexts": { "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2Context" } }, "followupEventInput": { "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields.", "$ref": "GoogleCloudDialogflowV2EventInput" }, "sessionEntityTypes": { "description": "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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2SessionEntityType" } } } }, "GoogleCloudDialogflowV2EventInput": { "id": "GoogleCloudDialogflowV2EventInput", "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` 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?\"`.", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of the event.", "type": "string" }, "parameters": { "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "languageCode": { "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) 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. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.", "type": "string" } } }, "GoogleCloudDialogflowV2SessionEntityType": { "id": "GoogleCloudDialogflowV2SessionEntityType", "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", "type": "object", "properties": { "name": { "description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "type": "string" }, "entityOverrideMode": { "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", "The collection of session entities extends the collection of entities in the corresponding custom 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 custom entity type and merge." ], "enum": [ "ENTITY_OVERRIDE_MODE_UNSPECIFIED", "ENTITY_OVERRIDE_MODE_OVERRIDE", "ENTITY_OVERRIDE_MODE_SUPPLEMENT" ] }, "entities": { "description": "Required. The collection of entities associated with this session entity type.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" } } } }, "GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata": { "id": "GoogleCloudDialogflowV2DeleteConversationDatasetOperationMetadata", "description": "Metadata for ConversationDatasets.", "type": "object", "properties": {} }, "GoogleCloudDialogflowV2ImportConversationDataOperationResponse": { "id": "GoogleCloudDialogflowV2ImportConversationDataOperationResponse", "description": "Response used for ConversationDatasets.ImportConversationData long running operation.", "type": "object", "properties": { "conversationDataset": { "description": "The resource name of the imported conversation dataset. Format: `projects//locations//conversationDatasets/`", "type": "string" }, "importCount": { "description": "Number of conversations imported successfully.", "type": "integer", "format": "int32" } } }, "GoogleCloudDialogflowV2ImportConversationDataOperationMetadata": { "id": "GoogleCloudDialogflowV2ImportConversationDataOperationMetadata", "description": "Metadata for a ConversationDatasets.ImportConversationData operation.", "type": "object", "properties": { "conversationDataset": { "description": "The resource name of the imported conversation dataset. Format: `projects//locations//conversationDatasets/`", "type": "string" }, "partialFailures": { "description": "Partial failures are failures that don't fail the whole long running operation, e.g. single files that couldn't be read.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } }, "createTime": { "description": "Timestamp when import conversation data request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata": { "id": "GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata", "description": "Metadata for ConversationDatasets.", "type": "object", "properties": { "conversationDataset": { "description": "The resource name of the conversation dataset that will be created. Format: `projects//locations//conversationDatasets/`", "type": "string" } } }, "GoogleCloudDialogflowV2ConversationModel": { "id": "GoogleCloudDialogflowV2ConversationModel", "description": "Represents a conversation model.", "type": "object", "properties": { "name": { "description": "ConversationModel resource name. Format: `projects//conversationModels/`", "type": "string" }, "displayName": { "description": "Required. The display name of the model. At most 64 bytes long.", "type": "string" }, "createTime": { "description": "Output only. Creation time of this model.", "readOnly": true, "type": "string", "format": "google-datetime" }, "datasets": { "description": "Required. Datasets used to create model.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2InputDataset" } }, "state": { "description": "Output only. State of the model. A model can only serve prediction requests after it gets deployed.", "readOnly": true, "type": "string", "enumDescriptions": [ "Should not be used, an un-set enum has this value by default.", "Model being created.", "Model is not deployed but ready to deploy.", "Model is deploying.", "Model is deployed and ready to use.", "Model is undeploying.", "Model is deleting.", "Model is in error state. Not ready to deploy and use.", "Model is being created but the training has not started, The model may remain in this state until there is enough capacity to start training." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "UNDEPLOYED", "DEPLOYING", "DEPLOYED", "UNDEPLOYING", "DELETING", "FAILED", "PENDING" ] }, "languageCode": { "description": "Language code for the conversation model. If not specified, the language is en-US. Language at ConversationModel should be set for all non en-us languages. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", "type": "string" }, "articleSuggestionModelMetadata": { "description": "Metadata for article suggestion models.", "$ref": "GoogleCloudDialogflowV2ArticleSuggestionModelMetadata" }, "smartReplyModelMetadata": { "description": "Metadata for smart reply models.", "$ref": "GoogleCloudDialogflowV2SmartReplyModelMetadata" } } }, "GoogleCloudDialogflowV2InputDataset": { "id": "GoogleCloudDialogflowV2InputDataset", "description": "InputDataset used to create model or do evaluation. NextID:5", "type": "object", "properties": { "dataset": { "description": "Required. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/`", "type": "string" } } }, "GoogleCloudDialogflowV2ArticleSuggestionModelMetadata": { "id": "GoogleCloudDialogflowV2ArticleSuggestionModelMetadata", "description": "Metadata for article suggestion models.", "type": "object", "properties": { "trainingModelType": { "description": "Optional. Type of the article suggestion model. If not provided, model_type is used.", "type": "string", "enumDescriptions": [ "ModelType unspecified.", "ModelType smart reply dual encoder model.", "ModelType smart reply bert model." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "SMART_REPLY_DUAL_ENCODER_MODEL", "SMART_REPLY_BERT_MODEL" ] } } }, "GoogleCloudDialogflowV2SmartReplyModelMetadata": { "id": "GoogleCloudDialogflowV2SmartReplyModelMetadata", "description": "Metadata for smart reply models.", "type": "object", "properties": { "trainingModelType": { "description": "Optional. Type of the smart reply model. If not provided, model_type is used.", "type": "string", "enumDescriptions": [ "ModelType unspecified.", "ModelType smart reply dual encoder model.", "ModelType smart reply bert model." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "SMART_REPLY_DUAL_ENCODER_MODEL", "SMART_REPLY_BERT_MODEL" ] } } }, "GoogleCloudDialogflowV2CreateConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2CreateConversationModelOperationMetadata", "description": "Metadata for a ConversationModels.CreateConversationModel operation.", "type": "object", "properties": { "conversationModel": { "description": "The resource name of the conversation model. Format: `projects//conversationModels/`", "type": "string" }, "state": { "description": "State of CreateConversationModel operation.", "type": "string", "enumDescriptions": [ "Invalid.", "Request is submitted, but training has not started yet. The model may remain in this state until there is enough capacity to start training.", "The training has succeeded.", "The training has succeeded.", "The training has been cancelled.", "The training is in cancelling state.", "Custom model is training." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "SUCCEEDED", "FAILED", "CANCELLED", "CANCELLING", "TRAINING" ] }, "createTime": { "description": "Timestamp when the request to create conversation model is submitted. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2DeleteConversationModelOperationMetadata", "description": "Metadata for a ConversationModels.DeleteConversationModel operation.", "type": "object", "properties": { "conversationModel": { "description": "The resource name of the conversation model. Format: `projects//conversationModels/`", "type": "string" }, "createTime": { "description": "Timestamp when delete conversation model request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2DeployConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2DeployConversationModelOperationMetadata", "description": "Metadata for a ConversationModels.DeployConversationModel operation.", "type": "object", "properties": { "conversationModel": { "description": "The resource name of the conversation model. Format: `projects//conversationModels/`", "type": "string" }, "createTime": { "description": "Timestamp when request to deploy conversation model was submitted. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", "description": "Metadata for a ConversationModels.UndeployConversationModel operation.", "type": "object", "properties": { "conversationModel": { "description": "The resource name of the conversation model. Format: `projects//conversationModels/`", "type": "string" }, "createTime": { "description": "Timestamp when the request to undeploy conversation model was submitted. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata": { "id": "GoogleCloudDialogflowV2CreateConversationModelEvaluationOperationMetadata", "description": "Metadata for a ConversationModels.CreateConversationModelEvaluation operation.", "type": "object", "properties": { "conversationModelEvaluation": { "description": "The resource name of the conversation model. Format: `projects//locations//conversationModels//evaluations/`", "type": "string" }, "conversationModel": { "description": "The resource name of the conversation model. Format: `projects//locations//conversationModels/`", "type": "string" }, "state": { "description": "State of CreateConversationModel operation.", "type": "string", "enumDescriptions": [ "Operation status not specified.", "The operation is being prepared.", "The operation is running.", "The operation is cancelled.", "The operation has succeeded.", "The operation has failed." ], "enum": [ "STATE_UNSPECIFIED", "INITIALIZING", "RUNNING", "CANCELLED", "SUCCEEDED", "FAILED" ] }, "createTime": { "description": "Timestamp when the request to create conversation model was submitted. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": { "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse", "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", "type": "object", "properties": { "entityTypes": { "description": "The collection of updated or created entity types.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" } } } }, "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": { "id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse", "description": "The response message for Intents.BatchUpdateIntents.", "type": "object", "properties": { "intents": { "description": "The collection of updated or created intents.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Intent" } } } }, "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigOperationMetadata", "description": "Metadata for a ConversationProfile.ClearSuggestionFeatureConfig operation.", "type": "object", "properties": { "conversationProfile": { "description": "The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`", "type": "string" }, "participantRole": { "description": "Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureType": { "description": "Required. The type of the suggestion feature to remove.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", "KNOWLEDGE_SEARCH" ] }, "createTime": { "description": "Timestamp whe the request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1ConversationEvent": { "id": "GoogleCloudDialogflowV2beta1ConversationEvent", "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.", "type": "object", "properties": { "conversation": { "description": "Required. The unique identifier of the conversation this notification refers to. Format: `projects//conversations/`.", "type": "string" }, "type": { "description": "Required. The type of the event that this notification refers to.", "type": "string", "enumDescriptions": [ "Type not set.", "A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API.", "An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.", "An existing conversation has received notification from Dialogflow that human intervention is required.", "An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config", "Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error." ], "enum": [ "TYPE_UNSPECIFIED", "CONVERSATION_STARTED", "CONVERSATION_FINISHED", "HUMAN_INTERVENTION_NEEDED", "NEW_MESSAGE", "UNRECOVERABLE_ERROR" ] }, "errorStatus": { "description": "Optional. More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.", "$ref": "GoogleRpcStatus" }, "newMessagePayload": { "description": "Payload of NEW_MESSAGE event.", "$ref": "GoogleCloudDialogflowV2beta1Message" } } }, "GoogleCloudDialogflowV2beta1ExportAgentResponse": { "id": "GoogleCloudDialogflowV2beta1ExportAgentResponse", "description": "The response message for Agents.ExportAgent.", "type": "object", "properties": { "agentUri": { "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", "type": "string" }, "agentContent": { "description": "Zip compressed raw byte content for agent.", "type": "string", "format": "byte" } } }, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", "description": "Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.", "type": "object", "properties": { "conversation": { "description": "The conversation this notification refers to. Format: `projects//conversations/`.", "type": "string" }, "participant": { "description": "The participant that the suggestion is compiled for. And This field is used to call Participants.ListSuggestions API. Format: `projects//conversations//participants/`. It will not be set in legacy workflow. HumanAgentAssistantConfig.name for more information.", "type": "string" }, "suggestionResults": { "description": "The suggestion results payload that this notification refers to. It will only be set when HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses sets to true.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SuggestionResult" } } } }, "GoogleCloudDialogflowV2beta1ImportDocumentsResponse": { "id": "GoogleCloudDialogflowV2beta1ImportDocumentsResponse", "description": "Response message for Documents.ImportDocuments.", "type": "object", "properties": { "warnings": { "description": "Includes details about skipped documents or any other warnings.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "type": "object", "properties": { "state": { "description": "Required. Output only. The current state of this operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ] }, "knowledgeBase": { "description": "The name of the knowledge base interacted with during the operation.", "type": "string" }, "exportOperationMetadata": { "description": "Metadata for the Export Data Operation such as the destination of export.", "$ref": "GoogleCloudDialogflowV2beta1ExportOperationMetadata" } } }, "GoogleCloudDialogflowV2beta1ExportOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1ExportOperationMetadata", "description": "Metadata related to the Export Data Operations (e.g. ExportDocument).", "type": "object", "properties": { "exportedGcsDestination": { "description": "Cloud Storage file path of the exported data.", "$ref": "GoogleCloudDialogflowV2beta1GcsDestination" } } }, "GoogleCloudDialogflowV2beta1GcsDestination": { "id": "GoogleCloudDialogflowV2beta1GcsDestination", "description": "Google Cloud Storage location for the output.", "type": "object", "properties": { "uri": { "description": "Required. The Google Cloud Storage URIs for the output. A URI is of the form: `gs://bucket/object-prefix-or-name` Whether a prefix or name is used depends on the use case. The requesting user must have \"write-permission\" to the bucket.", "type": "string" } } }, "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": { "id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", "type": "object", "properties": { "source": { "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", "type": "string" }, "version": { "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", "type": "string" }, "payload": { "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigOperationMetadata", "description": "Metadata for a ConversationProfile.SetSuggestionFeatureConfig operation.", "type": "object", "properties": { "conversationProfile": { "description": "The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`", "type": "string" }, "participantRole": { "description": "Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.", "type": "string", "enumDescriptions": [ "Participant role not set.", "Participant is a human agent.", "Participant is an automated agent, such as a Dialogflow agent.", "Participant is an end user that has called or chatted with Dialogflow services." ], "enum": [ "ROLE_UNSPECIFIED", "HUMAN_AGENT", "AUTOMATED_AGENT", "END_USER" ] }, "suggestionFeatureType": { "description": "Required. The type of the suggestion feature to add or update.", "type": "string", "enumDescriptions": [ "Unspecified feature type.", "Run article suggestion model for chat.", "Run FAQ model.", "Run smart reply model for chat.", "Run Dialogflow assist model for chat, which will return automated agent response as suggestion.", "Run conversation summarization model for chat.", "Run knowledge search with text input from agent or text generated query." ], "enum": [ "TYPE_UNSPECIFIED", "ARTICLE_SUGGESTION", "FAQ", "SMART_REPLY", "DIALOGFLOW_ASSIST", "CONVERSATION_SUMMARIZATION", "KNOWLEDGE_SEARCH" ] }, "createTime": { "description": "Timestamp whe the request was created. The time is measured on server side.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudDialogflowV2beta1WebhookRequest": { "id": "GoogleCloudDialogflowV2beta1WebhookRequest", "description": "The request message for a webhook call.", "type": "object", "properties": { "session": { "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`,", "type": "string" }, "responseId": { "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", "type": "string" }, "queryResult": { "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`.", "$ref": "GoogleCloudDialogflowV2beta1QueryResult" }, "alternativeQueryResults": { "description": "Alternative query results from KnowledgeService.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1QueryResult" } }, "originalDetectIntentRequest": { "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call.", "$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest" } } }, "GoogleCloudDialogflowV2beta1WebhookResponse": { "id": "GoogleCloudDialogflowV2beta1WebhookResponse", "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", "type": "object", "properties": { "fulfillmentText": { "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", "type": "string" }, "fulfillmentMessages": { "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" } }, "source": { "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", "type": "string" }, "payload": { "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "outputContexts": { "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1Context" } }, "followupEventInput": { "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields.", "$ref": "GoogleCloudDialogflowV2beta1EventInput" }, "liveAgentHandoff": { "description": "Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.", "type": "boolean" }, "endInteraction": { "description": "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.", "type": "boolean" }, "sessionEntityTypes": { "description": "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. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", "type": "array", "items": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" } } } }, "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", "description": "Response message for Documents.ImportDocuments.", "type": "object", "properties": { "warnings": { "description": "Includes details about skipped documents or any other warnings.", "type": "array", "items": { "$ref": "GoogleRpcStatus" } } } }, "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", "description": "Metadata for CreateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", "description": "Metadata in google::longrunning::Operation for Knowledge operations.", "type": "object", "properties": { "state": { "description": "Required. Output only. The current state of this operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "State unspecified.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "DONE" ] } } }, "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", "description": "Metadata for DeleteDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", "description": "Metadata for ImportDocuments operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", "description": "Metadata for ReloadDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { "id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", "description": "Metadata for UpdateDocument operation.", "type": "object", "properties": { "genericMetadata": { "description": "The generic information of the operation.", "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata" } } }, "GoogleCloudDialogflowV3alpha1ConversationSignals": { "id": "GoogleCloudDialogflowV3alpha1ConversationSignals", "description": "This message is used to hold all the Conversation Signals data, which will be converted to JSON and exported to BigQuery.", "type": "object", "properties": { "turnSignals": { "description": "Required. Turn signals for the current turn.", "$ref": "GoogleCloudDialogflowV3alpha1TurnSignals" } } }, "GoogleCloudDialogflowV3alpha1TurnSignals": { "id": "GoogleCloudDialogflowV3alpha1TurnSignals", "description": "Collection of all signals that were extracted for a single turn of the conversation.", "type": "object", "properties": { "noMatch": { "description": "Whether NLU predicted NO_MATCH.", "type": "boolean" }, "noUserInput": { "description": "Whether user provided no input.", "type": "boolean" }, "dtmfUsed": { "description": "Whether user was using DTMF input.", "type": "boolean" }, "userEscalated": { "description": "Whether user was specifically asking for a live agent.", "type": "boolean" }, "agentEscalated": { "description": "Whether agent responded with LiveAgentHandoff fulfillment.", "type": "boolean" }, "triggeredAbandonmentEvent": { "description": "Whether agent has triggered the event corresponding to user abandoning the conversation.", "type": "boolean" }, "reachedEndPage": { "description": "Whether turn resulted in End Session page.", "type": "boolean" }, "webhookStatuses": { "description": "Human-readable statuses of the webhooks triggered during this turn.", "type": "array", "items": { "type": "string" } }, "failureReasons": { "description": "Failure reasons of the turn.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Failure reason is not assigned.", "Whether NLU failed to recognize user intent.", "Whether webhook failed during the turn." ], "enum": [ "FAILURE_REASON_UNSPECIFIED", "FAILED_INTENT", "FAILED_WEBHOOK" ] } }, "sentimentScore": { "description": "Sentiment score of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" }, "sentimentMagnitude": { "description": "Sentiment magnitude of the user utterance if [sentiment](https://cloud.google.com/dialogflow/cx/docs/concept/sentiment) was enabled.", "type": "number", "format": "float" } } } }, "discoveryVersion": "v1", "mtlsRootUrl": "https://dialogflow.mtls.googleapis.com/", "kind": "discovery#restDescription", "ownerName": "Google", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "title": "Dialogflow API", "servicePath": "", "name": "dialogflow", "rootUrl": "https://dialogflow.googleapis.com/", "version": "v2beta1", "resources": { "projects": { "methods": { "getAgent": { "id": "dialogflow.projects.getAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/agent", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent." }, "setAgent": { "id": "dialogflow.projects.setAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/agent", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "deleteAgent": { "id": "dialogflow.projects.deleteAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/agent", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified agent." } }, "resources": { "operations": { "methods": { "list": { "id": "dialogflow.projects.operations.list", "path": "v2beta1/{+name}/operations", "flatPath": "v2beta1/projects/{projectsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "dialogflow.projects.operations.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "cancel": { "id": "dialogflow.projects.operations.cancel", "path": "v2beta1/{+name}:cancel", "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." } } }, "agent": { "methods": { "getFulfillment": { "id": "dialogflow.projects.agent.getFulfillment", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/fulfillment", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", "pattern": "^projects/[^/]+/agent/fulfillment$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the fulfillment." }, "updateFulfillment": { "id": "dialogflow.projects.agent.updateFulfillment", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/fulfillment", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "pattern": "^projects/[^/]+/agent/fulfillment$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the fulfillment." }, "search": { "id": "dialogflow.projects.agent.search", "path": "v2beta1/{+parent}/agent:search", "flatPath": "v2beta1/projects/{projectsId}/agent:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list agents from. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id \"-\". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections)." }, "train": { "id": "dialogflow.projects.agent.train", "path": "v2beta1/{+parent}/agent:train", "flatPath": "v2beta1/projects/{projectsId}/agent:train", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Trains the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "export": { "id": "dialogflow.projects.agent.export", "path": "v2beta1/{+parent}/agent:export", "flatPath": "v2beta1/projects/{projectsId}/agent:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Exports the specified agent to a ZIP file. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse" }, "import": { "id": "dialogflow.projects.agent.import", "path": "v2beta1/{+parent}/agent:import", "flatPath": "v2beta1/projects/{projectsId}/agent:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "restore": { "id": "dialogflow.projects.agent.restore", "path": "v2beta1/{+parent}/agent:restore", "flatPath": "v2beta1/projects/{projectsId}/agent:restore", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "getValidationResult": { "id": "dialogflow.projects.agent.getValidationResult", "path": "v2beta1/{+parent}/agent/validationResult", "flatPath": "v2beta1/projects/{projectsId}/agent/validationResult", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ValidationResult" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed." } }, "resources": { "environments": { "methods": { "list": { "id": "dialogflow.projects.agent.environments.list", "path": "v2beta1/{+parent}/environments", "flatPath": "v2beta1/projects/{projectsId}/agent/environments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all non-draft environments of the specified agent." }, "get": { "id": "dialogflow.projects.agent.environments.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent environment." }, "create": { "id": "dialogflow.projects.agent.environments.create", "path": "v2beta1/{+parent}/environments", "flatPath": "v2beta1/projects/{projectsId}/agent/environments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "environmentId": { "description": "Required. The unique id of the new environment.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an agent environment." }, "patch": { "id": "dialogflow.projects.agent.environments.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowLoadToDraftAndDiscardChanges": { "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function." }, "delete": { "id": "dialogflow.projects.agent.environments.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified agent environment." }, "getHistory": { "id": "dialogflow.projects.agent.environments.getHistory", "path": "v2beta1/{+parent}/history", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/history", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets the history of the specified environment." } }, "resources": { "users": { "resources": { "sessions": { "methods": { "deleteContexts": { "id": "dialogflow.projects.agent.environments.users.sessions.deleteContexts", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes all active contexts in the specified session." }, "detectIntent": { "id": "dialogflow.projects.agent.environments.users.sessions.detectIntent", "path": "v2beta1/{+session}:detectIntent", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}:detectIntent", "httpMethod": "POST", "parameters": { "session": { "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "session" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. If you might use [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) or other CCAI products now or in the future, consider using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "contexts": { "methods": { "list": { "id": "dialogflow.projects.agent.environments.users.sessions.contexts.list", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all contexts in the specified session." }, "get": { "id": "dialogflow.projects.agent.environments.users.sessions.contexts.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified context." }, "create": { "id": "dialogflow.projects.agent.environments.users.sessions.contexts.create", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a context. If the specified context already exists, overrides the context." }, "patch": { "id": "dialogflow.projects.agent.environments.users.sessions.contexts.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified context." }, "delete": { "id": "dialogflow.projects.agent.environments.users.sessions.contexts.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified context." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "get": { "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "create": { "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "patch": { "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "delete": { "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." } } } } } } }, "intents": { "methods": { "list": { "id": "dialogflow.projects.agent.environments.intents.list", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/agent/environments/{environmentsId}/intents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.", "pattern": "^projects/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all intents in the specified agent." } } } } }, "sessions": { "methods": { "deleteContexts": { "id": "dialogflow.projects.agent.sessions.deleteContexts", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes all active contexts in the specified session." }, "detectIntent": { "id": "dialogflow.projects.agent.sessions.detectIntent", "path": "v2beta1/{+session}:detectIntent", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent", "httpMethod": "POST", "parameters": { "session": { "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "session" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. If you might use [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) or other CCAI products now or in the future, consider using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "contexts": { "methods": { "list": { "id": "dialogflow.projects.agent.sessions.contexts.list", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all contexts in the specified session." }, "get": { "id": "dialogflow.projects.agent.sessions.contexts.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified context." }, "create": { "id": "dialogflow.projects.agent.sessions.contexts.create", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a context. If the specified context already exists, overrides the context." }, "patch": { "id": "dialogflow.projects.agent.sessions.contexts.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified context." }, "delete": { "id": "dialogflow.projects.agent.sessions.contexts.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified context." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.agent.sessions.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "get": { "id": "dialogflow.projects.agent.sessions.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "create": { "id": "dialogflow.projects.agent.sessions.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "patch": { "id": "dialogflow.projects.agent.sessions.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "delete": { "id": "dialogflow.projects.agent.sessions.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." } } } } }, "intents": { "methods": { "list": { "id": "dialogflow.projects.agent.intents.list", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/agent/intents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all intents in the specified agent." }, "get": { "id": "dialogflow.projects.agent.intents.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the intent. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified intent." }, "create": { "id": "dialogflow.projects.agent.intents.create", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/agent/intents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a intent for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an intent in the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "patch": { "id": "dialogflow.projects.agent.intents.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified intent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "delete": { "id": "dialogflow.projects.agent.intents.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified intent and its direct or indirect followup intents. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.agent.intents.batchUpdate", "path": "v2beta1/{+parent}/intents:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to update or create intents in. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates/Creates multiple intents in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchDelete": { "id": "dialogflow.projects.agent.intents.batchDelete", "path": "v2beta1/{+parent}/intents:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes intents in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.agent.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all entity types from. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all entity types in the specified agent." }, "get": { "id": "dialogflow.projects.agent.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the entity type. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified entity type." }, "create": { "id": "dialogflow.projects.agent.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a entity type for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "patch": { "id": "dialogflow.projects.agent.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified entity type. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "delete": { "id": "dialogflow.projects.agent.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified entity type. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.agent.entityTypes.batchUpdate", "path": "v2beta1/{+parent}/entityTypes:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to update or create entity types in. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates/Creates multiple entity types in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchDelete": { "id": "dialogflow.projects.agent.entityTypes.batchDelete", "path": "v2beta1/{+parent}/entityTypes:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent`, - `projects//locations//agent`.", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes entity types in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } }, "resources": { "entities": { "methods": { "batchCreate": { "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate", "path": "v2beta1/{+parent}/entities:batchCreate", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates multiple new entities in the specified entity type. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate", "path": "v2beta1/{+parent}/entities:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to update or create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)" }, "batchDelete": { "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete", "path": "v2beta1/{+parent}/entities:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to delete entries for. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes entities in the specified entity type. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } } } } }, "knowledgeBases": { "methods": { "list": { "id": "dialogflow.projects.agent.knowledgeBases.list", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list of knowledge bases for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains \"articles\". * 'display_name:\"Best Articles\"' matches knowledge bases whose display name contains \"Best Articles\". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains \"articles\" and whose language code is \"en-gb\". Note: An empty filter string (i.e. \"\") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "get": { "id": "dialogflow.projects.agent.knowledgeBases.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "create": { "id": "dialogflow.projects.agent.knowledgeBases.create", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project to create a knowledge base for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "delete": { "id": "dialogflow.projects.agent.knowledgeBases.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "patch": { "id": "dialogflow.projects.agent.knowledgeBases.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." } }, "resources": { "documents": { "methods": { "list": { "id": "dialogflow.projects.agent.knowledgeBases.documents.list", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * \"knowledge_types:FAQ\" matches documents with FAQ knowledge type. * \"display_name:customer\" matches documents whose display name contains \"customer\". * \"state=ACTIVE\" matches documents with ACTIVE state. * \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all documents of the knowledge base. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "get": { "id": "dialogflow.projects.agent.knowledgeBases.documents.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "create": { "id": "dialogflow.projects.agent.knowledgeBases.documents.create", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "importGcsCustomMetadata": { "description": "Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "delete": { "id": "dialogflow.projects.agent.knowledgeBases.documents.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "patch": { "id": "dialogflow.projects.agent.knowledgeBases.documents.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "reload": { "id": "dialogflow.projects.agent.knowledgeBases.documents.reload", "path": "v2beta1/{+name}:reload", "flatPath": "v2beta1/projects/{projectsId}/agent/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}:reload", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`", "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." } } } } }, "versions": { "methods": { "list": { "id": "dialogflow.projects.agent.versions.list", "path": "v2beta1/{+parent}/versions", "flatPath": "v2beta1/projects/{projectsId}/agent/versions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all versions of the specified agent." }, "get": { "id": "dialogflow.projects.agent.versions.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent version." }, "create": { "id": "dialogflow.projects.agent.versions.create", "path": "v2beta1/{+parent}/versions", "flatPath": "v2beta1/projects/{projectsId}/agent/versions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment." }, "patch": { "id": "dialogflow.projects.agent.versions.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource." }, "delete": { "id": "dialogflow.projects.agent.versions.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/agent/versions/{versionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Delete the specified agent version." } } } } }, "locations": { "methods": { "getAgent": { "id": "dialogflow.projects.locations.getAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent." }, "setAgent": { "id": "dialogflow.projects.locations.setAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Agent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "deleteAgent": { "id": "dialogflow.projects.locations.deleteAgent", "path": "v2beta1/{+parent}/agent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified agent." }, "list": { "id": "dialogflow.projects.locations.list", "path": "v2beta1/{+name}/locations", "flatPath": "v2beta1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Lists information about the supported locations for this service." }, "get": { "id": "dialogflow.projects.locations.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudLocationLocation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "dialogflow.projects.locations.operations.list", "path": "v2beta1/{+name}/operations", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "dialogflow.projects.locations.operations.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "cancel": { "id": "dialogflow.projects.locations.operations.cancel", "path": "v2beta1/{+name}:cancel", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." } } }, "agent": { "methods": { "getFulfillment": { "id": "dialogflow.projects.locations.agent.getFulfillment", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/fulfillment", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the fulfillment." }, "updateFulfillment": { "id": "dialogflow.projects.locations.agent.updateFulfillment", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/fulfillment", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment` This field is not used for Fulfillment in an Environment.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the fulfillment." }, "search": { "id": "dialogflow.projects.locations.agent.search", "path": "v2beta1/{+parent}/agent:search", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent:search", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list agents from. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id \"-\". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections)." }, "train": { "id": "dialogflow.projects.locations.agent.train", "path": "v2beta1/{+parent}/agent:train", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent:train", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Trains the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "export": { "id": "dialogflow.projects.locations.agent.export", "path": "v2beta1/{+parent}/agent:export", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Exports the specified agent to a ZIP file. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse" }, "import": { "id": "dialogflow.projects.locations.agent.import", "path": "v2beta1/{+parent}/agent:import", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "restore": { "id": "dialogflow.projects.locations.agent.restore", "path": "v2beta1/{+parent}/agent:restore", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent:restore", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "getValidationResult": { "id": "dialogflow.projects.locations.agent.getValidationResult", "path": "v2beta1/{+parent}/agent/validationResult", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/validationResult", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ValidationResult" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed." } }, "resources": { "environments": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.environments.list", "path": "v2beta1/{+parent}/environments", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all non-draft environments of the specified agent." }, "get": { "id": "dialogflow.projects.locations.agent.environments.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent environment." }, "create": { "id": "dialogflow.projects.locations.agent.environments.create", "path": "v2beta1/{+parent}/environments", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create an environment for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "environmentId": { "description": "Required. The unique id of the new environment.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an agent environment." }, "patch": { "id": "dialogflow.projects.locations.agent.environments.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowLoadToDraftAndDiscardChanges": { "description": "Optional. This field is used to prevent accidental overwrite of the draft environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the draft environment (environment ID = `-`).", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Environment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting `environment.agent_version`, the environment is temporarily set to the `LOADING` state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the `RUNNING` state. You can use \"-\" as Environment ID in environment name to update version in \"draft\" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function." }, "delete": { "id": "dialogflow.projects.locations.agent.environments.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the environment to delete. / Format: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified agent environment." }, "getHistory": { "id": "dialogflow.projects.locations.agent.environments.getHistory", "path": "v2beta1/{+parent}/history", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/history", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the environment to retrieve history for. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1EnvironmentHistory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets the history of the specified environment." } }, "resources": { "users": { "resources": { "sessions": { "methods": { "deleteContexts": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.deleteContexts", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes all active contexts in the specified session." }, "detectIntent": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.detectIntent", "path": "v2beta1/{+session}:detectIntent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}:detectIntent", "httpMethod": "POST", "parameters": { "session": { "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "session" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. If you might use [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) or other CCAI products now or in the future, consider using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "contexts": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.list", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all contexts in the specified session." }, "get": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified context." }, "create": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.create", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a context. If the specified context already exists, overrides the context." }, "patch": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified context." }, "delete": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified context." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "get": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "create": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "patch": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "delete": { "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/users/{usersId}/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." } } } } } } }, "intents": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.environments.intents.list", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/environments/{environmentsId}/intents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all intents in the specified agent." } } } } }, "sessions": { "methods": { "deleteContexts": { "id": "dialogflow.projects.locations.agent.sessions.deleteContexts", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "DELETE", "parameters": { "parent": { "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes all active contexts in the specified session." }, "detectIntent": { "id": "dialogflow.projects.locations.agent.sessions.detectIntent", "path": "v2beta1/{+session}:detectIntent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}:detectIntent", "httpMethod": "POST", "parameters": { "session": { "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment (`Environment ID` might be referred to as environment name at some places). If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "session" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. If you might use [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa) or other CCAI products now or in the future, consider using AnalyzeContent instead of `DetectIntent`. `AnalyzeContent` has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "contexts": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.sessions.contexts.list", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all contexts in the specified session." }, "get": { "id": "dialogflow.projects.locations.agent.sessions.contexts.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified context." }, "create": { "id": "dialogflow.projects.locations.agent.sessions.contexts.create", "path": "v2beta1/{+parent}/contexts", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a context. If the specified context already exists, overrides the context." }, "patch": { "id": "dialogflow.projects.locations.agent.sessions.contexts.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified context." }, "delete": { "id": "dialogflow.projects.locations.agent.sessions.contexts.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified context." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.sessions.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "get": { "id": "dialogflow.projects.locations.agent.sessions.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "create": { "id": "dialogflow.projects.locations.agent.sessions.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "patch": { "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." }, "delete": { "id": "dialogflow.projects.locations.agent.sessions.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration." } } } } }, "intents": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.intents.list", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all intents from. Format: `projects//agent` or `projects//locations//agent`. Alternatively, you can specify the environment to list intents for. Format: `projects//agent/environments/` or `projects//locations//agent/environments/`. Note: training phrases of the intents will not be returned for non-draft environment.", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all intents in the specified agent." }, "get": { "id": "dialogflow.projects.locations.agent.intents.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the intent. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified intent." }, "create": { "id": "dialogflow.projects.locations.agent.intents.create", "path": "v2beta1/{+parent}/intents", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a intent for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an intent in the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "patch": { "id": "dialogflow.projects.locations.agent.intents.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "intentView": { "description": "Optional. The resource view to apply to the returned intent.", "location": "query", "type": "string", "enumDescriptions": [ "Training phrases field is not populated in the response.", "All fields are populated." ], "enum": [ "INTENT_VIEW_UNSPECIFIED", "INTENT_VIEW_FULL" ] } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Intent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified intent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "delete": { "id": "dialogflow.projects.locations.agent.intents.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents/{intentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified intent and its direct or indirect followup intents. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.locations.agent.intents.batchUpdate", "path": "v2beta1/{+parent}/intents:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to update or create intents in. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates/Creates multiple intents in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchDelete": { "id": "dialogflow.projects.locations.agent.intents.batchDelete", "path": "v2beta1/{+parent}/intents:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/intents:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes intents in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } } }, "entityTypes": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.entityTypes.list", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all entity types from. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all entity types in the specified agent." }, "get": { "id": "dialogflow.projects.locations.agent.entityTypes.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the entity type. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified entity type." }, "create": { "id": "dialogflow.projects.locations.agent.entityTypes.create", "path": "v2beta1/{+parent}/entityTypes", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a entity type for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "patch": { "id": "dialogflow.projects.locations.agent.entityTypes.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "languageCode": { "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", "location": "query", "type": "string" }, "updateMask": { "description": "Optional. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified entity type. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "delete": { "id": "dialogflow.projects.locations.agent.entityTypes.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified entity type. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.locations.agent.entityTypes.batchUpdate", "path": "v2beta1/{+parent}/entityTypes:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to update or create entity types in. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates/Creates multiple entity types in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchDelete": { "id": "dialogflow.projects.locations.agent.entityTypes.batchDelete", "path": "v2beta1/{+parent}/entityTypes:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent`, - `projects//locations//agent`.", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes entity types in the specified agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } }, "resources": { "entities": { "methods": { "batchCreate": { "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchCreate", "path": "v2beta1/{+parent}/entities:batchCreate", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates multiple new entities in the specified entity type. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." }, "batchUpdate": { "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchUpdate", "path": "v2beta1/{+parent}/entities:batchUpdate", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to update or create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training). This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)" }, "batchDelete": { "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchDelete", "path": "v2beta1/{+parent}/entities:batchDelete", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the entity type to delete entries for. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes entities in the specified entity type. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training)." } } } } }, "versions": { "methods": { "list": { "id": "dialogflow.projects.locations.agent.versions.list", "path": "v2beta1/{+parent}/versions", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all versions of the specified agent." }, "get": { "id": "dialogflow.projects.locations.agent.versions.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified agent version." }, "create": { "id": "dialogflow.projects.locations.agent.versions.create", "path": "v2beta1/{+parent}/versions", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent`", "pattern": "^projects/[^/]+/locations/[^/]+/agent$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates an agent version. The new version points to the agent instance in the \"default\" environment." }, "patch": { "id": "dialogflow.projects.locations.agent.versions.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Version" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource." }, "delete": { "id": "dialogflow.projects.locations.agent.versions.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/agent/versions/{versionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", "pattern": "^projects/[^/]+/locations/[^/]+/agent/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Delete the specified agent version." } } } } }, "answerRecords": { "methods": { "get": { "id": "dialogflow.projects.locations.answerRecords.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/answerRecords/{answerRecordsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the answer record to retrieve. Format: `projects//locations//answerRecords/`.", "pattern": "^projects/[^/]+/locations/[^/]+/answerRecords/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "deprecated": true, "description": "Deprecated. Retrieves a specific answer record." }, "list": { "id": "dialogflow.projects.locations.answerRecords.list", "path": "v2beta1/{+parent}/answerRecords", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/answerRecords", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "deprecated": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all answer records in the specified project in reverse chronological order." }, "patch": { "id": "dialogflow.projects.locations.answerRecords.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/answerRecords/{answerRecordsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of this answer record. Required for AnswerRecords.UpdateAnswerRecord method. Format: `projects//locations//answerRecords/`.", "pattern": "^projects/[^/]+/locations/[^/]+/answerRecords/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified answer record." } } }, "conversationProfiles": { "methods": { "list": { "id": "dialogflow.projects.locations.conversationProfiles.list", "path": "v2beta1/{+parent}/conversationProfiles", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list all conversation profiles from. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all conversation profiles in the specified project." }, "get": { "id": "dialogflow.projects.locations.conversationProfiles.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified conversation profile." }, "create": { "id": "dialogflow.projects.locations.conversationProfiles.create", "path": "v2beta1/{+parent}/conversationProfiles", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project to create a conversation profile for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API." }, "patch": { "id": "dialogflow.projects.locations.conversationProfiles.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API." }, "delete": { "id": "dialogflow.projects.locations.conversationProfiles.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the conversation profile to delete. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified conversation profile." }, "setSuggestionFeatureConfig": { "id": "dialogflow.projects.locations.conversationProfiles.setSuggestionFeatureConfig", "path": "v2beta1/{+conversationProfile}:setSuggestionFeatureConfig", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig", "httpMethod": "POST", "parameters": { "conversationProfile": { "description": "Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversationProfile" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: SetSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected." }, "clearSuggestionFeatureConfig": { "id": "dialogflow.projects.locations.conversationProfiles.clearSuggestionFeatureConfig", "path": "v2beta1/{+conversationProfile}:clearSuggestionFeatureConfig", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig", "httpMethod": "POST", "parameters": { "conversationProfile": { "description": "Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversationProfile" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Clears a suggestion feature from a conversation profile for the given participant role. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ClearSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile" } } }, "conversations": { "methods": { "create": { "id": "dialogflow.projects.locations.conversations.create", "path": "v2beta1/{+parent}/conversations", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the project creating the conversation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "conversationId": { "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage." }, "list": { "id": "dialogflow.projects.locations.conversations.list", "path": "v2beta1/{+parent}/conversations", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project from which to list all conversation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either `=`,`!=`, `\u003e`, or `\u003c`. - To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`). - For clarity, expressions can be enclosed in parentheses. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = \"COMPLETED\"` For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all conversations in the specified project." }, "get": { "id": "dialogflow.projects.locations.conversations.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the conversation. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specific conversation." }, "complete": { "id": "dialogflow.projects.locations.conversations.complete", "path": "v2beta1/{+name}:complete", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:complete", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Resource identifier of the conversation to close. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1CompleteConversationRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Completes the specified conversation. Finished conversations are purged from the database after 30 days." } }, "resources": { "participants": { "methods": { "create": { "id": "dialogflow.projects.locations.conversations.participants.create", "path": "v2beta1/{+parent}/participants", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the conversation adding the participant. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new participant in a conversation." }, "get": { "id": "dialogflow.projects.locations.conversations.participants.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the participant. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves a conversation participant." }, "list": { "id": "dialogflow.projects.locations.conversations.participants.list", "path": "v2beta1/{+parent}/participants", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The conversation to list all participants from. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListParticipantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all participants in the specified conversation." }, "patch": { "id": "dialogflow.projects.locations.conversations.participants.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to specify which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified participant." }, "analyzeContent": { "id": "dialogflow.projects.locations.conversations.participants.analyzeContent", "path": "v2beta1/{+participant}:analyzeContent", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent", "httpMethod": "POST", "parameters": { "participant": { "description": "Required. The name of the participant this text comes from. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "participant" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "suggestions": { "methods": { "suggestArticles": { "id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestArticles", "path": "v2beta1/{+parent}/suggestions:suggestArticles", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestArticles", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time." }, "suggestFaqAnswers": { "id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestFaqAnswers", "path": "v2beta1/{+parent}/suggestions:suggestFaqAnswers", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestFaqAnswers", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets suggested faq answers for a participant based on specific historical messages." }, "suggestSmartReplies": { "id": "dialogflow.projects.locations.conversations.participants.suggestions.suggestSmartReplies", "path": "v2beta1/{+parent}/suggestions:suggestSmartReplies", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets smart replies for a participant based on specific historical messages." } } } } }, "messages": { "methods": { "batchCreate": { "id": "dialogflow.projects.locations.conversations.messages.batchCreate", "path": "v2beta1/{+parent}/messages:batchCreate", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/messages:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the conversation to create message. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation." }, "list": { "id": "dialogflow.projects.locations.conversations.messages.list", "path": "v2beta1/{+parent}/messages", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/messages", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the conversation to list messages for. Format: `projects//locations//conversations/`", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds \u003e 1551790877964485` or `create_time \u003e \"2017-01-15T01:30:15.01Z\"`. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListMessagesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Lists messages that belong to a given conversation. `messages` are ordered by `create_time` in descending order. To fetch updates without duplication, send request with filter `create_time_epoch_microseconds \u003e [first item's create_time of previous request]` and empty page_token." } } }, "suggestions": { "methods": { "suggestConversationSummary": { "id": "dialogflow.projects.locations.conversations.suggestions.suggestConversationSummary", "path": "v2beta1/{+conversation}/suggestions:suggestConversationSummary", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:suggestConversationSummary", "httpMethod": "POST", "parameters": { "conversation": { "description": "Required. The conversation to fetch suggestion for. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversation" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request." }, "searchKnowledge": { "id": "dialogflow.projects.locations.conversations.suggestions.searchKnowledge", "path": "v2beta1/{+conversation}/suggestions:searchKnowledge", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:searchKnowledge", "httpMethod": "POST", "parameters": { "conversation": { "description": "The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversation" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Get answers for the given query based on knowledge documents." } } } } }, "suggestions": { "methods": { "generateStatelessSummary": { "id": "dialogflow.projects.locations.suggestions.generateStatelessSummary", "path": "v2beta1/{+parent}/suggestions:generateStatelessSummary", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/suggestions:generateStatelessSummary", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource to charge for the Summary's generation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Generates and returns a summary for a conversation that does not have a resource created for it." }, "searchKnowledge": { "id": "dialogflow.projects.locations.suggestions.searchKnowledge", "path": "v2beta1/{+parent}/suggestions:searchKnowledge", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/suggestions:searchKnowledge", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Get answers for the given query based on knowledge documents." } } }, "knowledgeBases": { "methods": { "list": { "id": "dialogflow.projects.locations.knowledgeBases.list", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list of knowledge bases for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains \"articles\". * 'display_name:\"Best Articles\"' matches knowledge bases whose display name contains \"Best Articles\". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains \"articles\" and whose language code is \"en-gb\". Note: An empty filter string (i.e. \"\") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "get": { "id": "dialogflow.projects.locations.knowledgeBases.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "create": { "id": "dialogflow.projects.locations.knowledgeBases.create", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project to create a knowledge base for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "delete": { "id": "dialogflow.projects.locations.knowledgeBases.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "patch": { "id": "dialogflow.projects.locations.knowledgeBases.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." } }, "resources": { "documents": { "methods": { "list": { "id": "dialogflow.projects.locations.knowledgeBases.documents.list", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * \"knowledge_types:FAQ\" matches documents with FAQ knowledge type. * \"display_name:customer\" matches documents whose display name contains \"customer\". * \"state=ACTIVE\" matches documents with ACTIVE state. * \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all documents of the knowledge base. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "get": { "id": "dialogflow.projects.locations.knowledgeBases.documents.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "create": { "id": "dialogflow.projects.locations.knowledgeBases.documents.create", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "importGcsCustomMetadata": { "description": "Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "import": { "id": "dialogflow.projects.locations.knowledgeBases.documents.import", "path": "v2beta1/{+parent}/documents:import", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The knowledge base to import documents into. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ImportDocumentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: ImportDocumentsResponse" }, "delete": { "id": "dialogflow.projects.locations.knowledgeBases.documents.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "patch": { "id": "dialogflow.projects.locations.knowledgeBases.documents.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "reload": { "id": "dialogflow.projects.locations.knowledgeBases.documents.reload", "path": "v2beta1/{+name}:reload", "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}:reload", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`", "pattern": "^projects/[^/]+/locations/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." } } } } } } }, "answerRecords": { "methods": { "get": { "id": "dialogflow.projects.answerRecords.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/answerRecords/{answerRecordsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the answer record to retrieve. Format: `projects//locations//answerRecords/`.", "pattern": "^projects/[^/]+/answerRecords/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "deprecated": true, "description": "Deprecated. Retrieves a specific answer record." }, "list": { "id": "dialogflow.projects.answerRecords.list", "path": "v2beta1/{+parent}/answerRecords", "flatPath": "v2beta1/projects/{projectsId}/answerRecords", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "deprecated": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all answer records in the specified project in reverse chronological order." }, "patch": { "id": "dialogflow.projects.answerRecords.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/answerRecords/{answerRecordsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of this answer record. Required for AnswerRecords.UpdateAnswerRecord method. Format: `projects//locations//answerRecords/`.", "pattern": "^projects/[^/]+/answerRecords/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields get updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1AnswerRecord" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified answer record." } } }, "conversationProfiles": { "methods": { "list": { "id": "dialogflow.projects.conversationProfiles.list", "path": "v2beta1/{+parent}/conversationProfiles", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list all conversation profiles from. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListConversationProfilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all conversation profiles in the specified project." }, "get": { "id": "dialogflow.projects.conversationProfiles.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the conversation profile. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified conversation profile." }, "create": { "id": "dialogflow.projects.conversationProfiles.create", "path": "v2beta1/{+parent}/conversationProfiles", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project to create a conversation profile for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a conversation profile in the specified project. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API." }, "patch": { "id": "dialogflow.projects.conversationProfiles.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The unique identifier of this conversation profile. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to control which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1ConversationProfile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API." }, "delete": { "id": "dialogflow.projects.conversationProfiles.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the conversation profile to delete. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified conversation profile." }, "setSuggestionFeatureConfig": { "id": "dialogflow.projects.conversationProfiles.setSuggestionFeatureConfig", "path": "v2beta1/{+conversationProfile}:setSuggestionFeatureConfig", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:setSuggestionFeatureConfig", "httpMethod": "POST", "parameters": { "conversationProfile": { "description": "Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversationProfile" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: SetSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected." }, "clearSuggestionFeatureConfig": { "id": "dialogflow.projects.conversationProfiles.clearSuggestionFeatureConfig", "path": "v2beta1/{+conversationProfile}:clearSuggestionFeatureConfig", "flatPath": "v2beta1/projects/{projectsId}/conversationProfiles/{conversationProfilesId}:clearSuggestionFeatureConfig", "httpMethod": "POST", "parameters": { "conversationProfile": { "description": "Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects//locations//conversationProfiles/`.", "pattern": "^projects/[^/]+/conversationProfiles/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversationProfile" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Clears a suggestion feature from a conversation profile for the given participant role. This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields: - `metadata`: ClearSuggestionFeatureConfigOperationMetadata - `response`: ConversationProfile" } } }, "conversations": { "methods": { "create": { "id": "dialogflow.projects.conversations.create", "path": "v2beta1/{+parent}/conversations", "flatPath": "v2beta1/projects/{projectsId}/conversations", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the project creating the conversation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "conversationId": { "description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage." }, "list": { "id": "dialogflow.projects.conversations.list", "path": "v2beta1/{+parent}/conversations", "flatPath": "v2beta1/projects/{projectsId}/conversations", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project from which to list all conversation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either `=`,`!=`, `\u003e`, or `\u003c`. - To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`). - For clarity, expressions can be enclosed in parentheses. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = \"COMPLETED\"` For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListConversationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all conversations in the specified project." }, "get": { "id": "dialogflow.projects.conversations.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the conversation. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specific conversation." }, "complete": { "id": "dialogflow.projects.conversations.complete", "path": "v2beta1/{+name}:complete", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}:complete", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Resource identifier of the conversation to close. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1CompleteConversationRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Conversation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Completes the specified conversation. Finished conversations are purged from the database after 30 days." } }, "resources": { "participants": { "methods": { "create": { "id": "dialogflow.projects.conversations.participants.create", "path": "v2beta1/{+parent}/participants", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the conversation adding the participant. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new participant in a conversation." }, "get": { "id": "dialogflow.projects.conversations.participants.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the participant. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves a conversation participant." }, "list": { "id": "dialogflow.projects.conversations.participants.list", "path": "v2beta1/{+parent}/participants", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The conversation to list all participants from. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListParticipantsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all participants in the specified conversation." }, "patch": { "id": "dialogflow.projects.conversations.participants.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The unique identifier of this participant. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The mask to specify which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1Participant" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified participant." }, "analyzeContent": { "id": "dialogflow.projects.conversations.participants.analyzeContent", "path": "v2beta1/{+participant}:analyzeContent", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}:analyzeContent", "httpMethod": "POST", "parameters": { "participant": { "description": "Required. The name of the participant this text comes from. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "participant" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1AnalyzeContentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions)." } }, "resources": { "suggestions": { "methods": { "suggestArticles": { "id": "dialogflow.projects.conversations.participants.suggestions.suggestArticles", "path": "v2beta1/{+parent}/suggestions:suggestArticles", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestArticles", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time." }, "suggestFaqAnswers": { "id": "dialogflow.projects.conversations.participants.suggestions.suggestFaqAnswers", "path": "v2beta1/{+parent}/suggestions:suggestFaqAnswers", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestFaqAnswers", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets suggested faq answers for a participant based on specific historical messages." }, "suggestSmartReplies": { "id": "dialogflow.projects.conversations.participants.suggestions.suggestSmartReplies", "path": "v2beta1/{+parent}/suggestions:suggestSmartReplies", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:suggestSmartReplies", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Gets smart replies for a participant based on specific historical messages." }, "list": { "id": "dialogflow.projects.conversations.participants.suggestions.list", "path": "v2beta1/{+parent}/suggestions", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestions for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. The default value is 100; the maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter on suggestions fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds \u003e 1551790877964485` or `create_time \u003e \"2017-01-15T01:30:15.01Z\"` For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListSuggestionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "deprecated": true, "description": "Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the `next_page_token` field to fetch the next batch of suggestions. `suggestions` are sorted by `create_time` in descending order. To fetch latest suggestion, just set `page_size` to 1. To fetch new suggestions without duplication, send request with filter `create_time_epoch_microseconds \u003e [first item's create_time of previous request]` and empty page_token." }, "compile": { "id": "dialogflow.projects.conversations.participants.suggestions.compile", "path": "v2beta1/{+parent}/suggestions:compile", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/participants/{participantsId}/suggestions:compile", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the participant to fetch suggestion for. Format: `projects//locations//conversations//participants/`.", "pattern": "^projects/[^/]+/conversations/[^/]+/participants/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1CompileSuggestionRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1CompileSuggestionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "deprecated": true, "description": "Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time." } } } } }, "messages": { "methods": { "batchCreate": { "id": "dialogflow.projects.conversations.messages.batchCreate", "path": "v2beta1/{+parent}/messages:batchCreate", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/messages:batchCreate", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. Resource identifier of the conversation to create message. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation." }, "list": { "id": "dialogflow.projects.conversations.messages.list", "path": "v2beta1/{+parent}/messages", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/messages", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the conversation to list messages for. Format: `projects//locations//conversations/`", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. Filter on message fields. Currently predicates on `create_time` and `create_time_epoch_microseconds` are supported. `create_time` only support milliseconds accuracy. E.g., `create_time_epoch_microseconds \u003e 1551790877964485` or `create_time \u003e \"2017-01-15T01:30:15.01Z\"`. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListMessagesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Lists messages that belong to a given conversation. `messages` are ordered by `create_time` in descending order. To fetch updates without duplication, send request with filter `create_time_epoch_microseconds \u003e [first item's create_time of previous request]` and empty page_token." } } }, "suggestions": { "methods": { "suggestConversationSummary": { "id": "dialogflow.projects.conversations.suggestions.suggestConversationSummary", "path": "v2beta1/{+conversation}/suggestions:suggestConversationSummary", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:suggestConversationSummary", "httpMethod": "POST", "parameters": { "conversation": { "description": "Required. The conversation to fetch suggestion for. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversation" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Suggest summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request." }, "searchKnowledge": { "id": "dialogflow.projects.conversations.suggestions.searchKnowledge", "path": "v2beta1/{+conversation}/suggestions:searchKnowledge", "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:searchKnowledge", "httpMethod": "POST", "parameters": { "conversation": { "description": "The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`.", "pattern": "^projects/[^/]+/conversations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "conversation" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Get answers for the given query based on knowledge documents." } } } } }, "suggestions": { "methods": { "generateStatelessSummary": { "id": "dialogflow.projects.suggestions.generateStatelessSummary", "path": "v2beta1/{+parent}/suggestions:generateStatelessSummary", "flatPath": "v2beta1/projects/{projectsId}/suggestions:generateStatelessSummary", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource to charge for the Summary's generation. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Generates and returns a summary for a conversation that does not have a resource created for it." }, "searchKnowledge": { "id": "dialogflow.projects.suggestions.searchKnowledge", "path": "v2beta1/{+parent}/suggestions:searchKnowledge", "flatPath": "v2beta1/projects/{projectsId}/suggestions:searchKnowledge", "httpMethod": "POST", "parameters": { "parent": { "description": "The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeRequest" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1SearchKnowledgeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Get answers for the given query based on knowledge documents." } } }, "knowledgeBases": { "methods": { "list": { "id": "dialogflow.projects.knowledgeBases.list", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The project to list of knowledge bases for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains \"articles\". * 'display_name:\"Best Articles\"' matches knowledge bases whose display name contains \"Best Articles\". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains \"articles\" and whose language code is \"en-gb\". Note: An empty filter string (i.e. \"\") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "get": { "id": "dialogflow.projects.knowledgeBases.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the knowledge base to retrieve. Format `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "create": { "id": "dialogflow.projects.knowledgeBases.create", "path": "v2beta1/{+parent}/knowledgeBases", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project to create a knowledge base for. Format: `projects//locations/`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "delete": { "id": "dialogflow.projects.knowledgeBases.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the knowledge base to delete. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "force": { "description": "Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." }, "patch": { "id": "dialogflow.projects.knowledgeBases.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "response": { "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`." } }, "resources": { "documents": { "methods": { "list": { "id": "dialogflow.projects.knowledgeBases.documents.list", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The next_page_token value returned from a previous list request.", "location": "query", "type": "string" }, "filter": { "description": "The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * \"knowledge_types:FAQ\" matches documents with FAQ knowledge type. * \"display_name:customer\" matches documents whose display name contains \"customer\". * \"state=ACTIVE\" matches documents with ACTIVE state. * \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Returns the list of all documents of the knowledge base. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "get": { "id": "dialogflow.projects.knowledgeBases.documents.get", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Retrieves the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "create": { "id": "dialogflow.projects.knowledgeBases.documents.create", "path": "v2beta1/{+parent}/documents", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" }, "importGcsCustomMetadata": { "description": "Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Creates a new document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "import": { "id": "dialogflow.projects.knowledgeBases.documents.import", "path": "v2beta1/{+parent}/documents:import", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents:import", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The knowledge base to import documents into. Format: `projects//locations//knowledgeBases/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ImportDocumentsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Create documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: ImportDocumentsResponse" }, "delete": { "id": "dialogflow.projects.knowledgeBases.documents.delete", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Deletes the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "patch": { "id": "dialogflow.projects.knowledgeBases.documents.patch", "path": "v2beta1/{+name}", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1Document" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Updates the specified document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." }, "reload": { "id": "dialogflow.projects.knowledgeBases.documents.reload", "path": "v2beta1/{+name}:reload", "flatPath": "v2beta1/projects/{projectsId}/knowledgeBases/{knowledgeBasesId}/documents/{documentsId}:reload", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`", "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dialogflow" ], "description": "Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the `import_gcs_custom_metadata` field is set to true in the request. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`." } } } } } } } }, "id": "dialogflow:v2beta1", "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "batchPath": "batch", "revision": "20240507", "version_module": true }