Index
Agents
(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)Agent
(message)AgentValidationResult
(message)AudioEncoding
(enum)AudioInput
(message)BatchDeleteTestCasesRequest
(message)BatchRunTestCasesMetadata
(message)BatchRunTestCasesRequest
(message)BatchRunTestCasesResponse
(message)CalculateCoverageRequest
(message)CalculateCoverageRequest.CoverageType
(enum)CalculateCoverageResponse
(message)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)DetectIntentRequest
(message)DetectIntentResponse
(message)DtmfInput
(message)EntityType
(message)EntityType.AutoExpansionMode
(enum)EntityType.Entity
(message)EntityType.ExcludedPhrase
(message)EntityType.Kind
(enum)Environment
(message)Environment.VersionConfig
(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)ExportAgentResponse
(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)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)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)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.Text
(message)RestoreAgentRequest
(message)RestoreAgentRequest.RestoreOption
(enum)RunTestCaseMetadata
(message)RunTestCaseRequest
(message)RunTestCaseResponse
(message)SecuritySettings
(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)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.
|
DeleteAgent | |
---|---|
Deletes the specified agent.
|
ExportAgent | |
---|---|
Exports the specified agent to a binary file.
|
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.
|
UpdateAgent | |
---|---|
Updates the specified agent.
|
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.
|
EntityTypes
Service for managing EntityTypes
.
CreateEntityType | |
---|---|
Creates an entity type in the specified agent.
|
DeleteEntityType | |
---|---|
Deletes the specified entity type.
|
GetEntityType | |
---|---|
Retrieves the specified entity type.
|
ListEntityTypes | |
---|---|
Returns the list of all entity types in the specified agent.
|
UpdateEntityType | |
---|---|
Updates the specified entity type.
|
Environments
Service for managing Environments
.
CreateEnvironment | |
---|---|
Creates an
|
DeleteEnvironment | |
---|---|
Deletes the specified
|
GetEnvironment | |
---|---|
Retrieves the specified
|
ListEnvironments | |
---|---|
Returns the list of all environments in the specified
|
LookupEnvironmentHistory | |
---|---|
Looks up the history of the specified
|
UpdateEnvironment | |
---|---|
Updates the specified
|
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.
|
DeleteFlow | |
---|---|
Deletes a specified flow.
|
GetFlow | |
---|---|
Retrieves the specified flow.
|
GetFlowValidationResult | |
---|---|
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
|
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.
|
UpdateFlow | |
---|---|
Updates the specified flow.
|
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.
|
DeleteIntent | |
---|---|
Deletes the specified intent.
|
GetIntent | |
---|---|
Retrieves the specified intent.
|
ListIntents | |
---|---|
Returns the list of all intents in the specified agent.
|
UpdateIntent | |
---|---|
Updates the specified intent.
|
Pages
Service for managing Pages
.
CreatePage | |
---|---|
Creates a page in the specified flow.
|
DeletePage | |
---|---|
Deletes the specified page.
|
GetPage | |
---|---|
Retrieves the specified page.
|
ListPages | |
---|---|
Returns the list of all pages in the specified flow.
|
UpdatePage | |
---|---|
Updates the specified page.
|
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.
|
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.
|
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 overwite any existing ones. The provided ID in the imported test case is neglected.
|
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.
|
UpdateTestCase | |
---|---|
Updates the specified test case.
|
TransitionRouteGroups
Service for managing TransitionRouteGroups
.
CreateTransitionRouteGroup | |
---|---|
Creates an
|
DeleteTransitionRouteGroup | |
---|---|
Deletes the specified
|
GetTransitionRouteGroup | |
---|---|
Retrieves the specified
|
ListTransitionRouteGroups | |
---|---|
Returns the list of all transition route groups in the specified flow.
|
UpdateTransitionRouteGroup | |
---|---|
Updates the specified
|
Versions
Service for managing Versions
.
CreateVersion | |
---|---|
Creates a
|
DeleteVersion | |
---|---|
Deletes the specified
|
GetVersion | |
---|---|
Retrieves the specified
|
ListVersions | |
---|---|
Returns the list of all versions in the specified
|
LoadVersion | |
---|---|
Loads a specified version to draft version.
|
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.
|
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 |
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 |
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. |
enable_spell_correction |
Indicates if automatic spell correction is enabled in detect intent requests. |
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. |
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. |
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 |
Required. Input only. The diagnostic [info][Session.DetectIntentResponse.QueryResult.diagnostic_info] output for the turn. |
triggered_intent |
The |
current_page |
The |
text_responses[] |
The |
status |
Response error from the agent in the test result. If set, other output is empty. |
CreateAgentRequest
The request message for Agents.CreateAgent
.
Fields | |
---|---|
parent |
Required. The location to create a agent for. Format: Authorization requires the following IAM permission on the specified resource
|
agent |
Required. The agent to create. |
CreateDocumentOperationMetadata
Metadata for CreateDocument operation.
Fields | |
---|---|
generic_metadata |
The generic information of the operation. |
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType
.
Fields | |
---|---|
parent |
Required. The agent to create a entity type for. Format: Authorization requires the following IAM permission on the specified resource
|
entity_type |
Required. The entity type to create. |
language_code |
The language of the following fields in
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. |
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
environment |
Required. The environment to create. |
CreateExperimentRequest
The request message for Experiments.CreateExperiment
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
experiment |
Required. The experiment to create. |
CreateFlowRequest
The request message for Flows.CreateFlow
.
Fields | |
---|---|
parent |
Required. The agent to create a flow for. Format: Authorization requires the following IAM permission on the specified resource
|
flow |
Required. The flow to create. |
language_code |
The language of the following fields in
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. |
CreateIntentRequest
The request message for Intents.CreateIntent
.
Fields | |
---|---|
parent |
Required. The agent to create an intent for. Format: Authorization requires the following IAM permission on the specified resource
|
intent |
Required. The intent to create. |
language_code |
The language of the following fields in
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. |
CreatePageRequest
The request message for Pages.CreatePage
.
Fields | |
---|---|
parent |
Required. The flow to create a page for. Format: Authorization requires the following IAM permission on the specified resource
|
page |
Required. The page to create. |
language_code |
The language of the following fields in
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. |
CreateSecuritySettingsRequest
The request message for [SecuritySettings.CreateSecuritySettings][].
Fields | |
---|---|
parent |
Required. The location to create an Authorization requires the following IAM permission on the specified resource
|
security_settings |
Required. The security settings to create. |
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType
.
Fields | |
---|---|
parent |
Required. The session to create a session entity type for. Format: Authorization requires the following IAM permission on the specified resource
|
session_entity_type |
Required. The session entity type to create. |
CreateTestCaseRequest
The request message for TestCases.CreateTestCase
.
Fields | |
---|---|
parent |
Required. The agent to create the test case for. Format: Authorization requires the following IAM permission on the specified resource
|
test_case |
Required. The test case to create. |
CreateTransitionRouteGroupRequest
The request message for TransitionRouteGroups.CreateTransitionRouteGroup
.
Fields | |
---|---|
parent |
Required. The flow to create an Authorization requires the following IAM permission on the specified resource
|
transition_route_group |
Required. The transition route group to create. |
language_code |
The language to list transition route groups for. The field [ 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. |
CreateVersionOperationMetadata
Metadata associated with the long running operation for Versions.CreateVersion
.
Fields | |
---|---|
version |
Name of the created version. Format: |
CreateVersionRequest
The request message for Versions.CreateVersion
.
Fields | |
---|---|
parent |
Required. The Authorization requires the following IAM permission on the specified resource
|
version |
Required. The version to create. |
CreateWebhookRequest
The request message for Webhooks.CreateWebhook
.
Fields | |
---|---|
parent |
Required. The agent to create a webhook for. Format: Authorization requires the following IAM permission on the specified resource
|
webhook |
Required. The webhook to create. |
DeleteAgentRequest
The request message for Agents.DeleteAgent
.
Fields | |
---|---|
name |
Required. The name of the agent to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteDocumentOperationMetadata
Metadata for DeleteDocument operation.
Fields | |
---|---|
generic_metadata |
The generic information of the operation. |
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType
.
Fields | |
---|---|
name |
Required. The name of the entity type to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for entity type not being used. For entity types that are used by intents or pages:
|
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment
.
Fields | |
---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteExperimentRequest
The request message for Experiments.DeleteExperiment
.
Fields | |
---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteFlowRequest
The request message for Flows.DeleteFlow
.
Fields | |
---|---|
name |
Required. The name of the flow to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for flows with no incoming transitions. For flows with incoming transitions:
|
DeleteIntentRequest
The request message for Intents.DeleteIntent
.
Fields | |
---|---|
name |
Required. The name of the intent to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeletePageRequest
The request message for Pages.DeletePage
.
Fields | |
---|---|
name |
Required. The name of the page to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for pages with no incoming transitions. For pages with incoming transitions:
|
DeleteSecuritySettingsRequest
The request message for [SecuritySettings.DeleteSecuritySettings][].
Fields | |
---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType
.
Fields | |
---|---|
name |
Required. The name of the session entity type to delete. Format: Authorization requires the following IAM permission on the specified resource
|
DeleteTransitionRouteGroupRequest
The request message for TransitionRouteGroups.DeleteTransitionRouteGroup
.
Fields | |
---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page:
|
DeleteVersionRequest
The request message for Versions.DeleteVersion
.
Fields | |
---|---|
name |
Required. The name of the Authorization requires the following IAM permission on the specified resource
|
DeleteWebhookRequest
The request message for Webhooks.DeleteWebhook
.
Fields | |
---|---|
name |
Required. The name of the webhook to delete. Format: Authorization requires the following IAM permission on the specified resource
|
force |
This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: |
DetectIntentRequest
The request to detect user's intent.
Fields | |
---|---|
session |
Required. The name of the session this query is sent to. Format: For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments. Authorization requires the following IAM permission on the specified resource
|
query_params |
The parameters of this query. |
query_input |
Required. The input specification. |
output_audio_config |
Instructs the speech synthesizer how to generate the output audio. |
DetectIntentResponse
The message returned from the DetectIntent method.
Fields | |
---|---|
response_id |
Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
query_result |
The result of the conversational query. |
output_audio |
The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content. |
output_audio_config |
The config used by the speech synthesizer to generate the output audio. |
DtmfInput
Represents the input for dtmf event.
Fields | |
---|---|
digits |
The dtmf digits. |
finish_digit |
The finish digit (if any). |
EntityType
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A custom entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the
SessionEntityType
type.
For more information about entity types, see the Dialogflow documentation.
Fields | |
---|---|
name |
The unique identifier of the entity type. Required for |
display_name |
Required. The human-readable name of the entity type, unique within the agent. |
kind |
Required. Indicates the kind of entity type. |
auto_expansion_mode |
Indicates whether the entity type can be automatically expanded. |
entities[] |
The collection of entity entries associated with the entity type. |
excluded_phrases[] |
Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry |
enable_fuzzy_extraction |
Enables fuzzy entity extraction during classification. |
redact |
Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name during logging. |
AutoExpansionMode
Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).
Enums | |
---|---|
AUTO_EXPANSION_MODE_UNSPECIFIED |
Auto expansion disabled for the entity. |
AUTO_EXPANSION_MODE_DEFAULT |
Allows an agent to recognize values that have not been explicitly listed in the entity. |
Entity
An entity entry for an associated entity type.
Fields | |
---|---|
value |
Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For
For
|
synonyms[] |
Required. A collection of value synonyms. For example, if the entity type is vegetable, and For
|
ExcludedPhrase
An ex