Index
Agents
(interface)Changelogs
(interface)Deployments
(interface)EntityTypes
(interface)Environments
(interface)Experiments
(interface)Flows
(interface)Intents
(interface)Pages
(interface)SecuritySettingsService
(interface)SessionEntityTypes
(interface)Sessions
(interface)TestCases
(interface)TransitionRouteGroups
(interface)Versions
(interface)Webhooks
(interface)AdvancedSettings
(message)AdvancedSettings.LoggingSettings
(message)Agent
(message)AgentValidationResult
(message)AudioEncoding
(enum)AudioInput
(message)BatchDeleteTestCasesRequest
(message)BatchRunTestCasesMetadata
(message)BatchRunTestCasesRequest
(message)BatchRunTestCasesResponse
(message)CalculateCoverageRequest
(message)CalculateCoverageRequest.CoverageType
(enum)CalculateCoverageResponse
(message)Changelog
(message)CompareVersionsRequest
(message)CompareVersionsResponse
(message)ContinuousTestResult
(message)ContinuousTestResult.AggregatedTestResult
(enum)ConversationTurn
(message)ConversationTurn.UserInput
(message)ConversationTurn.VirtualAgentOutput
(message)CreateAgentRequest
(message)CreateDocumentOperationMetadata
(message)CreateEntityTypeRequest
(message)CreateEnvironmentRequest
(message)CreateExperimentRequest
(message)CreateFlowRequest
(message)CreateIntentRequest
(message)CreatePageRequest
(message)CreateSecuritySettingsRequest
(message)CreateSessionEntityTypeRequest
(message)CreateTestCaseRequest
(message)CreateTransitionRouteGroupRequest
(message)CreateVersionOperationMetadata
(message)CreateVersionRequest
(message)CreateWebhookRequest
(message)DeleteAgentRequest
(message)DeleteDocumentOperationMetadata
(message)DeleteEntityTypeRequest
(message)DeleteEnvironmentRequest
(message)DeleteExperimentRequest
(message)DeleteFlowRequest
(message)DeleteIntentRequest
(message)DeletePageRequest
(message)DeleteSecuritySettingsRequest
(message)DeleteSessionEntityTypeRequest
(message)DeleteTransitionRouteGroupRequest
(message)DeleteVersionRequest
(message)DeleteWebhookRequest
(message)DeployFlowMetadata
(message)DeployFlowRequest
(message)DeployFlowResponse
(message)Deployment
(message)Deployment.Result
(message)Deployment.State
(enum)DetectIntentRequest
(message)DetectIntentResponse
(message)DetectIntentResponse.ResponseType
(enum)DtmfInput
(message)EntityType
(message)EntityType.AutoExpansionMode
(enum)EntityType.Entity
(message)EntityType.ExcludedPhrase
(message)EntityType.Kind
(enum)Environment
(message)Environment.TestCasesConfig
(message)Environment.VersionConfig
(message)Environment.WebhookConfig
(message)EventHandler
(message)EventInput
(message)Experiment
(message)Experiment.Definition
(message)Experiment.Result
(message)Experiment.Result.ConfidenceInterval
(message)Experiment.Result.CountType
(enum)Experiment.Result.Metric
(message)Experiment.Result.MetricType
(enum)Experiment.Result.VersionMetrics
(message)Experiment.State
(enum)ExportAgentRequest
(message)ExportAgentRequest.DataFormat
(enum)ExportAgentResponse
(message)ExportFlowRequest
(message)ExportFlowResponse
(message)ExportTestCasesMetadata
(message)ExportTestCasesRequest
(message)ExportTestCasesRequest.DataFormat
(enum)ExportTestCasesResponse
(message)Flow
(message)FlowValidationResult
(message)Form
(message)Form.Parameter
(message)Form.Parameter.FillBehavior
(message)FulfillIntentRequest
(message)FulfillIntentResponse
(message)Fulfillment
(message)Fulfillment.ConditionalCases
(message)Fulfillment.ConditionalCases.Case
(message)Fulfillment.ConditionalCases.Case.CaseContent
(message)Fulfillment.SetParameterAction
(message)GenericKnowledgeOperationMetadata
(message)GenericKnowledgeOperationMetadata.State
(enum)GetAgentRequest
(message)GetAgentValidationResultRequest
(message)GetChangelogRequest
(message)GetDeploymentRequest
(message)GetEntityTypeRequest
(message)GetEnvironmentRequest
(message)GetExperimentRequest
(message)GetFlowRequest
(message)GetFlowValidationResultRequest
(message)GetIntentRequest
(message)GetPageRequest
(message)GetSecuritySettingsRequest
(message)GetSessionEntityTypeRequest
(message)GetTestCaseRequest
(message)GetTestCaseResultRequest
(message)GetTransitionRouteGroupRequest
(message)GetVersionRequest
(message)GetWebhookRequest
(message)ImportDocumentsOperationMetadata
(message)ImportDocumentsResponse
(message)ImportFlowRequest
(message)ImportFlowRequest.ImportOption
(enum)ImportFlowResponse
(message)ImportTestCasesMetadata
(message)ImportTestCasesRequest
(message)ImportTestCasesResponse
(message)InputAudioConfig
(message)Intent
(message)Intent.Parameter
(message)Intent.TrainingPhrase
(message)Intent.TrainingPhrase.Part
(message)IntentCoverage
(message)IntentCoverage.Intent
(message)IntentInput
(message)IntentView
(enum)ListAgentsRequest
(message)ListAgentsResponse
(message)ListChangelogsRequest
(message)ListChangelogsResponse
(message)ListContinuousTestResultsRequest
(message)ListContinuousTestResultsResponse
(message)ListDeploymentsRequest
(message)ListDeploymentsResponse
(message)ListEntityTypesRequest
(message)ListEntityTypesResponse
(message)ListEnvironmentsRequest
(message)ListEnvironmentsResponse
(message)ListExperimentsRequest
(message)ListExperimentsResponse
(message)ListFlowsRequest
(message)ListFlowsResponse
(message)ListIntentsRequest
(message)ListIntentsResponse
(message)ListPagesRequest
(message)ListPagesResponse
(message)ListSecuritySettingsRequest
(message)ListSecuritySettingsResponse
(message)ListSessionEntityTypesRequest
(message)ListSessionEntityTypesResponse
(message)ListTestCaseResultsRequest
(message)ListTestCaseResultsResponse
(message)ListTestCasesRequest
(message)ListTestCasesRequest.TestCaseView
(enum)ListTestCasesResponse
(message)ListTransitionRouteGroupsRequest
(message)ListTransitionRouteGroupsResponse
(message)ListVersionsRequest
(message)ListVersionsResponse
(message)ListWebhooksRequest
(message)ListWebhooksResponse
(message)LoadVersionRequest
(message)LookupEnvironmentHistoryRequest
(message)LookupEnvironmentHistoryResponse
(message)Match
(message)Match.MatchType
(enum)MatchIntentRequest
(message)MatchIntentResponse
(message)NluSettings
(message)NluSettings.ModelTrainingMode
(enum)NluSettings.ModelType
(enum)OutputAudioConfig
(message)OutputAudioEncoding
(enum)Page
(message)PageInfo
(message)PageInfo.FormInfo
(message)PageInfo.FormInfo.ParameterInfo
(message)PageInfo.FormInfo.ParameterInfo.ParameterState
(enum)QueryInput
(message)QueryParameters
(message)QueryResult
(message)ReloadDocumentOperationMetadata
(message)ResourceName
(message)ResponseMessage
(message)ResponseMessage.ConversationSuccess
(message)ResponseMessage.EndInteraction
(message)ResponseMessage.LiveAgentHandoff
(message)ResponseMessage.MixedAudio
(message)ResponseMessage.MixedAudio.Segment
(message)ResponseMessage.OutputAudioText
(message)ResponseMessage.PlayAudio
(message)ResponseMessage.TelephonyTransferCall
(message)ResponseMessage.Text
(message)RestoreAgentRequest
(message)RestoreAgentRequest.RestoreOption
(enum)RolloutConfig
(message)RolloutConfig.RolloutStep
(message)RolloutState
(message)RunContinuousTestMetadata
(message)RunContinuousTestRequest
(message)RunContinuousTestResponse
(message)RunTestCaseMetadata
(message)RunTestCaseRequest
(message)RunTestCaseResponse
(message)SecuritySettings
(message)SecuritySettings.AudioExportSettings
(message)SecuritySettings.AudioExportSettings.AudioFormat
(enum)SecuritySettings.InsightsExportSettings
(message)SecuritySettings.PurgeDataType
(enum)SecuritySettings.RedactionScope
(enum)SecuritySettings.RedactionStrategy
(enum)SentimentAnalysisResult
(message)SessionEntityType
(message)SessionEntityType.EntityOverrideMode
(enum)SessionInfo
(message)SpeechModelVariant
(enum)SpeechToTextSettings
(message)SpeechWordInfo
(message)SsmlVoiceGender
(enum)StartExperimentRequest
(message)StopExperimentRequest
(message)StreamingDetectIntentRequest
(message)StreamingDetectIntentResponse
(message)StreamingRecognitionResult
(message)StreamingRecognitionResult.MessageType
(enum)SynthesizeSpeechConfig
(message)TestCase
(message)TestCaseError
(message)TestCaseResult
(message)TestConfig
(message)TestError
(message)TestResult
(enum)TestRunDifference
(message)TestRunDifference.DiffType
(enum)TextInput
(message)TrainFlowRequest
(message)TransitionCoverage
(message)TransitionCoverage.Transition
(message)TransitionCoverage.TransitionNode
(message)TransitionRoute
(message)TransitionRouteGroup
(message)TransitionRouteGroupCoverage
(message)TransitionRouteGroupCoverage.Coverage
(message)TransitionRouteGroupCoverage.Coverage.Transition
(message)UpdateAgentRequest
(message)UpdateDocumentOperationMetadata
(message)UpdateEntityTypeRequest
(message)UpdateEnvironmentRequest
(message)UpdateExperimentRequest
(message)UpdateFlowRequest
(message)UpdateIntentRequest
(message)UpdatePageRequest
(message)UpdateSecuritySettingsRequest
(message)UpdateSessionEntityTypeRequest
(message)UpdateTestCaseRequest
(message)UpdateTransitionRouteGroupRequest
(message)UpdateVersionRequest
(message)UpdateWebhookRequest
(message)ValidateAgentRequest
(message)ValidateFlowRequest
(message)ValidationMessage
(message)ValidationMessage.ResourceType
(enum)ValidationMessage.Severity
(enum)VariantsHistory
(message)Version
(message)Version.State
(enum)VersionVariants
(message)VersionVariants.Variant
(message)VoiceSelectionParams
(message)Webhook
(message)Webhook.GenericWebService
(message)Webhook.ServiceDirectoryConfig
(message)WebhookRequest
(message)WebhookRequest.FulfillmentInfo
(message)WebhookRequest.IntentInfo
(message)WebhookRequest.IntentInfo.IntentParameterValue
(message)WebhookRequest.SentimentAnalysisResult
(message)WebhookResponse
(message)WebhookResponse.FulfillmentResponse
(message)WebhookResponse.FulfillmentResponse.MergeBehavior
(enum)
Agents
Service for managing Agents
.
CreateAgent |
---|
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.
|
DeleteAgent |
---|
Deletes the specified agent.
|
ExportAgent |
---|
Exports the specified agent to a binary file. This method is a long-running operation. The returned
|
GetAgent |
---|
Retrieves the specified agent.
|
GetAgentValidationResult |
---|
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
|
ListAgents |
---|
Returns the list of all agents in the specified location.
|
RestoreAgent |
---|
Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a long-running operation. The returned
Note: You should always train flows prior to sending them queries. See the training documentation.
|
UpdateAgent |
---|
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.
|
ValidateAgent |
---|
Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.
|
Changelogs
Service for managing Changelogs
.
GetChangelog |
---|
Retrieves the specified Changelog.
|
ListChangelogs |
---|
Returns the list of Changelogs.
|
Deployments
Service for managing Deployments
.
GetDeployment |
---|
Retrieves the specified
|
ListDeployments |
---|
Returns the list of all deployments in the specified
|
EntityTypes
Service for managing EntityTypes
.
CreateEntityType |
---|
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
DeleteEntityType |
---|
Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
GetEntityType |
---|
Retrieves the specified entity type.
|
ListEntityTypes |
---|
Returns the list of all entity types in the specified agent.
|
UpdateEntityType |
---|
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Environments
Service for managing Environments
.
CreateEnvironment |
---|
Creates an This method is a long-running operation. The returned
|
DeleteEnvironment |
---|
Deletes the specified
|
DeployFlow |
---|
Deploys a flow to the specified This method is a long-running operation. The returned
|
GetEnvironment |
---|
Retrieves the specified
|
ListContinuousTestResults |
---|
Fetches a list of continuous test results for a given environment.
|
ListEnvironments |
---|
Returns the list of all environments in the specified
|
LookupEnvironmentHistory |
---|
Looks up the history of the specified
|
RunContinuousTest |
---|
Kicks off a continuous test under the specified This method is a long-running operation. The returned
|
UpdateEnvironment |
---|
Updates the specified This method is a long-running operation. The returned
|
Experiments
Service for managing Experiments
.
CreateExperiment |
---|
Creates an
|
DeleteExperiment |
---|
Deletes the specified
|
GetExperiment |
---|
Retrieves the specified
|
ListExperiments |
---|
Returns the list of all experiments in the specified
|
StartExperiment |
---|
Starts the specified
|
StopExperiment |
---|
Stops the specified
|
UpdateExperiment |
---|
Updates the specified
|
Flows
Service for managing Flows
.
CreateFlow |
---|
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
DeleteFlow |
---|
Deletes a specified flow.
|
ExportFlow |
---|
Exports the specified flow to a binary file. This method is a long-running operation. The returned
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
|
GetFlow |
---|
Retrieves the specified flow.
|
GetFlowValidationResult |
---|
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
|
ImportFlow |
---|
Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned
Note: You should always train a flow prior to sending it queries. See the training documentation.
|
ListFlows |
---|
Returns the list of all flows in the specified agent.
|
TrainFlow |
---|
Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned
Note: You should always train a flow prior to sending it queries. See the training documentation.
|
UpdateFlow |
---|
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
ValidateFlow |
---|
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
|
Intents
Service for managing Intents
.
CreateIntent |
---|
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
DeleteIntent |
---|
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
GetIntent |
---|
Retrieves the specified intent.
|
ListIntents |
---|
Returns the list of all intents in the specified agent.
|
UpdateIntent |
---|
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Pages
Service for managing Pages
.
CreatePage |
---|
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
DeletePage |
---|
Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
GetPage |
---|
Retrieves the specified page.
|
ListPages |
---|
Returns the list of all pages in the specified flow.
|
UpdatePage |
---|
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
|
SecuritySettingsService
Service for managing security settings for Dialogflow.
CreateSecuritySettings |
---|
Create security settings in the specified location.
|
DeleteSecuritySettings |
---|
Deletes the specified
|
GetSecuritySettings |
---|
Retrieves the specified
|
ListSecuritySettings |
---|
Returns the list of all security settings in the specified location.
|
UpdateSecuritySettings |
---|
Updates the specified
|
SessionEntityTypes
Service for managing SessionEntityTypes
.
CreateSessionEntityType |
---|
Creates a session entity type.
|
DeleteSessionEntityType |
---|
Deletes the specified session entity type.
|
GetSessionEntityType |
---|
Retrieves the specified session entity type.
|
ListSessionEntityTypes |
---|
Returns the list of all session entity types in the specified session.
|
UpdateSessionEntityType |
---|
Updates the specified session entity type.
|
Sessions
A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent
method to determine user intent and respond.
DetectIntent |
---|
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.
|
FulfillIntent |
---|
Fulfills a matched intent returned by
|
MatchIntent |
---|
Returns preliminary intent match results, doesn't change the session status.
|
StreamingDetectIntent |
---|
Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST). Note: Always use agent versions for production traffic. See Versions and environments.
|
TestCases
Service for managing Test Cases
and Test Case Results
.
BatchDeleteTestCases |
---|
Batch deletes test cases.
|
BatchRunTestCases |
---|
Kicks off a batch run of test cases. This method is a long-running operation. The returned
|
CalculateCoverage |
---|
Calculates the test coverage for an agent.
|
CreateTestCase |
---|
Creates a test case for the given agent.
|
ExportTestCases |
---|
Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned
|
GetTestCase |
---|
Gets a test case.
|
GetTestCaseResult |
---|
Gets a test case result.
|
ImportTestCases |
---|
Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned
|
ListTestCaseResults |
---|
Fetches a list of results for a given test case.
|
ListTestCases |
---|
Fetches a list of test cases for a given agent.
|
RunTestCase |
---|
Kicks off a test case run. This method is a long-running operation. The returned
|
UpdateTestCase |
---|
Updates the specified test case.
|
TransitionRouteGroups
Service for managing TransitionRouteGroups
.
CreateTransitionRouteGroup |
---|
Creates an Note: You should always train a flow prior to sending it queries. See the training documentation.
|
DeleteTransitionRouteGroup |
---|
Deletes the specified Note: You should always train a flow prior to sending it queries. See the training documentation.
|
GetTransitionRouteGroup |
---|
Retrieves the specified
|
ListTransitionRouteGroups |
---|
Returns the list of all transition route groups in the specified flow.
|
UpdateTransitionRouteGroup |
---|
Updates the specified Note: You should always train a flow prior to sending it queries. See the training documentation.
|
Versions
Service for managing Versions
.
CompareVersions |
---|
Compares the specified base version with target version.
|
CreateVersion |
---|
Creates a This method is a long-running operation. The returned
|
DeleteVersion |
---|
Deletes the specified
|
GetVersion |
---|
Retrieves the specified
|
ListVersions |
---|
Returns the list of all versions in the specified
|
LoadVersion |
---|
Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned
|
UpdateVersion |
---|
Updates the specified
|
Webhooks
Service for managing Webhooks
.
CreateWebhook |
---|
Creates a webhook in the specified agent.
|
DeleteWebhook |
---|
Deletes the specified webhook.
|
GetWebhook |
---|
Retrieves the specified webhook.
|
ListWebhooks |
---|
Returns the list of all webhooks in the specified agent.
|
UpdateWebhook |
---|
Updates the specified webhook.
|
AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged.
DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
Fields | |
---|---|
logging_settings |
Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. |
LoggingSettings
Define behaviors on logging.
Fields | |
---|---|
enable_stackdriver_logging |
If true, StackDriver logging is currently enabled. |
enable_interaction_logging |
If true, DF Interaction logging is currently enabled. |
Agent
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.
After you create an agent, you can add Intents
, Entity Types
, Flows
, Fulfillments
, Webhooks
, and so on to manage the conversation flows..
Fields | |
---|---|
name |
The unique identifier of the agent. Required for the |
display_name |
Required. The human-readable name of the agent, unique within the location. |
default_language_code |
Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the |
supported_language_codes[] |
The list of all languages supported by the agent (except for the |
time_zone |
Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris. |
description |
The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. |
avatar_uri |
The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. |
speech_to_text_settings |
Speech recognition related settings. |
start_flow |
Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: |
security_settings |
Name of the |
enable_stackdriver_logging |
Indicates if stackdriver logging is enabled for the agent. Please use |
enable_spell_correction |
Indicates if automatic spell correction is enabled in detect intent requests. |
locked |
Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][]. |
advanced_settings |
Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. |
AgentValidationResult
The response message for Agents.GetAgentValidationResult
.
Fields | |
---|---|
name |
The unique identifier of the agent validation result. Format: |
flow_validation_results[] |
Contains all flow validation results. |
AudioEncoding
Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.
Enums | |
---|---|
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. |
AudioInput
Represents the natural speech audio to be processed.
Fields | |
---|---|
config |
Required. Instructs the speech recognizer how to process the speech audio. |
audio |
The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The For non-streaming audio detect intent, both |
BatchDeleteTestCasesRequest
The request message for TestCases.BatchDeleteTestCases
.
Fields | |
---|---|
parent |
Required. The agent to delete test cases from. Format: Authorization requires the following IAM permission on the specified resource
|
names[] |
Required. Format of test case names: |
BatchRunTestCasesMetadata
Metadata returned for the TestCases.BatchRunTestCases
long running operation.
Fields | |
---|---|
errors[] |
The test errors. |
BatchRunTestCasesRequest
The request message for TestCases.BatchRunTestCases
.
Fields | |
---|---|
parent |
Required. Agent name. Format: |
environment |
Optional. If not set, draft environment is assumed. Format: |
test_cases[] |
Required. Format: |
BatchRunTestCasesResponse
The response message for TestCases.BatchRunTestCases
.
Fields | |
---|---|
results[] |
The test case results. The detailed |
CalculateCoverageRequest
The request message for TestCases.CalculateCoverage
.
Fields | |
---|---|
agent |
Required. The agent to calculate coverage for. Format: Authorization requires the following IAM permission on the specified resource
|
type |
Required. The type of coverage requested. |
CoverageType
The type of coverage score requested.
Enums | |
---|---|
COVERAGE_TYPE_UNSPECIFIED |
Should never be used. |
INTENT |
Intent coverage. |
PAGE_TRANSITION |
Page transition coverage. |
TRANSITION_ROUTE_GROUP |
Transition route group coverage. |
CalculateCoverageResponse
The response message for TestCases.CalculateCoverage
.
Fields | |
---|---|
agent |
The agent to calculate coverage for. Format: |
Union field coverage_type . The type of coverage requested. coverage_type can be only one of the following: |
|
intent_coverage |
Intent coverage. |
transition_coverage |
Transition (excluding transition route groups) coverage. |
route_group_coverage |
Transition route group coverage. |
Changelog
Changelogs represents a change made to a given agent.
Fields | |
---|---|
name |
The unique identifier of the changelog. Format: |
user_email |
Email address of the authenticated user. |
display_name |
The affected resource display name of the change. |
action |
The action of the change. |
type |
The affected resource type. |
resource |
The affected resource name of the change. |
create_time |
The timestamp of the change. |
CompareVersionsRequest
The request message for Versions.CompareVersions
.
Fields | |
---|---|
base_version |
Required. Name of the base flow version to compare with the target version. Use version ID Format: Authorization requires the following IAM permission on the specified resource
|
target_version |
Required. Name of the target flow version to compare with the base version. Use version ID Authorization requires the following IAM permission on the specified resource
|
language_code |
The language to compare the flow versions for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used. |
CompareVersionsResponse
The response message for Versions.CompareVersions
.
Fields | |
---|---|
base_version_content_json |
JSON representation of the base version content. |
target_version_content_json |
JSON representation of the target version content. |
compare_time |
The timestamp when the two version compares. |
ContinuousTestResult
Represents a result from running a test case in an agent environment.
Fields | |
---|---|
name |
The resource name for the continuous test result. Format: |
result |
The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not. |
test_case_results[] |
A list of individual test case results names in this continuous test run. |
run_time |
Time when the continuous testing run starts. |
AggregatedTestResult
The overall result for a continuous test run in an agent environment.
Enums | |
---|---|
AGGREGATED_TEST_RESULT_UNSPECIFIED |
Not specified. Should never be used. |
PASSED |
All the tests passed. |
FAILED |
At least one test did not pass. |
ConversationTurn
One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.
Fields | |
---|---|
user_input |
The user input. |
virtual_agent_output |
The virtual agent output. |
UserInput
The input from the human user.
Fields | |
---|---|
input |
Supports |
injected_parameters |
Parameters that need to be injected into the conversation during intent detection. |
is_webhook_enabled |
If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled. |
enable_sentiment_analysis |
Whether sentiment analysis is enabled. |
VirtualAgentOutput
The output from the virtual agent.
Fields | |
---|---|
session_parameters |
The session parameters available to the bot at this point. |
differences[] |
Output only. If this is part of a [result conversation turn][TestCaseResult.conversation_turns], the list of differences between the original run and the replay for this output, if any. |
diagnostic_info |