Creates a test case for the given agent.
Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist
on Google Cloud even though it will be deleted from Pulumi state.
Create TestCase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def TestCase(resource_name: str,
args: TestCaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TestCase(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
display_name: Optional[str] = None,
last_test_result: Optional[GoogleCloudDialogflowCxV3beta1TestCaseResultArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
notes: Optional[str] = None,
project: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
test_case_conversation_turns: Optional[Sequence[GoogleCloudDialogflowCxV3beta1ConversationTurnArgs]] = None,
test_config: Optional[GoogleCloudDialogflowCxV3beta1TestConfigArgs] = None)
public TestCase(String name, TestCaseArgs args)
public TestCase(String name, TestCaseArgs args, CustomResourceOptions options)
type: google-native:dialogflow/v3beta1:TestCase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_dialogflow_v3beta1_test_case" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
TestCaseArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
TestCaseArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
TestCaseArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
TestCaseArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
TestCaseArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
TestCase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TestCase resource accepts the following input properties:
- agent_id
string
- display_name
string
- The human-readable name of the test case, unique within the agent. Limit of 200 characters.
- last_test_result
object
- The latest test result.
- location
string
- name
string
- The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format:
projects//locations//agents/ /testCases/. - notes
string
- Additional freeform notes about the test case. Limit of 400 characters.
- project
string
- tags
list(string)
- Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.
- test_case_conversation_turns
list(object)
- The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.
- test_config
object
- Config for the test case.
- agentId
String
- displayName
String
- The human-readable name of the test case, unique within the agent. Limit of 200 characters.
- lastTestResult
Property Map
- The latest test result.
- location
String
- name
String
- The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format:
projects//locations//agents/ /testCases/. - notes
String
- Additional freeform notes about the test case. Limit of 400 characters.
- project
String
- tags
List<String>
- Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.
- testCaseConversationTurns
List<Property Map>
- The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.
- testConfig
Property Map
- Config for the test case.
Outputs
All input properties are implicitly available as output properties. Additionally, the TestCase resource produces the following output properties:
- CreationTime
string
- When the test was created.
- Id
string
- The provider-assigned unique ID for this managed resource.
- CreationTime
string
- When the test was created.
- Id
string
- The provider-assigned unique ID for this managed resource.
- creation_time
string
- When the test was created.
- id
string
- The provider-assigned unique ID for this managed resource.
- creationTime
String
- When the test was created.
- id
String
- The provider-assigned unique ID for this managed resource.
- creationTime
string
- When the test was created.
- id
string
- The provider-assigned unique ID for this managed resource.
- creation_time
str
- When the test was created.
- id
str
- The provider-assigned unique ID for this managed resource.
- creationTime
String
- When the test was created.
- id
String
- The provider-assigned unique ID for this managed resource.
Look up Existing TestCase Resource
Get an existing TestCase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static TestCase get(String name, Output<String> id, CustomResourceOptions options)
resources: existingTestCase: type: google-native:dialogflow/v3beta1:TestCase get: id: ${id}
import {
to = google-native_dialogflow_v3beta1_test_case.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
TestCaseState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
GoogleCloudDialogflowCxV3beta1AdvancedSettings, GoogleCloudDialogflowCxV3beta1AdvancedSettingsArgs
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.- audio_export_gcs_destination
object
- If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- dtmf_settings
object
- Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
- logging_settings
object
- Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- audioExportGcsDestination
Property Map
- If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- dtmfSettings
Property Map
- Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
- loggingSettings
Property Map
- Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings, GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettingsArgs
Define behaviors for DTMF (dual tone multi frequency).- Enabled
bool
- 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).
- FinishDigit
string
- The digit that terminates a DTMF digit sequence.
- MaxDigits
int
- Max length of DTMF digits.
- Enabled
bool
- 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).
- FinishDigit
string
- The digit that terminates a DTMF digit sequence.
- MaxDigits
int
- Max length of DTMF digits.
- enabled
bool
- 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).
- finish_digit
string
- The digit that terminates a DTMF digit sequence.
- max_digits
number
- Max length of DTMF digits.
- enabled
Boolean
- 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).
- finishDigit
String
- The digit that terminates a DTMF digit sequence.
- maxDigits
Integer
- Max length of DTMF digits.
- enabled
boolean
- 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).
- finishDigit
string
- The digit that terminates a DTMF digit sequence.
- maxDigits
number
- Max length of DTMF digits.
- enabled
bool
- 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).
- finish_digit
str
- The digit that terminates a DTMF digit sequence.
- max_digits
int
- Max length of DTMF digits.
- enabled
Boolean
- 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).
- finishDigit
String
- The digit that terminates a DTMF digit sequence.
- maxDigits
Number
- Max length of DTMF digits.
GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettingsResponse, GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettingsResponseArgs
Define behaviors for DTMF (dual tone multi frequency).- Enabled
bool
- 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).
- FinishDigit
string
- The digit that terminates a DTMF digit sequence.
- MaxDigits
int
- Max length of DTMF digits.
- Enabled
bool
- 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).
- FinishDigit
string
- The digit that terminates a DTMF digit sequence.
- MaxDigits
int
- Max length of DTMF digits.
- enabled
bool
- 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).
- finish_digit
string
- The digit that terminates a DTMF digit sequence.
- max_digits
number
- Max length of DTMF digits.
- enabled
Boolean
- 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).
- finishDigit
String
- The digit that terminates a DTMF digit sequence.
- maxDigits
Integer
- Max length of DTMF digits.
- enabled
boolean
- 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).
- finishDigit
string
- The digit that terminates a DTMF digit sequence.
- maxDigits
number
- Max length of DTMF digits.
- enabled
bool
- 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).
- finish_digit
str
- The digit that terminates a DTMF digit sequence.
- max_digits
int
- Max length of DTMF digits.
- enabled
Boolean
- 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).
- finishDigit
String
- The digit that terminates a DTMF digit sequence.
- maxDigits
Number
- Max length of DTMF digits.
GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings, GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsArgs
Define behaviors on logging.GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponse, GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettingsResponseArgs
Define behaviors on logging.GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse, GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponseArgs
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.- audio_export_gcs_destination
object
- If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- dtmf_settings
object
- Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
- logging_settings
object
- Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
- audioExportGcsDestination
Property Map
- If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
- dtmfSettings
Property Map
- Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
- loggingSettings
Property Map
- Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
Represents the natural speech audio to be processed.- Config
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1InputAudioConfig
- Instructs the speech recognizer how to process the speech audio.
- Audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- Config
GoogleCloudDialogflowCxV3beta1InputAudioConfig
- Instructs the speech recognizer how to process the speech audio.
- Audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- config
object
- Instructs the speech recognizer how to process the speech audio.
- audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- config
GoogleCloudDialogflowCxV3beta1InputAudioConfig
- Instructs the speech recognizer how to process the speech audio.
- audio
String
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- config
GoogleCloudDialogflowCxV3beta1InputAudioConfig
- Instructs the speech recognizer how to process the speech audio.
- audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- config
GoogleCloudDialogflowCxV3beta1InputAudioConfig
- Instructs the speech recognizer how to process the speech audio.
- audio
str
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
- config
Property Map
- Instructs the speech recognizer how to process the speech audio.
- audio
String
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests.
Represents the natural speech audio to be processed.- Audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - Config
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1InputAudioConfigResponse
- Instructs the speech recognizer how to process the speech audio.
- Audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - Config
GoogleCloudDialogflowCxV3beta1InputAudioConfigResponse
- Instructs the speech recognizer how to process the speech audio.
- audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - config
object
- Instructs the speech recognizer how to process the speech audio.
- audio
String
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - config
GoogleCloudDialogflowCxV3beta1InputAudioConfigResponse
- Instructs the speech recognizer how to process the speech audio.
- audio
string
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - config
GoogleCloudDialogflowCxV3beta1InputAudioConfigResponse
- Instructs the speech recognizer how to process the speech audio.
- audio
str
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - config
GoogleCloudDialogflowCxV3beta1InputAudioConfigResponse
- Instructs the speech recognizer how to process the speech audio.
- audio
String
- The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both
config and audio must be provided. For streaming audio detect intent, config must be provided in the first request and audio must be provided in all following requests. - config
Property Map
- Instructs the speech recognizer how to process the speech audio.
GoogleCloudDialogflowCxV3beta1BargeInConfig, GoogleCloudDialogflowCxV3beta1BargeInConfigArgs
Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length fromt the the start of the input audio. The flow goes like below: --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ No-speech event is a response with END_OF_UTTERANCE without any transcript following up.- NoBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- TotalDuration
string
- Total duration for the playback at the beginning of the input audio.
- NoBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- TotalDuration
string
- Total duration for the playback at the beginning of the input audio.
- no_barge_in_duration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- total_duration
string
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
String
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
String
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
string
- Total duration for the playback at the beginning of the input audio.
- no_barge_in_duration
str
- Duration that is not eligible for barge-in at the beginning of the input audio.
- total_duration
str
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
String
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
String
- Total duration for the playback at the beginning of the input audio.
GoogleCloudDialogflowCxV3beta1BargeInConfigResponse, GoogleCloudDialogflowCxV3beta1BargeInConfigResponseArgs
Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length fromt the the start of the input audio. The flow goes like below: --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ No-speech event is a response with END_OF_UTTERANCE without any transcript following up.- NoBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- TotalDuration
string
- Total duration for the playback at the beginning of the input audio.
- NoBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- TotalDuration
string
- Total duration for the playback at the beginning of the input audio.
- no_barge_in_duration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- total_duration
string
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
String
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
String
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
string
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
string
- Total duration for the playback at the beginning of the input audio.
- no_barge_in_duration
str
- Duration that is not eligible for barge-in at the beginning of the input audio.
- total_duration
str
- Total duration for the playback at the beginning of the input audio.
- noBargeInDuration
String
- Duration that is not eligible for barge-in at the beginning of the input audio.
- totalDuration
String
- Total duration for the playback at the beginning of the input audio.
GoogleCloudDialogflowCxV3beta1ConversationTurn, GoogleCloudDialogflowCxV3beta1ConversationTurnArgs
One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.GoogleCloudDialogflowCxV3beta1ConversationTurnResponse, GoogleCloudDialogflowCxV3beta1ConversationTurnResponseArgs
One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.The input from the human user.- enable_sentiment_analysis
bool
- Whether sentiment analysis is enabled.
- injected_parameters
map(string)
- Parameters that need to be injected into the conversation during intent detection.
- input
object
- Supports text input, event input, dtmf input in the test case.
- is_webhook_enabled
bool
- If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.
- enableSentimentAnalysis
Boolean
- Whether sentiment analysis is enabled.
- injectedParameters
Map<String>
- Parameters that need to be injected into the conversation during intent detection.
- input
Property Map
- Supports text input, event input, dtmf input in the test case.
- isWebhookEnabled
Boolean
- If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.
The input from the human user.- enable_sentiment_analysis
bool
- Whether sentiment analysis is enabled.
- injected_parameters
map(string)
- Parameters that need to be injected into the conversation during intent detection.
- input
object
- Supports text input, event input, dtmf input in the test case.
- is_webhook_enabled
bool
- If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.
- enableSentimentAnalysis
Boolean
- Whether sentiment analysis is enabled.
- injectedParameters
Map<String>
- Parameters that need to be injected into the conversation during intent detection.
- input
Property Map
- Supports text input, event input, dtmf input in the test case.
- isWebhookEnabled
Boolean
- If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.
GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput, GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutputArgs
The output from the virtual agent.- diagnostic_info
map(string)
- Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.
- current_page
object
- The Page on which the utterance was spoken. Only name and displayName will be set.
- session_parameters
map(string)
- The session parameters available to the bot at this point.
- status
object
- Response error from the agent in the test result. If set, other output is empty.
- text_responses
list(object)
- The text responses from the agent for the turn.
- triggered_intent
object
- The Intent that triggered the response. Only name and displayName will be set.
GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutputResponse, GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutputResponseArgs
The output from the virtual agent.- current_page
object
- The Page on which the utterance was spoken. Only name and displayName will be set.
- diagnostic_info
map(string)
- Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.
- differences
list(object)
- If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.
- session_parameters
map(string)
- The session parameters available to the bot at this point.
- status
object
- Response error from the agent in the test result. If set, other output is empty.
- text_responses
list(object)
- The text responses from the agent for the turn.
- triggered_intent
object
- The Intent that triggered the response. Only name and displayName will be set.
GoogleCloudDialogflowCxV3beta1DataStoreConnection, GoogleCloudDialogflowCxV3beta1DataStoreConnectionArgs
A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreType, GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreTypeArgs
The type of the connected data store.| Name | Value | Description |
|---|
| DataStoreTypeUnspecified | DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| PublicWeb | PUBLIC_WEB | A data store that contains public web content. |
| Unstructured | UNSTRUCTURED | A data store that contains unstructured private data. |
| Structured | STRUCTURED | A data store that contains structured data (for example FAQ). |
| Name | Value | Description |
|---|
| GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreTypeDataStoreTypeUnspecified | DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreTypePublicWeb | PUBLIC_WEB | A data store that contains public web content. |
| GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreTypeUnstructured | UNSTRUCTURED | A data store that contains unstructured private data. |
| GoogleCloudDialogflowCxV3beta1DataStoreConnectionDataStoreTypeStructured | STRUCTURED | A data store that contains structured data (for example FAQ). |
| Value | Description |
|---|
DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
PUBLIC_WEB | A data store that contains public web content. |
UNSTRUCTURED | A data store that contains unstructured private data. |
STRUCTURED | A data store that contains structured data (for example FAQ). |
| Name | Value | Description |
|---|
| DataStoreTypeUnspecified | DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| PublicWeb | PUBLIC_WEB | A data store that contains public web content. |
| Unstructured | UNSTRUCTURED | A data store that contains unstructured private data. |
| Structured | STRUCTURED | A data store that contains structured data (for example FAQ). |
| Name | Value | Description |
|---|
| DataStoreTypeUnspecified | DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| PublicWeb | PUBLIC_WEB | A data store that contains public web content. |
| Unstructured | UNSTRUCTURED | A data store that contains unstructured private data. |
| Structured | STRUCTURED | A data store that contains structured data (for example FAQ). |
| Name | Value | Description |
|---|
| DATA_STORE_TYPE_UNSPECIFIED | DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| PUBLIC_WEB | PUBLIC_WEB | A data store that contains public web content. |
| UNSTRUCTURED | UNSTRUCTURED | A data store that contains unstructured private data. |
| STRUCTURED | STRUCTURED | A data store that contains structured data (for example FAQ). |
| Value | Description |
|---|
DATA_STORE_TYPE_UNSPECIFIED | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
PUBLIC_WEB | A data store that contains public web content. |
UNSTRUCTURED | A data store that contains unstructured private data. |
STRUCTURED | A data store that contains structured data (for example FAQ). |
GoogleCloudDialogflowCxV3beta1DataStoreConnectionResponse, GoogleCloudDialogflowCxV3beta1DataStoreConnectionResponseArgs
A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.- DataStore
string
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - DataStoreType
string
- The type of the connected data store.
- DataStore
string
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - DataStoreType
string
- The type of the connected data store.
- data_store
string
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - data_store_type
string
- The type of the connected data store.
- dataStore
String
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - dataStoreType
String
- The type of the connected data store.
- dataStore
string
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - dataStoreType
string
- The type of the connected data store.
- data_store
str
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - data_store_type
str
- The type of the connected data store.
- dataStore
String
- The full name of the referenced data store. Formats:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} projects/{project}/locations/{location}/dataStores/{data_store} - dataStoreType
String
- The type of the connected data store.
Represents the input for dtmf event.Represents the input for dtmf event.GoogleCloudDialogflowCxV3beta1EventHandler, GoogleCloudDialogflowCxV3beta1EventHandlerArgs
An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a trigger_fulfillment associated with the event, it will be called. * If there is a target_page associated with the event, the session will transition into the specified page. * If there is a target_flow associated with the event, the session will transition into the specified flow.- Event
string
- The name of the event to handle.
- TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
string
- The name of the event to handle.
- target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
String
- The name of the event to handle.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
string
- The name of the event to handle.
- targetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
str
- The name of the event to handle.
- target_flow
str
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
str
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
String
- The name of the event to handle.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
GoogleCloudDialogflowCxV3beta1EventHandlerResponse, GoogleCloudDialogflowCxV3beta1EventHandlerResponseArgs
An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a trigger_fulfillment associated with the event, it will be called. * If there is a target_page associated with the event, the session will transition into the specified page. * If there is a target_flow associated with the event, the session will transition into the specified flow.- Event
string
- The name of the event to handle.
- Name
string
- The unique identifier of this event handler.
- TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
string
- The name of the event to handle.
- name
string
- The unique identifier of this event handler.
- target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
String
- The name of the event to handle.
- name
String
- The unique identifier of this event handler.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
string
- The name of the event to handle.
- name
string
- The unique identifier of this event handler.
- targetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
str
- The name of the event to handle.
- name
str
- The unique identifier of this event handler.
- target_flow
str
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
str
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
- event
String
- The name of the event to handle.
- name
String
- The unique identifier of this event handler.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.
Represents the event to trigger.- Event
string
- Name of the event.
- Event
string
- Name of the event.
- event
string
- Name of the event.
- event
String
- Name of the event.
- event
string
- Name of the event.
- event
str
- Name of the event.
- event
String
- Name of the event.
Represents the event to trigger.- Event
string
- Name of the event.
- Event
string
- Name of the event.
- event
string
- Name of the event.
- event
String
- Name of the event.
- event
string
- Name of the event.
- event
str
- Name of the event.
- event
String
- Name of the event.
A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.Represents a form parameter.- DisplayName
string
- The human-readable name of the parameter, unique within the form.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - FillBehavior
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
- Defines fill behavior for the parameter.
- AdvancedSettings
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- DefaultValue
object
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- Required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- DisplayName
string
- The human-readable name of the parameter, unique within the form.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - FillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
- Defines fill behavior for the parameter.
- AdvancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- DefaultValue
interface{}
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- Required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- display_name
string
- The human-readable name of the parameter, unique within the form.
- entity_type
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fill_behavior
object
- Defines fill behavior for the parameter.
- advanced_settings
object
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- default_value
any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- displayName
String
- The human-readable name of the parameter, unique within the form.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
- Defines fill behavior for the parameter.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
Object
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
Boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- displayName
string
- The human-readable name of the parameter, unique within the form.
- entityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
- Defines fill behavior for the parameter.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- isList
boolean
- Indicates whether the parameter represents a list of values.
- redact
boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- display_name
str
- The human-readable name of the parameter, unique within the form.
- entity_type
str
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fill_behavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
- Defines fill behavior for the parameter.
- advanced_settings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- default_value
Any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- displayName
String
- The human-readable name of the parameter, unique within the form.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
Property Map
- Defines fill behavior for the parameter.
- advancedSettings
Property Map
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
Any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
Boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
Configuration for how the filling of a parameter should be handled.- InitialPromptFulfillment
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- RepromptEventHandlers
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EventHandler>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- InitialPromptFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- RepromptEventHandlers
[]GoogleCloudDialogflowCxV3beta1EventHandler
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initial_prompt_fulfillment
object
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- reprompt_event_handlers
list(object)
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
List<GoogleCloudDialogflowCxV3beta1EventHandler>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
GoogleCloudDialogflowCxV3beta1EventHandler[]
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initial_prompt_fulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- reprompt_event_handlers
Sequence[GoogleCloudDialogflowCxV3beta1EventHandler]
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
Property Map
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
List<Property Map>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
Configuration for how the filling of a parameter should be handled.- InitialPromptFulfillment
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- RepromptEventHandlers
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EventHandlerResponse>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- InitialPromptFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- RepromptEventHandlers
[]GoogleCloudDialogflowCxV3beta1EventHandlerResponse
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initial_prompt_fulfillment
object
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- reprompt_event_handlers
list(object)
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
List<GoogleCloudDialogflowCxV3beta1EventHandlerResponse>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
GoogleCloudDialogflowCxV3beta1EventHandlerResponse[]
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initial_prompt_fulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- reprompt_event_handlers
Sequence[GoogleCloudDialogflowCxV3beta1EventHandlerResponse]
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
- initialPromptFulfillment
Property Map
- The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.
- repromptEventHandlers
List<Property Map>
- The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: *
sys.no-match-, where N can be from 1 to 6 * sys.no-match-default * sys.no-input-, where N can be from 1 to 6 * sys.no-input-default * sys.invalid-parameter initial_prompt_fulfillment provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on. A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.
Represents a form parameter.- AdvancedSettings
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- DefaultValue
object
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- DisplayName
string
- The human-readable name of the parameter, unique within the form.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - FillBehavior
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse
- Defines fill behavior for the parameter.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- Required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- AdvancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- DefaultValue
interface{}
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- DisplayName
string
- The human-readable name of the parameter, unique within the form.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - FillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse
- Defines fill behavior for the parameter.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- Required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- advanced_settings
object
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- default_value
any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- display_name
string
- The human-readable name of the parameter, unique within the form.
- entity_type
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fill_behavior
object
- Defines fill behavior for the parameter.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
Object
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- displayName
String
- The human-readable name of the parameter, unique within the form.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse
- Defines fill behavior for the parameter.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
Boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- displayName
string
- The human-readable name of the parameter, unique within the form.
- entityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse
- Defines fill behavior for the parameter.
- isList
boolean
- Indicates whether the parameter represents a list of values.
- redact
boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- advanced_settings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- default_value
Any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- display_name
str
- The human-readable name of the parameter, unique within the form.
- entity_type
str
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fill_behavior
GoogleCloudDialogflowCxV3beta1FormParameterFillBehaviorResponse
- Defines fill behavior for the parameter.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
bool
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
- advancedSettings
Property Map
- Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
- defaultValue
Any
- The default value of an optional parameter. If the parameter is required, the default value will be ignored.
- displayName
String
- The human-readable name of the parameter, unique within the form.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - fillBehavior
Property Map
- Defines fill behavior for the parameter.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- required
Boolean
- Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.GoogleCloudDialogflowCxV3beta1Fulfillment, GoogleCloudDialogflowCxV3beta1FulfillmentArgs
A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.- AdvancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- ConditionalCases
[]GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases
- Conditional cases for this fulfillment.
- EnableGenerativeFallback
bool
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- Messages
[]GoogleCloudDialogflowCxV3beta1ResponseMessage
- The list of rich message responses to present to the user.
- ReturnPartialResponses
bool
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- SetParameterActions
[]GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction
- Set parameter values before executing the webhook.
- Tag
string
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - Webhook
string
- The webhook to call. Format:
projects//locations//agents//webhooks/.
- advanced_settings
object
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditional_cases
list(object)
- Conditional cases for this fulfillment.
- enable_generative_fallback
bool
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
list(object)
- The list of rich message responses to present to the user.
- return_partial_responses
bool
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- set_parameter_actions
list(object)
- Set parameter values before executing the webhook.
- tag
string
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
string
- The webhook to call. Format:
projects//locations//agents//webhooks/.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditionalCases
List<GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases>
- Conditional cases for this fulfillment.
- enableGenerativeFallback
Boolean
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
List<GoogleCloudDialogflowCxV3beta1ResponseMessage>
- The list of rich message responses to present to the user.
- returnPartialResponses
Boolean
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- setParameterActions
List<GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction>
- Set parameter values before executing the webhook.
- tag
String
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
String
- The webhook to call. Format:
projects//locations//agents//webhooks/.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditionalCases
GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases[]
- Conditional cases for this fulfillment.
- enableGenerativeFallback
boolean
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
GoogleCloudDialogflowCxV3beta1ResponseMessage[]
- The list of rich message responses to present to the user.
- returnPartialResponses
boolean
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- setParameterActions
GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction[]
- Set parameter values before executing the webhook.
- tag
string
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
string
- The webhook to call. Format:
projects//locations//agents//webhooks/.
- advancedSettings
Property Map
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditionalCases
List<Property Map>
- Conditional cases for this fulfillment.
- enableGenerativeFallback
Boolean
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
List<Property Map>
- The list of rich message responses to present to the user.
- returnPartialResponses
Boolean
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- setParameterActions
List<Property Map>
- Set parameter values before executing the webhook.
- tag
String
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
String
- The webhook to call. Format:
projects//locations//agents//webhooks/.
GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesArgs
A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseArgs
Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentArgs
The list of messages or conditional cases to activate for this case.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponse, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContentResponseArgs
The list of messages or conditional cases to activate for this case.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseResponse, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseResponseArgs
Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponse, GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesResponseArgs
A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.GoogleCloudDialogflowCxV3beta1FulfillmentResponse, GoogleCloudDialogflowCxV3beta1FulfillmentResponseArgs
A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.- advanced_settings
object
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditional_cases
list(object)
- Conditional cases for this fulfillment.
- enable_generative_fallback
bool
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
list(object)
- The list of rich message responses to present to the user.
- return_partial_responses
bool
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- set_parameter_actions
list(object)
- Set parameter values before executing the webhook.
- tag
string
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
string
- The webhook to call. Format:
projects//locations//agents//webhooks/.
- advancedSettings
Property Map
- Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
- conditionalCases
List<Property Map>
- Conditional cases for this fulfillment.
- enableGenerativeFallback
Boolean
- If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
- messages
List<Property Map>
- The list of rich message responses to present to the user.
- returnPartialResponses
Boolean
- Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
- setParameterActions
List<Property Map>
- Set parameter values before executing the webhook.
- tag
String
- The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if webhook is specified. - webhook
String
- The webhook to call. Format:
projects//locations//agents//webhooks/.
GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction, GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionArgs
Setting a parameter value.- Parameter
string
- Display name of the parameter.
- Value
object
- The new value of the parameter. A null value clears the parameter.
- Parameter
string
- Display name of the parameter.
- Value
interface{}
- The new value of the parameter. A null value clears the parameter.
- parameter
string
- Display name of the parameter.
- value
any
- The new value of the parameter. A null value clears the parameter.
- parameter
String
- Display name of the parameter.
- value
Object
- The new value of the parameter. A null value clears the parameter.
- parameter
string
- Display name of the parameter.
- value
any
- The new value of the parameter. A null value clears the parameter.
- parameter
str
- Display name of the parameter.
- value
Any
- The new value of the parameter. A null value clears the parameter.
- parameter
String
- Display name of the parameter.
- value
Any
- The new value of the parameter. A null value clears the parameter.
GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponse, GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterActionResponseArgs
Setting a parameter value.- Parameter
string
- Display name of the parameter.
- Value
object
- The new value of the parameter. A null value clears the parameter.
- Parameter
string
- Display name of the parameter.
- Value
interface{}
- The new value of the parameter. A null value clears the parameter.
- parameter
string
- Display name of the parameter.
- value
any
- The new value of the parameter. A null value clears the parameter.
- parameter
String
- Display name of the parameter.
- value
Object
- The new value of the parameter. A null value clears the parameter.
- parameter
string
- Display name of the parameter.
- value
any
- The new value of the parameter. A null value clears the parameter.
- parameter
str
- Display name of the parameter.
- value
Any
- The new value of the parameter. A null value clears the parameter.
- parameter
String
- Display name of the parameter.
- value
Any
- The new value of the parameter. A null value clears the parameter.
GoogleCloudDialogflowCxV3beta1GcsDestination, GoogleCloudDialogflowCxV3beta1GcsDestinationArgs
Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.- Uri
string
- 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.
- Uri
string
- 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.
- uri
string
- 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.
- uri
String
- 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.
- uri
string
- 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.
- uri
str
- 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.
- uri
String
- 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.
GoogleCloudDialogflowCxV3beta1GcsDestinationResponse, GoogleCloudDialogflowCxV3beta1GcsDestinationResponseArgs
Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow.- Uri
string
- 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.
- Uri
string
- 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.
- uri
string
- 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.
- uri
String
- 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.
- uri
string
- 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.
- uri
str
- 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.
- uri
String
- 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.
Instructs the speech recognizer on how to process the audio content.- AudioEncoding
Pulumi.GoogleNative.Dialogflow.V3Beta1.GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncoding
- Audio encoding of the audio content to process.
- BargeInConfig
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1BargeInConfig
- Configuration of barge-in behavior during the streaming of input audio.
- EnableWordInfo
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - Model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- ModelVariant
Pulumi.GoogleNative.Dialogflow.V3Beta1.GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariant
- Optional. Which variant of the Speech model to use.
- PhraseHints
List<string>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- SampleRateHertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- SingleUtterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- AudioEncoding
GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncoding
- Audio encoding of the audio content to process.
- BargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfig
- Configuration of barge-in behavior during the streaming of input audio.
- EnableWordInfo
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - Model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- ModelVariant
GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariant
- Optional. Which variant of the Speech model to use.
- PhraseHints
[]string
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- SampleRateHertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- SingleUtterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audio_encoding
"AUDIO_ENCODING_UNSPECIFIED" | "AUDIO_ENCODING_LINEAR_16" | "AUDIO_ENCODING_FLAC" | "AUDIO_ENCODING_MULAW" | "AUDIO_ENCODING_AMR" | "AUDIO_ENCODING_AMR_WB" | "AUDIO_ENCODING_OGG_OPUS" | "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
- Audio encoding of the audio content to process.
- barge_in_config
object
- Configuration of barge-in behavior during the streaming of input audio.
- enable_word_info
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- model_variant
"SPEECH_MODEL_VARIANT_UNSPECIFIED" | "USE_BEST_AVAILABLE" | "USE_STANDARD" | "USE_ENHANCED"
- Optional. Which variant of the Speech model to use.
- phrase_hints
list(string)
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sample_rate_hertz
number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- single_utterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncoding
- Audio encoding of the audio content to process.
- bargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfig
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
Boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
String
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariant
- Optional. Which variant of the Speech model to use.
- phraseHints
List<String>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
Integer
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
Boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncoding
- Audio encoding of the audio content to process.
- bargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfig
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariant
- Optional. Which variant of the Speech model to use.
- phraseHints
string[]
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audio_encoding
GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncoding
- Audio encoding of the audio content to process.
- barge_in_config
GoogleCloudDialogflowCxV3beta1BargeInConfig
- Configuration of barge-in behavior during the streaming of input audio.
- enable_word_info
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
str
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- model_variant
GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariant
- Optional. Which variant of the Speech model to use.
- phrase_hints
Sequence[str]
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sample_rate_hertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- single_utterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
"AUDIO_ENCODING_UNSPECIFIED" | "AUDIO_ENCODING_LINEAR_16" | "AUDIO_ENCODING_FLAC" | "AUDIO_ENCODING_MULAW" | "AUDIO_ENCODING_AMR" | "AUDIO_ENCODING_AMR_WB" | "AUDIO_ENCODING_OGG_OPUS" | "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
- Audio encoding of the audio content to process.
- bargeInConfig
Property Map
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
Boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
String
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
"SPEECH_MODEL_VARIANT_UNSPECIFIED" | "USE_BEST_AVAILABLE" | "USE_STANDARD" | "USE_ENHANCED"
- Optional. Which variant of the Speech model to use.
- phraseHints
List<String>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
Number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
Boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
Required. Audio encoding of the audio content to process.| Name | Value | Description |
|---|
| AudioEncodingUnspecified | AUDIO_ENCODING_UNSPECIFIED | Not specified. |
| AudioEncodingLinear16 | AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
| AudioEncodingFlac | AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
| AudioEncodingMulaw | AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| AudioEncodingAmr | AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
| AudioEncodingAmrWb | AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
| AudioEncodingOggOpus | AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
| AudioEncodingSpeexWithHeaderByte | AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Name | Value | Description |
|---|
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingUnspecified | AUDIO_ENCODING_UNSPECIFIED | Not specified. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingLinear16 | AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingFlac | AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingMulaw | AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingAmr | AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingAmrWb | AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingOggOpus | AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigAudioEncodingAudioEncodingSpeexWithHeaderByte | AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Value | Description |
|---|
AUDIO_ENCODING_UNSPECIFIED | Not specified. |
AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Name | Value | Description |
|---|
| AudioEncodingUnspecified | AUDIO_ENCODING_UNSPECIFIED | Not specified. |
| AudioEncodingLinear16 | AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
| AudioEncodingFlac | AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
| AudioEncodingMulaw | AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| AudioEncodingAmr | AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
| AudioEncodingAmrWb | AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
| AudioEncodingOggOpus | AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
| AudioEncodingSpeexWithHeaderByte | AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Name | Value | Description |
|---|
| AudioEncodingUnspecified | AUDIO_ENCODING_UNSPECIFIED | Not specified. |
| AudioEncodingLinear16 | AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
| AudioEncodingFlac | AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
| AudioEncodingMulaw | AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| AudioEncodingAmr | AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
| AudioEncodingAmrWb | AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
| AudioEncodingOggOpus | AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
| AudioEncodingSpeexWithHeaderByte | AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Name | Value | Description |
|---|
| AUDIO_ENCODING_UNSPECIFIED | AUDIO_ENCODING_UNSPECIFIED | Not specified. |
| AUDIO_ENCODING_LINEAR16 | AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
| AUDIO_ENCODING_FLAC | AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
| AUDIO_ENCODING_MULAW | AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| AUDIO_ENCODING_AMR | AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
| AUDIO_ENCODING_AMR_WB | AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
| AUDIO_ENCODING_OGG_OPUS | AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
| AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
| Value | Description |
|---|
AUDIO_ENCODING_UNSPECIFIED | Not specified. |
AUDIO_ENCODING_LINEAR_16 | Uncompressed 16-bit signed little-endian samples (Linear PCM). |
AUDIO_ENCODING_FLAC | FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported. |
AUDIO_ENCODING_MULAW | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
AUDIO_ENCODING_AMR | Adaptive Multi-Rate Narrowband codec. sample_rate_hertz must be 8000. |
AUDIO_ENCODING_AMR_WB | Adaptive Multi-Rate Wideband codec. sample_rate_hertz must be 16000. |
AUDIO_ENCODING_OGG_OPUS | Opus encoded audio frames in Ogg container (OggOpus). sample_rate_hertz must be 16000. |
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE | Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sample_rate_hertz must be 16000. |
Optional. Which variant of the Speech model to use.| Name | Value | Description |
|---|
| SpeechModelVariantUnspecified | SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
| UseBestAvailable | USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
| UseStandard | USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
| UseEnhanced | USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Name | Value | Description |
|---|
| GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariantSpeechModelVariantUnspecified | SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariantUseBestAvailable | USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariantUseStandard | USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
| GoogleCloudDialogflowCxV3beta1InputAudioConfigModelVariantUseEnhanced | USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Value | Description |
|---|
SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Name | Value | Description |
|---|
| SpeechModelVariantUnspecified | SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
| UseBestAvailable | USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
| UseStandard | USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
| UseEnhanced | USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Name | Value | Description |
|---|
| SpeechModelVariantUnspecified | SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
| UseBestAvailable | USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
| UseStandard | USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
| UseEnhanced | USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Name | Value | Description |
|---|
| SPEECH_MODEL_VARIANT_UNSPECIFIED | SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
| USE_BEST_AVAILABLE | USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
| USE_STANDARD | USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
| USE_ENHANCED | USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
| Value | Description |
|---|
SPEECH_MODEL_VARIANT_UNSPECIFIED | No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE. |
USE_BEST_AVAILABLE | Use the best available variant of the Speech model that the caller is eligible for. Please see the Dialogflow docs for how to make your project eligible for enhanced models. |
USE_STANDARD | Use standard model variant even if an enhanced model is available. See the Cloud Speech documentation for details about enhanced models. |
USE_ENHANCED | Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The Cloud Speech documentation describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the Dialogflow docs for how to make your project eligible. |
Instructs the speech recognizer on how to process the audio content.- AudioEncoding
string
- Audio encoding of the audio content to process.
- BargeInConfig
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1BargeInConfigResponse
- Configuration of barge-in behavior during the streaming of input audio.
- EnableWordInfo
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - Model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- ModelVariant
string
- Optional. Which variant of the Speech model to use.
- PhraseHints
List<string>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- SampleRateHertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- SingleUtterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- AudioEncoding
string
- Audio encoding of the audio content to process.
- BargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfigResponse
- Configuration of barge-in behavior during the streaming of input audio.
- EnableWordInfo
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - Model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- ModelVariant
string
- Optional. Which variant of the Speech model to use.
- PhraseHints
[]string
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- SampleRateHertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- SingleUtterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audio_encoding
string
- Audio encoding of the audio content to process.
- barge_in_config
object
- Configuration of barge-in behavior during the streaming of input audio.
- enable_word_info
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- model_variant
string
- Optional. Which variant of the Speech model to use.
- phrase_hints
list(string)
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sample_rate_hertz
number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- single_utterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
String
- Audio encoding of the audio content to process.
- bargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfigResponse
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
Boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
String
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
String
- Optional. Which variant of the Speech model to use.
- phraseHints
List<String>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
Integer
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
Boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
string
- Audio encoding of the audio content to process.
- bargeInConfig
GoogleCloudDialogflowCxV3beta1BargeInConfigResponse
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
string
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
string
- Optional. Which variant of the Speech model to use.
- phraseHints
string[]
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audio_encoding
str
- Audio encoding of the audio content to process.
- barge_in_config
GoogleCloudDialogflowCxV3beta1BargeInConfigResponse
- Configuration of barge-in behavior during the streaming of input audio.
- enable_word_info
bool
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
str
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- model_variant
str
- Optional. Which variant of the Speech model to use.
- phrase_hints
Sequence[str]
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sample_rate_hertz
int
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- single_utterance
bool
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
- audioEncoding
String
- Audio encoding of the audio content to process.
- bargeInConfig
Property Map
- Configuration of barge-in behavior during the streaming of input audio.
- enableWordInfo
Boolean
- Optional. If
true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - model
String
- Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search (best for very short utterances and commands)
- modelVariant
String
- Optional. Which variant of the Speech model to use.
- phraseHints
List<String>
- Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See the Cloud Speech documentation for more details.
- sampleRateHertz
Number
- Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
- singleUtterance
Boolean
- Optional. If
false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.
GoogleCloudDialogflowCxV3beta1Intent, GoogleCloudDialogflowCxV3beta1IntentArgs
An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.- DisplayName
string
- The human-readable name of the intent, unique within the agent.
- Description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- IsFallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- Labels
Dictionary<string, string>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- Name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - Parameters
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentParameter>
- The collection of parameters associated with the intent.
- Priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - TrainingPhrases
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase>
- The collection of training phrases the agent is trained on to identify the intent.
- DisplayName
string
- The human-readable name of the intent, unique within the agent.
- Description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- IsFallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- Labels
map[string]string
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- Name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - Parameters
[]GoogleCloudDialogflowCxV3beta1IntentParameter
- The collection of parameters associated with the intent.
- Priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - TrainingPhrases
[]GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase
- The collection of training phrases the agent is trained on to identify the intent.
- display_name
string
- The human-readable name of the intent, unique within the agent.
- description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- is_fallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
map(string)
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
list(object)
- The collection of parameters associated with the intent.
- priority
number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - training_phrases
list(object)
- The collection of training phrases the agent is trained on to identify the intent.
- displayName
String
- The human-readable name of the intent, unique within the agent.
- description
String
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- isFallback
Boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Map<String,String>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
String
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
List<GoogleCloudDialogflowCxV3beta1IntentParameter>
- The collection of parameters associated with the intent.
- priority
Integer
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
List<GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase>
- The collection of training phrases the agent is trained on to identify the intent.
- displayName
string
- The human-readable name of the intent, unique within the agent.
- description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- isFallback
boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
{[key: string]: string}
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
GoogleCloudDialogflowCxV3beta1IntentParameter[]
- The collection of parameters associated with the intent.
- priority
number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase[]
- The collection of training phrases the agent is trained on to identify the intent.
- display_name
str
- The human-readable name of the intent, unique within the agent.
- description
str
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- is_fallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Mapping[str, str]
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
str
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
Sequence[GoogleCloudDialogflowCxV3beta1IntentParameter]
- The collection of parameters associated with the intent.
- priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - training_phrases
Sequence[GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase]
- The collection of training phrases the agent is trained on to identify the intent.
- displayName
String
- The human-readable name of the intent, unique within the agent.
- description
String
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- isFallback
Boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Map<String>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
String
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
List<Property Map>
- The collection of parameters associated with the intent.
- priority
Number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
List<Property Map>
- The collection of training phrases the agent is trained on to identify the intent.
Represents the intent to trigger programmatically rather than as a result of natural language processing.- Intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- Intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
String
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
str
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
String
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
Represents the intent to trigger programmatically rather than as a result of natural language processing.- Intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- Intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
String
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
string
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
str
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
- intent
String
- The unique identifier of the intent. Format:
projects//locations//agents//intents/.
GoogleCloudDialogflowCxV3beta1IntentParameter, GoogleCloudDialogflowCxV3beta1IntentParameterArgs
Represents an intent parameter.- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - Id
string
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - Id
string
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entity_type
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - id
string
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - id
String
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - id
string
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- isList
boolean
- Indicates whether the parameter represents a list of values.
- redact
boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entity_type
str
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - id
str
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - id
String
- The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
- isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
GoogleCloudDialogflowCxV3beta1IntentParameterResponse, GoogleCloudDialogflowCxV3beta1IntentParameterResponseArgs
Represents an intent parameter.- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- EntityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - IsList
bool
- Indicates whether the parameter represents a list of values.
- Redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entity_type
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
string
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - isList
boolean
- Indicates whether the parameter represents a list of values.
- redact
boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entity_type
str
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - is_list
bool
- Indicates whether the parameter represents a list of values.
- redact
bool
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
- entityType
String
- The entity type of the parameter. Format:
projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types. - isList
Boolean
- Indicates whether the parameter represents a list of values.
- redact
Boolean
- Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
GoogleCloudDialogflowCxV3beta1IntentResponse, GoogleCloudDialogflowCxV3beta1IntentResponseArgs
An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.- Description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- DisplayName
string
- The human-readable name of the intent, unique within the agent.
- IsFallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- Labels
Dictionary<string, string>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- Name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - Parameters
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentParameterResponse>
- The collection of parameters associated with the intent.
- Priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - TrainingPhrases
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse>
- The collection of training phrases the agent is trained on to identify the intent.
- Description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- DisplayName
string
- The human-readable name of the intent, unique within the agent.
- IsFallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- Labels
map[string]string
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- Name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - Parameters
[]GoogleCloudDialogflowCxV3beta1IntentParameterResponse
- The collection of parameters associated with the intent.
- Priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - TrainingPhrases
[]GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse
- The collection of training phrases the agent is trained on to identify the intent.
- description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- display_name
string
- The human-readable name of the intent, unique within the agent.
- is_fallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
map(string)
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
list(object)
- The collection of parameters associated with the intent.
- priority
number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - training_phrases
list(object)
- The collection of training phrases the agent is trained on to identify the intent.
- description
String
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- displayName
String
- The human-readable name of the intent, unique within the agent.
- isFallback
Boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Map<String,String>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
String
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
List<GoogleCloudDialogflowCxV3beta1IntentParameterResponse>
- The collection of parameters associated with the intent.
- priority
Integer
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
List<GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse>
- The collection of training phrases the agent is trained on to identify the intent.
- description
string
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- displayName
string
- The human-readable name of the intent, unique within the agent.
- isFallback
boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
{[key: string]: string}
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
string
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
GoogleCloudDialogflowCxV3beta1IntentParameterResponse[]
- The collection of parameters associated with the intent.
- priority
number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse[]
- The collection of training phrases the agent is trained on to identify the intent.
- description
str
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- display_name
str
- The human-readable name of the intent, unique within the agent.
- is_fallback
bool
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Mapping[str, str]
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
str
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
Sequence[GoogleCloudDialogflowCxV3beta1IntentParameterResponse]
- The collection of parameters associated with the intent.
- priority
int
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - training_phrases
Sequence[GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse]
- The collection of training phrases the agent is trained on to identify the intent.
- description
String
- Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.
- displayName
String
- The human-readable name of the intent, unique within the agent.
- isFallback
Boolean
- Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.
- labels
Map<String>
- The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys-contextual" means the intent is a contextual intent.
- name
String
- The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format:
projects//locations//agents//intents/. - parameters
List<Property Map>
- The collection of parameters associated with the intent.
- priority
Number
- The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the
Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. - trainingPhrases
List<Property Map>
- The collection of training phrases the agent is trained on to identify the intent.
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase, GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseArgs
Represents an example that the agent is trained on to identify the intent.- Parts
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - RepeatCount
int
- Indicates how many times this example was added to the intent.
- Parts
[]GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - RepeatCount
int
- Indicates how many times this example was added to the intent.
- parts
list(object)
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeat_count
number
- Indicates how many times this example was added to the intent.
- parts
List<GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
Integer
- Indicates how many times this example was added to the intent.
- parts
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart[]
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
number
- Indicates how many times this example was added to the intent.
- parts
Sequence[GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart]
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeat_count
int
- Indicates how many times this example was added to the intent.
- parts
List<Property Map>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
Number
- Indicates how many times this example was added to the intent.
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart, GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartArgs
Represents a part of a training phrase.- Text
string
- The text for this part.
- ParameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- Text
string
- The text for this part.
- ParameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
string
- The text for this part.
- parameter_id
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
String
- The text for this part.
- parameterId
String
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
string
- The text for this part.
- parameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
str
- The text for this part.
- parameter_id
str
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
String
- The text for this part.
- parameterId
String
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse, GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponseArgs
Represents a part of a training phrase.- ParameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- Text
string
- The text for this part.
- ParameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- Text
string
- The text for this part.
- parameter_id
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
string
- The text for this part.
- parameterId
String
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
String
- The text for this part.
- parameterId
string
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
string
- The text for this part.
- parameter_id
str
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
str
- The text for this part.
- parameterId
String
- The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.
- text
String
- The text for this part.
GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponse, GoogleCloudDialogflowCxV3beta1IntentTrainingPhraseResponseArgs
Represents an example that the agent is trained on to identify the intent.- Parts
List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - RepeatCount
int
- Indicates how many times this example was added to the intent.
- Parts
[]GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - RepeatCount
int
- Indicates how many times this example was added to the intent.
- parts
list(object)
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeat_count
number
- Indicates how many times this example was added to the intent.
- parts
List<GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
Integer
- Indicates how many times this example was added to the intent.
- parts
GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse[]
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
number
- Indicates how many times this example was added to the intent.
- parts
Sequence[GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePartResponse]
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeat_count
int
- Indicates how many times this example was added to the intent.
- parts
List<Property Map>
- The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: -
Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set. - repeatCount
Number
- Indicates how many times this example was added to the intent.
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings, GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsArgs
The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.- data_store_connections
list(object)
- Optional. List of related data store connections.
- enabled
bool
- Whether Knowledge Connector is enabled or not.
- target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter
$request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.
- dataStoreConnections
List<Property Map>
- Optional. List of related data store connections.
- enabled
Boolean
- Whether Knowledge Connector is enabled or not.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter
$request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponse, GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponseArgs
The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.- data_store_connections
list(object)
- Optional. List of related data store connections.
- enabled
bool
- Whether Knowledge Connector is enabled or not.
- target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter
$request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.
- dataStoreConnections
List<Property Map>
- Optional. List of related data store connections.
- enabled
Boolean
- Whether Knowledge Connector is enabled or not.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter
$request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.
GoogleCloudDialogflowCxV3beta1Page, GoogleCloudDialogflowCxV3beta1PageArgs
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide.- DisplayName
string
- The human-readable name of the page, unique within the flow.
- AdvancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- EntryFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the session is entering the page.
- EventHandlers
[]GoogleCloudDialogflowCxV3beta1EventHandler
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- Form
GoogleCloudDialogflowCxV3beta1Form
- The form associated with the page, used for collecting parameters relevant to the page.
- KnowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
- Optional. Knowledge connector configuration.
- Name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - TransitionRouteGroups
[]string
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - TransitionRoutes
[]GoogleCloudDialogflowCxV3beta1TransitionRoute
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- display_name
string
- The human-readable name of the page, unique within the flow.
- advanced_settings
object
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- entry_fulfillment
object
- The fulfillment to call when the session is entering the page.
- event_handlers
list(object)
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
object
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledge_connector_settings
object
- Optional. Knowledge connector configuration.
- name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transition_route_groups
list(string)
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transition_routes
list(object)
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- displayName
String
- The human-readable name of the page, unique within the flow.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- entryFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the session is entering the page.
- eventHandlers
List<GoogleCloudDialogflowCxV3beta1EventHandler>
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1Form
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
- Optional. Knowledge connector configuration.
- name
String
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
List<String>
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
List<GoogleCloudDialogflowCxV3beta1TransitionRoute>
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- displayName
string
- The human-readable name of the page, unique within the flow.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- entryFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the session is entering the page.
- eventHandlers
GoogleCloudDialogflowCxV3beta1EventHandler[]
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1Form
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
- Optional. Knowledge connector configuration.
- name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
string[]
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
GoogleCloudDialogflowCxV3beta1TransitionRoute[]
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- display_name
str
- The human-readable name of the page, unique within the flow.
- advanced_settings
GoogleCloudDialogflowCxV3beta1AdvancedSettings
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- entry_fulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the session is entering the page.
- event_handlers
Sequence[GoogleCloudDialogflowCxV3beta1EventHandler]
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1Form
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledge_connector_settings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings
- Optional. Knowledge connector configuration.
- name
str
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transition_route_groups
Sequence[str]
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transition_routes
Sequence[GoogleCloudDialogflowCxV3beta1TransitionRoute]
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- displayName
String
- The human-readable name of the page, unique within the flow.
- advancedSettings
Property Map
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- entryFulfillment
Property Map
- The fulfillment to call when the session is entering the page.
- eventHandlers
List<Property Map>
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
Property Map
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
Property Map
- Optional. Knowledge connector configuration.
- name
String
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
List<String>
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
List<Property Map>
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide.- AdvancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- DisplayName
string
- The human-readable name of the page, unique within the flow.
- EntryFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the session is entering the page.
- EventHandlers
[]GoogleCloudDialogflowCxV3beta1EventHandlerResponse
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- Form
GoogleCloudDialogflowCxV3beta1FormResponse
- The form associated with the page, used for collecting parameters relevant to the page.
- KnowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponse
- Optional. Knowledge connector configuration.
- Name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - TransitionRouteGroups
[]string
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - TransitionRoutes
[]GoogleCloudDialogflowCxV3beta1TransitionRouteResponse
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- advanced_settings
object
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- display_name
string
- The human-readable name of the page, unique within the flow.
- entry_fulfillment
object
- The fulfillment to call when the session is entering the page.
- event_handlers
list(object)
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
object
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledge_connector_settings
object
- Optional. Knowledge connector configuration.
- name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transition_route_groups
list(string)
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transition_routes
list(object)
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- displayName
String
- The human-readable name of the page, unique within the flow.
- entryFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the session is entering the page.
- eventHandlers
List<GoogleCloudDialogflowCxV3beta1EventHandlerResponse>
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1FormResponse
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponse
- Optional. Knowledge connector configuration.
- name
String
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
List<String>
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
List<GoogleCloudDialogflowCxV3beta1TransitionRouteResponse>
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- advancedSettings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- displayName
string
- The human-readable name of the page, unique within the flow.
- entryFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the session is entering the page.
- eventHandlers
GoogleCloudDialogflowCxV3beta1EventHandlerResponse[]
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1FormResponse
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponse
- Optional. Knowledge connector configuration.
- name
string
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
string[]
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
GoogleCloudDialogflowCxV3beta1TransitionRouteResponse[]
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- advanced_settings
GoogleCloudDialogflowCxV3beta1AdvancedSettingsResponse
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- display_name
str
- The human-readable name of the page, unique within the flow.
- entry_fulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the session is entering the page.
- event_handlers
Sequence[GoogleCloudDialogflowCxV3beta1EventHandlerResponse]
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
GoogleCloudDialogflowCxV3beta1FormResponse
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledge_connector_settings
GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettingsResponse
- Optional. Knowledge connector configuration.
- name
str
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transition_route_groups
Sequence[str]
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transition_routes
Sequence[GoogleCloudDialogflowCxV3beta1TransitionRouteResponse]
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
- advancedSettings
Property Map
- Hierarchical advanced settings for this page. The settings exposed at the lower level overrides the settings exposed at the higher level.
- displayName
String
- The human-readable name of the page, unique within the flow.
- entryFulfillment
Property Map
- The fulfillment to call when the session is entering the page.
- eventHandlers
List<Property Map>
- Handlers associated with the page to handle events such as webhook errors, no match or no input.
- form
Property Map
- The form associated with the page, used for collecting parameters relevant to the page.
- knowledgeConnectorSettings
Property Map
- Optional. Knowledge connector configuration.
- name
String
- The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format:
projects//locations//agents//flows//pages/. - transitionRouteGroups
List<String>
- Ordered list of
TransitionRouteGroups added to the page. Transition route groups must be unique within a page. If the page links both flow-level transition route groups and agent-level transition route groups, the flow-level ones will have higher priority and will be put before the agent-level ones. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/ for agent-level groups. - transitionRoutes
List<Property Map>
- A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.
Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value.- language_code
string
- The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- audio
object
- The natural language speech audio to be processed.
- dtmf
object
- The DTMF event to be handled.
- event
object
- The event to be triggered.
- intent
object
- The intent to be triggered.
- text
object
- The natural language text to be processed.
Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter value.- audio
object
- The natural language speech audio to be processed.
- dtmf
object
- The DTMF event to be handled.
- event
object
- The event to be triggered.
- intent
object
- The intent to be triggered.
- language_code
string
- The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- text
object
- The natural language text to be processed.
GoogleCloudDialogflowCxV3beta1ResponseMessage, GoogleCloudDialogflowCxV3beta1ResponseMessageArgs
Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.- channel
string
- The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
- conversation_success
object
- Indicates that the conversation succeeded.
- knowledge_info_card
object
- Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
- live_agent_handoff
object
- Hands off conversation to a human agent.
- output_audio_text
object
- A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
- payload
map(string)
- Returns a response containing a custom, platform-specific payload.
- play_audio
object
- Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
- telephony_transfer_call
object
- A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
- text
object
- Returns a text response.
- channel
String
- The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
- conversationSuccess
Property Map
- Indicates that the conversation succeeded.
- knowledgeInfoCard
Property Map
- Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
- liveAgentHandoff
Property Map
- Hands off conversation to a human agent.
- outputAudioText
Property Map
- A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
- payload
Map<String>
- Returns a response containing a custom, platform-specific payload.
- playAudio
Property Map
- Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
- telephonyTransferCall
Property Map
- A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
- text
Property Map
- Returns a text response.
GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessArgs
Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.- Metadata
Dictionary<string, string>
- Custom metadata. Dialogflow doesn't impose any structure on this.
- Metadata
map[string]string
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
map(string)
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Map<String,String>
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
{[key: string]: string}
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Mapping[str, str]
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Map<String>
- Custom metadata. Dialogflow doesn't impose any structure on this.
GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccessResponseArgs
Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.- Metadata
Dictionary<string, string>
- Custom metadata. Dialogflow doesn't impose any structure on this.
- Metadata
map[string]string
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
map(string)
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Map<String,String>
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
{[key: string]: string}
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Mapping[str, str]
- Custom metadata. Dialogflow doesn't impose any structure on this.
- metadata
Map<String>
- Custom metadata. Dialogflow doesn't impose any structure on this.
GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff, GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffArgs
Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.- Metadata
Dictionary<string, string>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- Metadata
map[string]string
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
map(string)
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Map<String,String>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
{[key: string]: string}
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Mapping[str, str]
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Map<String>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoffResponseArgs
Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.- Metadata
Dictionary<string, string>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- Metadata
map[string]string
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
map(string)
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Map<String,String>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
{[key: string]: string}
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Mapping[str, str]
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
- metadata
Map<String>
- Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.
GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioResponseArgs
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegmentResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegmentResponseArgs
Represents one segment of audio.- AllowPlaybackInterruption
bool
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- Audio
string
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- Uri
string
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- AllowPlaybackInterruption
bool
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- Audio
string
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- Uri
string
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- allow_playback_interruption
bool
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- audio
string
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- uri
string
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- allowPlaybackInterruption
Boolean
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- audio
String
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- uri
String
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- allowPlaybackInterruption
boolean
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- audio
string
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- uri
string
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- allow_playback_interruption
bool
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- audio
str
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- uri
str
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
- allowPlaybackInterruption
Boolean
- Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.
- audio
String
- Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.
- uri
String
- Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText, GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextArgs
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.- Ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- Text
string
- The raw text to be synthesized.
- Ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- Text
string
- The raw text to be synthesized.
- ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- text
string
- The raw text to be synthesized.
- ssml
String
- The SSML text to be synthesized. For more information, see SSML.
- text
String
- The raw text to be synthesized.
- ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- text
string
- The raw text to be synthesized.
- ssml
str
- The SSML text to be synthesized. For more information, see SSML.
- text
str
- The raw text to be synthesized.
- ssml
String
- The SSML text to be synthesized. For more information, see SSML.
- text
String
- The raw text to be synthesized.
GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioTextResponseArgs
A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- Ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- Text
string
- The raw text to be synthesized.
- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- Ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- Text
string
- The raw text to be synthesized.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- text
string
- The raw text to be synthesized.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- ssml
String
- The SSML text to be synthesized. For more information, see SSML.
- text
String
- The raw text to be synthesized.
- allowPlaybackInterruption
boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- ssml
string
- The SSML text to be synthesized. For more information, see SSML.
- text
string
- The raw text to be synthesized.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- ssml
str
- The SSML text to be synthesized. For more information, see SSML.
- text
str
- The raw text to be synthesized.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- ssml
String
- The SSML text to be synthesized. For more information, see SSML.
- text
String
- The raw text to be synthesized.
GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio, GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioArgs
Specifies an audio clip to be played by the client as part of the response.- AudioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- AudioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- audio_uri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- audioUri
String
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- audioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- audio_uri
str
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- audioUri
String
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponse, GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudioResponseArgs
Specifies an audio clip to be played by the client as part of the response.- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- AudioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- AudioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- audio_uri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- audioUri
String
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- allowPlaybackInterruption
boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- audioUri
string
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- audio_uri
str
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- audioUri
String
- URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
GoogleCloudDialogflowCxV3beta1ResponseMessageResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageResponseArgs
Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.- channel
string
- The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
- conversation_success
object
- Indicates that the conversation succeeded.
- end_interaction
object
- A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches
END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - knowledge_info_card
object
- Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
- live_agent_handoff
object
- Hands off conversation to a human agent.
- mixed_audio
object
- An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
- output_audio_text
object
- A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
- payload
map(string)
- Returns a response containing a custom, platform-specific payload.
- play_audio
object
- Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
- telephony_transfer_call
object
- A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
- text
object
- Returns a text response.
- channel
String
- The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
- conversationSuccess
Property Map
- Indicates that the conversation succeeded.
- endInteraction
Property Map
- A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches
END_SESSION page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response. - knowledgeInfoCard
Property Map
- Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
- liveAgentHandoff
Property Map
- Hands off conversation to a human agent.
- mixedAudio
Property Map
- An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
- outputAudioText
Property Map
- A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
- payload
Map<String>
- Returns a response containing a custom, platform-specific payload.
- playAudio
Property Map
- Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
- telephonyTransferCall
Property Map
- A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
- text
Property Map
- Returns a text response.
GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCall, GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallArgs
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageTelephonyTransferCallResponseArgs
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.GoogleCloudDialogflowCxV3beta1ResponseMessageText, GoogleCloudDialogflowCxV3beta1ResponseMessageTextArgs
The text response message.- Text
List<string>
- A collection of text responses.
- Text
[]string
- A collection of text responses.
- text
list(string)
- A collection of text responses.
- text
List<String>
- A collection of text responses.
- text
string[]
- A collection of text responses.
- text
Sequence[str]
- A collection of text responses.
- text
List<String>
- A collection of text responses.
GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponse, GoogleCloudDialogflowCxV3beta1ResponseMessageTextResponseArgs
The text response message.- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- Text
List<string>
- A collection of text responses.
- AllowPlaybackInterruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- Text
[]string
- A collection of text responses.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- text
list(string)
- A collection of text responses.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- text
List<String>
- A collection of text responses.
- allowPlaybackInterruption
boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- text
string[]
- A collection of text responses.
- allow_playback_interruption
bool
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- text
Sequence[str]
- A collection of text responses.
- allowPlaybackInterruption
Boolean
- Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.
- text
List<String>
- A collection of text responses.
GoogleCloudDialogflowCxV3beta1TestCaseResult, GoogleCloudDialogflowCxV3beta1TestCaseResultArgs
Represents a result from running a test case in an agent environment.GoogleCloudDialogflowCxV3beta1TestCaseResultResponse, GoogleCloudDialogflowCxV3beta1TestCaseResultResponseArgs
Represents a result from running a test case in an agent environment.- conversation_turns
list(object)
- The conversation turns uttered during the test case replay in chronological order.
- environment
string
- Environment where the test was run. If not set, it indicates the draft environment.
- name
string
- The resource name for the test case result. Format:
projects//locations//agents//testCases/ /results/. - test_result
string
- Whether the test case passed in the agent environment.
- test_time
string
- The time that the test was run.
- conversationTurns
List<Property Map>
- The conversation turns uttered during the test case replay in chronological order.
- environment
String
- Environment where the test was run. If not set, it indicates the draft environment.
- name
String
- The resource name for the test case result. Format:
projects//locations//agents//testCases/ /results/. - testResult
String
- Whether the test case passed in the agent environment.
- testTime
String
- The time that the test was run.
GoogleCloudDialogflowCxV3beta1TestCaseResultTestResult, GoogleCloudDialogflowCxV3beta1TestCaseResultTestResultArgs
Whether the test case passed in the agent environment.| Name | Value | Description |
|---|
| TestResultUnspecified | TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
| Passed | PASSED | The test passed. |
| Failed | FAILED | The test did not pass. |
| Name | Value | Description |
|---|
| GoogleCloudDialogflowCxV3beta1TestCaseResultTestResultTestResultUnspecified | TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
| GoogleCloudDialogflowCxV3beta1TestCaseResultTestResultPassed | PASSED | The test passed. |
| GoogleCloudDialogflowCxV3beta1TestCaseResultTestResultFailed | FAILED | The test did not pass. |
| Value | Description |
|---|
TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
PASSED | The test passed. |
FAILED | The test did not pass. |
| Name | Value | Description |
|---|
| TestResultUnspecified | TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
| Passed | PASSED | The test passed. |
| Failed | FAILED | The test did not pass. |
| Name | Value | Description |
|---|
| TestResultUnspecified | TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
| Passed | PASSED | The test passed. |
| Failed | FAILED | The test did not pass. |
| Name | Value | Description |
|---|
| TEST_RESULT_UNSPECIFIED | TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
| PASSED | PASSED | The test passed. |
| FAILED | FAILED | The test did not pass. |
| Value | Description |
|---|
TEST_RESULT_UNSPECIFIED | Not specified. Should never be used. |
PASSED | The test passed. |
FAILED | The test did not pass. |
GoogleCloudDialogflowCxV3beta1TestConfig, GoogleCloudDialogflowCxV3beta1TestConfigArgs
Represents configurations for a test case.- Flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - Page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - TrackingParameters
List<string>
- Session parameters to be compared when calculating differences.
- Flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - Page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - TrackingParameters
[]string
- Session parameters to be compared when calculating differences.
- flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - tracking_parameters
list(string)
- Session parameters to be compared when calculating differences.
- flow
String
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
String
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
List<String>
- Session parameters to be compared when calculating differences.
- flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
string[]
- Session parameters to be compared when calculating differences.
- flow
str
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
str
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - tracking_parameters
Sequence[str]
- Session parameters to be compared when calculating differences.
- flow
String
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
String
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
List<String>
- Session parameters to be compared when calculating differences.
GoogleCloudDialogflowCxV3beta1TestConfigResponse, GoogleCloudDialogflowCxV3beta1TestConfigResponseArgs
Represents configurations for a test case.- Flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - Page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - TrackingParameters
List<string>
- Session parameters to be compared when calculating differences.
- Flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - Page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - TrackingParameters
[]string
- Session parameters to be compared when calculating differences.
- flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - tracking_parameters
list(string)
- Session parameters to be compared when calculating differences.
- flow
String
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
String
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
List<String>
- Session parameters to be compared when calculating differences.
- flow
string
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
string
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
string[]
- Session parameters to be compared when calculating differences.
- flow
str
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
str
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - tracking_parameters
Sequence[str]
- Session parameters to be compared when calculating differences.
- flow
String
- Flow name to start the test case with. Format:
projects//locations//agents//flows/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - page
String
- The page to start the test case with. Format:
projects//locations//agents//flows//pages/. Only one of flow and page should be set to indicate the starting point of the test case. If both are set, page takes precedence over flow. If neither is set, the test case will start with start page on the default start flow. - trackingParameters
List<String>
- Session parameters to be compared when calculating differences.
GoogleCloudDialogflowCxV3beta1TestRunDifferenceResponse, GoogleCloudDialogflowCxV3beta1TestRunDifferenceResponseArgs
The description of differences between original and replayed agent output.- Description
string
- A human readable description of the diff, showing the actual output vs expected output.
- Type
string
- The type of diff.
- Description
string
- A human readable description of the diff, showing the actual output vs expected output.
- Type
string
- The type of diff.
- description
string
- A human readable description of the diff, showing the actual output vs expected output.
- type
string
- The type of diff.
- description
String
- A human readable description of the diff, showing the actual output vs expected output.
- type
String
- The type of diff.
- description
string
- A human readable description of the diff, showing the actual output vs expected output.
- type
string
- The type of diff.
- description
str
- A human readable description of the diff, showing the actual output vs expected output.
- type
str
- The type of diff.
- description
String
- A human readable description of the diff, showing the actual output vs expected output.
- type
String
- The type of diff.
GoogleCloudDialogflowCxV3beta1TextInput, GoogleCloudDialogflowCxV3beta1TextInputArgs
Represents the natural language text to be processed.- Text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- Text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
String
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
str
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
String
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
GoogleCloudDialogflowCxV3beta1TextInputResponse, GoogleCloudDialogflowCxV3beta1TextInputResponseArgs
Represents the natural language text to be processed.- Text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- Text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
String
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
string
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
str
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
- text
String
- The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.
GoogleCloudDialogflowCxV3beta1TransitionRoute, GoogleCloudDialogflowCxV3beta1TransitionRouteArgs
A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a trigger_fulfillment associated with the transition, it will be called. * If there is a target_page associated with the transition, the session will transition into the specified page. * If there is a target_flow associated with the transition, the session will transition into the specified flow.- Condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- Intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- Condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- Intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
String
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
String
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
String
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - targetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
str
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
str
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
str
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - target_flow
str
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
str
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
GoogleCloudDialogflowCxV3beta1Fulfillment
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
String
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
String
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
String
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
GoogleCloudDialogflowCxV3beta1TransitionRouteResponse, GoogleCloudDialogflowCxV3beta1TransitionRouteResponseArgs
A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a trigger_fulfillment associated with the transition, it will be called. * If there is a target_page associated with the transition, the session will transition into the specified page. * If there is a target_flow associated with the transition, the session will transition into the specified flow.- Condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- Intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Name
string
- The unique identifier of this transition route.
- TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- Condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- Intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - Name
string
- The unique identifier of this transition route.
- TargetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - TargetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - TriggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - name
string
- The unique identifier of this transition route.
- target_flow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
object
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
String
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
String
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
String
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - name
String
- The unique identifier of this transition route.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
string
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
string
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
string
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - name
string
- The unique identifier of this transition route.
- targetFlow
string
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
string
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
str
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
str
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
str
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - name
str
- The unique identifier of this transition route.
- target_flow
str
- The target flow to transition to. Format:
projects//locations//agents//flows/. - target_page
str
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - trigger_fulfillment
GoogleCloudDialogflowCxV3beta1FulfillmentResponse
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
- condition
String
- The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of
intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - description
String
- Optional. The description of the transition route. The maximum length is 500 characters.
- intent
String
- The unique identifier of an Intent. Format:
projects//locations//agents//intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. - name
String
- The unique identifier of this transition route.
- targetFlow
String
- The target flow to transition to. Format:
projects//locations//agents//flows/. - targetPage
String
- The target page to transition to. Format:
projects//locations//agents//flows//pages/. - triggerFulfillment
Property Map
- The fulfillment to call when the condition is satisfied. At least one of
trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.
GoogleRpcStatus, GoogleRpcStatusArgs
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. 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.- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<ImmutableDictionary<string, string>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
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.
- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
[]map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
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.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
list(map(string))
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
Integer
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
{[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
int
- The status code, which should be an enum value of google.rpc.Code.
- details
Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
str
- 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.
- code
Number
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
GoogleRpcStatusResponse, GoogleRpcStatusResponseArgs
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. 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.- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<ImmutableDictionary<string, string>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
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.
- Code
int
- The status code, which should be an enum value of google.rpc.Code.
- Details
[]map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
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.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
list(map(string))
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
Integer
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
number
- The status code, which should be an enum value of google.rpc.Code.
- details
{[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
- code
int
- The status code, which should be an enum value of google.rpc.Code.
- details
Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
str
- 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.
- code
Number
- The status code, which should be an enum value of google.rpc.Code.
- details
List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
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.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0