Returns the changelogs Resource.
Returns the entityTypes Resource.
Returns the environments Resource.
Returns the flows Resource.
Returns the generators Resource.
Returns the intents Resource.
Returns the sessions Resource.
Returns the testCases Resource.
Returns the transitionRouteGroups Resource.
Returns the webhooks Resource.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Deletes the specified agent.
export(name, body=None, x__xgafv=None)
Exports the specified agent to a binary file. 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`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse
Retrieves the specified agent.
getGenerativeSettings(name, languageCode=None, x__xgafv=None)
Gets the generative settings for the agent.
getValidationResult(name, languageCode=None, x__xgafv=None)
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all agents in the specified location.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
restore(name, body=None, x__xgafv=None)
Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. 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`: 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 flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
updateGenerativeSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates the generative settings for the agent.
validate(name, body=None, x__xgafv=None)
Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
parent: string, Required. The location to create a agent for. Format: `projects//locations/`. (required)
body: object, The request body.
The object takes the form of:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
delete(name, x__xgafv=None)
Deletes the specified agent.
Args:
name: string, Required. The name of the agent to delete. Format: `projects//locations//agents/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}
export(name, body=None, x__xgafv=None)
Exports the specified agent to a binary file. 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`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse
Args:
name: string, Required. The name of the agent to export. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.ExportAgent.
"agentUri": "A String", # 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).
"dataFormat": "A String", # Optional. The data format of the exported agent. If not specified, `BLOB` is assumed.
"environment": "A String", # Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.
"gitDestination": { # Settings for exporting to a git branch. # Optional. The Git branch to export the agent to.
"commitMessage": "A String", # Commit message for the git push.
"trackingBranch": "A String", # Tracking branch for the git push.
},
"includeBigqueryExportSettings": True or False, # Optional. Whether to include BigQuery Export setting.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Retrieves the specified agent.
Args:
name: string, Required. The name of the agent. Format: `projects//locations//agents/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
getGenerativeSettings(name, languageCode=None, x__xgafv=None)
Gets the generative settings for the agent.
Args:
name: string, Required. Format: `projects//locations//agents//generativeSettings`. (required)
languageCode: string, Required. Language code of the generative settings.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}
getValidationResult(name, languageCode=None, x__xgafv=None)
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
Args:
name: string, Required. The agent name. Format: `projects//locations//agents//validationResult`. (required)
languageCode: string, If not specified, the agent's default language is used.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.GetAgentValidationResult.
"flowValidationResults": [ # Contains all flow validation results.
{ # The response message for Flows.GetFlowValidationResult.
"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
"updateTime": "A String", # Last time the flow was validated.
"validationMessages": [ # Contains all validation messages.
{ # Agent/flow validation message.
"detail": "A String", # The message detail.
"resourceNames": [ # The resource names of the resources where the message is found.
{ # Resource name and display name.
"displayName": "A String", # Display name.
"name": "A String", # Name.
},
],
"resourceType": "A String", # The type of the resources where the message is found.
"resources": [ # The names of the resources where the message is found.
"A String",
],
"severity": "A String", # Indicates the severity of the message.
},
],
},
],
"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all agents in the specified location.
Args:
parent: string, Required. The location to list all agents for. Format: `projects//locations/`. (required)
pageSize: integer, The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.ListAgents.
"agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
name: string, The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
updateMask: string, The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, TransitionRouteGroups and so on to manage the conversation flows.
"advancedSettings": { # 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->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.
"audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
"uri": "A String", # 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.
},
"dtmfSettings": { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
"enabled": True or False, # 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).
"endpointingTimeoutDuration": "A String", # Endpoint timeout setting for matching dtmf input to regex.
"finishDigit": "A String", # The digit that terminates a DTMF digit sequence.
"interdigitTimeoutDuration": "A String", # Interdigit timeout setting for matching dtmf input to regex.
"maxDigits": 42, # Max length of DTMF digits.
},
"loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
"enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled.
"enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled.
},
"speechSettings": { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
"endpointerSensitivity": 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
"models": { # 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).
"a_key": "A String",
},
"noSpeechTimeout": "A String", # Timeout before detecting no speech.
"useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.
},
},
"answerFeedbackSettings": { # Settings for answer feedback collection. # Optional. Answer feedback collection settings.
"enableAnswerFeedback": True or False, # Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.
},
"avatarUri": "A String", # 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.
"defaultLanguageCode": "A String", # Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
"description": "A String", # The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
"displayName": "A String", # Required. The human-readable name of the agent, unique within the location.
"enableMultiLanguageTraining": True or False, # Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent.
"enableSpellCorrection": True or False, # Indicates if automatic spell correction is enabled in detect intent requests.
"enableStackdriverLogging": True or False, # Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.
"genAppBuilderSettings": { # Settings for Gen App Builder. # Gen App Builder-related agent-level settings.
"engine": "A String", # Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: `projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}`
},
"gitIntegrationSettings": { # Settings for connecting to Git repository for an agent. # Git integration settings for this agent.
"githubSettings": { # Settings of integration with GitHub. # GitHub settings.
"accessToken": "A String", # The access token used to authenticate the access to the GitHub repository.
"branches": [ # A list of branches configured to be used from Dialogflow.
"A String",
],
"displayName": "A String", # The unique repository display name for the GitHub repository.
"repositoryUri": "A String", # The GitHub repository URI related to the agent.
"trackingBranch": "A String", # The branch of the GitHub repository tracked for this agent.
},
},
"locked": True or False, # Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
"name": "A String", # The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.
"personalizationSettings": { # Settings for end user personalization. # Optional. Settings for end user personalization.
"defaultEndUserMetadata": { # Optional. Default end user metadata, used when processing DetectIntent requests. Recommended to be filled as a template instead of hard-coded value, for example { "age": "$session.params.age" }. The data will be merged with the QueryParameters.end_user_metadata in DetectIntentRequest.query_params during query processing.
"a_key": "", # Properties of the object.
},
},
"securitySettings": "A String", # Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.
"speechToTextSettings": { # Settings related to speech recognition. # Speech recognition related settings.
"enableSpeechAdaptation": True or False, # Whether to use speech adaptation for speech recognition.
},
"startFlow": "A String", # Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.
"supportedLanguageCodes": [ # The list of all languages supported by the agent (except for the `default_language_code`).
"A String",
],
"textToSpeechSettings": { # Settings related to speech synthesizing. # Settings on instructing the speech synthesizer on how to generate the output audio content.
"synthesizeSpeechConfigs": { # Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/cx/docs/reference/language) to SynthesizeSpeechConfig. These settings affect: - The [phone gateway](https://cloud.google.com/dialogflow/cx/docs/concept/integration/phone-gateway) synthesize configuration set via Agent.text_to_speech_settings. - How speech is synthesized when invoking session APIs. Agent.text_to_speech_settings only applies if OutputAudioConfig.synthesize_speech_config is not specified.
"a_key": { # Configuration of how speech should be synthesized.
"effectsProfileId": [ # 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.
"A String",
],
"pitch": 3.14, # 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.
"speakingRate": 3.14, # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
"voice": { # Description of which voice to use for speech synthesis. # Optional. The desired voice of the synthesized audio.
"name": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).
"ssmlGender": "A String", # 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 substitutes a voice with a different gender rather than failing the request.
},
"volumeGainDb": 3.14, # 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.
},
},
},
"timeZone": "A String", # Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
}
restore(name, body=None, x__xgafv=None)
Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. 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`: 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 flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Args:
name: string, Required. The name of the agent to restore into. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.RestoreAgent.
"agentContent": "A String", # Uncompressed raw byte content for agent.
"agentUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `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).
"gitSource": { # Settings for restoring from a git branch # Setting for restoring from a git branch
"trackingBranch": "A String", # tracking branch for the git pull
},
"restoreOption": "A String", # Agent restore mode. If not specified, `KEEP` is assumed.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
updateGenerativeSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates the generative settings for the agent.
Args:
name: string, Format: `projects//locations//agents//generativeSettings`. (required)
body: object, The request body.
The object takes the form of:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}
updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Settings for Generative AI.
"fallbackSettings": { # Settings for Generative Fallback. # Settings for Generative Fallback.
"promptTemplates": [ # Stored prompts that can be selected, for example default templates like "conservative" or "chatty", or user defined ones.
{ # Prompt template.
"displayName": "A String", # Prompt name.
"frozen": True or False, # If the flag is true, the prompt is frozen and cannot be modified by users.
"promptText": "A String", # Prompt text that is sent to a LLM on no-match default, placeholders are filled downstream. For example: "Here is a conversation $conversation, a response is: "
},
],
"selectedPrompt": "A String", # Display name of the selected prompt.
},
"generativeSafetySettings": { # Settings for Generative Safety. # Settings for Generative Safety.
"bannedPhrases": [ # Banned phrases for generated text.
{ # Text input which can be used for prompt or banned phrases.
"languageCode": "A String", # Required. Language code of the phrase.
"text": "A String", # Required. Text input which can be used for prompt or banned phrases.
},
],
},
"knowledgeConnectorSettings": { # Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ". # Settings for knowledge connector.
"agent": "A String", # Name of the virtual agent. Used for LLM prompt. Can be left empty.
"agentIdentity": "A String", # Identity of the agent, e.g. "virtual agent", "AI assistant".
"agentScope": "A String", # Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
"business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
"businessDescription": "A String", # Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
"disableDataStoreFallback": True or False, # Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.
},
"languageCode": "A String", # Language for this settings.
"name": "A String", # Format: `projects//locations//agents//generativeSettings`.
}
validate(name, body=None, x__xgafv=None)
Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
Args:
name: string, Required. The agent to validate. Format: `projects//locations//agents/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Agents.ValidateAgent.
"languageCode": "A String", # If not specified, the agent's default language is used.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Agents.GetAgentValidationResult.
"flowValidationResults": [ # Contains all flow validation results.
{ # The response message for Flows.GetFlowValidationResult.
"name": "A String", # The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.
"updateTime": "A String", # Last time the flow was validated.
"validationMessages": [ # Contains all validation messages.
{ # Agent/flow validation message.
"detail": "A String", # The message detail.
"resourceNames": [ # The resource names of the resources where the message is found.
{ # Resource name and display name.
"displayName": "A String", # Display name.
"name": "A String", # Name.
},
],
"resourceType": "A String", # The type of the resources where the message is found.
"resources": [ # The names of the resources where the message is found.
"A String",
],
"severity": "A String", # Indicates the severity of the message.
},
],
},
],
"name": "A String", # The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.
}