Summary of entries of Classes for dialogflow.
Classes
AgentsAsyncClient
Service for managing Agents.
AgentsClient
Service for managing Agents.
SearchAgentsAsyncPager
A pager for iterating through search_agents
requests.
This class thinly wraps an initial
SearchAgentsResponse object, and
provides an __aiter__
method to iterate through its
agents
field.
If there are more pages, the __aiter__
method will make additional
SearchAgents
requests and continue to iterate
through the agents
field on the
corresponding responses.
All the usual SearchAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SearchAgentsPager
A pager for iterating through search_agents
requests.
This class thinly wraps an initial
SearchAgentsResponse object, and
provides an __iter__
method to iterate through its
agents
field.
If there are more pages, the __iter__
method will make additional
SearchAgents
requests and continue to iterate
through the agents
field on the
corresponding responses.
All the usual SearchAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AnswerRecordsAsyncClient
Service for managing AnswerRecords.
AnswerRecordsClient
Service for managing AnswerRecords.
ListAnswerRecordsAsyncPager
A pager for iterating through list_answer_records
requests.
This class thinly wraps an initial
ListAnswerRecordsResponse object, and
provides an __aiter__
method to iterate through its
answer_records
field.
If there are more pages, the __aiter__
method will make additional
ListAnswerRecords
requests and continue to iterate
through the answer_records
field on the
corresponding responses.
All the usual ListAnswerRecordsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListAnswerRecordsPager
A pager for iterating through list_answer_records
requests.
This class thinly wraps an initial
ListAnswerRecordsResponse object, and
provides an __iter__
method to iterate through its
answer_records
field.
If there are more pages, the __iter__
method will make additional
ListAnswerRecords
requests and continue to iterate
through the answer_records
field on the
corresponding responses.
All the usual ListAnswerRecordsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ContextsAsyncClient
Service for managing Contexts.
ContextsClient
Service for managing Contexts.
ListContextsAsyncPager
A pager for iterating through list_contexts
requests.
This class thinly wraps an initial
ListContextsResponse object, and
provides an __aiter__
method to iterate through its
contexts
field.
If there are more pages, the __aiter__
method will make additional
ListContexts
requests and continue to iterate
through the contexts
field on the
corresponding responses.
All the usual ListContextsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListContextsPager
A pager for iterating through list_contexts
requests.
This class thinly wraps an initial
ListContextsResponse object, and
provides an __iter__
method to iterate through its
contexts
field.
If there are more pages, the __iter__
method will make additional
ListContexts
requests and continue to iterate
through the contexts
field on the
corresponding responses.
All the usual ListContextsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationDatasetsAsyncClient
Conversation datasets.
Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsClient
Conversation datasets.
Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ListConversationDatasetsAsyncPager
A pager for iterating through list_conversation_datasets
requests.
This class thinly wraps an initial
ListConversationDatasetsResponse object, and
provides an __aiter__
method to iterate through its
conversation_datasets
field.
If there are more pages, the __aiter__
method will make additional
ListConversationDatasets
requests and continue to iterate
through the conversation_datasets
field on the
corresponding responses.
All the usual ListConversationDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationDatasetsPager
A pager for iterating through list_conversation_datasets
requests.
This class thinly wraps an initial
ListConversationDatasetsResponse object, and
provides an __iter__
method to iterate through its
conversation_datasets
field.
If there are more pages, the __iter__
method will make additional
ListConversationDatasets
requests and continue to iterate
through the conversation_datasets
field on the
corresponding responses.
All the usual ListConversationDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationModelsAsyncClient
Manages a collection of models for human agent assistant.
ConversationModelsClient
Manages a collection of models for human agent assistant.
ListConversationModelEvaluationsAsyncPager
A pager for iterating through list_conversation_model_evaluations
requests.
This class thinly wraps an initial
ListConversationModelEvaluationsResponse object, and
provides an __aiter__
method to iterate through its
conversation_model_evaluations
field.
If there are more pages, the __aiter__
method will make additional
ListConversationModelEvaluations
requests and continue to iterate
through the conversation_model_evaluations
field on the
corresponding responses.
All the usual ListConversationModelEvaluationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationModelEvaluationsPager
A pager for iterating through list_conversation_model_evaluations
requests.
This class thinly wraps an initial
ListConversationModelEvaluationsResponse object, and
provides an __iter__
method to iterate through its
conversation_model_evaluations
field.
If there are more pages, the __iter__
method will make additional
ListConversationModelEvaluations
requests and continue to iterate
through the conversation_model_evaluations
field on the
corresponding responses.
All the usual ListConversationModelEvaluationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationModelsAsyncPager
A pager for iterating through list_conversation_models
requests.
This class thinly wraps an initial
ListConversationModelsResponse object, and
provides an __aiter__
method to iterate through its
conversation_models
field.
If there are more pages, the __aiter__
method will make additional
ListConversationModels
requests and continue to iterate
through the conversation_models
field on the
corresponding responses.
All the usual ListConversationModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationModelsPager
A pager for iterating through list_conversation_models
requests.
This class thinly wraps an initial
ListConversationModelsResponse object, and
provides an __iter__
method to iterate through its
conversation_models
field.
If there are more pages, the __iter__
method will make additional
ListConversationModels
requests and continue to iterate
through the conversation_models
field on the
corresponding responses.
All the usual ListConversationModelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationProfilesAsyncClient
Service for managing ConversationProfiles.
ConversationProfilesClient
Service for managing ConversationProfiles.
ListConversationProfilesAsyncPager
A pager for iterating through list_conversation_profiles
requests.
This class thinly wraps an initial
ListConversationProfilesResponse object, and
provides an __aiter__
method to iterate through its
conversation_profiles
field.
If there are more pages, the __aiter__
method will make additional
ListConversationProfiles
requests and continue to iterate
through the conversation_profiles
field on the
corresponding responses.
All the usual ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationProfilesPager
A pager for iterating through list_conversation_profiles
requests.
This class thinly wraps an initial
ListConversationProfilesResponse object, and
provides an __iter__
method to iterate through its
conversation_profiles
field.
If there are more pages, the __iter__
method will make additional
ListConversationProfiles
requests and continue to iterate
through the conversation_profiles
field on the
corresponding responses.
All the usual ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationsAsyncClient
Service for managing Conversations.
ConversationsClient
Service for managing Conversations.
ListConversationsAsyncPager
A pager for iterating through list_conversations
requests.
This class thinly wraps an initial
ListConversationsResponse object, and
provides an __aiter__
method to iterate through its
conversations
field.
If there are more pages, the __aiter__
method will make additional
ListConversations
requests and continue to iterate
through the conversations
field on the
corresponding responses.
All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationsPager
A pager for iterating through list_conversations
requests.
This class thinly wraps an initial
ListConversationsResponse object, and
provides an __iter__
method to iterate through its
conversations
field.
If there are more pages, the __iter__
method will make additional
ListConversations
requests and continue to iterate
through the conversations
field on the
corresponding responses.
All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListMessagesAsyncPager
A pager for iterating through list_messages
requests.
This class thinly wraps an initial
ListMessagesResponse object, and
provides an __aiter__
method to iterate through its
messages
field.
If there are more pages, the __aiter__
method will make additional
ListMessages
requests and continue to iterate
through the messages
field on the
corresponding responses.
All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListMessagesPager
A pager for iterating through list_messages
requests.
This class thinly wraps an initial
ListMessagesResponse object, and
provides an __iter__
method to iterate through its
messages
field.
If there are more pages, the __iter__
method will make additional
ListMessages
requests and continue to iterate
through the messages
field on the
corresponding responses.
All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
DocumentsAsyncClient
Service for managing knowledge Documents.
DocumentsClient
Service for managing knowledge Documents.
ListDocumentsAsyncPager
A pager for iterating through list_documents
requests.
This class thinly wraps an initial
ListDocumentsResponse object, and
provides an __aiter__
method to iterate through its
documents
field.
If there are more pages, the __aiter__
method will make additional
ListDocuments
requests and continue to iterate
through the documents
field on the
corresponding responses.
All the usual ListDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDocumentsPager
A pager for iterating through list_documents
requests.
This class thinly wraps an initial
ListDocumentsResponse object, and
provides an __iter__
method to iterate through its
documents
field.
If there are more pages, the __iter__
method will make additional
ListDocuments
requests and continue to iterate
through the documents
field on the
corresponding responses.
All the usual ListDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
EncryptionSpecServiceAsyncClient
Manages encryption spec settings for Dialogflow and Agent Assist.
EncryptionSpecServiceClient
Manages encryption spec settings for Dialogflow and Agent Assist.
EntityTypesAsyncClient
Service for managing EntityTypes.
EntityTypesClient
Service for managing EntityTypes.
ListEntityTypesAsyncPager
A pager for iterating through list_entity_types
requests.
This class thinly wraps an initial
ListEntityTypesResponse object, and
provides an __aiter__
method to iterate through its
entity_types
field.
If there are more pages, the __aiter__
method will make additional
ListEntityTypes
requests and continue to iterate
through the entity_types
field on the
corresponding responses.
All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEntityTypesPager
A pager for iterating through list_entity_types
requests.
This class thinly wraps an initial
ListEntityTypesResponse object, and
provides an __iter__
method to iterate through its
entity_types
field.
If there are more pages, the __iter__
method will make additional
ListEntityTypes
requests and continue to iterate
through the entity_types
field on the
corresponding responses.
All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
EnvironmentsAsyncClient
Service for managing Environments.
EnvironmentsClient
Service for managing Environments.
GetEnvironmentHistoryAsyncPager
A pager for iterating through get_environment_history
requests.
This class thinly wraps an initial
EnvironmentHistory object, and
provides an __aiter__
method to iterate through its
entries
field.
If there are more pages, the __aiter__
method will make additional
GetEnvironmentHistory
requests and continue to iterate
through the entries
field on the
corresponding responses.
All the usual EnvironmentHistory attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
GetEnvironmentHistoryPager
A pager for iterating through get_environment_history
requests.
This class thinly wraps an initial
EnvironmentHistory object, and
provides an __iter__
method to iterate through its
entries
field.
If there are more pages, the __iter__
method will make additional
GetEnvironmentHistory
requests and continue to iterate
through the entries
field on the
corresponding responses.
All the usual EnvironmentHistory attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEnvironmentsAsyncPager
A pager for iterating through list_environments
requests.
This class thinly wraps an initial
ListEnvironmentsResponse object, and
provides an __aiter__
method to iterate through its
environments
field.
If there are more pages, the __aiter__
method will make additional
ListEnvironments
requests and continue to iterate
through the environments
field on the
corresponding responses.
All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEnvironmentsPager
A pager for iterating through list_environments
requests.
This class thinly wraps an initial
ListEnvironmentsResponse object, and
provides an __iter__
method to iterate through its
environments
field.
If there are more pages, the __iter__
method will make additional
ListEnvironments
requests and continue to iterate
through the environments
field on the
corresponding responses.
All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
FulfillmentsAsyncClient
Service for managing Fulfillments.
FulfillmentsClient
Service for managing Fulfillments.
GeneratorsAsyncClient
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
GeneratorsClient
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
ListGeneratorsAsyncPager
A pager for iterating through list_generators
requests.
This class thinly wraps an initial
ListGeneratorsResponse object, and
provides an __aiter__
method to iterate through its
generators
field.
If there are more pages, the __aiter__
method will make additional
ListGenerators
requests and continue to iterate
through the generators
field on the
corresponding responses.
All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListGeneratorsPager
A pager for iterating through list_generators
requests.
This class thinly wraps an initial
ListGeneratorsResponse object, and
provides an __iter__
method to iterate through its
generators
field.
If there are more pages, the __iter__
method will make additional
ListGenerators
requests and continue to iterate
through the generators
field on the
corresponding responses.
All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
IntentsAsyncClient
Service for managing Intents.
IntentsClient
Service for managing Intents.
ListIntentsAsyncPager
A pager for iterating through list_intents
requests.
This class thinly wraps an initial
ListIntentsResponse object, and
provides an __aiter__
method to iterate through its
intents
field.
If there are more pages, the __aiter__
method will make additional
ListIntents
requests and continue to iterate
through the intents
field on the
corresponding responses.
All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListIntentsPager
A pager for iterating through list_intents
requests.
This class thinly wraps an initial
ListIntentsResponse object, and
provides an __iter__
method to iterate through its
intents
field.
If there are more pages, the __iter__
method will make additional
ListIntents
requests and continue to iterate
through the intents
field on the
corresponding responses.
All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
KnowledgeBasesAsyncClient
Service for managing KnowledgeBases.
KnowledgeBasesClient
Service for managing KnowledgeBases.
ListKnowledgeBasesAsyncPager
A pager for iterating through list_knowledge_bases
requests.
This class thinly wraps an initial
ListKnowledgeBasesResponse object, and
provides an __aiter__
method to iterate through its
knowledge_bases
field.
If there are more pages, the __aiter__
method will make additional
ListKnowledgeBases
requests and continue to iterate
through the knowledge_bases
field on the
corresponding responses.
All the usual ListKnowledgeBasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListKnowledgeBasesPager
A pager for iterating through list_knowledge_bases
requests.
This class thinly wraps an initial
ListKnowledgeBasesResponse object, and
provides an __iter__
method to iterate through its
knowledge_bases
field.
If there are more pages, the __iter__
method will make additional
ListKnowledgeBases
requests and continue to iterate
through the knowledge_bases
field on the
corresponding responses.
All the usual ListKnowledgeBasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ParticipantsAsyncClient
Service for managing Participants.
ParticipantsClient
Service for managing Participants.
ListParticipantsAsyncPager
A pager for iterating through list_participants
requests.
This class thinly wraps an initial
ListParticipantsResponse object, and
provides an __aiter__
method to iterate through its
participants
field.
If there are more pages, the __aiter__
method will make additional
ListParticipants
requests and continue to iterate
through the participants
field on the
corresponding responses.
All the usual ListParticipantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListParticipantsPager
A pager for iterating through list_participants
requests.
This class thinly wraps an initial
ListParticipantsResponse object, and
provides an __iter__
method to iterate through its
participants
field.
If there are more pages, the __iter__
method will make additional
ListParticipants
requests and continue to iterate
through the participants
field on the
corresponding responses.
All the usual ListParticipantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SessionEntityTypesAsyncClient
Service for managing SessionEntityTypes.
SessionEntityTypesClient
Service for managing SessionEntityTypes.
ListSessionEntityTypesAsyncPager
A pager for iterating through list_session_entity_types
requests.
This class thinly wraps an initial
ListSessionEntityTypesResponse object, and
provides an __aiter__
method to iterate through its
session_entity_types
field.
If there are more pages, the __aiter__
method will make additional
ListSessionEntityTypes
requests and continue to iterate
through the session_entity_types
field on the
corresponding responses.
All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSessionEntityTypesPager
A pager for iterating through list_session_entity_types
requests.
This class thinly wraps an initial
ListSessionEntityTypesResponse object, and
provides an __iter__
method to iterate through its
session_entity_types
field.
If there are more pages, the __iter__
method will make additional
ListSessionEntityTypes
requests and continue to iterate
through the session_entity_types
field on the
corresponding responses.
All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SessionsAsyncClient
A service used for session interactions.
For more information, see the API interactions
guide <https://cloud.google.com/dialogflow/docs/api-overview>
__.
SessionsClient
A service used for session interactions.
For more information, see the API interactions
guide <https://cloud.google.com/dialogflow/docs/api-overview>
__.
VersionsAsyncClient
Service for managing Versions.
VersionsClient
Service for managing Versions.
ListVersionsAsyncPager
A pager for iterating through list_versions
requests.
This class thinly wraps an initial
ListVersionsResponse object, and
provides an __aiter__
method to iterate through its
versions
field.
If there are more pages, the __aiter__
method will make additional
ListVersions
requests and continue to iterate
through the versions
field on the
corresponding responses.
All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVersionsPager
A pager for iterating through list_versions
requests.
This class thinly wraps an initial
ListVersionsResponse object, and
provides an __iter__
method to iterate through its
versions
field.
If there are more pages, the __iter__
method will make additional
ListVersions
requests and continue to iterate
through the versions
field on the
corresponding responses.
All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
Agent
A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system.
For more information about agents, see the Agent
guide <https://cloud.google.com/dialogflow/docs/agents-overview>
__.
ApiVersion
API version for the agent.
MatchMode
Match mode determines how intents are detected from user queries.
Tier
Represents the agent tier.
AgentAssistantFeedback
Detail feedback of Agent Assist result.
AnswerRelevance
Relevance of an answer.
DocumentCorrectness
Correctness of document.
DocumentEfficiency
Efficiency of document.
KnowledgeAssistFeedback
Feedback for knowledge assist.
KnowledgeSearchFeedback
Feedback for knowledge search.
SummarizationFeedback
Feedback for conversation summarization.
TextSectionsEntry
The abstract base class for a message.
AgentAssistantRecord
Represents a record of a human agent assist answer.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnalyzeContentRequest
The request message for Participants.AnalyzeContent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnalyzeContentResponse
The response message for Participants.AnalyzeContent.
AnnotatedMessagePart
Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.
AnswerFeedback
Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CorrectnessLevel
The correctness level of an answer.
AnswerRecord
Answer records are records to manage answer history and feedbacks for Dialogflow.
Currently, answer record includes:
- human agent assistant article suggestion
- human agent assistant faq article
It doesn't include:
DetectIntent
intent matchingDetectIntent
knowledge
Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.
A typical workflow for customers provide feedback to an answer is:
- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers.
- The customer uses the AnswerRecord.name to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ArticleAnswer
Represents article answer.
MetadataEntry
The abstract base class for a message.
ArticleSuggestionModelMetadata
Metadata for article suggestion models.
AssistQueryParameters
Represents the parameters of human assist query.
DocumentsMetadataFiltersEntry
The abstract base class for a message.
AudioEncoding
Audio encoding of the audio content sent in the conversational query
request. Refer to the Cloud Speech API
documentation <https://cloud.google.com/speech-to-text/docs/basics>
__
for more details.
AutomatedAgentConfig
Defines the Automated Agent to connect to a conversation.
AutomatedAgentReply
Represents a response from an automated agent.
AutomatedAgentReplyType
Represents different automated agent reply types.
BatchCreateEntitiesRequest
The request message for EntityTypes.BatchCreateEntities.
BatchDeleteEntitiesRequest
The request message for EntityTypes.BatchDeleteEntities.
BatchDeleteEntityTypesRequest
The request message for EntityTypes.BatchDeleteEntityTypes.
BatchDeleteIntentsRequest
The request message for Intents.BatchDeleteIntents.
BatchUpdateEntitiesRequest
The request message for EntityTypes.BatchUpdateEntities.
BatchUpdateEntityTypesRequest
The request message for EntityTypes.BatchUpdateEntityTypes.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchUpdateEntityTypesResponse
The response message for EntityTypes.BatchUpdateEntityTypes.
BatchUpdateIntentsRequest
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchUpdateIntentsResponse
The response message for Intents.BatchUpdateIntents.
ClearSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.
ClearSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.ClearFeature][].
CloudConversationDebuggingInfo
Cloud conversation info for easier debugging. It will get populated
in StreamingDetectIntentResponse
or
StreamingAnalyzeContentResponse
when the flag
enable_debugging_info
is set to true in corresponding requests.
CompleteConversationRequest
The request message for Conversations.CompleteConversation.
Context
Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.
Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.
For more information about context, see the Contexts
guide <https://cloud.google.com/dialogflow/docs/contexts-overview>
__.
Conversation
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
ConversationStage
Enumeration of the different conversation stages a conversation can be in. Reference:
https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
LifecycleState
Enumeration of the completion status of the conversation.
ConversationContext
Context of the conversation, including transcripts.
ConversationDataset
Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ConversationEvent
Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Type
Enumeration of the types of events available.
In general non-recoverable errors only occur if something
was misconfigured in the ConversationProfile corresponding
to the call. After a non-recoverable error, Dialogflow may
stop responding.
We don't fire this event:
- in an API call because we can directly return the error,
or,
- when we can recover from an error.
ConversationInfo
Represents metadata of a conversation.
ConversationModel
Represents a conversation model.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ModelType
Model type.
State
State of the model.
ConversationModelEvaluation
Represents evaluation result of a conversation model.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ConversationPhoneNumber
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.
ConversationProfile
Defines the services to connect to incoming Dialogflow conversations.
CreateContextRequest
The request message for Contexts.CreateContext.
CreateConversationDatasetOperationMetadata
Metadata for ConversationDatasets][CreateConversationDataset]
.
CreateConversationDatasetRequest
The request message for ConversationDatasets.CreateConversationDataset.
CreateConversationModelEvaluationOperationMetadata
Metadata for a ConversationModels.CreateConversationModelEvaluation operation.
State
State of CreateConversationModel operation.
CreateConversationModelEvaluationRequest
The request message for ConversationModels.CreateConversationModelEvaluation
CreateConversationModelOperationMetadata
Metadata for a ConversationModels.CreateConversationModel operation.
State
State of CreateConversationModel operation.
CreateConversationModelRequest
The request message for ConversationModels.CreateConversationModel
CreateConversationProfileRequest
The request message for ConversationProfiles.CreateConversationProfile.
CreateConversationRequest
The request message for Conversations.CreateConversation.
CreateDocumentRequest
Request message for Documents.CreateDocument.
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment.
CreateGeneratorRequest
Request message of CreateGenerator.
CreateIntentRequest
The request message for Intents.CreateIntent.
CreateKnowledgeBaseRequest
Request message for KnowledgeBases.CreateKnowledgeBase.
CreateParticipantRequest
The request message for Participants.CreateParticipant.
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
CreateVersionRequest
The request message for Versions.CreateVersion.
DeleteAgentRequest
The request message for Agents.DeleteAgent.
DeleteAllContextsRequest
The request message for Contexts.DeleteAllContexts.
DeleteContextRequest
The request message for Contexts.DeleteContext.
DeleteConversationDatasetOperationMetadata
Metadata for ConversationDatasets][DeleteConversationDataset]
.
DeleteConversationDatasetRequest
The request message for ConversationDatasets.DeleteConversationDataset.
DeleteConversationModelOperationMetadata
Metadata for a ConversationModels.DeleteConversationModel operation.
DeleteConversationModelRequest
The request message for ConversationModels.DeleteConversationModel
DeleteConversationProfileRequest
The request message for ConversationProfiles.DeleteConversationProfile.
This operation fails if the conversation profile is still referenced from a phone number.
DeleteDocumentRequest
Request message for Documents.DeleteDocument.
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
DeleteGeneratorRequest
Request of DeleteGenerator.
DeleteIntentRequest
The request message for Intents.DeleteIntent.
DeleteKnowledgeBaseRequest
Request message for KnowledgeBases.DeleteKnowledgeBase.
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
DeleteVersionRequest
The request message for Versions.DeleteVersion.
DeployConversationModelOperationMetadata
Metadata for a ConversationModels.DeployConversationModel operation.
DeployConversationModelRequest
The request message for ConversationModels.DeployConversationModel
DetectIntentRequest
The request to detect user's intent.
DetectIntentResponse
The message returned from the DetectIntent method.
DialogflowAssistAnswer
Represents a Dialogflow assist answer.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Document
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base
guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>
__.
Note: The projects.agent.knowledgeBases.documents
resource is
deprecated; only use projects.knowledgeBases.documents
.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
KnowledgeType
The knowledge type of document content.
CSV must have questions in the first column and
answers in the second, with no header. Because
of this explicit format, they are always parsed
accurately.
EXTRACTIVE_QA (2):
Documents for which unstructured text is
extracted and used for question answering.
ARTICLE_SUGGESTION (3):
The entire document content as a whole can be
used for query results. Only for Contact Center
Solutions on Dialogflow.
AGENT_FACING_SMART_REPLY (4):
The document contains agent-facing Smart
Reply entries.
MetadataEntry
The abstract base class for a message.
ReloadStatus
The status of a reload attempt.
State
Possible states of the document
DtmfParameters
The message in the response that indicates the parameters of DTMF.
EncryptionSpec
A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
EntityType
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.
Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.
For more information, see the Entity
guide <https://cloud.google.com/dialogflow/docs/entities-overview>
__.
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).
Entity
An entity entry for an associated entity type.
Kind
Represents kinds of entities.
EntityTypeBatch
This message is a wrapper around a collection of entity types.
Environment
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments
guide <https://cloud.google.com/dialogflow/docs/agents-versions>
__.
State
Represents an environment state. When an environment is pointed to a
new agent version, the environment is temporarily set to the
LOADING
state. During that time, the environment keeps on
serving the previous version of the agent. After the new agent
version is done loading, the environment is set back to the
RUNNING
state.
EnvironmentHistory
The response message for Environments.GetEnvironmentHistory.
Entry
Represents an environment history entry.
EvaluationConfig
The configuration for model evaluation.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SmartComposeConfig
Smart compose specific configuration for evaluation job.
SmartReplyConfig
Smart reply specific configuration for evaluation job.
EventInput
Events allow for matching intents by event name instead of the
natural language input. For instance, input
<event: { name: "welcome_event", parameters: { name: "Sam" } }>
can trigger a personalized welcome response. The parameter name
may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?"
.
ExportAgentRequest
The request message for Agents.ExportAgent.
ExportAgentResponse
The response message for Agents.ExportAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportDocumentRequest
Request message for Documents.ExportDocument.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportOperationMetadata
Metadata related to the Export Data Operations (e.g. ExportDocument).
FaqAnswer
Represents answer from "frequently asked questions".
MetadataEntry
The abstract base class for a message.
FewShotExample
Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExtraInfoEntry
The abstract base class for a message.
Fulfillment
By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.
For more information, see the fulfillment
guide <https://cloud.google.com/dialogflow/docs/fulfillment-overview>
__.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Feature
Whether fulfillment is enabled for the specific feature.
Type
The type of the feature.
GenericWebService
Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers.
More information could be found at:
https://cloud.google.com/dialogflow/docs/fulfillment-configure.
RequestHeadersEntry
The abstract base class for a message.
GcsDestination
Google Cloud Storage location for the output.
GcsSources
Google Cloud Storage location for the inputs.
GenerateStatelessSuggestionRequest
The request message for Conversations.GenerateStatelessSuggestion.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GenerateStatelessSuggestionResponse
The response message for Conversations.GenerateStatelessSuggestion.
GenerateStatelessSummaryRequest
The request message for Conversations.GenerateStatelessSummary.
MinimalConversation
The minimum amount of information required to generate a Summary without having a Conversation resource created.
GenerateStatelessSummaryResponse
The response message for Conversations.GenerateStatelessSummary.
Summary
Generated summary for a conversation.
TextSectionsEntry
The abstract base class for a message.
Generator
LLM generator.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GeneratorSuggestion
Suggestion generated using a Generator.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetAgentRequest
The request message for Agents.GetAgent.
GetContextRequest
The request message for Contexts.GetContext.
GetConversationDatasetRequest
The request message for ConversationDatasets.GetConversationDataset.
GetConversationModelEvaluationRequest
The request message for ConversationModels.GetConversationModelEvaluation
GetConversationModelRequest
The request message for ConversationModels.GetConversationModel
GetConversationProfileRequest
The request message for ConversationProfiles.GetConversationProfile.
GetConversationRequest
The request message for Conversations.GetConversation.
GetDocumentRequest
Request message for Documents.GetDocument.
GetEncryptionSpecRequest
The request to get location-level encryption specification.
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
GetEnvironmentHistoryRequest
The request message for Environments.GetEnvironmentHistory.
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
GetFulfillmentRequest
The request message for Fulfillments.GetFulfillment.
GetGeneratorRequest
Request message of GetGenerator.
GetIntentRequest
The request message for Intents.GetIntent.
GetKnowledgeBaseRequest
Request message for KnowledgeBases.GetKnowledgeBase.
GetParticipantRequest
The request message for Participants.GetParticipant.
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
GetValidationResultRequest
The request message for Agents.GetValidationResult.
GetVersionRequest
The request message for Versions.GetVersion.
HumanAgentAssistantConfig
Defines the Human Agent Assist to connect to a conversation.
ConversationModelConfig
Custom conversation models used in agent assist feature.
Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.
ConversationProcessConfig
Config to process conversation.
MessageAnalysisConfig
Configuration for analyses to run on each conversation message.
SuggestionConfig
Detail human agent assistant config.
SuggestionFeatureConfig
Config for suggestion features.
SuggestionQueryConfig
Config for suggestion query.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ContextFilterSettings
Settings that determine how to filter recent conversation context when generating suggestions.
DialogflowQuerySource
Dialogflow source setting.
Supported feature: DIALOGFLOW_ASSIST.
HumanAgentSideConfig
The configuration used for human agent side Dialogflow assist suggestion.
DocumentQuerySource
Document source settings.
Supported features: SMART_REPLY, SMART_COMPOSE.
KnowledgeBaseQuerySource
Knowledge base source settings.
Supported features: ARTICLE_SUGGESTION, FAQ.
Sections
Custom sections to return when requesting a summary of a
conversation. This is only supported when baseline_model_version
== '2.0'.
Supported features: CONVERSATION_SUMMARIZATION, CONVERSATION_SUMMARIZATION_VOICE.
SectionType
Selectable sections to return when requesting a summary of a conversation.
SuggestionTriggerSettings
Settings of suggestion trigger.
HumanAgentAssistantEvent
Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.
HumanAgentHandoffConfig
Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation.
Currently, this feature is not general available, please contact Google to get access.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LivePersonConfig
Configuration specific to
LivePerson <https://www.liveperson.com>
__.
SalesforceLiveAgentConfig
Configuration specific to Salesforce Live Agent.
ImportAgentRequest
The request message for Agents.ImportAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportConversationDataOperationMetadata
Metadata for a ConversationDatasets.ImportConversationData operation.
ImportConversationDataOperationResponse
Response used for ConversationDatasets.ImportConversationData long running operation.
ImportConversationDataRequest
The request message for ConversationDatasets.ImportConversationData.
ImportDocumentTemplate
The template used for importing documents.
MetadataEntry
The abstract base class for a message.
ImportDocumentsRequest
Request message for Documents.ImportDocuments.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportDocumentsResponse
Response message for Documents.ImportDocuments.
InferenceParameter
The parameters of inference.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
InitializeEncryptionSpecMetadata
Metadata for initializing a location-level encryption specification.
InitializeEncryptionSpecRequest
The request to initialize a location-level encryption specification.
InitializeEncryptionSpecResponse
The response to initialize a location-level encryption specification.
InputAudioConfig
Instructs the speech recognizer how to process the audio content.
InputConfig
Represents the configuration of importing a set of conversation files in Google Cloud Storage.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
InputDataset
InputDataset used to create model or do evaluation. NextID:5
InputTextConfig
Defines the language used in the input text.
Intent
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.
For more information, see the intent
guide <https://cloud.google.com/dialogflow/docs/intents-overview>
__.
FollowupIntentInfo
Represents a single followup intent in the chain.
Message
A rich response message. Corresponds to the intent Response
field in the Dialogflow console. For more information, see Rich
response
messages <https://cloud.google.com/dialogflow/docs/intents-rich-messages>
__.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BasicCard
The basic card message. Useful for displaying information.
Button
The button object that appears at the bottom of a card.
OpenUriAction
Opens the given URI.
BrowseCarouselCard
Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel
BrowseCarouselCardItem
Browsing carousel tile
OpenUrlAction
Actions on Google action to open a given url.
UrlTypeHint
Type of the URI.
ImageDisplayOptions
Image display options for Actions on Google. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.
Card
The card response message.
Button
Contains information about a button.
CarouselSelect
The card for presenting a carousel of options to select from.
Item
An item in the carousel.
ColumnProperties
Column properties for TableCard.
HorizontalAlignment
Text alignments within a cell.
Image
The image response message.
LinkOutSuggestion
The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
ListSelect
The card for presenting a list of options to select from.
Item
An item in the list.
MediaContent
The media content card for Actions on Google.
ResponseMediaObject
Response media object for media content card.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResponseMediaType
Format of response media type.
Platform
The rich response message integration platform. See
Integrations <https://cloud.google.com/dialogflow/docs/integrations>
__.
QuickReplies
The quick replies response message.
SelectItemInfo
Additional info about the select item for when it is triggered in a dialog.
SimpleResponse
The simple response message containing speech or text.
SimpleResponses
The collection of simple response candidates. This message in
QueryResult.fulfillment_messages
and
WebhookResponse.fulfillment_messages
should contain only one
SimpleResponse
.
Suggestion
The suggestion chip message that the user can tap to quickly post a reply to the conversation.
Suggestions
The collection of suggestions.
TableCard
Table card for Actions on Google.
TableCardCell
Cell of TableCardRow.
TableCardRow
Row of TableCard.
Text
The text response message.
Parameter
Represents intent parameters.
TrainingPhrase
Represents an example that the agent is trained on.
Part
Represents a part of a training phrase.
Type
Represents different types of training phrases.
WebhookState
Represents the different states that webhooks can be in.
IntentBatch
This message is a wrapper around a collection of intents.
IntentSuggestion
Represents an intent suggestion.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.
KnowledgeAssistAnswer
Represents a Knowledge Assist answer.
KnowledgeAnswer
Represents an answer from Knowledge. Currently supports FAQ and Generative answers.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FaqSource
Details about source of FAQ answer.
GenerativeSource
Details about source of Generative answer.
Snippet
Snippet Source for a Generative Prediction.
SuggestedQuery
Represents a suggested query.
KnowledgeBase
A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input.
For more information, see the knowledge base
guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>
__.
Note: The projects.agent.knowledgeBases
resource is deprecated;
only use projects.knowledgeBases
.
KnowledgeOperationMetadata
Metadata in google::longrunning::Operation for Knowledge operations.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
States of the operation.
ListAnswerRecordsRequest
Request message for AnswerRecords.ListAnswerRecords.
ListAnswerRecordsResponse
Response message for AnswerRecords.ListAnswerRecords.
ListContextsRequest
The request message for Contexts.ListContexts.
ListContextsResponse
The response message for Contexts.ListContexts.
ListConversationDatasetsRequest
The request message for ConversationDatasets.ListConversationDatasets.
ListConversationDatasetsResponse
The response message for ConversationDatasets.ListConversationDatasets.
ListConversationModelEvaluationsRequest
The request message for ConversationModels.ListConversationModelEvaluations
ListConversationModelEvaluationsResponse
The response message for ConversationModels.ListConversationModelEvaluations
ListConversationModelsRequest
The request message for ConversationModels.ListConversationModels
ListConversationModelsResponse
The response message for ConversationModels.ListConversationModels
ListConversationProfilesRequest
The request message for ConversationProfiles.ListConversationProfiles.
ListConversationProfilesResponse
The response message for ConversationProfiles.ListConversationProfiles.
ListConversationsRequest
The request message for Conversations.ListConversations.
ListConversationsResponse
The response message for Conversations.ListConversations.
ListDocumentsRequest
Request message for Documents.ListDocuments.
ListDocumentsResponse
Response message for Documents.ListDocuments.
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
ListGeneratorsRequest
Request message of ListGenerators.
ListGeneratorsResponse
Response of ListGenerators.
ListIntentsRequest
The request message for Intents.ListIntents.
ListIntentsResponse
The response message for Intents.ListIntents.
ListKnowledgeBasesRequest
Request message for KnowledgeBases.ListKnowledgeBases.
ListKnowledgeBasesResponse
Response message for KnowledgeBases.ListKnowledgeBases.
ListMessagesRequest
The request message for Conversations.ListMessages.
ListMessagesResponse
The response message for Conversations.ListMessages.
ListParticipantsRequest
The request message for Participants.ListParticipants.
ListParticipantsResponse
The response message for Participants.ListParticipants.
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
ListVersionsRequest
The request message for Versions.ListVersions.
ListVersionsResponse
The response message for Versions.ListVersions.
LoggingConfig
Defines logging behavior for conversation lifecycle events.
Message
Represents a message posted into a conversation.
MessageAnnotation
Represents the result of annotation for the message.
MessageEntry
Represents a message entry of a conversation.
Role
Enumeration of the roles a participant can play in a conversation.
NotificationConfig
Defines notification behavior.
MessageFormat
Format of cloud pub/sub message.
OriginalDetectIntentRequest
Represents the contents of the original request that was passed to
the [Streaming]DetectIntent
call.
OutputAudio
Represents the natural language speech audio to be played to the end user.
OutputAudioConfig
Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.
OutputAudioEncoding
Audio encoding of the output audio format in Text-To-Speech.
Participant
Represents a conversation participant (human agent, virtual agent, end-user).
DocumentsMetadataFiltersEntry
The abstract base class for a message.
Role
Enumeration of the roles a participant can play in a conversation.
QueryInput
Represents the query input. It can contain either:
An audio config which instructs the speech recognizer how to process the speech audio.
A conversational query in the form of text.
An event that specifies which intent to trigger.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QueryParameters
Represents the parameters of the conversational query.
WebhookHeadersEntry
The abstract base class for a message.
QueryResult
Represents the result of conversational query or event processing.
ReloadDocumentRequest
Request message for Documents.ReloadDocument.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RestoreAgentRequest
The request message for Agents.RestoreAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchAgentsRequest
The request message for Agents.SearchAgents.
SearchAgentsResponse
The response message for Agents.SearchAgents.
SearchKnowledgeAnswer
Represents a SearchKnowledge answer.
AnswerSource
The sources of the answers.
AnswerType
The type of the answer.
SearchKnowledgeRequest
The request message for Conversations.SearchKnowledge.
QuerySource
The source of the query. We use QuerySource to distinguish queries directly entered by agents and suggested queries from Participants.SuggestKnowledgeAssist. If SUGGESTED_QUERY source is specified, we will treat it as a continuation of a SuggestKnowledgeAssist call.
SearchConfig
Configuration specific to search queries with data stores.
BoostSpecs
Boost specifications for data stores.
BoostSpec
Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
ConditionBoostSpec
Boost applies to documents which match a condition.
BoostControlSpec
Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
AttributeType
The attribute(or function) for which the custom ranking is to be applied.
ControlPoint
The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
InterpolationType
The interpolation type to be applied. Default will be linear (Piecewise Linear).
FilterSpecs
Filter specification for data store queries.
SearchKnowledgeResponse
The response message for Conversations.SearchKnowledge.
Sentiment
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.
SentimentAnalysisRequestConfig
Configures the types of sentiment analysis to perform.
SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config
SessionEntityType
A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.
For more information, see the session entity
guide <https://cloud.google.com/dialogflow/docs/entities-session>
__.
EntityOverrideMode
The types of modifications for a session entity type.
Note: Even in this override mode calls to
`ListSessionEntityTypes`, `GetSessionEntityType`,
`CreateSessionEntityType` and `UpdateSessionEntityType`
only return the additional entities added in this session
entity type. If you want to get the supplemented list,
please call
<xref uid="google.cloud.dialogflow.v2.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>
on the custom entity type and merge.
SetAgentRequest
The request message for Agents.SetAgent.
SetSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.
SetSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.SetSuggestionFeature][].
SmartReplyAnswer
Represents a smart reply answer.
SmartReplyMetrics
The evaluation metrics for smart reply model.
TopNMetrics
Evaluation metrics when retrieving n
smart replies with the
model.
SmartReplyModelMetadata
Metadata for smart reply models.
SpeechContext
Hints for the speech recognizer to help with recognition in a specific conversation state.
SpeechModelVariant
Variant of the specified [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.
See the Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>
__
for which models have different variants. For example, the
"phone_call" model has both a standard and an enhanced variant. When
you use an enhanced model, you will generally receive higher quality
results than for a standard model.
Please see the `Dialogflow
docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
for how to make your project eligible for enhanced models.
USE_STANDARD (2):
Use standard model variant even if an enhanced model is
available. See the `Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
for details about enhanced models.
USE_ENHANCED (3):
Use an enhanced model variant:
- If an enhanced variant does not exist for the given
<xref uid="google.cloud.dialogflow.v2.InputAudioConfig.model">model</xref>
and request language, Dialogflow falls back to the
standard variant.
The `Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
describes which models have enhanced variants.
- If the API caller isn't eligible for enhanced models,
Dialogflow returns an error. Please see the `Dialogflow
docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
for how to make your project eligible.
SpeechToTextConfig
Configures speech transcription for ConversationProfile.
SpeechWordInfo
Information for a word recognized by the speech recognizer.
SsmlVoiceGender
Gender of the voice as described in SSML voice
element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>
__.
StreamingAnalyzeContentRequest
The top-level message sent by the client to the Participants.StreamingAnalyzeContent method.
Multiple request messages should be sent in order:
The first message must contain participant, config and optionally query_params. If you want to receive an audio response, it should also contain reply_audio_config. The message must not contain input.
If config in the first message was set to audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. However, note that:
- Dialogflow will bill you for the audio so far.
- Dialogflow discards all Speech recognition results in favor of the text input.
If StreamingAnalyzeContentRequest.config in the first message was set to StreamingAnalyzeContentRequest.text_config, then the second message must contain only input_text. Moreover, you must not send more than two messages.
After you sent all input, you must half-close or abort the request stream.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StreamingAnalyzeContentResponse
The top-level message returned from the StreamingAnalyzeContent
method.
Multiple response messages can be returned in order:
If the input was set to streaming audio, the first one or more messages contain
recognition_result
. Eachrecognition_result
represents a more complete transcript of what the user said. The lastrecognition_result
hasis_final
set totrue
.In virtual agent stage: if
enable_partial_automated_agent_reply
is true, the following N (currently 1 <= N <= 4) messages containautomated_agent_reply
and optionallyreply_audio
returned by the virtual agent. The first (N-1)automated_agent_reply
\ s will haveautomated_agent_reply_type
set toPARTIAL
. The lastautomated_agent_reply
hasautomated_agent_reply_type
set toFINAL
. Ifenable_partial_automated_agent_reply
is not enabled, response stream only contains the final reply.In human assist stage: the following N (N >= 1) messages contain
human_agent_suggestion_results
,end_user_suggestion_results
ormessage
.
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.
If query_input was set to query_input.audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.
However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message.
After you sent all input, you must half-close or abort the request stream.
StreamingDetectIntentResponse
The top-level message returned from the StreamingDetectIntent
method.
Multiple response messages can be returned in order:
If the
StreamingDetectIntentRequest.input_audio
field was set, therecognition_result
field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence.The next message contains
response_id
,query_result
and optionallywebhook_status
if a WebHook was called.
StreamingRecognitionResult
Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series
of results. Each result may contain a transcript
value. A
transcript represents a portion of the utterance. While the
recognizer is processing audio, transcript values may be interim
values or finalized values. Once a transcript is finalized, the
is_final
value is set to true and processing continues for the
next transcript.
If
StreamingDetectIntentRequest.query_input.audio_config.single_utterance
was true, and the recognizer has completed processing audio, the
message_type
value is set to `END_OF_SINGLE_UTTERANCE and the
following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.
::
Num | transcript | message_type | is_final |
---|---|---|---|
1 | "tube" | TRANSCRIPT | false |
2 | "to be a" | TRANSCRIPT | false |
3 | "to be" | TRANSCRIPT | false |
4 | "to be or not to be" | TRANSCRIPT | true |
5 | "that's" | TRANSCRIPT | false |
6 | "that is | TRANSCRIPT | false |
7 | unset | END_OF_SINGLE_UTTERANCE | unset |
8 | " that is the question" | TRANSCRIPT | true |
Concatenating the finalized transcripts with is_final
set to
true, the complete utterance becomes "to be or not to be that is the
question".
MessageType
Type of the response message.
SuggestArticlesRequest
The request message for Participants.SuggestArticles.
SuggestArticlesResponse
The response message for Participants.SuggestArticles.
SuggestConversationSummaryRequest
The request message for Conversations.SuggestConversationSummary.
SuggestConversationSummaryResponse
The response message for Conversations.SuggestConversationSummary.
Summary
Generated summary for a conversation.
TextSectionsEntry
The abstract base class for a message.
SuggestFaqAnswersRequest
The request message for Participants.SuggestFaqAnswers.
SuggestFaqAnswersResponse
The request message for Participants.SuggestFaqAnswers.
SuggestKnowledgeAssistRequest
The request message for Participants.SuggestKnowledgeAssist.
SuggestKnowledgeAssistResponse
The response message for Participants.SuggestKnowledgeAssist.
SuggestSmartRepliesRequest
The request message for Participants.SuggestSmartReplies.
SuggestSmartRepliesResponse
The response message for Participants.SuggestSmartReplies.
SuggestionFeature
The type of Human Agent Assistant API suggestion to perform, and the
maximum number of results to return for that type. Multiple
Feature
objects can be specified in the features
list.
Type
Defines the type of Human Agent Assistant feature.
SuggestionInput
Represents the selection of a suggestion.
SuggestionResult
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationContext
Summarization context that customer can configure.
SummarizationSection
Represents the section of summarization.
Type
Type enum of the summarization sections.
SummarizationSectionList
List of summarization sections.
SummarySuggestion
Suggested summary of the conversation.
SummarySection
A component of the generated summary.
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
TelephonyDtmf
DTMF <https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling>
__
digit in Telephony Gateway.
TelephonyDtmfEvents
A wrapper of repeated TelephonyDtmf digits.
TextInput
Auxiliary proto messages.
Represents the natural language text to be processed.
TextToSpeechSettings
Instructs the speech synthesizer on how to generate the output audio content.
SynthesizeSpeechConfigsEntry
The abstract base class for a message.
TrainAgentRequest
The request message for Agents.TrainAgent.
TriggerEvent
The event that triggers the generator and LLM execution.
UndeployConversationModelOperationMetadata
Metadata for a ConversationModels.UndeployConversationModel operation.
UndeployConversationModelRequest
The request message for ConversationModels.UndeployConversationModel
UpdateAnswerRecordRequest
Request message for AnswerRecords.UpdateAnswerRecord.
UpdateContextRequest
The request message for Contexts.UpdateContext.
UpdateConversationProfileRequest
The request message for ConversationProfiles.UpdateConversationProfile.
UpdateDocumentRequest
Request message for Documents.UpdateDocument.
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
UpdateFulfillmentRequest
The request message for Fulfillments.UpdateFulfillment.
UpdateGeneratorRequest
Request of UpdateGenerator.
UpdateIntentRequest
The request message for Intents.UpdateIntent.
UpdateKnowledgeBaseRequest
Request message for KnowledgeBases.UpdateKnowledgeBase.
UpdateParticipantRequest
The request message for Participants.UpdateParticipant.
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
UpdateVersionRequest
The request message for Versions.UpdateVersion.
ValidationError
Represents a single validation error.
Severity
Represents a level of severity.
ValidationResult
Represents the output of agent validation.
Version
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments
guide <https://cloud.google.com/dialogflow/docs/agents-versions>
__.
VersionStatus
The status of a version.
VoiceSelectionParams
Description of which voice to use for speech synthesis.
WebhookRequest
The request message for a webhook call.
WebhookResponse
The response message for a webhook call.
This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use
{}
ornull
for empty objects - Use
[]
ornull
for empty arrays
For more information, see the Protocol Buffers Language
Guide <https://developers.google.com/protocol-buffers/docs/proto3#json>
__.
AgentsAsyncClient
Service for managing Agents.
AgentsClient
Service for managing Agents.
SearchAgentsAsyncPager
A pager for iterating through search_agents
requests.
This class thinly wraps an initial
SearchAgentsResponse object, and
provides an __aiter__
method to iterate through its
agents
field.
If there are more pages, the __aiter__
method will make additional
SearchAgents
requests and continue to iterate
through the agents
field on the
corresponding responses.
All the usual SearchAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SearchAgentsPager
A pager for iterating through search_agents
requests.
This class thinly wraps an initial
SearchAgentsResponse object, and
provides an __iter__
method to iterate through its
agents
field.
If there are more pages, the __iter__
method will make additional
SearchAgents
requests and continue to iterate
through the agents
field on the
corresponding responses.
All the usual SearchAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AnswerRecordsAsyncClient
Service for managing AnswerRecords.
AnswerRecordsClient
Service for managing AnswerRecords.
ListAnswerRecordsAsyncPager
A pager for iterating through list_answer_records
requests.
This class thinly wraps an initial
ListAnswerRecordsResponse object, and
provides an __aiter__
method to iterate through its
answer_records
field.
If there are more pages, the __aiter__
method will make additional
ListAnswerRecords
requests and continue to iterate
through the answer_records
field on the
corresponding responses.
All the usual ListAnswerRecordsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListAnswerRecordsPager
A pager for iterating through list_answer_records
requests.
This class thinly wraps an initial
ListAnswerRecordsResponse object, and
provides an __iter__
method to iterate through its
answer_records
field.
If there are more pages, the __iter__
method will make additional
ListAnswerRecords
requests and continue to iterate
through the answer_records
field on the
corresponding responses.
All the usual ListAnswerRecordsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ContextsAsyncClient
Service for managing Contexts.
ContextsClient
Service for managing Contexts.
ListContextsAsyncPager
A pager for iterating through list_contexts
requests.
This class thinly wraps an initial
ListContextsResponse object, and
provides an __aiter__
method to iterate through its
contexts
field.
If there are more pages, the __aiter__
method will make additional
ListContexts
requests and continue to iterate
through the contexts
field on the
corresponding responses.
All the usual ListContextsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListContextsPager
A pager for iterating through list_contexts
requests.
This class thinly wraps an initial
ListContextsResponse object, and
provides an __iter__
method to iterate through its
contexts
field.
If there are more pages, the __iter__
method will make additional
ListContexts
requests and continue to iterate
through the contexts
field on the
corresponding responses.
All the usual ListContextsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationProfilesAsyncClient
Service for managing ConversationProfiles.
ConversationProfilesClient
Service for managing ConversationProfiles.
ListConversationProfilesAsyncPager
A pager for iterating through list_conversation_profiles
requests.
This class thinly wraps an initial
ListConversationProfilesResponse object, and
provides an __aiter__
method to iterate through its
conversation_profiles
field.
If there are more pages, the __aiter__
method will make additional
ListConversationProfiles
requests and continue to iterate
through the conversation_profiles
field on the
corresponding responses.
All the usual ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationProfilesPager
A pager for iterating through list_conversation_profiles
requests.
This class thinly wraps an initial
ListConversationProfilesResponse object, and
provides an __iter__
method to iterate through its
conversation_profiles
field.
If there are more pages, the __iter__
method will make additional
ListConversationProfiles
requests and continue to iterate
through the conversation_profiles
field on the
corresponding responses.
All the usual ListConversationProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ConversationsAsyncClient
Service for managing Conversations.
ConversationsClient
Service for managing Conversations.
ListConversationsAsyncPager
A pager for iterating through list_conversations
requests.
This class thinly wraps an initial
ListConversationsResponse object, and
provides an __aiter__
method to iterate through its
conversations
field.
If there are more pages, the __aiter__
method will make additional
ListConversations
requests and continue to iterate
through the conversations
field on the
corresponding responses.
All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListConversationsPager
A pager for iterating through list_conversations
requests.
This class thinly wraps an initial
ListConversationsResponse object, and
provides an __iter__
method to iterate through its
conversations
field.
If there are more pages, the __iter__
method will make additional
ListConversations
requests and continue to iterate
through the conversations
field on the
corresponding responses.
All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListMessagesAsyncPager
A pager for iterating through list_messages
requests.
This class thinly wraps an initial
ListMessagesResponse object, and
provides an __aiter__
method to iterate through its
messages
field.
If there are more pages, the __aiter__
method will make additional
ListMessages
requests and continue to iterate
through the messages
field on the
corresponding responses.
All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListMessagesPager
A pager for iterating through list_messages
requests.
This class thinly wraps an initial
ListMessagesResponse object, and
provides an __iter__
method to iterate through its
messages
field.
If there are more pages, the __iter__
method will make additional
ListMessages
requests and continue to iterate
through the messages
field on the
corresponding responses.
All the usual ListMessagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
DocumentsAsyncClient
Service for managing knowledge Documents.
DocumentsClient
Service for managing knowledge Documents.
ListDocumentsAsyncPager
A pager for iterating through list_documents
requests.
This class thinly wraps an initial
ListDocumentsResponse object, and
provides an __aiter__
method to iterate through its
documents
field.
If there are more pages, the __aiter__
method will make additional
ListDocuments
requests and continue to iterate
through the documents
field on the
corresponding responses.
All the usual ListDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDocumentsPager
A pager for iterating through list_documents
requests.
This class thinly wraps an initial
ListDocumentsResponse object, and
provides an __iter__
method to iterate through its
documents
field.
If there are more pages, the __iter__
method will make additional
ListDocuments
requests and continue to iterate
through the documents
field on the
corresponding responses.
All the usual ListDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
EncryptionSpecServiceAsyncClient
Manages encryption spec settings for Dialogflow and Agent Assist.
EncryptionSpecServiceClient
Manages encryption spec settings for Dialogflow and Agent Assist.
EntityTypesAsyncClient
Service for managing EntityTypes.
EntityTypesClient
Service for managing EntityTypes.
ListEntityTypesAsyncPager
A pager for iterating through list_entity_types
requests.
This class thinly wraps an initial
ListEntityTypesResponse object, and
provides an __aiter__
method to iterate through its
entity_types
field.
If there are more pages, the __aiter__
method will make additional
ListEntityTypes
requests and continue to iterate
through the entity_types
field on the
corresponding responses.
All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEntityTypesPager
A pager for iterating through list_entity_types
requests.
This class thinly wraps an initial
ListEntityTypesResponse object, and
provides an __iter__
method to iterate through its
entity_types
field.
If there are more pages, the __iter__
method will make additional
ListEntityTypes
requests and continue to iterate
through the entity_types
field on the
corresponding responses.
All the usual ListEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
EnvironmentsAsyncClient
Service for managing Environments.
EnvironmentsClient
Service for managing Environments.
GetEnvironmentHistoryAsyncPager
A pager for iterating through get_environment_history
requests.
This class thinly wraps an initial
EnvironmentHistory object, and
provides an __aiter__
method to iterate through its
entries
field.
If there are more pages, the __aiter__
method will make additional
GetEnvironmentHistory
requests and continue to iterate
through the entries
field on the
corresponding responses.
All the usual EnvironmentHistory attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
GetEnvironmentHistoryPager
A pager for iterating through get_environment_history
requests.
This class thinly wraps an initial
EnvironmentHistory object, and
provides an __iter__
method to iterate through its
entries
field.
If there are more pages, the __iter__
method will make additional
GetEnvironmentHistory
requests and continue to iterate
through the entries
field on the
corresponding responses.
All the usual EnvironmentHistory attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEnvironmentsAsyncPager
A pager for iterating through list_environments
requests.
This class thinly wraps an initial
ListEnvironmentsResponse object, and
provides an __aiter__
method to iterate through its
environments
field.
If there are more pages, the __aiter__
method will make additional
ListEnvironments
requests and continue to iterate
through the environments
field on the
corresponding responses.
All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListEnvironmentsPager
A pager for iterating through list_environments
requests.
This class thinly wraps an initial
ListEnvironmentsResponse object, and
provides an __iter__
method to iterate through its
environments
field.
If there are more pages, the __iter__
method will make additional
ListEnvironments
requests and continue to iterate
through the environments
field on the
corresponding responses.
All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
FulfillmentsAsyncClient
Service for managing Fulfillments.
FulfillmentsClient
Service for managing Fulfillments.
GeneratorsAsyncClient
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
GeneratorsClient
Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.
ListGeneratorsAsyncPager
A pager for iterating through list_generators
requests.
This class thinly wraps an initial
ListGeneratorsResponse object, and
provides an __aiter__
method to iterate through its
generators
field.
If there are more pages, the __aiter__
method will make additional
ListGenerators
requests and continue to iterate
through the generators
field on the
corresponding responses.
All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListGeneratorsPager
A pager for iterating through list_generators
requests.
This class thinly wraps an initial
ListGeneratorsResponse object, and
provides an __iter__
method to iterate through its
generators
field.
If there are more pages, the __iter__
method will make additional
ListGenerators
requests and continue to iterate
through the generators
field on the
corresponding responses.
All the usual ListGeneratorsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
IntentsAsyncClient
Service for managing Intents.
IntentsClient
Service for managing Intents.
ListIntentsAsyncPager
A pager for iterating through list_intents
requests.
This class thinly wraps an initial
ListIntentsResponse object, and
provides an __aiter__
method to iterate through its
intents
field.
If there are more pages, the __aiter__
method will make additional
ListIntents
requests and continue to iterate
through the intents
field on the
corresponding responses.
All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListIntentsPager
A pager for iterating through list_intents
requests.
This class thinly wraps an initial
ListIntentsResponse object, and
provides an __iter__
method to iterate through its
intents
field.
If there are more pages, the __iter__
method will make additional
ListIntents
requests and continue to iterate
through the intents
field on the
corresponding responses.
All the usual ListIntentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
KnowledgeBasesAsyncClient
Service for managing KnowledgeBases.
KnowledgeBasesClient
Service for managing KnowledgeBases.
ListKnowledgeBasesAsyncPager
A pager for iterating through list_knowledge_bases
requests.
This class thinly wraps an initial
ListKnowledgeBasesResponse object, and
provides an __aiter__
method to iterate through its
knowledge_bases
field.
If there are more pages, the __aiter__
method will make additional
ListKnowledgeBases
requests and continue to iterate
through the knowledge_bases
field on the
corresponding responses.
All the usual ListKnowledgeBasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListKnowledgeBasesPager
A pager for iterating through list_knowledge_bases
requests.
This class thinly wraps an initial
ListKnowledgeBasesResponse object, and
provides an __iter__
method to iterate through its
knowledge_bases
field.
If there are more pages, the __iter__
method will make additional
ListKnowledgeBases
requests and continue to iterate
through the knowledge_bases
field on the
corresponding responses.
All the usual ListKnowledgeBasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ParticipantsAsyncClient
Service for managing Participants.
ParticipantsClient
Service for managing Participants.
ListParticipantsAsyncPager
A pager for iterating through list_participants
requests.
This class thinly wraps an initial
ListParticipantsResponse object, and
provides an __aiter__
method to iterate through its
participants
field.
If there are more pages, the __aiter__
method will make additional
ListParticipants
requests and continue to iterate
through the participants
field on the
corresponding responses.
All the usual ListParticipantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListParticipantsPager
A pager for iterating through list_participants
requests.
This class thinly wraps an initial
ListParticipantsResponse object, and
provides an __iter__
method to iterate through its
participants
field.
If there are more pages, the __iter__
method will make additional
ListParticipants
requests and continue to iterate
through the participants
field on the
corresponding responses.
All the usual ListParticipantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSuggestionsAsyncPager
A pager for iterating through list_suggestions
requests.
This class thinly wraps an initial
ListSuggestionsResponse object, and
provides an __aiter__
method to iterate through its
suggestions
field.
If there are more pages, the __aiter__
method will make additional
ListSuggestions
requests and continue to iterate
through the suggestions
field on the
corresponding responses.
All the usual ListSuggestionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSuggestionsPager
A pager for iterating through list_suggestions
requests.
This class thinly wraps an initial
ListSuggestionsResponse object, and
provides an __iter__
method to iterate through its
suggestions
field.
If there are more pages, the __iter__
method will make additional
ListSuggestions
requests and continue to iterate
through the suggestions
field on the
corresponding responses.
All the usual ListSuggestionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SessionEntityTypesAsyncClient
Service for managing SessionEntityTypes.
SessionEntityTypesClient
Service for managing SessionEntityTypes.
ListSessionEntityTypesAsyncPager
A pager for iterating through list_session_entity_types
requests.
This class thinly wraps an initial
ListSessionEntityTypesResponse object, and
provides an __aiter__
method to iterate through its
session_entity_types
field.
If there are more pages, the __aiter__
method will make additional
ListSessionEntityTypes
requests and continue to iterate
through the session_entity_types
field on the
corresponding responses.
All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSessionEntityTypesPager
A pager for iterating through list_session_entity_types
requests.
This class thinly wraps an initial
ListSessionEntityTypesResponse object, and
provides an __iter__
method to iterate through its
session_entity_types
field.
If there are more pages, the __iter__
method will make additional
ListSessionEntityTypes
requests and continue to iterate
through the session_entity_types
field on the
corresponding responses.
All the usual ListSessionEntityTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
SessionsAsyncClient
A service used for session interactions.
For more information, see the API interactions
guide <https://cloud.google.com/dialogflow/docs/api-overview>
__.
SessionsClient
A service used for session interactions.
For more information, see the API interactions
guide <https://cloud.google.com/dialogflow/docs/api-overview>
__.
SipTrunksAsyncClient
Service for managing SipTrunks.
SipTrunksClient
Service for managing SipTrunks.
ListSipTrunksAsyncPager
A pager for iterating through list_sip_trunks
requests.
This class thinly wraps an initial
ListSipTrunksResponse object, and
provides an __aiter__
method to iterate through its
sip_trunks
field.
If there are more pages, the __aiter__
method will make additional
ListSipTrunks
requests and continue to iterate
through the sip_trunks
field on the
corresponding responses.
All the usual ListSipTrunksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSipTrunksPager
A pager for iterating through list_sip_trunks
requests.
This class thinly wraps an initial
ListSipTrunksResponse object, and
provides an __iter__
method to iterate through its
sip_trunks
field.
If there are more pages, the __iter__
method will make additional
ListSipTrunks
requests and continue to iterate
through the sip_trunks
field on the
corresponding responses.
All the usual ListSipTrunksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
VersionsAsyncClient
Service for managing Versions.
VersionsClient
Service for managing Versions.
ListVersionsAsyncPager
A pager for iterating through list_versions
requests.
This class thinly wraps an initial
ListVersionsResponse object, and
provides an __aiter__
method to iterate through its
versions
field.
If there are more pages, the __aiter__
method will make additional
ListVersions
requests and continue to iterate
through the versions
field on the
corresponding responses.
All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListVersionsPager
A pager for iterating through list_versions
requests.
This class thinly wraps an initial
ListVersionsResponse object, and
provides an __iter__
method to iterate through its
versions
field.
If there are more pages, the __iter__
method will make additional
ListVersions
requests and continue to iterate
through the versions
field on the
corresponding responses.
All the usual ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
Agent
A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system.
For more information about agents, see the Agent
guide <https://cloud.google.com/dialogflow/docs/agents-overview>
__.
ApiVersion
API version for the agent.
MatchMode
Match mode determines how intents are detected from user queries.
Tier
Represents the agent tier.
AgentAssistantFeedback
Detail feedback of Agent Assistant result.
AnswerRelevance
Relevance of an answer.
DocumentCorrectness
Correctness of document.
DocumentEfficiency
Efficiency of document.
KnowledgeAssistFeedback
Feedback for knowledge assist.
KnowledgeSearchFeedback
Feedback for knowledge search.
SummarizationFeedback
Feedback for conversation summarization.
TextSectionsEntry
The abstract base class for a message.
AgentAssistantRecord
Represents a record of a human agent assistant answer.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnalyzeContentRequest
The request message for Participants.AnalyzeContent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AnalyzeContentResponse
The response message for Participants.AnalyzeContent.
AnnotatedMessagePart
Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.
AnswerFeedback
Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CorrectnessLevel
The correctness level of an answer.
AnswerRecord
Answer records are records to manage answer history and feedbacks for Dialogflow.
Currently, answer record includes:
- human agent assistant article suggestion
- human agent assistant faq article
It doesn't include:
DetectIntent
intent matchingDetectIntent
knowledge
Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.
A typical workflow for customers provide feedback to an answer is:
- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers.
- The customer uses the AnswerRecord.name to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ArticleAnswer
Represents article answer.
MetadataEntry
The abstract base class for a message.
AssistQueryParameters
Represents the parameters of human assist query.
DocumentsMetadataFiltersEntry
The abstract base class for a message.
AudioEncoding
Audio encoding of the audio content sent in the conversational query
request. Refer to the Cloud Speech API
documentation <https://cloud.google.com/speech-to-text/docs/basics>
__
for more details.
AudioInput
Represents the natural language speech audio to be processed.
AutomatedAgentConfig
Defines the Automated Agent to connect to a conversation.
AutomatedAgentReply
Represents a response from an automated agent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AutomatedAgentReplyType
Represents different automated agent reply types.
BargeInConfig
Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request.
The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases:
No barge-in phase: which goes first and during which speech detection should not be carried out.
Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase.
The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio.
The flow goes like below:
::
--> 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.
BatchCreateEntitiesRequest
The request message for EntityTypes.BatchCreateEntities.
BatchCreateMessagesRequest
The request message for [Conversations.BatchCreateMessagesRequest][].
BatchCreateMessagesResponse
The request message for [Conversations.BatchCreateMessagesResponse][].
BatchDeleteEntitiesRequest
The request message for EntityTypes.BatchDeleteEntities.
BatchDeleteEntityTypesRequest
The request message for EntityTypes.BatchDeleteEntityTypes.
BatchDeleteIntentsRequest
The request message for Intents.BatchDeleteIntents.
BatchUpdateEntitiesRequest
The request message for EntityTypes.BatchUpdateEntities.
BatchUpdateEntityTypesRequest
The request message for EntityTypes.BatchUpdateEntityTypes.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchUpdateEntityTypesResponse
The response message for EntityTypes.BatchUpdateEntityTypes.
BatchUpdateIntentsRequest
The request message for Intents.BatchUpdateIntents.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchUpdateIntentsResponse
The response message for Intents.BatchUpdateIntents.
ClearSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.
ClearSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.ClearFeature][].
CloudConversationDebuggingInfo
Cloud conversation info for easier debugging. It will get populated
in StreamingDetectIntentResponse
or
StreamingAnalyzeContentResponse
when the flag
enable_debugging_info
is set to true in corresponding requests.
CompileSuggestionRequest
The request message for Participants.CompileSuggestion.
CompileSuggestionResponse
The response message for Participants.CompileSuggestion.
CompleteConversationRequest
The request message for Conversations.CompleteConversation.
Connection
Represents a connection for SIP Trunk.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CertificateState
The state of Sip Trunk certificate authentication.
ErrorDetails
The error details of Sip Trunk connection authentication.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
The state of Sip Trunk connection.
Context
Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.
Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.
For more information about context, see the Contexts
guide <https://cloud.google.com/dialogflow/docs/contexts-overview>
__.
Conversation
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
ConversationStage
Enumeration of the different conversation stages a conversation can be in. Reference:
https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
LifecycleState
Enumeration of the completion status of the conversation.
ConversationContext
Context of the conversation, including transcripts.
ConversationEvent
Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Type
Enumeration of the types of events available.
In general non-recoverable errors only occur if something
was misconfigured in the ConversationProfile corresponding
to the call. After a non-recoverable error, Dialogflow may
stop responding.
We don't fire this event:
- in an API call because we can directly return the error,
or,
- when we can recover from an error.
ConversationPhoneNumber
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.
ConversationProfile
Defines the services to connect to incoming Dialogflow conversations.
CreateContextRequest
The request message for Contexts.CreateContext.
CreateConversationProfileRequest
The request message for ConversationProfiles.CreateConversationProfile.
CreateConversationRequest
The request message for Conversations.CreateConversation.
CreateDocumentRequest
Request message for Documents.CreateDocument.
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment.
CreateGeneratorRequest
Request message of CreateGenerator.
CreateIntentRequest
The request message for Intents.CreateIntent.
CreateKnowledgeBaseRequest
Request message for KnowledgeBases.CreateKnowledgeBase.
CreateMessageRequest
The request message to create one Message. Currently it is only used in BatchCreateMessagesRequest.
CreateParticipantRequest
The request message for Participants.CreateParticipant.
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
CreateSipTrunkRequest
The request message for SipTrunks.CreateSipTrunk.
CreateVersionRequest
The request message for Versions.CreateVersion.
DeleteAgentRequest
The request message for Agents.DeleteAgent.
DeleteAllContextsRequest
The request message for Contexts.DeleteAllContexts.
DeleteContextRequest
The request message for Contexts.DeleteContext.
DeleteConversationProfileRequest
The request message for ConversationProfiles.DeleteConversationProfile.
This operation fails if the conversation profile is still referenced from a phone number.
DeleteDocumentRequest
Request message for Documents.DeleteDocument.
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
DeleteGeneratorRequest
Request of DeleteGenerator.
DeleteIntentRequest
The request message for Intents.DeleteIntent.
DeleteKnowledgeBaseRequest
Request message for KnowledgeBases.DeleteKnowledgeBase.
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
DeleteSipTrunkRequest
The request message for SipTrunks.DeleteSipTrunk.
DeleteVersionRequest
The request message for Versions.DeleteVersion.
DetectIntentRequest
The request to detect user's intent.
DetectIntentResponse
The message returned from the DetectIntent method.
DialogflowAssistAnswer
Represents a Dialogflow assist answer.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Document
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base
guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>
__.
Note: The projects.agent.knowledgeBases.documents
resource is
deprecated; only use projects.knowledgeBases.documents
.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
KnowledgeType
The knowledge type of document content.
CSV must have questions in the first column and
answers in the second, with no header. Because
of this explicit format, they are always parsed
accurately.
EXTRACTIVE_QA (2):
Documents for which unstructured text is
extracted and used for question answering.
ARTICLE_SUGGESTION (3):
The entire document content as a whole can be
used for query results. Only for Contact Center
Solutions on Dialogflow.
AGENT_FACING_SMART_REPLY (4):
The document contains agent-facing Smart
Reply entries.
SMART_REPLY (4):
The legacy enum for agent-facing smart reply
feature.
MetadataEntry
The abstract base class for a message.
ReloadStatus
The status of a reload attempt.
State
Possible states of the document
DtmfParameters
The message in the response that indicates the parameters of DTMF.
EncryptionSpec
A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
EntityType
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.
Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.
For more information, see the Entity
guide <https://cloud.google.com/dialogflow/docs/entities-overview>
__.
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).
Entity
An entity entry for an associated entity type.
Kind
Represents kinds of entities.
EntityTypeBatch
This message is a wrapper around a collection of entity types.
Environment
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments
guide <https://cloud.google.com/dialogflow/docs/agents-versions>
__.
State
Represents an environment state. When an environment is pointed to a
new agent version, the environment is temporarily set to the
LOADING
state. During that time, the environment keeps on
serving the previous version of the agent. After the new agent
version is done loading, the environment is set back to the
RUNNING
state.
EnvironmentHistory
The response message for Environments.GetEnvironmentHistory.
Entry
Represents an environment history entry.
EventInput
Events allow for matching intents by event name instead of the
natural language input. For instance, input
<event: { name: "welcome_event", parameters: { name: "Sam" } }>
can trigger a personalized welcome response. The parameter name
may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?"
.
ExportAgentRequest
The request message for Agents.ExportAgent.
ExportAgentResponse
The response message for Agents.ExportAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExportOperationMetadata
Metadata related to the Export Data Operations (e.g. ExportDocument).
FaqAnswer
Represents answer from "frequently asked questions".
MetadataEntry
The abstract base class for a message.
FewShotExample
Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ExtraInfoEntry
The abstract base class for a message.
Fulfillment
By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.
For more information, see the fulfillment
guide <https://cloud.google.com/dialogflow/docs/fulfillment-overview>
__.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Feature
Whether fulfillment is enabled for the specific feature.
Type
The type of the feature.
GenericWebService
Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers.
More information could be found at:
https://cloud.google.com/dialogflow/docs/fulfillment-configure.
RequestHeadersEntry
The abstract base class for a message.
GcsDestination
Google Cloud Storage location for the output.
GcsSource
Google Cloud Storage location for single input.
GcsSources
Google Cloud Storage locations for the inputs.
GenerateStatelessSuggestionRequest
The request message for Conversations.GenerateStatelessSuggestion.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GenerateStatelessSuggestionResponse
The response message for Conversations.GenerateStatelessSuggestion.
GenerateStatelessSummaryRequest
The request message for Conversations.GenerateStatelessSummary.
MinimalConversation
The minimum amount of information required to generate a Summary without having a Conversation resource created.
GenerateStatelessSummaryResponse
The response message for Conversations.GenerateStatelessSummary.
Summary
Generated summary for a conversation.
TextSectionsEntry
The abstract base class for a message.
Generator
LLM generator.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GeneratorSuggestion
Suggestion generated using a Generator.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetAgentRequest
The request message for Agents.GetAgent.
GetAnswerRecordRequest
Request message for AnswerRecords.GetAnswerRecord.
GetContextRequest
The request message for Contexts.GetContext.
GetConversationProfileRequest
The request message for ConversationProfiles.GetConversationProfile.
GetConversationRequest
The request message for Conversations.GetConversation.
GetDocumentRequest
Request message for Documents.GetDocument.
GetEncryptionSpecRequest
The request to get location-level encryption specification.
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
GetEnvironmentHistoryRequest
The request message for Environments.GetEnvironmentHistory.
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
GetFulfillmentRequest
The request message for Fulfillments.GetFulfillment.
GetGeneratorRequest
Request message of GetGenerator.
GetIntentRequest
The request message for Intents.GetIntent.
GetKnowledgeBaseRequest
Request message for KnowledgeBases.GetKnowledgeBase.
GetParticipantRequest
The request message for Participants.GetParticipant.
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
GetSipTrunkRequest
The request message for SipTrunks.GetSipTrunk.
GetValidationResultRequest
The request message for Agents.GetValidationResult.
GetVersionRequest
The request message for Versions.GetVersion.
HumanAgentAssistantConfig
Defines the Human Agent Assistant to connect to a conversation.
ConversationModelConfig
Custom conversation models used in agent assist feature.
Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.
ConversationProcessConfig
Config to process conversation.
MessageAnalysisConfig
Configuration for analyses to run on each conversation message.
SuggestionConfig
Detail human agent assistant config.
SuggestionFeatureConfig
Config for suggestion features.
SuggestionQueryConfig
Config for suggestion query.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ContextFilterSettings
Settings that determine how to filter recent conversation context when generating suggestions.
DialogflowQuerySource
Dialogflow source setting.
Supported feature: DIALOGFLOW_ASSIST, ENTITY_EXTRACTION.
HumanAgentSideConfig
The configuration used for human agent side Dialogflow assist suggestion.
DocumentQuerySource
Document source settings.
Supported features: SMART_REPLY, SMART_COMPOSE.
KnowledgeBaseQuerySource
Knowledge base source settings.
Supported features: ARTICLE_SUGGESTION, FAQ.
Sections
Custom sections to return when requesting a summary of a
conversation. This is only supported when baseline_model_version
== '2.0'.
Supported features: CONVERSATION_SUMMARIZATION, CONVERSATION_SUMMARIZATION_VOICE.
SectionType
Selectable sections to return when requesting a summary of a conversation.
SuggestionTriggerSettings
Settings of suggestion trigger.
HumanAgentAssistantEvent
Output only. Represents a notification sent to Pub/Sub subscribers for agent assistant events in a specific conversation.
HumanAgentHandoffConfig
Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation.
Currently, this feature is not general available, please contact Google to get access.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LivePersonConfig
Configuration specific to
LivePerson <https://www.liveperson.com>
__.
SalesforceLiveAgentConfig
Configuration specific to Salesforce Live Agent.
ImportAgentRequest
The request message for Agents.ImportAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportDocumentTemplate
The template used for importing documents.
MetadataEntry
The abstract base class for a message.
ImportDocumentsRequest
Request message for Documents.ImportDocuments.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportDocumentsResponse
Response message for Documents.ImportDocuments.
InferenceParameter
The parameters of inference.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
InitializeEncryptionSpecMetadata
Metadata for initializing a location-level encryption specification.
InitializeEncryptionSpecRequest
The request to initialize a location-level encryption specification.
InitializeEncryptionSpecResponse
The response to initialize a location-level encryption specification.
InputAudioConfig
Instructs the speech recognizer on how to process the audio content.
InputTextConfig
Defines the language used in the input text.
Intent
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.
For more information, see the intent
guide <https://cloud.google.com/dialogflow/docs/intents-overview>
__.
FollowupIntentInfo
Represents a single followup intent in the chain.
Message
Corresponds to the Response
field in the Dialogflow console.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BasicCard
The basic card message. Useful for displaying information.
Button
The button object that appears at the bottom of a card.
OpenUriAction
Opens the given URI.
BrowseCarouselCard
Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel
BrowseCarouselCardItem
Browsing carousel tile
OpenUrlAction
Actions on Google action to open a given url.
UrlTypeHint
Type of the URI.
ImageDisplayOptions
Image display options for Actions on Google. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.
Card
The card response message.
Button
Optional. Contains information about a button.
CarouselSelect
The card for presenting a carousel of options to select from.
Item
An item in the carousel.
ColumnProperties
Column properties for TableCard.
HorizontalAlignment
Text alignments within a cell.
Image
The image response message.
LinkOutSuggestion
The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
ListSelect
The card for presenting a list of options to select from.
Item
An item in the list.
MediaContent
The media content card for Actions on Google.
ResponseMediaObject
Response media object for media content card.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResponseMediaType
Format of response media type.
Platform
Represents different platforms that a rich message can be intended for.
QuickReplies
The quick replies response message.
RbmCardContent
Rich Business Messaging (RBM) Card content
RbmMedia
Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported:
Image Types
- image/jpeg
- image/jpg'
- image/gif
- image/png
Video Types
- video/h263
- video/m4v
- video/mp4
- video/mpeg
- video/mpeg4
- video/webm
Height
Media height
RbmCarouselCard
Carousel Rich Business Messaging (RBM) rich card.
Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.
If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.
CardWidth
The width of the cards in the carousel.
RbmStandaloneCard
Standalone Rich Business Messaging (RBM) rich card.
Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions.
You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.
CardOrientation
Orientation of the card.
ThumbnailImageAlignment
Thumbnail preview alignment for standalone cards with horizontal layout.
RbmSuggestedAction
Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RbmSuggestedActionDial
Opens the user's default dialer app with the specified phone number but does not dial automatically.
RbmSuggestedActionOpenUri
Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.
RbmSuggestedActionShareLocation
Opens the device's location chooser so the user can pick a location to send back to the agent.
RbmSuggestedReply
Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.
RbmSuggestion
Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RbmText
Rich Business Messaging (RBM) text response with suggestions.
SelectItemInfo
Additional info about the select item for when it is triggered in a dialog.
SimpleResponse
The simple response message containing speech or text.
SimpleResponses
The collection of simple response candidates. This message in
QueryResult.fulfillment_messages
and
WebhookResponse.fulfillment_messages
should contain only one
SimpleResponse
.
Suggestion
The suggestion chip message that the user can tap to quickly post a reply to the conversation.
Suggestions
The collection of suggestions.
TableCard
Table card for Actions on Google.
TableCardCell
Cell of TableCardRow.
TableCardRow
Row of TableCard.
TelephonyPlayAudio
Plays audio from a file in Telephony Gateway.
TelephonySynthesizeSpeech
Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway.
Telephony Gateway takes the synthesizer settings from
DetectIntentResponse.output_audio_config
which can either be set
at request-level or can come from the agent-level synthesizer
config.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TelephonyTransferCall
Transfers the call in Telephony Gateway.
Text
The text response message.
Parameter
Represents intent parameters.
TrainingPhrase
Represents an example that the agent is trained on.
Part
Represents a part of a training phrase.
Type
Represents different types of training phrases.
WebhookState
Represents the different states that webhooks can be in.
IntentBatch
This message is a wrapper around a collection of intents.
IntentInput
Represents the intent to trigger programmatically rather than as a result of natural language processing. The intent input is only used for V3 agent.
IntentSuggestion
Represents an intent suggestion.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.
KnowledgeAnswers
Represents the result of querying a Knowledge base.
Answer
An answer from Knowledge Connector.
MatchConfidenceLevel
Represents the system's confidence that this knowledge answer is a good match for this conversational query.
KnowledgeAssistAnswer
Represents a Knowledge Assist answer.
KnowledgeAnswer
Represents an answer from Knowledge. Currently supports FAQ and Generative answers.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FaqSource
Details about source of FAQ answer.
GenerativeSource
Details about source of Generative answer.
Snippet
Snippet Source for a Generative Prediction.
SuggestedQuery
Represents a suggested query.
KnowledgeBase
A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input.
For more information, see the knowledge base
guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>
__.
Note: The projects.agent.knowledgeBases
resource is deprecated;
only use projects.knowledgeBases
.
KnowledgeOperationMetadata
Metadata in google::longrunning::Operation for Knowledge operations.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
State
States of the operation.
ListAnswerRecordsRequest
Request message for AnswerRecords.ListAnswerRecords.
ListAnswerRecordsResponse
Response message for AnswerRecords.ListAnswerRecords.
ListContextsRequest
The request message for Contexts.ListContexts.
ListContextsResponse
The response message for Contexts.ListContexts.
ListConversationProfilesRequest
The request message for ConversationProfiles.ListConversationProfiles.
ListConversationProfilesResponse
The response message for ConversationProfiles.ListConversationProfiles.
ListConversationsRequest
The request message for Conversations.ListConversations.
ListConversationsResponse
The response message for Conversations.ListConversations.
ListDocumentsRequest
Request message for Documents.ListDocuments.
ListDocumentsResponse
Response message for Documents.ListDocuments.
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
ListGeneratorsRequest
Request message of ListGenerators.
ListGeneratorsResponse
Response of ListGenerators.
ListIntentsRequest
The request message for Intents.ListIntents.
ListIntentsResponse
The response message for Intents.ListIntents.
ListKnowledgeBasesRequest
Request message for KnowledgeBases.ListKnowledgeBases.
ListKnowledgeBasesResponse
Response message for KnowledgeBases.ListKnowledgeBases.
ListMessagesRequest
The request message for Conversations.ListMessages.
ListMessagesResponse
The response message for Conversations.ListMessages.
ListParticipantsRequest
The request message for Participants.ListParticipants.
ListParticipantsResponse
The response message for Participants.ListParticipants.
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
ListSipTrunksRequest
The request message for SipTrunks.ListSipTrunks.
ListSipTrunksResponse
The response message for SipTrunks.ListSipTrunks.
ListSuggestionsRequest
The request message for Participants.ListSuggestions.
ListSuggestionsResponse
The response message for Participants.ListSuggestions.
ListVersionsRequest
The request message for Versions.ListVersions.
ListVersionsResponse
The response message for Versions.ListVersions.
LoggingConfig
Defines logging behavior for conversation lifecycle events.
Message
Represents a message posted into a conversation.
MessageAnnotation
Represents the result of annotation for the message.
MessageEntry
Represents a message entry of a conversation.
Role
Enumeration of the roles a participant can play in a conversation.
NotificationConfig
Defines notification behavior.
MessageFormat
Format of cloud pub/sub message.
OriginalDetectIntentRequest
Represents the contents of the original request that was passed to
the [Streaming]DetectIntent
call.
OutputAudio
Represents the natural language speech audio to be played to the end user.
OutputAudioConfig
Instructs the speech synthesizer how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.
OutputAudioEncoding
Audio encoding of the output audio format in Text-To-Speech.
Participant
Represents a conversation participant (human agent, virtual agent, end-user).
DocumentsMetadataFiltersEntry
The abstract base class for a message.
Role
Enumeration of the roles a participant can play in a conversation.
QueryInput
Represents the query input. It can contain either:
An audio config which instructs the speech recognizer how to process the speech audio.
A conversational query in the form of text.
An event that specifies which intent to trigger.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
QueryParameters
Represents the parameters of the conversational query.
WebhookHeadersEntry
The abstract base class for a message.
QueryResult
Represents the result of conversational query or event processing.
ReloadDocumentRequest
Request message for Documents.ReloadDocument.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResponseMessage
Response messages from an automated agent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EndInteraction
Indicates that interaction with the Dialogflow agent has ended.
LiveAgentHandoff
Indicates that the conversation should be handed off to a human agent.
Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
You may set this, for example:
- In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation.
- In a webhook response when you determine that the customer issue can only be handled by a human.
MixedAudio
Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.
Segment
Represents one segment of audio.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TelephonyTransferCall
Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Text
The text response message.
RestoreAgentRequest
The request message for Agents.RestoreAgent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchAgentsRequest
The request message for Agents.SearchAgents.
SearchAgentsResponse
The response message for Agents.SearchAgents.
SearchKnowledgeAnswer
Represents a SearchKnowledge answer.
AnswerSource
The sources of the answers.
AnswerType
The type of the answer.
SearchKnowledgeRequest
The request message for Conversations.SearchKnowledge.
QuerySource
The source of the query. We use QuerySource to distinguish queries directly entered by agents and suggested queries from Participants.SuggestKnowledgeAssist. If SUGGESTED_QUERY source is specified, we will treat it as a continuation of a SuggestKnowledgeAssist call.
SearchConfig
Configuration specific to search queries with data stores.
BoostSpecs
Boost specifications for data stores.
BoostSpec
Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
ConditionBoostSpec
Boost applies to documents which match a condition.
BoostControlSpec
Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
AttributeType
The attribute(or function) for which the custom ranking is to be applied.
ControlPoint
The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
InterpolationType
The interpolation type to be applied. Default will be linear (Piecewise Linear).
FilterSpecs
Filter specification for data store queries.
SearchKnowledgeResponse
The response message for Conversations.SearchKnowledge.
Sentiment
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.
SentimentAnalysisRequestConfig
Configures the types of sentiment analysis to perform.
SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config
SessionEntityType
A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.
For more information, see the session entity
guide <https://cloud.google.com/dialogflow/docs/entities-session>
__.
EntityOverrideMode
The types of modifications for a session entity type.
Note: Even in this override mode calls to
`ListSessionEntityTypes`, `GetSessionEntityType`,
`CreateSessionEntityType` and `UpdateSessionEntityType`
only return the additional entities added in this session
entity type. If you want to get the supplemented list,
please call
<xref uid="google.cloud.dialogflow.v2beta1.EntityTypes.GetEntityType">EntityTypes.GetEntityType</xref>
on the custom entity type and merge.
SetAgentRequest
The request message for Agents.SetAgent.
SetSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.
SetSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.SetSuggestionFeature][].
SipTrunk
SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service.
SmartReplyAnswer
Represents a smart reply answer.
SpeechContext
Hints for the speech recognizer to help with recognition in a specific conversation state.
SpeechModelVariant
Variant of the specified [Speech model][google.cloud.dialogflow.v2beta1.InputAudioConfig.model] to use.
See the Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>
__
for which models have different variants. For example, the
"phone_call" model has both a standard and an enhanced variant. When
you use an enhanced model, you will generally receive higher quality
results than for a standard model.
Please see the `Dialogflow
docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
for how to make your project eligible for enhanced models.
USE_STANDARD (2):
Use standard model variant even if an enhanced model is
available. See the `Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
for details about enhanced models.
USE_ENHANCED (3):
Use an enhanced model variant:
- If an enhanced variant does not exist for the given
<xref uid="google.cloud.dialogflow.v2beta1.InputAudioConfig.model">model</xref>
and request language, Dialogflow falls back to the
standard variant.
The `Cloud Speech
documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
describes which models have enhanced variants.
- If the API caller isn't eligible for enhanced models,
Dialogflow returns an error. Please see the `Dialogflow
docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
for how to make your project eligible.
SpeechToTextConfig
Configures speech transcription for ConversationProfile.
SpeechWordInfo
Information for a word recognized by the speech recognizer.
SsmlVoiceGender
Gender of the voice as described in SSML voice
element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>
__.
StreamingAnalyzeContentRequest
The top-level message sent by the client to the Participants.StreamingAnalyzeContent method.
Multiple request messages should be sent in order:
The first message must contain participant, config and optionally query_params. If you want to receive an audio response, it should also contain reply_audio_config. The message must not contain input.
If config in the first message was set to audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. If you decide to rather analyze text input after you already started Speech recognition, please send a message with StreamingAnalyzeContentRequest.input_text.
However, note that:
- Dialogflow will bill you for the audio so far.
- Dialogflow discards all Speech recognition results in favor of the text input.
If StreamingAnalyzeContentRequest.config in the first message was set to StreamingAnalyzeContentRequest.text_config, then the second message must contain only input_text. Moreover, you must not send more than two messages.
After you sent all input, you must half-close or abort the request stream.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StreamingAnalyzeContentResponse
The top-level message returned from the StreamingAnalyzeContent
method.
Multiple response messages can be returned in order:
If the input was set to streaming audio, the first one or more messages contain
recognition_result
. Eachrecognition_result
represents a more complete transcript of what the user said. The lastrecognition_result
hasis_final
set totrue
.In virtual agent stage: if
enable_partial_automated_agent_reply
is true, the following N (currently 1 <= N <= 4) messages containautomated_agent_reply
and optionallyreply_audio
returned by the virtual agent. The first (N-1)automated_agent_reply
\ s will haveautomated_agent_reply_type
set toPARTIAL
. The lastautomated_agent_reply
hasautomated_agent_reply_type
set toFINAL
. Ifenable_partial_automated_agent_reply
is not enabled, response stream only contains the final reply.In human assist stage: the following N (N >= 1) messages contain
human_agent_suggestion_results
,end_user_suggestion_results
ormessage
.
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method.
Multiple request messages should be sent in order:
The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.
If query_input was set to query_input.audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.
However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message.
After you sent all input, you must half-close or abort the request stream.
StreamingDetectIntentResponse
The top-level message returned from the StreamingDetectIntent
method.
Multiple response messages can be returned in order:
If the
StreamingDetectIntentRequest.input_audio
field was set, therecognition_result
field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence.The next message contains
response_id
,query_result
,alternative_query_results
and optionallywebhook_status
if a WebHook was called.If
output_audio_config
was specified in the request or agent-level speech synthesizer is configured, all subsequent messages containoutput_audio
andoutput_audio_config
.
StreamingRecognitionResult
Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series
of results. Each result may contain a transcript
value. A
transcript represents a portion of the utterance. While the
recognizer is processing audio, transcript values may be interim
values or finalized values. Once a transcript is finalized, the
is_final
value is set to true and processing continues for the
next transcript.
If
StreamingDetectIntentRequest.query_input.audio_config.single_utterance
was true, and the recognizer has completed processing audio, the
message_type
value is set to `END_OF_SINGLE_UTTERANCE and the
following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.
::
Num | transcript | message_type | is_final |
---|---|---|---|
1 | "tube" | TRANSCRIPT | false |
2 | "to be a" | TRANSCRIPT | false |
3 | "to be" | TRANSCRIPT | false |
4 | "to be or not to be" | TRANSCRIPT | true |
5 | "that's" | TRANSCRIPT | false |
6 | "that is | TRANSCRIPT | false |
7 | unset | END_OF_SINGLE_UTTERANCE | unset |
8 | " that is the question" | TRANSCRIPT | true |
Concatenating the finalized transcripts with is_final
set to
true, the complete utterance becomes "to be or not to be that is the
question".
MessageType
Type of the response message.
SubAgent
Contains basic configuration for a sub-agent.
SuggestArticlesRequest
The request message for Participants.SuggestArticles.
SuggestArticlesResponse
The response message for Participants.SuggestArticles.
SuggestConversationSummaryRequest
The request message for Conversations.SuggestConversationSummary.
SuggestConversationSummaryResponse
The response message for Conversations.SuggestConversationSummary.
Summary
Generated summary for a conversation.
TextSectionsEntry
The abstract base class for a message.
SuggestDialogflowAssistsResponse
The response message for Participants.SuggestDialogflowAssists.
SuggestFaqAnswersRequest
The request message for Participants.SuggestFaqAnswers.
SuggestFaqAnswersResponse
The request message for Participants.SuggestFaqAnswers.
SuggestKnowledgeAssistRequest
The request message for Participants.SuggestKnowledgeAssist.
SuggestKnowledgeAssistResponse
The response message for Participants.SuggestKnowledgeAssist.
SuggestSmartRepliesRequest
The request message for Participants.SuggestSmartReplies.
SuggestSmartRepliesResponse
The response message for Participants.SuggestSmartReplies.
Suggestion
Represents a suggestion for a human agent.
Article
Represents suggested article.
MetadataEntry
The abstract base class for a message.
FaqAnswer
Represents suggested answer from "frequently asked questions".
MetadataEntry
The abstract base class for a message.
SuggestionFeature
The type of Human Agent Assistant API suggestion to perform, and the
maximum number of results to return for that type. Multiple
Feature
objects can be specified in the features
list.
Type
Defines the type of Human Agent Assistant feature.
SuggestionInput
Represents the selection of a suggestion.
SuggestionResult
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SummarizationContext
Summarization context that customer can configure.
SummarizationSection
Represents the section of summarization.
Type
Type enum of the summarization sections.
SummarizationSectionList
List of summarization sections.
SummarySuggestion
Suggested summary of the conversation.
SummarySection
A component of the generated summary.
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
TelephonyDtmf
DTMF <https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling>
__
digit in Telephony Gateway.
TelephonyDtmfEvents
A wrapper of repeated TelephonyDtmf digits.
TextInput
Represents the natural language text to be processed.
TextToSpeechSettings
Instructs the speech synthesizer on how to generate the output audio content.
SynthesizeSpeechConfigsEntry
The abstract base class for a message.
TrainAgentRequest
The request message for Agents.TrainAgent.
TriggerEvent
The event that triggers the generator and LLM execution.
UpdateAnswerRecordRequest
Request message for AnswerRecords.UpdateAnswerRecord.
UpdateContextRequest
The request message for Contexts.UpdateContext.
UpdateConversationProfileRequest
The request message for ConversationProfiles.UpdateConversationProfile.
UpdateDocumentRequest
Request message for Documents.UpdateDocument.
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
UpdateFulfillmentRequest
The request message for Fulfillments.UpdateFulfillment.
UpdateGeneratorRequest
Request of UpdateGenerator.
UpdateIntentRequest
The request message for Intents.UpdateIntent.
UpdateKnowledgeBaseRequest
Request message for KnowledgeBases.UpdateKnowledgeBase.
UpdateParticipantRequest
The request message for Participants.UpdateParticipant.
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
UpdateSipTrunkRequest
The request message for SipTrunks.UpdateSipTrunk.
UpdateVersionRequest
The request message for Versions.UpdateVersion.
ValidationError
Represents a single validation error.
Severity
Represents a level of severity.
ValidationResult
Represents the output of agent validation.
Version
You can create multiple versions of your agent and publish them to separate environments.
When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent.
When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc.
For more information, see the versions and environments
guide <https://cloud.google.com/dialogflow/docs/agents-versions>
__.
VersionStatus
The status of a version.
VoiceSelectionParams
Description of which voice to use for speech synthesis.
WebhookRequest
The request message for a webhook call.
WebhookResponse
The response message for a webhook call.
This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use
{}
ornull
for empty objects - Use
[]
ornull
for empty arrays
For more information, see the Protocol Buffers Language
Guide <https://developers.google.com/protocol-buffers/docs/proto3#json>
__.
Modules
pagers
API documentation for dialogflow_v2.services.agents.pagers
module.
pagers
API documentation for dialogflow_v2.services.answer_records.pagers
module.
pagers
API documentation for dialogflow_v2.services.contexts.pagers
module.
pagers
API documentation for dialogflow_v2.services.conversation_datasets.pagers
module.
pagers
API documentation for dialogflow_v2.services.conversation_models.pagers
module.
pagers
API documentation for dialogflow_v2.services.conversation_profiles.pagers
module.
pagers
API documentation for dialogflow_v2.services.conversations.pagers
module.
pagers
API documentation for dialogflow_v2.services.documents.pagers
module.
pagers
API documentation for dialogflow_v2.services.entity_types.pagers
module.
pagers
API documentation for dialogflow_v2.services.environments.pagers
module.
pagers
API documentation for dialogflow_v2.services.generators.pagers
module.
pagers
API documentation for dialogflow_v2.services.intents.pagers
module.
pagers
API documentation for dialogflow_v2.services.knowledge_bases.pagers
module.
pagers
API documentation for dialogflow_v2.services.participants.pagers
module.
pagers
API documentation for dialogflow_v2.services.session_entity_types.pagers
module.
pagers
API documentation for dialogflow_v2.services.versions.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.agents.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.answer_records.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.contexts.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.conversation_profiles.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.conversations.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.documents.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.entity_types.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.environments.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.generators.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.intents.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.knowledge_bases.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.participants.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.session_entity_types.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.sip_trunks.pagers
module.
pagers
API documentation for dialogflow_v2beta1.services.versions.pagers
module.