endpoints of csi service
rpc CreateS2sPipeline (S2sPipeline) returns (.google.protobuf.Empty)Create the S2S pipeline specified in the request message. The pipeline with the specified ID must not exist.
Examples:
grpcurl -plaintext -d '{ "id": "pizza", "s2t_pipeline_id": "default_german", "nlu_project_id": "1f3425d2-41fd-4970-87e6-88e8e121bb49", "nlu_language_code": "de", "t2s_pipeline_id": "default_german" }' localhost:50051 ondewo.csi.Conversations.CreateS2sPipeline{}
rpc GetS2sPipeline (S2sPipelineId) returns (S2sPipeline)Retrieve the S2S pipeline with the ID specified in the request message.
Examples:
grpcurl -plaintext -d '{"id": "pizza"}' localhost:50051 ondewo.csi.Conversations.GetS2sPipeline{ "id": "pizza", "s2t_pipeline_id": "default_german", "nlu_project_id": "1f3425d2-41fd-4970-87e6-88e8e121bb49", "nlu_language_code": "de", "t2s_pipeline_id": "default_german" }
rpc UpdateS2sPipeline (S2sPipeline) returns (.google.protobuf.Empty)Update the S2S pipeline specified in the request message. The pipeline must exist.
Examples:
grpcurl -plaintext -d '{ "id": "pizza", "s2t_pipeline_id": "default_german", "nlu_project_id": "1f3425d2-41fd-4970-87e6-88e8e121bb49", "nlu_language_code": "en", "t2s_pipeline_id": "default_german" }' localhost:50051 ondewo.csi.Conversations.UpdateS2sPipeline{}
rpc DeleteS2sPipeline (S2sPipelineId) returns (.google.protobuf.Empty)Delete the S2S pipeline with the ID specified in the request message. The pipeline must exist.
Examples:
grpcurl -plaintext -d '{"id": "pizza"}' localhost:50051 ondewo.csi.Conversations.DeleteS2sPipeline{}
rpc ListS2sPipelines (ListS2sPipelinesRequest) returns (ListS2sPipelinesResponse)List all S2S pipelines of the server.
Examples:
grpcurl -plaintext localhost:50051 ondewo.csi.Conversations.ListS2sPipelines{ "pipelines": [ { "id": "pizza", "s2t_pipeline_id": "default_german", "nlu_project_id": "1f3425d2-41fd-4970-87e6-88e8e121bb49", "nlu_language_code": "de", "t2s_pipeline_id": "default_german" } ] }
rpc S2sStream (stream S2sStreamRequest) returns (stream S2sStreamResponse)Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result.
rpc CheckUpstreamHealth (.google.protobuf.Empty) returns (CheckUpstreamHealthResponse)Check the health of S2T, NLU and T2S servers
Examples:
grpcurl -plaintext localhost:50051 ondewo.csi.Conversations.CheckUpstreamHealthAll upstreams healthy: {} All upstreams unhealthy: { "s2t_status": { "code": 14, "message": "failed to connect to all addresses" }, "nlu_status": { "code": 14, "message": "failed to connect to all addresses" }, "t2s_status": { "code": 14, "message": "failed to connect to all addresses" } }
rpc GetControlStream (ControlStreamRequest) returns (stream ControlStreamResponse)Get the control stream to control sip, t2s, s2t etc. during a conversation
rpc SetControlStatus (SetControlStatusRequest) returns (SetControlStatusResponse)Send a message on the control stream to control sip, t2s, s2t etc. during a conversation
Health checks
Field | Type | Label | Description |
s2t_status | google.rpc.Status | Health checks for Speech-2-Text |
|
nlu_status | google.rpc.Status | Health checks for NLU |
|
t2s_status | google.rpc.Status | Health checks for Text-2-Speech |
A condition message with its type and value
A Condition can be of various types.
Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
immediate execution
{
"type": "immediate"
}
number of interactions of the user with the AI agent
{
"type": "interactions",
"value": “10”
}
number of seconds
{
"type": "duration",
"value": “3600”
}
at a specific date and time
{
"type": "datetime",
"value": "2021-12-23T13:45:00.000Z"
}
Field | Type | Label | Description |
type | ConditionType | Condition type |
|
value | string | Value of the condition. Examples of conditions values based on the condition type are given in the ConditionTypedocumentation |
A control message
Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
{
"service": "", // e.g. ondewo_s2t
"method": "", // e.g. update_config
"parameters": [
// primitive data types and JSON objects are possible
1,
1.0,
-2.0,
“string”,
true,
{
// parameter JSON object
},
{
// Condition start object
},
{
// Condition end object [optional]
},
]
}
Field | Type | Label | Description |
service | ControlMessageServiceName | Service to control. Valid service names are:'ondewo_nlu', 'ondewo_t2s', 'ondewo_s2t', 'ondewo_sip' and 'ondewo_csi' |
|
method | ControlMessageServiceMethod | Method to invoke on the service |
|
parameters | ControlMessageServiceParameters | Parameters to use to invoke the method of the service |
Parameters of the control message passed to the service specified in the control message
Field | Type | Label | Description |
t2s_config | ondewo.t2s.RequestConfig | Text-2-Speech: configuration to control the synthesis of a text into audio |
|
s2t_config | ondewo.s2t.TranscribeRequestConfig | Speech-2-Text: configuration to control the recognition of text based on human voice audio |
|
transfer_id | string | SIP: callee id to transfer call to |
|
wav_files | bytes | repeated | SIP: bytes of audio files to play to a caller |
text | string | text, e.g. for NLU detect intent response or Text-2-Speech voice synthesis |
|
context | ondewo.nlu.Context | NLU: context for creating, updating or deleting contextual information from a NLU session |
|
session_id | string | NLU: the session id of a NLU session |
|
context_name | string | NLU: the name of the context of a NLU session |
|
condition_start | Condition | CSI: the condition that defines when a control message should be executed |
|
condition_end | Condition | CSI: the condition that defines when a control message should stop its execution |
Control stream message
Control stream response message
Field | Type | Label | Description |
control_status | ControlStatus | Control status |
The top-level message sent by client to `ListS2sPipelines` endpoint. Currently without arguments.
TODO: add filtering options
The top-level message received from `ListS2sPipelines` endpoint.
Field | Type | Label | Description |
pipelines | S2sPipeline | repeated | Collection of S2S pipelines of the server. |
The top-level message sent by client to `CreateS2sPipeline` and `UpdateS2sPipeline` endpoints and received from
`GetS2sPipeline` endpoint.
Field | Type | Label | Description |
id | string | Required. CSI pipeline identifier consisting of S2T, NLU and T2S configuration. ID can be any non-empty string. |
|
s2t_pipeline_id | string | Required. S2T pipeline ID, e.g. "german_general" |
|
nlu_project_id | string | Required. NLU project ID, usually a hash, e.g. "ae33586b-x2s2-494a-aa73-1af0589cfc56". |
|
nlu_language_code | string | Required. Language code present in the corresponding NLU project, e.g. "de". |
|
t2s_pipeline_id | string | Required. T2S pipeline ID, e.g. "kerstin". |
The top-level message sent by client to `GetS2sPipeline` and `DeleteS2sPipeline` endpoints.
Field | Type | Label | Description |
id | string | Required. CSI pipeline identifier. |
The top-level message sent by the client to the
`S2sStream` method.
Multiple request messages should be sent in order:
1. The first message must contain `pipeline_id` and can contain `session_id` or `initial_intent_display_name`.
The message must not contain `audio` nor `end_of_stream`.
2. All subsequent messages must contain `audio`. If `end_of_stream` is `true`, the stream is closed.
Field | Type | Label | Description |
pipeline_id | string | Optional. The CSI pipeline ID specified in the initial request. |
|
session_id | string | Optional. The session or call ID specified in the initial request. It’s up to the API caller to choose an appropriate string. It can be a random number or some type of user identifier (preferably hashed). |
|
audio | bytes | If `true`, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. |
|
end_of_stream | bool |
|
|
initial_intent_display_name | string | Optional. Intent display name to trigger in NLU system in the beginning of the conversation. |
The top-level message returned from the
`S2sStream` method.
A response message is returned for each utterance of the input stream. It contains the full response from NLU system
in `detect_intent_response` or the full T2S response in `synthesize_response`.
Multiple response messages can be returned in order:
1. The first response message for an input utterance contains response from NLU system `detect_intent_response`
with detected intent and N fulfillment messages (N >= 0).
2. The next N response messages contain for each fulfillment message one of the following:
a. T2S response `synthesize_response` with synthesized audio
b. SIP trigger message `sip_trigger` with SIP trigger extracted from the fulfillment message
Field | Type | Label | Description |
detect_intent_response | ondewo.nlu.DetectIntentResponse | full NLU detect intent response |
|
synthesize_response | ondewo.t2s.SynthesizeResponse | full T2S synthesize response |
|
sip_trigger | SipTrigger | SIP trigger message |
Request to set control status
Field | Type | Label | Description |
control_status | ControlStatus | Control status |
Response of setting the control status with the old and new status objects
Field | Type | Label | Description |
old_control_status | ControlStatus | Previous 'old' control status |
|
new_control_status | ControlStatus | Current 'new' control status |
SIP trigger message
Field | Type | Label | Description |
type | SipTrigger.SipTriggerType |
|
|
content | google.protobuf.Struct | extra parameters for the trigger |
Type of condition that need to be satisfied to execute a control message
Name | Number | Description |
UNKNOWTYPE | 0 | Unknown type |
immediate | 1 | Immediate execution of the control message Example value need be given as a string in the format:
|
duration | 2 | Duration in number of seconds after a control message should be executed, Example value need be given as a string in the format:
|
datetime | 3 | Date and time when a control message should be executed, Example value need be given as a string in the format:
|
interactions | 4 | Number of interactions of the user with an ONDEWO AI agent after a control message should be executed Example value need be given as a string in the format:
|
Control message methods to control services during a conversation
Name | Number | Description |
UNKNOWNMETHOD | 0 | Unknown method (default) |
update_config | 1 | CSI: update configuration Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
undo_config | 2 | CSI: undo previous configuration update Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
reset_config | 3 | CSI: reset configuration to default Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
end_call | 4 | SIP: end conversation / hang up call Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
transfer_call | 5 | SIP: transfer call Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
play_wav_files | 6 | SIP: play wav files on the call Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
play_text | 7 | SIP: play a certain text on the phone based on Text-2-Speech synthesis Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
mute | 8 | SIP: mute microphone Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
un_mute | 9 | SIP: unmute microphone Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
stop_all_control_messages | 10 | CSI: stop the execution of all running and scheduled control messages Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
train_agent | 11 | NLU: train agent Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
cancel_train_agent | 12 | NLU: cancel the ongoing agent Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
delete_session | 13 | NLU: delete session all all session-related information Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
delete_all_contexts | 14 | NLU: delete all context information in the current session Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
create_context | 15 | NLU: create a context based on the provided contextual information in the current session Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
update_context | 16 | NLU: update an existing context based on the provided contextual information in the current session Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
delete_context | 17 | NLU: delete an existing context including all contextual information in the current session Example of a JSON how to invoke a control message via ONDEWO RABBITMQ service:
|
detect_intent | 18 | NLU: execute a detect intent request based on the provided information in the current session { "service": "ondewo_nlu", "method": "detect_intent", "parameters": [ { "session_id": "97ea1a20-0784-442b-93c0-eb9e2469420e", "text": "Are you an artificial intelligence?", }, { // condition_start object }, { // condition_end object (OPTIONAL) - for permanent change // no condition_end needs to be supplied i.e. // this parameter is missing or empty “{}” }, ] } |
Control message services
Name | Number | Description |
UNKNOWNNAME | 0 | Unknown control message service name |
ondewo_s2t | 1 | Speech-2-Text control message service name |
ondewo_t2s | 2 | Text-2-Speech control message service name |
ondewo_nlu | 3 | NLU control message service name |
ondewo_sip | 4 | SIP control message service name |
Control status
Name | Number | Description |
OK | 0 | Status that control stream is ok |
EMERGENCY_STOP | 1 | Status that control stream needs to stop immediately |
type of the SIP trigger
Name | Number | Description |
UNSPECIFIED | 0 | should never be used |
HANGUP | 1 | hard hangup |
HUMAN_HANDOVER | 2 | handover to human |
SEND_NOW | 3 | send now |
PAUSE | 4 | pause |
File-level comment for ondewo/nlu/agent.proto
.
This file contains a single service Agents.
The most important messages is Agent and its most complicated field is configs
.
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.
After you create an agent, you can add [Intents][google.cloud.dialogflow.v2.Intents], [Contexts][google.cloud.dialogflow.v2.Contexts], [Entity Types][google.cloud.dialogflow.v2.EntityTypes], [Webhooks][google.cloud.dialogflow.v2.WebhookRequest], and so on to manage the flow of a conversation and match user input to predefined intents and actions.
You can create an agent using both Dialogflow Standard Edition and Dialogflow Enterprise Edition. For details, see [Dialogflow Editions](/dialogflow-enterprise/docs/editions).
You can save your agent for backup or versioning by exporting the agent by using the [ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent] method. You can import a saved agent by using the [ImportAgent][google.cloud.dialogflow.v2.Agents.ImportAgent] method.
Dialogflow provides several [prebuilt agents](https://dialogflow.com/docs/prebuilt-agents) for common conversation scenarios such as determining a date and time, converting currency, and so on.
For more information about agents, see the [Dialogflow documentation](https://dialogflow.com/docs/agents).
rpc CreateAgent (CreateAgentRequest) returns (Agent)Creates the specified agent.
Examples:
grpcurl -plaintext -H 'cai-token: aimp' -d '{ "agent": { "display_name": "My Pizza Bot", "default_language_code": "en", "supported_language_codes": ["en"], "time_zone": "Europe/Vienna", "nlu_platform": "ONDEWO" } }' localhost:50055 ondewo.nlu.Agents.CreateAgent{ "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot", "default_language_code": "en", "supported_language_codes": [ "en" ], "time_zone": "Europe/Vienna", "nlu_platform": "ONDEWO", "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }
rpc UpdateAgent (UpdateAgentRequest) returns (Agent)Updates the specified agent.
Examples:
grpcurl -plaintext -H 'cai-token: aimp' -d '{ "agent": { "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "supported_language_codes": ["en", "de"] }, "update_mask": { "paths": [ "agent.display_name", "agent.supported_language_codes" ] } }' localhost:50055 ondewo.nlu.Agents.UpdateAgent{ "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "default_language_code": "en", "supported_language_codes": [ "en", "de" ], "time_zone": "Europe/Vienna", "nlu_platform": "ONDEWO", "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }
rpc GetAgent (GetAgentRequest) returns (Agent)Retrieves the specified agent.
Examples:
grpcurl -plaintext -H 'cai-token: aimp' -d '{ "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent" }' localhost:50055 ondewo.nlu.Agents.GetAgent{ "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "default_language_code": "en", "supported_language_codes": [ "en", "de" ], "time_zone": "Europe/Vienna", "nlu_platform": "ONDEWO", "configs": {...}, "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }
rpc DeleteAgent (DeleteAgentRequest) returns (.google.protobuf.Empty)Deletes the specified agent.
Examples:
grpcurl -plaintext -H 'cai-token: aimp' -d '{ "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent" }' localhost:50055 ondewo.nlu.Agents.DeleteAgent{}
rpc DeleteAllAgents (.google.protobuf.Empty) returns (.google.protobuf.Empty)Deletes all agents in the server (for development purposes only).
Examples:
grpcurl -plaintext -H 'cai-token: aimp' localhost:50055 ondewo.nlu.Agents.DeleteAllAgents{}
rpc ListAgents (ListAgentsRequest) returns (ListAgentsResponse)Lists agents in the server associated to the current user
Examples:
grpcurl -plaintext -H 'cai-token: aimp' localhost:50055 ondewo.nlu.Agents.ListAgents{ "agents_with_owners": [ { "agent": { "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }, "owner": { "user_id": "5aac51b8-668f-49dd-913f-cc683e56af34", "display_name": "admin", "server_role_id": 3, "user_email": "admin@ondewo.com" } } ], "next_page_token": "current_index-1" }
rpc ListAgentsOfUser (ListAgentsRequest) returns (ListAgentsOfUserResponse)Lists agents in the server associated to the given user
Examples:
grpcurl -plaintext -H 'cai-token: aimp' localhost:50055 ondewo.nlu.Agents.ListAgentsOfUser{ "agents_of_user_with_owners": [ { "agent_with_owner": { "agent": { "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }, "owner": { "user_id": "5aac51b8-668f-49dd-913f-cc683e56af34", "display_name": "admin", "server_role_id": 3, "user_email": "admin@ondewo.com" } }, "project_role": { "role_id": 4, "name": "ADMIN" } } ], "next_page_token": "current_index-1" }
rpc ListAllAgents (ListAgentsRequest) returns (ListAgentsResponse)Lists all agents in the server
Examples:
grpcurl -plaintext -H 'cai-token: aimp' localhost:50055 ondewo.nlu.Agents.ListAllAgents{ "agents_with_owners": [ { "agent": { "parent": "projects/76aaf4f3-a1f6-4fda-b4b3-351c64e65bc4/agent", "display_name": "Pizza Bot 2", "owner_id": "5aac51b8-668f-49dd-913f-cc683e56af34" }, "owner": { "user_id": "5aac51b8-668f-49dd-913f-cc683e56af34", "display_name": "admin", "server_role_id": 3, "user_email": "admin@ondewo.com" } } ], "next_page_token": "current_index-1" }
rpc AddUserToProject (AddUserToProjectRequest) returns (.google.protobuf.Empty)Adds a user with specified id to the project (agent)
rpc RemoveUserFromProject (RemoveUserFromProjectRequest) returns (.google.protobuf.Empty)Removes a user with specified id from the project (agent)
rpc ListUsersInProject (ListUsersInProjectRequest) returns (ListUsersInProjectResponse)Lists users in the project (agent)
rpc GetPlatformInfo (.google.protobuf.Empty) returns (GetPlatformInfoResponse)Gets information from the platform
rpc ListProjectPermissions (ListProjectPermissionsRequest) returns (ListProjectPermissionsResponse)List permissions from the project (agent)
rpc TrainAgent (TrainAgentRequest) returns (Operation)Trains the specified agent. Operation
rpc BuildCache (BuildCacheRequest) returns (Operation)Builds cache for the specified agent. Operation
rpc ExportAgent (ExportAgentRequest) returns (Operation)Exports the specified agent to a ZIP file. Operation
rpc ExportBenchmarkAgent (ExportBenchmarkAgentRequest) returns (Operation)Exports the specified train agent to a ZIP file after train-test split, returns the test TrainingPhrase list.
rpc ImportAgent (ImportAgentRequest) returns (Operation)Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation
rpc OptimizeRankingMatch (OptimizeRankingMatchRequest) returns (Operation)Runs optimize ranking match
rpc RestoreAgent (RestoreAgentRequest) returns (Operation)Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation
rpc GetAgentStatistics (GetAgentStatisticsRequest) returns (GetAgentStatisticsResponse)Gets statistics for the agent
rpc GetSessionsStatistics (GetSessionsStatisticsRequest) returns (GetSessionsStatisticsResponse)
rpc SetAgentStatus (SetAgentStatusRequest) returns (Agent)Sets status for the agent
rpc SetResources (SetResourcesRequest) returns (.google.protobuf.Empty)Sets resources
rpc DeleteResources (DeleteResourcesRequest) returns (.google.protobuf.Empty)Deletes resources
rpc ExportResources (ExportResourcesRequest) returns (ExportResourcesResponse)Exports resources
rpc GetModelStatuses (GetModelStatusesRequest) returns (GetModelStatusesResponse)Get statuses of models related to project
rpc GetPlatformMapping (GetPlatformMappingRequest) returns (PlatformMapping)Get all set platform name mappings for an Agent
rpc SetPlatformMapping (PlatformMapping) returns (PlatformMapping)Set platform name mappings for an Agent
rpc GetFullTextSearchEntityType (FullTextSearchRequest) returns (FullTextSearchResponseEntityType)Full text search endpoint in entity types
rpc GetFullTextSearchEntity (FullTextSearchRequest) returns (FullTextSearchResponseEntity)Full text search endpoint in entities
rpc GetFullTextSearchEntitySynonym (FullTextSearchRequest) returns (FullTextSearchResponseEntitySynonym)Full text search endpoint in entity synonyms
rpc GetFullTextSearchIntent (FullTextSearchRequest) returns (FullTextSearchResponseIntent)Full text search endpoint in intents
rpc GetFullTextSearchIntentContextIn (FullTextSearchRequest) returns (FullTextSearchResponseIntentContextIn)Full text search endpoint in context ins of intents
rpc GetFullTextSearchIntentContextOut (FullTextSearchRequest) returns (FullTextSearchResponseIntentContextOut)Full text search endpoint in context outs of intents
rpc GetFullTextSearchIntentUsersays (FullTextSearchRequest) returns (FullTextSearchResponseIntentUsersays)Full text search endpoint in user says of intents
rpc GetFullTextSearchIntentTags (FullTextSearchRequest) returns (FullTextSearchResponseIntentTags)Full text search endpoint in tags of intents
rpc GetFullTextSearchIntentResponse (FullTextSearchRequest) returns (FullTextSearchResponseIntentResponse)Full text search endpoint in responses of intents
rpc GetFullTextSearchIntentParameters (FullTextSearchRequest) returns (FullTextSearchResponseIntentParameters)Full text search endpoint in parameters of intents
rpc ReindexAgent (ReindexAgentRequest) returns (Operation)Force reindexing Intent and Entity data of Agent
rpc CreateCcaiProject (CreateCcaiProjectRequest) returns (CreateCcaiProjectResponse)RPC to create a new CCAI project
rpc DeleteCcaiProject (DeleteCcaiProjectRequest) returns (DeleteCcaiProjectResponse)RPC to delete an existing CCAI project
rpc GetCcaiProject (GetCcaiProjectRequest) returns (CcaiProject)RPC to get details of an existing CCAI project
rpc ListCcaiProjects (ListCcaiProjectsRequest) returns (ListCcaiProjectsResponse)RPC to list all available CCAI projects
rpc UpdateCcaiProject (UpdateCcaiProjectRequest) returns (UpdateCcaiProjectResponse)RPC to update an existing CCAI project
Method Name | Method | Pattern | Body |
CreateAgent | POST | /v2/projects | * |
UpdateAgent | PATCH | /v2/{agent.parent=projects/*/agent} | * |
GetAgent | GET | /v2/{parent=projects/*/agent} | |
DeleteAgent | DELETE | /v2/{parent=projects/*/agent} | |
DeleteAllAgents | DELETE | /v2/projects | |
ListAgents | GET | /v2/projects | |
ListAgentsOfUser | GET | /v2/projects | |
ListAllAgents | GET | /v2/projects:all | |
AddUserToProject | POST | /v2/{parent=projects/*/agent}/users/{user_id=*} | * |
RemoveUserFromProject | DELETE | /v2/{parent=projects/*/agent}/users/{user_id=*} | |
ListUsersInProject | GET | /v2/{parent=projects/*/agent}/users | |
GetPlatformInfo | GET | /v2/version | |
ListProjectPermissions | GET | /v2/project_permissions | |
TrainAgent | POST | /v2/{parent=projects/*/agent}:train | * |
BuildCache | POST | /v2/{parent=projects/*/agent}:build_cache | * |
ExportAgent | POST | /v2/{parent=projects/*/agent}:export | * |
ExportBenchmarkAgent | POST | /v2/{parent=projects/*/agent}:export_benchmark | * |
ImportAgent | POST | /v2/{parent=projects/*/agent}:import | * |
OptimizeRankingMatch | POST | /v2/{parent=projects/*/agent}:optimize_ranking_match | * |
RestoreAgent | POST | /v2/{parent=projects/*/agent}:restore | * |
GetAgentStatistics | GET | /v2/{parent=projects/*/agent}:statistics | |
GetSessionsStatistics | GET | /v2/{parent=projects/*/agent}:session_statistics | |
SetAgentStatus | POST | /v2/{parent=projects/*/agent}:status | * |
SetResources | POST | /v2/{parent=projects/*/agent}:resources | * |
DeleteResources | DELETE | /v2/{parent=projects/*/agent}:resources | |
ExportResources | POST | /v2/{parent=projects/*/agent}:resources | * |
Request to add user to project.
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
user_id | string | id of the user |
|
project_role_id | uint32 | ID of the project role of the user |
Project/Agent messages
Field | Type | Label | Description |
parent | string | Required. The project of this agent. Format:
Read-only in the Agent message |
|
display_name | string | Required. The name of this agent. |
|
default_language_code | string | Required. The default language of the agent as a language tag. See [Language Support](https://dialogflow.com/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. |
|
supported_language_codes | string | repeated | Optional. The list of all languages supported by this agent (except for the `default_language_code`). |
time_zone | string | Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. |
|
nlu_platform | string | Required. Specifies the format of the agent data. |
|
configs | google.protobuf.Struct | Optional. Agent configuration as OndewoConfig converted to Struct format. |
|
owner_id | string | Optional. User id of the project owner. If empty, in CreateAgent call it is set to user id in the call metadata. Read-only in the Agent message |
|
status | AgentStatus | Optional. Status of the agent Read-only in the Agent message |
|
description | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message contains the agent of user with owner
Field | Type | Label | Description |
agent_with_owner | AgentWithOwner | Required. Agent message and User message of its owner. |
|
project_role | ProjectRole | Required. The role of the user in the project in SHALLOW view (only ID and name fields are populated) |
Sorting order of agent
Field | Type | Label | Description |
sorting_field | AgentSorting.AgentSortingField | sorting field for agent sorting |
|
sorting_mode | SortingMode | Sorting mode |
This message contains the agent with owner
Field | Type | Label | Description |
agent | Agent | The agent |
|
owner | User | User who created the agent |
The request message for [Agents.TrainAgentBuildCache][google.cloud.dialogflow.v2.Agents.BuildCache].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to build cache is associated with. Format: |
|
branch | string | Name of the branch of the agent for versioning. The default branch name is |
Request to create an agent
Field | Type | Label | Description |
agent | Agent | The agent |
|
agent_view | AgentView | Optional. Specify the view of the returned agent (sparse view by default) |
This message contains the information of custom platform
Field | Type | Label | Description |
platform | Intent.Message.Platform | Required. ID of the Platform. Custom Intent.Message.Platform placeholder. Note: it will not work with non-placeholders values |
|
display_name | string | Required. Name to be displayed. |
|
position | uint32 | Optional. Sorting position of the GetPlatformMappingRequest. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Request to delete the agent
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
Request to delete resources
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
name | string |
|
|
type | string |
|
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to export is associated with. Format: |
|
agent_uri | string | Optional. The Google Cloud Storage URI to export the agent to. Note: The URI must start with "gs://". If left unspecified, the serialized agent is returned inline. |
|
compression_level | int32 | Optional. The compression level of the zip file created. Valid range 1-9; the grpc-default value 0 will be mapped to 1, other values cause an error in the request validation handler. |
The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].
Field | Type | Label | Description |
agent_uri | string | The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. |
|
agent_content | bytes | The exported agent.
Example for how to export an agent to a zip file via a command line:
curl \
'https://dialogflow.googleapis.com/v2/projects/ |
Request to export benchmark agent
Field | Type | Label | Description |
parent | string | Agent related info Required. The project that the agent to export is associated with. Format: |
|
compression_level | int32 | Optional. The compression level of the zip file created. Valid range 1-9; the grpc-default value 0 will be mapped to 1, other values cause an error in the request validation handler. |
|
test_size | float | Train-test split related parameters, for further info, check https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html default values come from API definition above Optional: bigger than zero |
|
train_size | float | Optional: bigger than zero |
|
random_state | int32 | Optional: random seed |
Response to export benchmark agent
Field | Type | Label | Description |
agent_content | bytes | Agent responses as zip file |
|
training_phrases | ExportBenchmarkAgentResponse.TrainingPhrasesEntry | repeated | Key is the language code, value is the corresponding ListTrainingPhrasesResponse |
Field | Type | Label | Description |
key | string |
|
|
value | ListTrainingPhrasesResponse |
|
Request to export resources
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
name | string |
|
|
type | string |
|
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
Response to export resources
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
name | string |
|
|
type | string |
|
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
resource_file | bytes |
|
This message is a request to run full text search
Field | Type | Label | Description |
parent | string | Required. The project that the agent is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
term | string | What to search for in the elastic server |
|
page_token | string | Composite string: current_index-0--page_size-10 The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
This message is a response of full text search of entity
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
entity_results | FullTextSearchResponseEntity.EntitySearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
display_name | string |
|
|
entity_type_name | string |
|
|
entity_type_display_name | string |
|
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of synonym entity
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
entity_synonym_results | FullTextSearchResponseEntitySynonym.EntitySynonymSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
display_name | string |
|
|
entity_type_name | string |
|
|
entity_type_display_name | string |
|
|
entity_name | string |
|
|
entity_display_name | string |
|
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of entity type
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
entity_type_results | FullTextSearchResponseEntityType.EntityTypeSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
display_name | string |
|
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_results | FullTextSearchResponseIntent.IntentSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
display_name | string |
|
|
domain_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent with context in
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_context_in_results | FullTextSearchResponseIntentContextIn.IntentContextInSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent with context out
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_context_out_results | FullTextSearchResponseIntentContextOut.IntentContextOutSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent with parameters
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_parameters_results | FullTextSearchResponseIntentParameters.IntentParametersSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
parameter_name | string |
|
|
parameter_display_name | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent response
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_response_results | FullTextSearchResponseIntentResponse.IntentResponseSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
Field | Type | Label | Description |
text | string |
|
|
platform | string |
|
|
response_type | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent with tags
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_tags_results | FullTextSearchResponseIntentTags.IntentTagsSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
text | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a response of full text search of intent with sentence
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
intent_usersays_results | FullTextSearchResponseIntentUsersays.IntentUsersaysSearchResult | repeated |
|
term | string |
|
|
elastic_query | string |
|
|
time | float |
|
|
next_page_token | string | The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2 |
Field | Type | Label | Description |
name | string |
|
|
text | string |
|
|
text_as_entity_types | string |
|
|
text_as_entity_values | string |
|
|
type | string |
|
|
intent_name | string |
|
|
intent_display_name | string |
|
|
tags | string | repeated |
|
language | string |
|
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
The request message for [Agents.GetAgent][google.cloud.dialogflow.v2.Agents.GetAgent].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
agent_view | AgentView | Optional. Specify the view of the returned agent (full view by default) |
Request statistics of the agent
Field | Type | Label | Description |
parent | string | Required. The project to get statistics from. Format: |
|
format | ReportFormat | File formats for reports |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru the language to calculate statistics about |
|
type | ReportType | Type of reports about the domain of the agent |
Response to get statistics of the agent
Field | Type | Label | Description |
reports | bytes | Statistic info. |
|
format | ReportFormat | File formats for reports |
|
type | ReportType | Type of reports about the domain of the agent |
Request to get model statuses
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
cache_version | int32 |
|
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
model_name | string |
|
Response to get model statuses
Field | Type | Label | Description |
model_statuses | ModelStatus | repeated |
|
GIT information about the version of the server
Field | Type | Label | Description |
version | string | version of the server build |
|
commit_hash | string | git commit hash of the server build |
Request to get platform mapping
Field | Type | Label | Description |
parent | string | Required. The project that the agent is associated with. Format: |
Request of the report of the statistics about sessions
Field | Type | Label | Description |
parent | string | Required. The project to get statistics from. Format: |
|
format | ReportFormat | File formats for reports |
|
type | SessionsReportType | Type of reports about the domain of the agent |
|
session_filter | SessionFilter | Optional. A filter to narrow reports based on sessions |
|
context_filters | ContextFilter | repeated | Optional. A filter to narrow reports based on contextual information (Coming soon! Not yet implemented) |
limit | int32 | Optional. limit the returned number of results |
|
group_bys | string | repeated | Optional. Grouping based on named properties |
order_bys | string | repeated | Optional. Order based on named properties |
field_mask | google.protobuf.FieldMask | Optional. The mask to control which data fields will be added to the returned data. Example: paths=["duration_in_s_min", "id", "session_id", "project_id"] |
|
sql_query | string | SQL Query - only usable with specific SessionsReportType such as SessionsReportType.SESSION_SQL_QUERY |
Report of the statistics about sessions
Field | Type | Label | Description |
reports | bytes | Statistic info. |
|
format | ReportFormat | File formats for reports |
|
type | SessionsReportType | Type of reports about the domain of the agent |
The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2.Agents.ImportAgent].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to import is associated with. Format: |
|
agent_uri | string | The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". |
|
agent_content | bytes | The agent to import.
Example for how to import an agent via the command line:
curl \
'https://dialogflow.googleapis.com/v2/projects/ |
Get list of agents of user
Field | Type | Label | Description |
agents_of_user_with_owners | AgentOfUserWithOwner | repeated | The list of agents with their owners of the given user. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
Request to get the list of agents
Field | Type | Label | Description |
agent_view | AgentView | Optional. Specify the view of the returned agent (full view by default) |
|
page_token | string | Optional. The next_page_token value returned from a previous list request. |
|
sort_by_field | AgentSorting | Optional. Defines the sorting of the list. Default, no sorting. |
Get list of agents
Field | Type | Label | Description |
agents_with_owners | AgentWithOwner | repeated | The list of agent and their owners. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
Project permissions
Field | Type | Label | Description |
page_token | string | Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
List project permissions
Field | Type | Label | Description |
permissions | string | repeated | The list of project permissions. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
Request to list users in the project
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
page_token | string | Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
List the users in a project
Field | Type | Label | Description |
users | UserInProject | repeated | The list of users in a project. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
Status of model
Field | Type | Label | Description |
cache_version | int32 | Cache version that contains the correspondent model |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
model_name | string | The model name |
|
status_set_time | google.protobuf.Timestamp |
|
|
config | string |
|
|
status | ModelStatus.StatusName |
|
This message is a request to run Optimize Ranking Match
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
language_codes | string | repeated | languages that should be optimized |
optimization_configs | RankingMatchOptimizationConfig | repeated | optimization config will contain all possible optimizations, with which we will come up in the future |
in_place | bool | if in_place is true then the config of the agent on the server will be updated, if False then config with optimized thresholds will be returned but not updated on the server |
This message is a response of Optimize Ranking Match
Field | Type | Label | Description |
optimization_info | google.protobuf.Struct | info about optimization |
|
optimized_ondewo_config | google.protobuf.Struct | the optimized configuration of the ondewo agent e.g., optimized parameters |
This message contains the mapping of platform
Field | Type | Label | Description |
parent | string | Required. The project that the agent is associated with. Format: |
|
platform_info | CustomPlatformInfo | repeated | Required. If not set, it will set it empty. |
This message contains the configuration to run Optimize Ranking Match
Field | Type | Label | Description |
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
n_splits | int32 | number of splits for optimization |
|
random_seed | int32 | random seed number for defining the split of train and test of training phrases for optimization |
|
initial_thresholds | google.protobuf.Struct | initial thresholds are optional, if not given will be taken from the current config example {'OndewoIntentSimilarityMatch': 0.59, 'OndewoIntentNamedSimilarityMatch': 0.39} |
This message is a request to reindex agent
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
branch_name | string | Optional, useful for versioning reasons of the agent data |
|
index_types | FullTextSearchRequest.QueryType | repeated | Optional, useful for reindexing specific indices in the future |
Request to remove user from the project.
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
user_id | string | id of the user |
The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2.Agents.RestoreAgent].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to restore is associated with. Format: |
|
agent_uri | string | The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". |
|
agent_content | bytes | The agent to restore.
Example for how to restore an agent via the command line:
curl \
'https://dialogflow.googleapis.com/v2/projects/ |
Request to set status of the agent
Field | Type | Label | Description |
parent | string | Required. The project of which to set the status. Format: |
|
status | AgentStatus | Required. Status of the agent |
|
agent_view | AgentView | Optional. View of the returned agent |
Request to set resources
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
name | string |
|
|
type | string |
|
|
resource_file | bytes |
|
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent].
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
branch | string | Name of the branch of the agent for versioning. The default branch name is |
|
initiation_protocol | InitiationProtocol | Defines when to initiate newly created agent when training started |
Request to update the agent
Field | Type | Label | Description |
agent | Agent | The agent |
|
agent_view | AgentView | Optional. Specify the view of the returned agent (sparse view by default) |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
Request to get user in project
Field | Type | Label | Description |
parent | string | Required. The project that the agent to train is associated with. Format: |
|
user | User | User object |
|
role_id | uint32 | ID of the project role of the user |
Sorting field
Name | Number | Description |
NO_AGENT_SORTING | 0 | no sorting |
SORT_AGENT_BY_NAME | 1 | sorting by name |
SORT_AGENT_BY_CREATION_DATE | 2 | sorting by creation date |
SORT_AGENT_BY_LAST_UPDATED | 3 | sorting by last updated date |
SORT_AGENT_BY_OWNER_NAME | 4 | sorting by owner, i.e. user who owns the agent which is usually the creator of the agent |
Type of Agent / Project status
Name | Number | Description |
ACTIVE | 0 | If project is active, all its endpoints are active |
INACTIVE | 1 | If project is inactive: * members of the project do not see the project anymore except users with project role "PROJECT_ADMIN" and users with server role "SERVER_ADMIN" * nothing is allowed (no endpoint) on the project except "SetAgentStatus" by PROJECT_ADMIN or SERVER_ADMIN |
Structure of agent view
Name | Number | Description |
AGENT_VIEW_UNSPECIFIED | 0 | Unspecified agent view: the view is defined by the call: - CreateAgent: AGENT_VIEW_SHALLOW - UpdateAgent: AGENT_VIEW_SHALLOW - GetAgent: AGENT_VIEW_FULL - ListAgents: AGENT_VIEW_SHALLOW |
AGENT_VIEW_FULL | 1 | Full agent view: populate all the fields of the Agent message including configs. |
AGENT_VIEW_SHALLOW | 2 | Shallow agent view: populates all the fields except configs. |
AGENT_VIEW_MINIMUM | 3 | Minimum view including only agent UUID and agent display name |
Type of query
Name | Number | Description |
ALL | 0 | just a placeholder, has to start with zero |
OndewoEntityQuery | 1 | |
OndewoEntityTypeQuery | 2 | |
OndewoEntitySynonymQuery | 3 | |
OndewoIntentQuery | 4 | |
OndewoIntentContextInQuery | 5 | |
OndewoIntentContextOutQuery | 6 | |
OndewoIntentUsersaysQuery | 7 | |
OndewoIntentTagsQuery | 8 | |
OndewoIntentParametersQuery | 9 | |
OndewoIntentResponseQuery | 10 |
Defines when to initiate newly created agent when training started
Name | Number | Description |
AS_SOON_AS_POSSIBLE | 0 | after cache successfully built and after each model trained the agent will be updated |
WHEN_TRAINED | 1 | after cache successfully built and all the active models successfully trained |
NEVER | 2 | do not initiate |
Name | Number | Description |
UNKNOWN | 0 | |
INITIALIZING | 1 | |
INITIALIZED | 2 | |
LOADING_DATA | 3 | |
TRAINING | 4 | |
TESTING | 5 | |
TRAINED | 6 |
File formats for reports
Name | Number | Description |
CSV | 0 | CSV (comma separated values) file format |
HTML | 1 | HTML file format |
JSON | 2 | JSON file format |
Type of reports about the domain of the agent
Name | Number | Description |
ALL | 0 | will return all reports as files of specified format compressed into a single zipfile |
INTENT_PER_LANGUAGE | 1 | statistics of the language specific part of the intent database |
ENTITY_PER_LANGUAGE | 2 | statistics of the language specific part of the entity database |
ENTITY_COLLISION | 3 | report on collision of the entity synonyms |
INTENT_GENERAL | 4 | report of statistics of the general (relevant to all supported languages) part of intent database |
Type of reports about the domain of the agent
Name | Number | Description |
SESSIONS | 0 | report on sessions. Supports SessionFilter to filter |
SESSION_STEPS | 1 | report on session steps. Supports SessionFilter to filter |
SESSION_TOP_X_INTENTS | 2 | report top x detected intents in session. Supports SessionFilter to filter |
SESSION_TOP_X_ENTITY_TYPES | 3 | report top x detected entity types. Supports SessionFilter to filter |
SESSION_TOP_X_ENTITY_VALUES | 4 | report top x detected entity values Supports SessionFilter to filter |
SESSION_TOP_X_USERS | 5 | report top x users. Supports SessionFilter to filter (Coming soon! Not yet implemented) |
SESSION_TOP_X_LABELS | 6 | report top x labels. Supports SessionFilter to filter |
SESSION_TOP_X_TAGS | 7 | report top x tags. Supports SessionFilter to filter |
SESSION_TOP_X_PHONE_NUMBERS | 8 | report top x phone_numbers. Supports SessionFilter to filter (Coming soon! Not yet implemented) |
SESSION_HUMAN_HANDOVERS | 9 | report on human handovers. Supports SessionFilter to filter (Coming soon! Not yet implemented) |
SESSION_SQL_QUERY | 10 | report based on a query issued tables with session information.
Requires to define |
SESSION_LEAST_X_INTENTS | 11 | report least x detected intents in session. Supports SessionFilter to filter |
SESSION_LEAST_X_ENTITY_TYPES | 12 | report least x detected entity types. Supports SessionFilter to filter |
SESSION_LEAST_X_ENTITY_VALUES | 13 | report least x detected entity values Supports SessionFilter to filter |
SESSION_LEAST_X_USERS | 14 | report least x users. Supports SessionFilter to filter (Coming soon! Not yet implemented) |
SESSION_LEAST_X_LABELS | 15 | report least x labels. Supports SessionFilter to filter |
SESSION_LEAST_X_TAGS | 16 | report least x tags. Supports SessionFilter to filter |
TOTAL_STATISTICS | 17 | report total numbers of e.g. sessions, session steps, etc. |
The Central class defining the ondewo ai services
rpc ExtractEntities (ExtractEntitiesRequest) returns (ExtractEntitiesResponse)Processes a natural language query and returns detected entities
rpc GenerateUserSays (GenerateUserSaysRequest) returns (GenerateUserSaysResponse)Generates a list of training phrases
rpc GenerateResponses (GenerateResponsesRequest) returns (GenerateResponsesResponse)Generate responses from all intents using synonyms
rpc GetAlternativeSentences (GetAlternativeSentencesRequest) returns (GetAlternativeSentencesResponse)Generates alternative phrase based on original phrase
rpc GetAlternativeTrainingPhrases (GetAlternativeTrainingPhrasesRequest) returns (GetAlternativeTrainingPhrasesResponse)Generates alternative training phrase based on original training phrase
rpc GetSynonyms (GetSynonymsRequest) returns (GetSynonymsResponse)Generates synonyms for a certain word
rpc ClassifyIntents (ClassifyIntentsRequest) returns (ClassifyIntentsResponse)Preprocess text and detects intents in a sentence
rpc ExtractEntitiesFuzzy (ExtractEntitiesFuzzyRequest) returns (ExtractEntitiesResponse)Processes a natural language query and returns detected entities
Method Name | Method | Pattern | Body |
ExtractEntities | POST | /v2/{parent=projects/*/agent}/entities:extract | * |
GenerateUserSays | POST | /v2/{parent=projects/*/agent}/generate_user_says | * |
GenerateResponses | POST | /v2/{parent=projects/*/agent}/generate_responses | * |
GetAlternativeSentences | POST | /v2/{parent=projects/*/agent}/get_alternative:sentence | * |
GetAlternativeTrainingPhrases | POST | /v2/{parent=projects/*/agent}/get_alternative:training_phrases | * |
GetSynonyms | POST | /v2/{parent=projects/*/agent}/get_synonyms | * |
ClassifyIntents | POST | /v2/{parent=projects/*/agent}/classify_intent | * |
This message contains an alternative sentence
Field | Type | Label | Description |
sentence | string | Alternative sentence |
|
score | float | Score associated to the alternative sentence resulted |
This message contains an alternative training phrase
Field | Type | Label | Description |
training_phrase | Intent.TrainingPhrase | Alternative training phrase |
|
score | float | Score associated to training_phrase |
Configuration for BERT augmenter enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
The request for intent classification.
Field | Type | Label | Description |
parent | string | Required. The project of this agent. Format: |
|
text | string | the input text |
|
language_code | string | the input language |
|
active_contexts | bool | Optional: if restrict classification result with input contexts listed in the field `context_names` |
|
context_names | string | repeated | Optional: names of the input contexts to restrict the classification result with. Intents can only be classified if the intent's input context set is the subset of the given context set. |
mode | Mode | Optional: Which mode to use: EXCLUSIVE - skip algorithms listed in `algorithms` field, INCLUSIVE - run ONLY algorithms listed in `algorithms` field, UNSPECIFIED - default mode, described in agent config |
|
algorithms | IntentAlgorithms | repeated | Optional: Algorithm list |
Response containing the intents classified in a sentence
Field | Type | Label | Description |
intents_classified | IntentClassified | repeated | A list of intents detected |
text | string | The text containing from which the intents were detected |
|
active_contexts | bool | Flag that enables the context through the conversation |
|
context_names | string | repeated | The context tags associated to the intents |
This message contains the configuration of data enrichment
Field | Type | Label | Description |
entity_enrichment | EntityEnrichmentConfig | Entity augmenter configuration |
|
thesaurus_enrichment | ThesaurusEnrichmentConfig | Thesaurus augmenter configuration |
|
word2vec_enrichment | Word2VecEnrichmentConfig | Word2Vec augmenter configuration |
|
word_net_enrichment | WordNetAugEnrichmentConfig | WordNet augmenter configuration |
|
gpt2_enrichment | GPT2EnrichmentConfig | GPT2 augmenter configuration |
|
glove_enrichment | GloVeEnrichmentConfig | GloVe augmenter configuration |
|
bert_enrichment | BertAugEnrichmentConfig | BERT augmenter configuration |
|
xlnet_enrichment | XLNetAugEnrichmentConfig | XLNet augmenter configuration |
This message contains the entity detected
Field | Type | Label | Description |
entity | Intent.TrainingPhrase.Entity | The entity name that is detected |
|
extraction_method | string | The extractor name, e.g. SpacyNer |
|
score | float | The confidence score of the detected entity |
Configuration for Entity enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Configuration for Fuzzy Entity Recognizer
Field | Type | Label | Description |
entity_type | EntityType | The Entity Type |
|
minimal_score | float | Optional. Overrides the minimal score in ExtractEntitiesFuzzyRequest. |
|
entity_values | string | repeated | Optional. If defined, only entity value from this list are considered. |
algorithm | EntityTypeFuzzyNerConfig.FuzzyNerAlgorithm | Optional. Specify the Fuzzy Ner algorithm |
|
allow_overlaps | bool | Should not use allow_overlaps here, since its default value is False |
This message is a request to extract entities with Fuzzy Entity Recognizer
Field | Type | Label | Description |
parent | string | the parent of the request Format: |
|
text | string | The text to be analyzed |
|
potential_entities | EntityTypeFuzzyNerConfig | repeated | Potential entities to be extracted from the text with entity-specific configs |
minimal_score | float | Minimal similarity score to consider entity as "matched" |
|
allow_overlaps | bool | Optional. Whether or not entities are allowed to overlap. |
The request to detect parameters.
Field | Type | Label | Description |
parent | string | the parent of the request Format: |
|
text | string | the input text |
|
language_code | string | the input language |
|
intent_name | string | Optional. The name of the relevant intent. Used to establish preference hierarchy for entities that correspond to intent parameters Format: |
This message is a response of extracting entities
Field | Type | Label | Description |
entities_detected | EntityDetected | repeated | A list of entities detected |
text | string | The text containing the entities detected |
Configuration for GPT2 enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Request to generate responses
Field | Type | Label | Description |
language_code | string | language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
parent | string | the parent of the request Format: |
|
n_repeat_synonym | int32 | The number of synonyms desired |
|
branch | string | Git branch |
|
drop_unknown_parameters | bool |
|
Response containing responses
Field | Type | Label | Description |
responses | string | repeated | A list of responses |
Request to generate user sentences
Field | Type | Label | Description |
language_code | string | language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
parent | string | the parent of the request Format: |
|
n_repeat_synonym | int32 | The number of synonyms desired |
|
branch | string | Git branch |
Response containing user sentences
Field | Type | Label | Description |
user_says | string | repeated | A list of sampled sentences |
Request to get alternative sentences
Field | Type | Label | Description |
config | DataEnrichmentConfig | Configuration type of the enricher |
|
sentence | string | The sentence from which it is desired to get alternative sentences |
|
language_code | string | Language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
parent | string | the parent of the request Format: |
|
protected_words | string | repeated | Protected words in the augmentation process |
words_to_change | string | repeated | Words to be changed in the augmentation process |
Response containing alternative sentences
Field | Type | Label | Description |
alternative_sentences | AltSentence | repeated | A list of alternative sentences |
Request to get alternative training phrases
Field | Type | Label | Description |
config | DataEnrichmentConfig | Configuration of the enricher |
|
training_phrase | Intent.TrainingPhrase | Training phrase from which an alternative one is got |
|
intent_name | string | The intent tag attached to the training phrase |
|
language_code | string | language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
parent | string | the parent of the request Format: |
|
detect_entities | bool | Flag to determine whether entities must or not be detected |
|
similarity_threshold | float | similarity threshold defines how similar sentences should be to drop generated training phrase as duplicate. Meaningful values of similarity_threshold are between 0.95 and 1.0 |
|
protected_words | string | repeated | Protected words in the augmentation process |
words_to_change | string | repeated | Words to be changed in the augmentation process |
branch | string | Git branch |
Response containing alternative training phrases
Field | Type | Label | Description |
alternative_training_phrases | AltTrainingPhrase | repeated | A list of alternative training phrases |
Request to get synonyms
Field | Type | Label | Description |
config | DataEnrichmentConfig | Configuration of the enricher |
|
word | string | Word from which a synonym is got |
|
language_code | string | language code specifies the language of the request, e.g. cz, de, en, es, fi, fr, it, nl, pl, pt, tr, ru |
|
parent | string | the parent of the request Format: |
Response containing synonyms
Field | Type | Label | Description |
synonyms | Synonym | repeated | A list of synonyms |
Configuration for GloVe enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Intent classified by a certain intent classifier
Field | Type | Label | Description |
intent_name | string | The unique identifier of this intent. Format: |
|
intent_display_name | string | The name of the intent. |
|
classifier | string | The name of the classifier that detected the intent |
|
score | float | Score associated to the detection of the intent by the classifier |
This message contains a Synonym
Field | Type | Label | Description |
synonym | string | Synonym word |
|
score | int32 | Score associated to the synonym resulted |
Configuration for Thesaurus enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Configuration for Word2Vec enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Configuration for WordNet augmenter enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Configuration for Thesaurus enrichment
Field | Type | Label | Description |
is_active | bool | Activation flag |
|
enrichment_factor | int32 | Factor of enrichment |
|
execution_order | int32 | Order of augmenter execution |
Enum of fuzzy ner algorithms
Name | Number | Description |
PREFILTER_LEVENSHTEIN | 0 | Levenshtein algorithm for fuzzy ner matching |
LOCAL_MAXIMUM | 1 | local maximum |
Type of Intent algorithm.
Name | Number | Description |
OndewoIntentExactContextDetector | 0 | By enabling this, a specific intent is triggered if the context and the intent name in the user says is matched. This can be used for directly triggering 'quick reply' button clicks confidence is always '1.0'. |
OndewoIntentExactMatch | 1 | exact matching' of user input to user says is used to detect the intent. Confidence is always '1.0' if an 'exact match' is found. |
OndewoIntentNamedExactMatch | 2 | the entity synonym in the user says text is replaced by the entity and 'exact matching' of user says text is performed. Confidence is always '1.0'. |
OndewoIntentSimilarityMatch | 3 | the algorithm computes the similarity of the user input to all user says of all intents. |
OndewoIntentNamedSimilarityMatch | 4 | the entity synonyms in the user says are replaced by their Entity. Text similarity algorithms are then used to detect the intent. |
OndewoIntentBertClassifier | 7 | new language representation model called BERT, which stands for Bidirectional Encoder Representations from Transformers.BERT is designed to pre-train deep bidirectional representations by jointly conditioning on both left and right context in all layers. As a result, the pre-trained BERT representations can be fine-tuned for multi-class intent detection. For details see https://arxiv.org/abs/1810.04805 |
OndewoIntentMetaClassifier | 8 | |
IntentExitDetector | 10 | Maximum number of repeated fallbacks before this algorithm exists the conversation and resets contexts |
OndewoIntentRankingMatch | 11 | Algorithm to improve the interplay of the other algorithms |
OndewoWeightedEnsemble | 13 | Ensemble calculation of used algorithms |
OndewoIntentExitDetector | 14 | Maximum number of repeated fallbacks before this algorithm exists the conversation and resets contexts |
OndewoIntentParameterMatch | 15 | Matches the intent based on the parameter constellation and the current user context |
Type of mode
Name | Number | Description |
UNSPECIFIED | 0 | default mode, described in agent config |
EXCLUSIVE | 1 | skip algorithms listed in `algorithms` field, |
INCLUSIVE | 2 | run ONLY algorithms listed in `algorithms` field |
Service to manage Call Center AI (CCAI) Projects.
rpc GetCcaiProject (GetCcaiProjectRequest) returns (CcaiProject)Retrieves information about a specific CCAI project.
rpc CreateCcaiProject (CreateCcaiProjectRequest) returns (CreateCcaiProjectResponse)Creates a new CCAI project based on the provided request.
rpc DeleteCcaiProject (DeleteCcaiProjectRequest) returns (DeleteCcaiProjectResponse)Deletes a CCAI project identified by the provided request.
rpc ListCcaiProjects (ListCcaiProjectsRequest) returns (ListCcaiProjectsResponse)Lists all CCAI projects based on the provided request.
rpc UpdateCcaiProject (UpdateCcaiProjectRequest) returns (UpdateCcaiProjectResponse)Updates the information of an existing CCAI project.
Message representing a CCAI project
Field | Type | Label | Description |
name | string | Resource name of the CCAI project |
|
display_name | string | Required. The display name of this ccai project. |
|
owner_name | string | Optional. Resource name of the user who is the owner of the project. |
|
ccai_services_map | CcaiProject.CcaiServicesMapEntry | repeated | Map of two letter language codes to lists of CcaiServiceList Two-letter language codes following ISO 639-1 (see https://en.wikipedia.org/wiki/ISO_639-1) |
ccai_project_status | CcaiProjectStatus | The status of the ccai project. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in the form of a valid UUID. |
|
modified_by | string | User id in the form of a valid UUID. |
|
nlu_project_name | string | Required. Associated NLU agent Format: |
Field | Type | Label | Description |
key | string |
|
|
value | CcaiServiceList |
|
This protobuf message defines the sorting order for CCAI (Virtual Test System Infrastructure) projects.
Field | Type | Label | Description |
sorting_field | CcaiProjectSorting.CcaiProjectSortingField | optional | sorting field for ccai projects sorting |
sorting_mode | SortingMode | optional | Sorting mode |
Definition of a Call Center AI (CCAI) Service.
Field | Type | Label | Description |
name | string | Resource name of the service. Must be unique. |
|
display_name | string | Display name for better identification. |
|
language_code | string | Language code representing the service language Format (e.g., "en" for English, "de" for German). |
|
grpc_host | string | gRPC host for communication with the specified port. |
|
grpc_port | int32 | Port for gRPC communication. |
|
webgrpc_host | string | Web gRPC host for web-based communication with the specified port. |
|
webgrpc_port | int32 | Port for web gRPC communication. |
|
grpc_cert | string | Path to the gRPC certificate for secure communication. |
|
host | string | Additional host for communication, if needed. |
|
port | int32 | Port for additional communication. |
|
port2 | int32 | Another additional port for communication if required. |
|
http_basic_auth_token | string | Http basic auth token |
|
account_name | string | Account name for authentication. |
|
account_password | string | Password for the specified account for authentication. |
|
api_key | string | API key for accessing the service, if applicable. |
|
ccai_service_type | CcaiServiceType | Type of CCAI service (e.g., TEXT_TO_SPEECH, SPEECH_TO_TEXT). |
|
ccai_project_name | string | Resource name of the ccai_project the ccai_service belongs to |
|
ccai_service_config | google.protobuf.Struct | Detailed configuration of the CcaiService |
|
created_at | google.protobuf.Timestamp | Creation date and time of the service. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time of the service. Read-only field. |
|
created_by | string | User ID of the creator in the form of a valid UUID. Read-only field. |
|
modified_by | string | User ID of the last modifier in the form of a valid UUID. Read-only field. |
Filter which services should be included in the returned CcaiProject
Field | Type | Label | Description |
language_codes | string | repeated | Language codes of the projects for which services are filtered. |
ccai_service_types | CcaiServiceType | repeated | Type of CCAI service |
Message representing a list of CCAI services
Field | Type | Label | Description |
ccai_services | CcaiService | repeated | CCAI services |
Request to create a Call Center AI (CCAI) project.
Field | Type | Label | Description |
ccai_project | CcaiProject | The CCAI project to be created. |
|
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
Response after attempting to create a Call Center AI (CCAI) project.
Field | Type | Label | Description |
ccai_project | CcaiProject | The created CCAI project. |
|
error_message | string | Error message if the creation is unsuccessful. |
Request to delete a CCAI project
If a deployed CCAI project was deleted then it was undeployed beforehand automatically
Field | Type | Label | Description |
name | string | CCAI project name with which to perform the call of the form |
|
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
Response to delete a CCAI project
If a deployed CCAI project was deleted then it was undeployed beforehand automatically
Field | Type | Label | Description |
name | string | CCAI project name with which to perform the call of the form |
|
error_message | string | error message if there are any. |
|
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
Request to retrieve a CCAI project
Field | Type | Label | Description |
name | string | CCAI project name with which to perform the call of the form |
|
ccai_project_view | CcaiProjectView | optional | Optional. Specify the view of the returned CcaiProject (full view by default) |
ccai_service_filter | CcaiServiceFilter | optional | Filter which services should be included in the returned CcaiProject |
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
Request to get the list of agents
Field | Type | Label | Description |
ccai_project_view | CcaiProjectView | Optional. Specify the view of the returned CcaiProject (full view by default) |
|
ccai_service_filter | CcaiServiceFilter | optional | Filter which services should be included in the CcaiProject |
ccai_project_sorting | CcaiProjectSorting | optional | Optional. Field to define the sorting of the list of CCAI projects in the response. If not specified, the default behavior is to have no sorting. |
page_token | string | optional | Optional. The next_page_token value returned from a previous list request. Example: "current_index-1--page_size-20" The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
This is a protobuf message definition for the response of getting a list of CCAI projects.
Field | Type | Label | Description |
ccai_projects | CcaiProject | repeated | The list of CCAI projects returned in the response. Use the 'repeated' keyword to indicate that this field can contain multiple instances of CcaiProject. |
next_page_token | string | Token to retrieve the next page of results. This field is a string that holds a token for fetching the next page of results. If there are no more results in the list, this field will be empty. |
Request to updated CCAI project
Field | Type | Label | Description |
ccai_project | CcaiProject | The CcaiProject that should be updated |
|
ccai_service_filter | CcaiServiceFilter | optional | Filter which services should be updated in the CcaiProject |
update_mask | google.protobuf.FieldMask | optional | Optional. The mask to control which fields get updated. Note: Not implemented yet |
nlu_project_name | string | Required. The nlu agent project of this CcaiProject. Format: |
Request to updated CCAI project
Field | Type | Label | Description |
name | string | CCAI project name with which to perform the call of the form |
|
error_message | string | error message if there are any. |
Enum to specify the sorting field for CCAI projects.
Name | Number | Description |
NO_CCAI_PROJECT_SORTING | 0 | No sorting |
SORT_CCAI_PROJECT_BY_NAME | 1 | Sort by project name such as . |
SORT_CCAI_PROJECT_BY_DISPLAY_NAME | 2 | Sort by display name |
SORT_CCAI_PROJECT_BY_CREATION_DATE | 3 | Sort by creation date |
SORT_CCAI_PROJECT_BY_LAST_MODIFIED | 4 | Sort by last modified date |
Status of a Call Center AI (CCAI) Project.
Name | Number | Description |
CCAI_PROJECT_STATUS_UNSPECIFIED | 0 | No status specified |
CCAI_PROJECT_STATUS_UNDEPLOYED | 1 | Project successfully created and undeployed |
CCAI_PROJECT_STATUS_UPDATING | 2 | Project configuration is updating |
CCAI_PROJECT_STATUS_DEPLOYING | 3 | Project is deploying |
CCAI_PROJECT_STATUS_DEPLOYED | 4 | Project is deployed |
CCAI_PROJECT_STATUS_UNDEPLOYING | 5 | Project is un-deploying |
CCAI_PROJECT_STATUS_DELETING | 6 | Project is currently deleting |
CCAI_PROJECT_STATUS_DELETED | 7 | Project is deleted |
CcaiProjectView defines what the CcaiProject message contains
Name | Number | Description |
CCAI_PROJECT_VIEW_UNSPECIFIED | 0 | Unspecified CCAI_PROJECT view: the view is defined by the call: |
CCAI_PROJECT_VIEW_FULL | 1 | Full CCAI_PROJECT view: populate all the fields of the CCAI_PROJECT message including configs. |
CCAI_PROJECT_VIEW_SHALLOW | 2 | Shallow CCAI_PROJECT view: populates all the fields except configs. |
CCAI_PROJECT_VIEW_MINIMUM | 3 | Minimum view including only CCAI_PROJECT UUID and CCAI_PROJECT display name |
Name | Number | Description |
CCAI_SERVICE_TYPE_UNSPECIFIED | 0 | unspecified |
CCAI_SERVICE_TYPE_ONDEWO_AIM | 1 | ondewo-aim service |
CCAI_SERVICE_TYPE_ONDEWO_BPI | 2 | ondewo-bpi service |
CCAI_SERVICE_TYPE_ONDEWO_CSI | 3 | ondewo-csi service |
CCAI_SERVICE_TYPE_ONDEWO_NLU | 4 | ondewo-nlu service |
CCAI_SERVICE_TYPE_ONDEWO_S2T | 5 | ondewo-s2t service |
CCAI_SERVICE_TYPE_ONDEWO_SIP | 6 | ondewo-sip service |
CCAI_SERVICE_TYPE_ONDEWO_T2S | 7 | ondewo-t2s service |
CCAI_SERVICE_TYPE_ONDEWO_VTSI | 8 | ondewo-vtsi service |
CCAI_SERVICE_TYPE_VTSI_RABBITMQ | 9 | ondewo-vtsi service |
CCAI_SERVICE_TYPE_ONDEWO_NLU_QA | 10 | ondewo-nlu-qa service |
CCAI_SERVICE_TYPE_ONDEWO_NLU_WEBHOOK | 11 | ondewo-nlu-webhook service |
CCAI_SERVICE_TYPE_ONDEWO_SURVEY | 12 | ondewo-survey service |
Message for adding notifications in a batch.
Field | Type | Label | Description |
notification | Notification | repeated | List of notifications to be added. |
Message containing the response to adding notifications.
Field | Type | Label | Description |
notification | Notification | repeated | List of notifications that have been added. |
Comment message
Field | Type | Label | Description |
name | string | resource name of the comment |
|
text | string | text of the comment |
|
user_id | string | User id as resource name Format: |
|
comment_about_name | string | name of the resource for which the comment is about Format: |
|
parent_comment_name | string | The resource name of the parent comment. A parent comment is a reply to a certain comment. Format: |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Key-Value pair message, where the value can be one of various types (int, float, double, string, etc.).
Field | Type | Label | Description |
key | string | The key of the key-value pair. |
|
int_value | int32 | The integer value (if applicable). |
|
float_value | float | The float value (if applicable). |
|
double_value | double | The double value (if applicable). |
|
string_value | string | The string value (if applicable). |
|
created_at | google.protobuf.Timestamp | The timestamp value (if applicable). |
Message for listing notifications based on certain criteria.
Field | Type | Label | Description |
notification_filter | NotificationFilter | Optional filter to narrow the response down to specific notifications. |
|
page_token | string | Optional. Token for pagination, obtained from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
field_mask | google.protobuf.FieldMask | Optional. Mask to control which fields will be filled with data. Example: path=["notification.user_names"] |
Message containing the response to a list request for notifications.
Field | Type | Label | Description |
notification | Notification | repeated | List of notifications that meet the specified criteria. |
Notification message
Field | Type | Label | Description |
name | string | resource name of the notification |
|
user_name | string | User id as resource name Format: |
|
title | string | User id as resource name Format: |
|
description_short | string | A short notification text is displayed directly with max. 50 chars which is a truncated version of the long message |
|
description_long | string | A long notification text |
|
notification_flagged_status | NotificationFlaggedStatus | Has a notification been flagged by a specific user |
|
notification_flagged_timestamp | google.protobuf.Timestamp | When the user marked the notification as read |
|
notification_read_status | NotificationReadStatus | Has a notification been read by a specific user |
|
notification_read_timestamp | google.protobuf.Timestamp | When the user marked the notification as read, i.e. read the notification |
|
notification_origin | NotificationOrigin | The origin of a notification A Notification origin can be from a product (service), e.g. ondewo-nlu, ondewo-s2t, ondewo-t2s, etc. |
|
origin_name | string | The name of resource of where the notification originated |
|
origin_language | string | language of the origin resource e.g. language of the nlu agent or language of the speech-to-text service |
|
notification_type | NotificationType | The type of notification |
|
notification_visibility | NotificationVisibility | The visibility level of the notification |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Message for filtering notifications based on various criteria.
Field | Type | Label | Description |
language_codes | string | repeated | Language codes of the projects for which notifications are filtered. |
notification_origins | NotificationOrigin | repeated | Origins of the notifications to filter. |
notification_visibilities | NotificationVisibility | repeated | Visibilities of the notifications to filter. |
notification_flagged_status | NotificationFlaggedStatus | repeated | Flagged status of the notifications to filter. |
notification_read_status | NotificationReadStatus | repeated | Read status of the notifications to filter. |
earliest | google.protobuf.Timestamp | Filter notifications with a time range starting from the specified earliest time. |
|
latest | google.protobuf.Timestamp | Filter notifications with a time range ending at the specified latest time. |
|
user_names | string | repeated | Resource names of users to filter notifications for. |
origin_names | string | repeated | Resource names of the origin of the notification to filter notifications. |
Message for setting the flagged status of notifications.
Field | Type | Label | Description |
notification_name | string | repeated | Names of notifications to set the flagged status for. |
flagged | bool | repeated | Flagged status to set for the specified notifications. |
Message for setting the read status of notifications.
Field | Type | Label | Description |
notification_name | string | repeated | Names of notifications to set the read status for. |
flagged | bool | repeated | Read status to set for the specified notifications. |
statistic response
Field | Type | Label | Description |
value | uint32 | Response wrapper for the "Get |
Enumerates the possible flagged statuses for a notification.
Name | Number | Description |
NOTIFICATION_FLAGGED_STATUS_UNSPECIFIED | 0 | Unspecified flagged status |
NOTIFICATION_FLAGGED_STATUS_FLAGGED | 1 | Notification is flagged |
NOTIFICATION_FLAGGED_STATUS_UNFLAGGED | 2 | Notification is unflagged |
Enumerates the possible origins for a notification.
Name | Number | Description |
NOTIFICATION_ORIGIN_UNSPECIFIED | 0 | unspecified |
NOTIFICATION_ORIGIN_ONDEWO_AIM | 1 | ondewo-aim service |
NOTIFICATION_ORIGIN_ONDEWO_BPI | 2 | ondewo-bpi service |
NOTIFICATION_ORIGIN_ONDEWO_CSI | 3 | ondewo-csi service |
NOTIFICATION_ORIGIN_ONDEWO_NLU | 4 | ondewo-nlu service |
NOTIFICATION_ORIGIN_ONDEWO_S2T | 5 | ondewo-s2t service |
NOTIFICATION_ORIGIN_ONDEWO_SIP | 6 | ondewo-sip service |
NOTIFICATION_ORIGIN_ONDEWO_T2S | 7 | ondewo-t2s service |
NOTIFICATION_ORIGIN_ONDEWO_VTSI | 8 | ondewo-vtsi service |
NOTIFICATION_ORIGIN_ONDEWO_VTSI_RABBITMQ | 9 | ondewo-vtsi-rabbitmq service |
Enumerates the possible read statuses for a notification.
Name | Number | Description |
NOTIFICATION_READ_STATUS_UNSPECIFIED | 0 | Unspecified read status |
NOTIFICATION_READ_STATUS_READ | 1 | Notification is marked as read |
NOTIFICATION_READ_STATUS_UNREAD | 2 | Notification is marked as unread |
Enumerates the possible types for a notification.
Name | Number | Description |
NOTIFICATION_TYPE_UNSPECIFIED | 0 | Unspecified notification type |
NOTIFICATION_TYPE_DEBUG | 1 | Debug notification type |
NOTIFICATION_TYPE_WARNING | 2 | Warning notification type |
NOTIFICATION_TYPE_INFO | 3 | Informational notification type |
NOTIFICATION_TYPE_ERROR | 4 | Error notification type |
NOTIFICATION_TYPE_NEWS | 5 | News notification type |
Enum for notification type
Name | Number | Description |
NOTIFICATION_VISIBILITY_UNSPECIFIED | 0 | unspecified |
NOTIFICATION_VISIBILITY_USER | 1 | only user sees the notification - usually a notification of the user interface |
NOTIFICATION_VISIBILITY_PROJECT | 2 | all members of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_OWNER | 3 | all admins of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_ADMIN | 4 | all admins of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_DEVELOPER | 5 | all admins of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_USER | 6 | all users of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_EXECUTOR | 7 | all users of a project see this notification |
NOTIFICATION_VISIBILITY_PROJECT_INACTIVE | 8 | all users of a project see this notification |
NOTIFICATION_VISIBILITY_SERVER_ADMIN | 9 | all admins of the server |
NOTIFICATION_VISIBILITY_SERVER_MANAGER | 10 | all admins of the server |
NOTIFICATION_VISIBILITY_SERVER_USER | 11 | all admins of the server |
NOTIFICATION_VISIBILITY_SERVER_INACTIVE | 12 | all admins of the server |
Sorting mode
Name | Number | Description |
ASCENDING | 0 | ascending sorting |
DESCENDING | 1 | descending sorting |
A context represents additional information included with user input or with
an intent returned by the Dialogflow API. Contexts are helpful for
differentiating user input which may be vague or have a different meaning
depending on additional details from your application such as user setting
and preferences, previous user input, where the user is in your application,
geographic location, and so on.
You can include contexts as input parameters of a
[DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
[StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) request,
or as output contexts included in the returned intent.
Contexts expire when an intent is matched, after the number of `DetectIntent`
requests specified by the `lifespan_count` parameter, or after 10 minutes
if no intents are matched for a `DetectIntent` request.
For more information about contexts, see the
[Dialogflow documentation](https://dialogflow.com/docs/contexts).
rpc ListContexts (ListContextsRequest) returns (ListContextsResponse)Returns the list of all contexts in the specified session.
rpc GetContext (GetContextRequest) returns (Context)Retrieves the specified context.
rpc CreateContext (CreateContextRequest) returns (Context)Creates a context.
rpc UpdateContext (UpdateContextRequest) returns (Context)Updates the specified context.
rpc DeleteContext (DeleteContextRequest) returns (.google.protobuf.Empty)Deletes the specified context.
rpc DeleteAllContexts (DeleteAllContextsRequest) returns (.google.protobuf.Empty)Deletes all active contexts in the specified session.
Method Name | Method | Pattern | Body |
ListContexts | GET | /v2/{parent=projects/*/agent/sessions/*}/contexts | |
GetContext | GET | /v2/{name=projects/*/agent/sessions/*/contexts/*} | |
CreateContext | POST | /v2/{parent=projects/*/agent/sessions/*}/contexts | context |
UpdateContext | PATCH | /v2/{context.name=projects/*/agent/sessions/*/contexts/*} | context |
DeleteContext | DELETE | /v2/{name=projects/*/agent/sessions/*/contexts/*} | |
DeleteAllContexts | DELETE | /v2/{parent=projects/*/agent/sessions/*}/contexts |
Represents a context.
Field | Type | Label | Description |
name | string | Required. The display name of the context (must be unique per session).
Note: we are deviating from the dialogflow format `projects/ |
|
lifespan_count | int32 | Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries. |
|
parameters | Context.ParametersEntry | repeated | Optional. The collection of parameters associated with this context. Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for syntax. Keys are the display names of context parameters. |
lifespan_time | float | Optional. The time span in seconds after which the context expires. By default it does not expire. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Field | Type | Label | Description |
name | string | The name of the context parameter. |
|
display_name | string | The display name of the context parameter. |
|
value | string | The value(s) of the context parameter. |
|
value_original | string | The original value(s) of the context parameter. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Field | Type | Label | Description |
key | string |
|
|
value | Context.Parameter |
|
The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2.Contexts.CreateContext].
Field | Type | Label | Description |
session_id | string | Required. The session to create a context for. Format: |
|
context | Context | Required. The context to create. |
The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2.Contexts.DeleteAllContexts].
Required. The name of the session to delete all contexts from.
Format:
projects/<project_uuid>/agent/sessions/<session_uuid>
Field | Type | Label | Description |
session_id | string |
|
The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2.Contexts.DeleteContext].
Field | Type | Label | Description |
name | string | Required. The name of the context to delete. Format:
`projects/ |
The request message for [Contexts.GetContext][google.cloud.dialogflow.v2.Contexts.GetContext].
Field | Type | Label | Description |
name | string | Required. The name of the context. Format:
`projects/ |
The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].
Field | Type | Label | Description |
session_id | string | Required. The session to list all contexts from. Format: |
|
page_token | string | Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].
Field | Type | Label | Description |
contexts | Context | repeated | The list of contexts. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2.Contexts.UpdateContext].
Field | Type | Label | Description |
context | Context | Required. The context to update. |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
Entities are extracted from user input and represent parameters that are
meaningful to your application. For example, a date range, a proper name
such as a geographic location or landmark, and so on. Entities represent
actionable data for your application.
When you define an entity, you can also include synonyms that all map to
that entity. For example, "soft drink", "soda", "pop", and so on.
There are three types of entities:
* **System** - entities that are defined by the Dialogflow API for common
data types such as date, time, currency, and so on. A system entity is
represented by the `EntityType` type.
* **Developer** - entities that are defined by you that represent
actionable data that is meaningful to your application. For example,
you could define a `pizza.sauce` entity for red or white pizza sauce,
a `pizza.cheese` entity for the different types of cheese on a pizza,
a `pizza.topping` entity for different toppings, and so on. A developer
entity is represented by the `EntityType` type.
* **User** - entities that are built for an individual user such as
favorites, preferences, playlists, and so on. A user entity is
represented by the [SessionEntityType][google.cloud.dialogflow.v2.SessionEntityType] type.
For more information about entity types, see the
[Dialogflow documentation](https://dialogflow.com/docs/entities).
rpc ListEntityTypes (ListEntityTypesRequest) returns (ListEntityTypesResponse)Returns the list of all entity types in the specified agent.
rpc GetEntityType (GetEntityTypeRequest) returns (EntityType)Retrieves the specified entity type.
rpc CreateEntityType (CreateEntityTypeRequest) returns (EntityType)Creates an entity type in the specified agent.
rpc UpdateEntityType (UpdateEntityTypeRequest) returns (EntityType)Updates the specified entity type.
rpc DeleteEntityType (DeleteEntityTypeRequest) returns (.google.protobuf.Empty)Deletes the specified entity type.
rpc BatchUpdateEntityTypes (BatchUpdateEntityTypesRequest) returns (Operation)Updates/Creates multiple entity types in the specified agent. Operation
rpc BatchDeleteEntityTypes (BatchDeleteEntityTypesRequest) returns (Operation)Deletes entity types in the specified agent. Operation
rpc GetEntity (GetEntityRequest) returns (EntityType.Entity)Retrieves the specified entity .
rpc CreateEntity (CreateEntityRequest) returns (EntityType.Entity)Creates an entity in the specified agent.
rpc UpdateEntity (UpdateEntityRequest) returns (EntityType.Entity)Updates the specified entity .
rpc DeleteEntity (DeleteEntityRequest) returns (DeleteEntityStatus)Deletes the specified entity .
rpc BatchCreateEntities (BatchCreateEntitiesRequest) returns (BatchEntitiesResponse)Creates an entity value in an entity type.
rpc BatchUpdateEntities (BatchUpdateEntitiesRequest) returns (BatchEntitiesResponse)Updates a specific entity value.
rpc BatchGetEntities (BatchGetEntitiesRequest) returns (BatchEntitiesResponse)Gets a specific entity value.
rpc BatchDeleteEntities (BatchDeleteEntitiesRequest) returns (BatchDeleteEntitiesResponse)Deletes the specified entity value.
rpc ListEntities (ListEntitiesRequest) returns (ListEntitiesResponse)List entities of an entity type
Method Name | Method | Pattern | Body |
ListEntityTypes | GET | /v2/{parent=projects/*/agent}/entityTypes | |
GetEntityType | GET | /v2/{name=projects/*/agent/entityTypes/*} | |
CreateEntityType | POST | /v2/{parent=projects/*/agent}/entityTypes | * |
UpdateEntityType | PATCH | /v2/{entity_type.name=projects/*/agent/entityTypes/*} | * |
DeleteEntityType | DELETE | /v2/{name=projects/*/agent/entityTypes/*} | |
BatchUpdateEntityTypes | POST | /v2/{parent=projects/*/agent}/entityTypes:batchUpdate | * |
BatchDeleteEntityTypes | POST | /v2/{parent=projects/*/agent}/entityTypes:batchDelete | * |
GetEntity | GET | /v2/{name=projects/*/agent/entityTypes/*/entities/*} | |
CreateEntity | POST | /v2/{parent=projects/*/agent}/entityTypes/*/entities/ | * |
UpdateEntity | PATCH | /v2/{entity_.name=projects/*/agent/entityTypes/*/entities/*} | * |
DeleteEntity | DELETE | /v2/{name=projects/*/agent/entityTypes/*/entities/*} |
This message is a request to create a batch entities
Field | Type | Label | Description |
create_entity_requests | CreateEntityRequest | repeated | The create entity requests in a batch |
This message is a request to delete a batch of entities
Field | Type | Label | Description |
names | string | repeated | The unique identifiers of the entities. Format:
`projects/ |
This message is a response of deletion of a batch of entities
Field | Type | Label | Description |
delete_statuses | DeleteEntityStatus | repeated | status of an entity deletion |
has_errors | bool | error messages |
The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchDeleteEntityTypes].
Field | Type | Label | Description |
parent | string | Required. The name of the agent to delete all entities types for. Format:
`projects/ |
|
entity_type_names | string | repeated | Required. The names entity types to delete. All names must point to the same agent as `parent`. |
This message is a response of batch entities
Field | Type | Label | Description |
entity_statuses | EntityStatus | repeated | A list of entity statuses |
has_errors | bool | indicates if statuses of some of the training phrases have errors |
This message is a request to get a batch of entities
Field | Type | Label | Description |
names | string | repeated | The unique identifiers of the entities. Format:
`projects/ |
This message is a request to update a batch of entities
Field | Type | Label | Description |
entities | EntityType.Entity | repeated | The entities to update |
The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].
Field | Type | Label | Description |
parent | string | Required. The name of the agent to update or create entity types in. Format: |
|
entity_type_batch_uri | string | The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://". |
|
entity_type_batch_inline | EntityTypeBatch | The collection of entity type to update or create. |
|
language_code | string | Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].
Field | Type | Label | Description |
entity_types | EntityType | repeated | The collection of updated or created entity types. |
Field | Type | Label | Description |
entity_type_name | string | Required. Name of the entity type in which to create the entity value. Format:
`projects/ |
|
entity | EntityType.Entity | The entity value to create |
The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2.EntityTypes.CreateEntityType].
Field | Type | Label | Description |
parent | string | Required. The agent to create a entity type for. Format: |
|
entity_type | EntityType | Required. The entity type to create. |
|
language_code | string | Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
entity_type_view | EntityTypeView | Optional. The resource view to apply to the returned Entity Type |
This message is a request to delete a batch of entities
Field | Type | Label | Description |
name | string | The unique identifiers of the entities. Format:
`projects/ |
This message contains the status of an entity deletion
Field | Type | Label | Description |
successfully_deleted | google.protobuf.Empty |
|
|
error_message | string |
|
The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2.EntityTypes.DeleteEntityType].
Field | Type | Label | Description |
name | string | Required. The name of the entity type to delete. Format: |
This message is for the entity status
Field | Type | Label | Description |
entity | EntityType.Entity | The entity |
|
error_message | string | Error message |
Represents an entity type.
Entity types serve as a tool for extracting parameter values from natural
language queries.
Field | Type | Label | Description |
name | string | Required for all methods except `create` (`create` populates the name
automatically.
The unique identifier of the entity type. Format:
`projects/ |
|
display_name | string | Required. The name of the entity type. |
|
kind | EntityType.Kind | Required. Indicates the kind of entity type. |
|
auto_expansion_mode | EntityType.AutoExpansionMode | Optional. Indicates whether the entity type can be automatically expanded. |
|
entities | EntityType.Entity | repeated | Optional. The collection of entities associated with the entity type. |
next_page_token | string |
|
|
entity_count | int32 | Read-Only field. Total count of entity values of the entity type |
|
status | EntityType.EntityTypeStatus | Indicates whether the entity type is active or not |
|
synonym_count | int32 | Read-Only field. Total count of entity synonyms of the entity type |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Optional. Represents an entity.
Field | Type | Label | Description |
value | string | Required. For `KIND_MAP` entity types: A canonical name to be used in place of synonyms. For `KIND_LIST` entity types: A string that can contain references to other entity types (with or without aliases). |
|
synonyms | string | repeated | Required. A collection of synonyms. For `KIND_LIST` entity types this must contain exactly one synonym equal to `value`. |
name | string | The unique identifier of the entity. Format:
`projects/ |
|
display_name | string | The name of the entity. |
|
synonym_count | int32 | Optional. Total count of entity synonyms |
|
language_code | string | Required. The language to list entity synonyms for. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a wrapper around a collection of entity types.
Field | Type | Label | Description |
entity_types | EntityType | repeated | A collection of entity types. |
This message contains Entity type sorting
Field | Type | Label | Description |
sorting_field | EntityTypeSorting.EntityTypeSortingField |
|
|
sorting_mode | SortingMode |
|
This message contains entity value sorting
Field | Type | Label | Description |
sorting_field | EntityValueSorting.EntityValueSortingField |
|
|
sorting_mode | SortingMode |
|
This message is a request to get a an entity
Field | Type | Label | Description |
name | string | The unique identifiers of the entities. Format:
`projects/ |
The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2.EntityTypes.GetEntityType].
Field | Type | Label | Description |
name | string | Required. The name of the entity type. Format: |
|
language_code | string | Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
page_token | string | The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
entity_type_view | EntityTypeView | Optional. The resource view to apply to the returned Entity Type |
This message is a request to get a list of entities
Field | Type | Label | Description |
entity_type_name | string | The unique identifier of the entity type. Format:
`projects/ |
|
language_code | string | Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. |
|
page_token | string | Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
sort_by_field | EntityValueSorting | Optional. Defines the sorting of the list. Default, no sorting. |
|
search_by_pattern | string | Optional. Defines a pattern to search for in the entity type "values" and "synonyms" Example: Pattern: "dark" Results: [Entity Value] [Entity Synonyms] Red red, scarlett, dark red, ... Blue blue, indico, dark blue, sky blue, ... Dark obscure, black, opaque, ... |
This message is a response of listing entities
Field | Type | Label | Description |
entities | EntityType.Entity | repeated | The list of entities |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].
Field | Type | Label | Description |
parent | string | Required. The agent to list all entity types from. Format: |
|
language_code | string | Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
page_token | string | Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
entity_type_view | EntityTypeView | Optional. The resource view to apply to the returned entity type. |
|
filter_by_category | EntityTypeCategory | Optional. Applies a filter to the list. Default, no filter. |
|
sort_by_field | EntityTypeSorting | Optional. Defines the sorting of the list. Default, no sorting. |
The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].
Field | Type | Label | Description |
entity_types | EntityType | repeated | The list of agent entity types. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
This message is a request to update an entity
Field | Type | Label | Description |
entity | EntityType.Entity | The entity to update |
The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType].
Field | Type | Label | Description |
entity_type | EntityType | Required. The entity type to update. Format: |
|
language_code | string | Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
|
entity_type_view | EntityTypeView | Optional. The resource view to apply to the returned Entity Type |
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).
Name | Number | Description |
AUTO_EXPANSION_MODE_UNSPECIFIED | 0 | Auto expansion disabled for the entity. |
AUTO_EXPANSION_MODE_DEFAULT | 1 | Allows an agent to recognize values that have not been explicitly listed in the entity. |
Name | Number | Description |
ACTIVE | 0 | |
INACTIVE | 1 |
Represents kinds of entities.
Name | Number | Description |
KIND_UNSPECIFIED | 0 | Not specified. This value should be never used. |
KIND_MAP | 1 | Map entity types allow mapping of a group of synonyms to a canonical value. |
KIND_LIST | 2 | List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases). |
Represents the category of entity types to filter by in the "List Entity Types" request
Name | Number | Description |
ALL_ENTITY_TYPES | 0 | represent all entity types |
DEFAULT_ENTITY_TYPES | 1 | represent the default entity types |
USER_DEFINED_ENTITY_TYPES | 2 | represent the user defined (custom) entity types |
Structure of Entity type sorting field
Name | Number | Description |
NO_ENTITY_TYPE_SORTING | 0 | |
SORT_ENTITY_TYPE_BY_NAME | 1 | |
SORT_ENTITY_TYPE_BY_CREATION_DATE | 2 | |
SORT_ENTITY_TYPE_BY_LAST_UPDATED | 3 | |
SORT_ENTITY_TYPE_BY_ENTITY_VALUE_COUNT | 4 | |
SORT_ENTITY_TYPE_BY_SYNONYM_COUNT | 5 |
Represents the options for views of an entity type.
An entity type can be a sizable object. Therefore, we provide a resource view that
does not return all values and synonyms besides the full view that is set by default.
Name | Number | Description |
ENTITY_TYPE_VIEW_UNSPECIFIED | 0 | Same as ENTITY_TYPE_VIEW_FULL |
ENTITY_TYPE_VIEW_FULL | 1 | All fields are populated. |
ENTITY_TYPE_VIEW_PARTIAL | 2 | The amount of entity values and synonyms is limited |
ENTITY_TYPE_VIEW_SHALLOW | 3 | No entity synonyms are returned, only entity values |
ENTITY_TYPE_VIEW_MINIMUM | 4 | Minimum view including only entity type UUID and entity type display name |
Structure of Entity value sorting field
Name | Number | Description |
NO_ENTITY_VALUE_SORTING | 0 | Default behaviour: Sorts by value |
SORT_ENTITY_VALUE_BY_DISPLAY_NAME | 1 | |
SORT_ENTITY_VALUE_BY_VALUE | 2 | |
SORT_ENTITY_VALUE_BY_SYNONYM_COUNT | 3 |
An intent represents a mapping between input from a user and an action to
be taken by your application. When you pass user input to the
[DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
[StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method, the
Dialogflow API analyzes the input and searches
for a matching intent. If no match is found, the Dialogflow API returns a
fallback intent (`is_fallback` = true).
You can provide additional information for the Dialogflow API to use to
match user input to an intent by adding the following to your intent.
* **Contexts** - provide additional context for intent analysis. For
example, if an intent is related to an object in your application that
plays music, you can provide a context to determine when to match the
intent if the user input is “turn it off”. You can include a context
that matches the intent when there is previous user input of
"play music", and not when there is previous user input of
"turn on the light".
* **Events** - allow for matching an intent by using an event name
instead of user input. Your application can provide an event name and
related parameters to the Dialogflow API to match an intent. For
example, when your application starts, you can send a welcome event
with a user name parameter to the Dialogflow API to match an intent with
a personalized welcome message for the user.
* **Training phrases** - provide examples of user input to train the
Dialogflow API agent to better match intents.
For more information about intents, see the
[Dialogflow documentation](https://dialogflow.com/docs/intents).
rpc ListIntents (ListIntentsRequest) returns (ListIntentsResponse)Returns the list of all intents in the specified agent.
rpc GetIntent (GetIntentRequest) returns (Intent)Retrieves the specified intent.
rpc CreateIntent (CreateIntentRequest) returns (Intent)Creates an intent in the specified agent.
rpc UpdateIntent (UpdateIntentRequest) returns (Intent)Updates the specified intent.
rpc DeleteIntent (DeleteIntentRequest) returns (.google.protobuf.Empty)Deletes the specified intent.
rpc BatchUpdateIntents (BatchUpdateIntentsRequest) returns (BatchUpdateIntentsResponse)Updates/Creates multiple intents in the specified agent. Operation
rpc BatchDeleteIntents (BatchDeleteIntentsRequest) returns (Operation)Deletes intents in the specified agent. Operation
rpc TagIntent (IntentTagRequest) returns (.google.protobuf.Empty)Tags a specific intent with tag(s)
rpc DeleteIntentTag (IntentTagRequest) returns (.google.protobuf.Empty)Deletes tag(s) for a specific intent
rpc GetIntentTags (GetIntentTagsRequest) returns (GetIntentTagsResponse)Gets all the tags for a specific intent
rpc GetAllIntentTags (GetAllIntentTagsRequest) returns (GetIntentTagsResponse)Gets all the tags for all the intents
rpc BatchCreateTrainingPhrases (BatchCreateTrainingPhrasesRequest) returns (BatchTrainingPhrasesStatusResponse)Creates batch of training phrases
rpc BatchGetTrainingPhrases (BatchGetTrainingPhrasesRequest) returns (BatchTrainingPhrasesStatusResponse)Retrieve a training phrases batch of the specified names.
rpc BatchUpdateTrainingPhrases (BatchUpdateTrainingPhrasesRequest) returns (BatchTrainingPhrasesStatusResponse)Updates batch of training phrases
rpc BatchDeleteTrainingPhrases (BatchDeleteTrainingPhrasesRequest) returns (BatchDeleteTrainingPhrasesResponse)Delete a training phrases batch of the specified names.
rpc ListTrainingPhrases (ListTrainingPhrasesRequest) returns (ListTrainingPhrasesResponse)List training phrases (of a specific intent).
rpc BatchCreateResponseMessages (BatchCreateResponseMessagesRequest) returns (BatchResponseMessagesStatusResponse)Creates batch of intent messages
rpc BatchGetResponseMessages (BatchGetResponseMessagesRequest) returns (BatchResponseMessagesStatusResponse)Retrieve a intent messages batch of the specified names.
rpc BatchUpdateResponseMessages (BatchUpdateResponseMessagesRequest) returns (BatchResponseMessagesStatusResponse)Updates batch of intent messages
rpc BatchDeleteResponseMessages (BatchDeleteResponseMessagesRequest) returns (BatchDeleteResponseMessagesResponse)Delete a intent messages batch of the specified names.
rpc ListResponseMessages (ListResponseMessagesRequest) returns (ListResponseMessagesResponse)List messages (of a specific intent).
rpc BatchCreateParameters (BatchCreateParametersRequest) returns (BatchParametersStatusResponse)Creates batch of intent messages
rpc BatchGetParameters (BatchGetParametersRequest) returns (BatchParametersStatusResponse)Retrieve a intent messages batch of the specified names.
rpc BatchUpdateParameters (BatchUpdateParametersRequest) returns (BatchParametersStatusResponse)Updates batch of intent messages
rpc BatchDeleteParameters (BatchDeleteParametersRequest) returns (BatchDeleteParametersResponse)Delete a intent messages batch of the specified names.
rpc ListParameters (ListParametersRequest) returns (ListParametersResponse)List messages (of a specific intent).
rpc ListTrainingPhrasesofIntentsWithEnrichment (ListTrainingPhrasesofIntentsWithEnrichmentRequest) returns (ListTrainingPhrasesofIntentsWithEnrichmentResponse)List Training phrases (of a specific intent).
Method Name | Method | Pattern | Body |
ListIntents | GET | /v2/{parent=projects/*/agent}/intents | |
GetIntent | GET | /v2/{name=projects/*/agent/intents/*} | |
CreateIntent | POST | /v2/{parent=projects/*/agent}/intents | * |
UpdateIntent | PATCH | /v2/{intent.name=projects/*/agent/intents/*} | * |
DeleteIntent | DELETE | /v2/{name=projects/*/agent/intents/*} | |
BatchUpdateIntents | POST | /v2/{parent=projects/*/agent}/intents:batchUpdate | * |
BatchDeleteIntents | POST | /v2/{parent=projects/*/agent}/intents:batchDelete | * |
TagIntent | POST | /v2/{parent=projects/*/agent}/intents:tagIntent | * |
DeleteIntentTag | POST | /v2/{parent=projects/*/agent}/intents:deleteIntentTag | * |
Request to create a batch of parameters in the specified intent
Field | Type | Label | Description |
parameter_requests | BatchCreateParametersRequest.CreateParameterRequest | repeated |
|
Field | Type | Label | Description |
intent_name | string | Required. The name of the intent for which to create a training phrase for. |
|
parameter | Intent.Parameter | Required. The response message. |
Request to create a list of new response messages and adds it to an intent
Field | Type | Label | Description |
response_message_requests | BatchCreateResponseMessagesRequest.CreateResponseMessageRequest | repeated |
|
Field | Type | Label | Description |
intent_name | string | Required. The name of the intent for which to create a response message for. |
|
response_message | Intent.Message | Required. The response message. |
This message is a request of a creation of a batch of training phrases
Field | Type | Label | Description |
training_phrase_requests | BatchCreateTrainingPhrasesRequest.CreateTrainingPhraseRequest | repeated |
|
Field | Type | Label | Description |
intent_name | string | Required. The name of the intent for which to create a training phrase for. |
|
training_phrase | Intent.TrainingPhrase | Required. The training phrase to create. |
The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2.Intents.BatchDeleteIntents].
Field | Type | Label | Description |
parent | string | Required. The name of the agent to delete all entities types for. Format:
`projects/ |
|
intents | Intent | repeated | Required. The collection of intents to delete. Only intent `name` must be filled in. |
Request to delete parameters specified by their names.
Field | Type | Label | Description |
names | string | repeated | Required. The names of the response messages. Format: |
This message contains response of deleted parameters
Field | Type | Label | Description |
delete_statuses | BatchDeleteParametersResponse.DeleteParameterStatus | repeated |
|
has_errors | bool |
|
Field | Type | Label | Description |
successfully_deleted | google.protobuf.Empty |
|
|
error_message | string |
|
Request to delete response messages specified by their names
Field | Type | Label | Description |
names | string | repeated | Required. The names of the response messages. Format: |
Response containing list with deleted response messages
Field | Type | Label | Description |
delete_statuses | BatchDeleteResponseMessagesResponse.DeleteResponseMessageStatus | repeated |
|
has_errors | bool |
|
Field | Type | Label | Description |
successfully_deleted | google.protobuf.Empty |
|
|
error_message | string |
|
This message is a request to delete a batch of training phrases
Field | Type | Label | Description |
names | string | repeated | Required. The names of the training phrases. Format: |
This message is a response of deleting a batch of training phrases
Field | Type | Label | Description |
delete_statuses | BatchDeleteTrainingPhrasesResponse.DeleteTrainingPhraseStatus | repeated |
|
has_errors | bool |
|
Field | Type | Label | Description |
successfully_deleted | google.protobuf.Empty |
|
|
error_message | string |
|
Request to get batch of parameters in a specified intent
Field | Type | Label | Description |
names | string | repeated | Required. The names of the response messages. Format: |
Request to retrieve a response messages
Field | Type | Label | Description |
names | string | repeated | Required. The names of the response messages. Format: |
This message is a request to get a batch training phrases
Field | Type | Label | Description |
names | string | repeated | Required. The names of the training phrases. Format: |
Response containing a batch of parameters in the specified intent
Field | Type | Label | Description |
parameter_statuses | BatchParametersStatusResponse.ParameterStatus | repeated |
|
has_errors | bool | indicates if statuses of some of the parameters have errors |
Field | Type | Label | Description |
parameter | Intent.Parameter |
|
|
error_message | string |
|
This message is a response of a batch responses of message status
Field | Type | Label | Description |
response_message_statuses | BatchResponseMessagesStatusResponse.ResponseMessageStatus | repeated |
|
has_errors | bool | indicates if statuses of some of the response messages have errors |
Field | Type | Label | Description |
response_message | Intent.Message |
|
|
error_message | string |
|
This message is a response of the status of a batch of training phrases
Field | Type | Label | Description |
training_phrase_statuses | TrainingPhraseStatus | repeated | A list of training phrase statuses |
has_errors | bool | indicates if statuses of some of the training phrases have errors |
The request message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents].
Field | Type | Label | Description |
parent | string | Required. The name of the agent to update or create intents in. Format: |
|
intent_batch_uri | string | The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". |
|
intent_batch_inline | IntentBatch | The collection of intents to update or create. |
|
language_code | string | Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
|
intent_view | IntentView | Optional. The resource view to apply to the returned intent. |
The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents].
Field | Type | Label | Description |
intents | Intent | repeated | The collection of updated or created intents. |
Request to update parameters and adds them to an intent
Field | Type | Label | Description |
parameters | Intent.Parameter | repeated | The response messages to update |
Request to update a response message in the specified intent
Field | Type | Label | Description |
response_messages | Intent.Message | repeated | The response messages to update |
This message is a request to update a batch of training phrases
Field | Type | Label | Description |
training_phrases | Intent.TrainingPhrase | repeated | A list of training phrases |
The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent].
Field | Type | Label | Description |
parent | string | Required. The agent to create a intent for. Format: |
|
intent | Intent | Required. The intent to create. |
|
language_code | string | Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
intent_view | IntentView | Optional. The resource view to apply to the returned intent. |
The request message for [Intents.DeleteIntent][google.cloud.dialogflow.v2.Intents.DeleteIntent].
Field | Type | Label | Description |
name | string | Required. The name of the intent to delete. Format: |
This message is a request to get all intent tags
Field | Type | Label | Description |
parent | string | Required. The name of the agent to delete all entities types for. Format:
`projects/ |
The request message for [Intents.GetIntent][google.cloud.dialogflow.v2.Intents.GetIntent].
Field | Type | Label | Description |
name | string | Required. The name of the intent. Format: |
|
language_code | string | Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
intent_view | IntentView | Optional. The resource view to apply to the returned intent. |
|
page_token | string | The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
This message is a request to get intent tags
Field | Type | Label | Description |
intent_name | string | The path of the intent. Format: |
This message is a response of getting intent tags
Field | Type | Label | Description |
intent_tags | string | repeated | All the distinct intent tags sorted |
Represents an intent.
Intents convert a number of user expressions or patterns into an action. An
action is an extraction of a user command or sentence semantics.
Field | Type | Label | Description |
name | string | Required for all methods except `create` (`create` populates the name automatically. The unique identifier of this intent. Format: |
|
display_name | string | Required. The name of this intent. |
|
webhook_state | Intent.WebhookState | Required. Indicates whether webhooks are enabled for the intent. |
|
priority | int32 | Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled. |
|
is_fallback | bool | Optional. Indicates whether this is a fallback intent. |
|
ml_disabled | bool | Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. |
|
input_context_names | string | repeated | Optional. The list of context names required for this intent to be triggered. Format: |
events | string | repeated | Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. |
training_phrases | Intent.TrainingPhrase | repeated | Optional. The collection of examples/templates that the agent is trained on. |
action | string | Optional. The name of the action associated with the intent. |
|
output_contexts | Context | repeated | Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: |
reset_contexts | bool | Optional. Indicates whether to delete all contexts in the current session when this intent is matched. |
|
parameters | Intent.Parameter | repeated | Optional. The collection of parameters associated with the intent. |
messages | Intent.Message | repeated | Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. |
default_response_platforms | Intent.Message.Platform | repeated | Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. |
root_followup_intent_name | string | The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: |
|
parent_followup_intent_name | string | The unique identifier of the parent intent in the chain of followup intents. It identifies the parent followup intent. Format: |
|
followup_intent_info | Intent.FollowupIntentInfo | repeated | Optional. Collection of information about all followup intents that have name of this intent as a root_name. |
next_page_token | string | Format: `current_index- |
|
domain_name | string | Optional. Domain to which the intent belongs |
|
is_start_of_deviation | bool | Optional. Indicates whether the intent starts a deviation in conversation flow |
|
is_end_of_deviation | bool | Optional. Indicates whether the intent ends a deviation in conversation flow |
|
training_phrase_count | int32 | Optional. Total count of training phrases associated to the intent. |
|
status | Intent.IntentStatus | Indicates whether the intent is active or not |
|
start_date | google.protobuf.Timestamp | Optional. Provides information that can be used in custom scripts |
|
end_date | google.protobuf.Timestamp | Optional. Provides information that can be used in custom scripts |
|
tags | string | repeated | Optional. Adds arbitrary "categories" for which one could filter the intents |
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Represents a single followup intent in the chain.
Field | Type | Label | Description |
followup_intent_name | string | The unique identifier of the followup intent. Format: |
|
parent_followup_intent_name | string | The unique identifier of the followup intent parent. Format: |
Corresponds to the `Response` field in the Dialogflow console.
Field | Type | Label | Description |
name | string | Required. The name of the return message. Format: |
|
language_code | string | Required. The language of the return message. |
|
text | Intent.Message.Text | The text response. |
|
image | Intent.Message.Image | The image response. |
|
quick_replies | Intent.Message.QuickReplies | The quick replies response. |
|
card | Intent.Message.Card | The card response. |
|
payload | google.protobuf.Struct | Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. |
|
simple_responses | Intent.Message.SimpleResponses | The voice and text-only responses for Actions on Google. |
|
basic_card | Intent.Message.BasicCard | The basic card response for Actions on Google. |
|
suggestions | Intent.Message.Suggestions | The suggestion chips for Actions on Google. |
|
link_out_suggestion | Intent.Message.LinkOutSuggestion | The link out suggestion chip for Actions on Google. |
|
list_select | Intent.Message.ListSelect | The list card response for Actions on Google. |
|
carousel_select | Intent.Message.CarouselSelect | The carousel card response for Actions on Google. |
|
html_text | Intent.Message.HTMLText | The HTML text response |
|
video | Intent.Message.Video | The Video response |
|
audio | Intent.Message.Audio | The Audio response |
|
platform | Intent.Message.Platform | Optional. The platform that this message is intended for. |
|
is_prompt | bool | Read-only. States if a returned message is a prompt or not. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
The Audio response message.
Field | Type | Label | Description |
uri | string | Optional. The public URI to an audio file. |
|
accessibility_text | string | Optional. A text description of the audio to be used for accessibility, e.g., screen readers. |
The basic card message. Useful for displaying information.
Field | Type | Label | Description |
title | string | Optional. The title of the card. |
|
subtitle | string | Optional. The subtitle of the card. |
|
formatted_text | string | Required, unless image is present. The body text of the card. |
|
image | Intent.Message.Image | Optional. The image for the card. |
|
buttons | Intent.Message.BasicCard.Button | repeated | Optional. The collection of card buttons. |
The button object that appears at the bottom of a card.
Field | Type | Label | Description |
title | string | Required. The title of the button. |
|
open_uri_action | Intent.Message.BasicCard.Button.OpenUriAction | Required. Action to take when a user taps on the button. |
Opens the given URI.
Field | Type | Label | Description |
uri | string | Required. The HTTP or HTTPS scheme URI. |
The card response message.
Field | Type | Label | Description |
title | string | Optional. The title of the card. |
|
subtitle | string | Optional. The subtitle of the card. |
|
image_uri | string | Optional. The public URI to an image file for the card. |
|
buttons | Intent.Message.Card.Button | repeated | Optional. The collection of card buttons. |
Optional. Contains information about a button.
Field | Type | Label | Description |
text | string | Note: One of the following is required: Optional. The text to show on the button. |
|
postback | string | Optional. The text to send back to the Dialogflow API or a URI to open. |
The card for presenting a carousel of options to select from.
Field | Type | Label | Description |
items | Intent.Message.CarouselSelect.Item | repeated | Required. Carousel items. |
An item in the carousel.
Field | Type | Label | Description |
info | Intent.Message.SelectItemInfo | Required. Additional info about the option item. |
|
title | string | Required. Title of the carousel item. |
|
description | string | Optional. The body text of the card. |
|
image | Intent.Message.Image | Optional. The image to display. |
This message contains HTML text
Field | Type | Label | Description |
text | string | repeated | Collection of the agent's responses in HTML format |
The image response message.
Field | Type | Label | Description |
image_uri | string | Optional. The public URI to an image file. |
|
accessibility_text | string | Optional. A text description of the image to be used for accessibility, e.g., screen readers. |
The suggestion chip message that allows the user to jump out to the app
or website associated with this agent.
Field | Type | Label | Description |
destination_name | string | Required. The name of the app or site this chip is linking to. |
|
uri | string | Required. The URI of the app or site to open when the user taps the suggestion chip. |
The card for presenting a list of options to select from.
Field | Type | Label | Description |
title | string | Optional. The overall title of the list. |
|
items | Intent.Message.ListSelect.Item | repeated | Required. List items. |
An item in the list.
Field | Type | Label | Description |
info | Intent.Message.SelectItemInfo | Required. Additional information about this option. |
|
title | string | Required. The title of the list item. |
|
description | string | Optional. The main text describing the item. |
|
image | Intent.Message.Image | Optional. The image to display. |
The quick replies response message.
Field | Type | Label | Description |
title | string | Optional. The title of the collection of quick replies. |
|
quick_replies | string | repeated | Optional. The collection of quick replies. |
Additional info about the select item for when it is triggered in a
dialog.
Field | Type | Label | Description |
key | string | Required. A unique key that will be sent back to the agent if this response is given. |
|
synonyms | string | repeated | Optional. A list of synonyms that can also be used to trigger this item in dialog. |
The simple response message containing speech or text.
Field | Type | Label | Description |
text_to_speech | string | One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. |
|
ssml | string | One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. |
|
display_text | string | Optional. The text to display. |
The collection of simple response candidates.
This message in `QueryResult.fulfillment_messages` and
`WebhookResponse.fulfillment_messages` should contain only one
`SimpleResponse`.
Field | Type | Label | Description |
simple_responses | Intent.Message.SimpleResponse | repeated | Required. The list of simple responses. |
The suggestion chip message that the user can tap to quickly post a reply
to the conversation.
Field | Type | Label | Description |
title | string | Required. The text shown the in the suggestion chip. |
The collection of suggestions.
Field | Type | Label | Description |
suggestions | Intent.Message.Suggestion | repeated | Required. The list of suggested replies. |
The text response message.
Field | Type | Label | Description |
text | string | repeated | Optional. The collection of the agent's responses. |
The Video response message.
Field | Type | Label | Description |
uri | string | Optional. The public URI to a video file. |
|
accessibility_text | string | Optional. A text description of the video to be used for accessibility, e.g., screen readers. |
Represents intent parameters.
Field | Type | Label | Description |
name | string | The unique identifier of this parameter. Format: |
|
display_name | string | Required. The name of the parameter. |
|
value | string | Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. |
|
default_value | string | Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. |
|
entity_type_name | string | Optional. The unique identifier of the entity type in format
`projects/ |
|
entity_type_display_name | string | Optional. The name of the entity type that describes values of the parameter. If the parameter is required, this must be provided. |
|
mandatory | bool | Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. |
|
prompts | Intent.Parameter.Prompt | repeated | Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. |
is_list | bool | Optional. Indicates whether the parameter represents a list of values. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Represents the prompts in the parameters.
Field | Type | Label | Description |
name | string | The unique identifier of this prompt. Format: |
|
text | string | Required. Text of the prompt |
|
language_code | string | The language of the prompts. If not specified, the default language code will be used. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Represents an example or template that the agent is trained on.
Field | Type | Label | Description |
name | string | Required. The unique identifier of this training phrase. Format: |
|
type | Intent.TrainingPhrase.Type | Required. The type of the training phrase. |
|
text | string | Required. The text of the training phrase. |
|
entities | Intent.TrainingPhrase.Entity | repeated | Optional. The collection of annotated entities in the training phrase. |
times_added_count | int32 | Optional. Indicates how many times this example or template was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. |
|
language_code | string | Optional. The language of the training phrase. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Represents an entity annotation in a training phrase. The entity can be annotated on the level of
entity type only or both entity type and entity value.
Field | Type | Label | Description |
entity_type_name | string | Required. The unique entity type identifier in format
`projects/ |
|
entity_type_display_name | string | Optional. The entity type name. |
|
entity_value_name | string | Optional. The unique entity value identifier in format
`projects/ |
|
entity_value_display_name | string | Optional. The entity value name. |
|
start | int32 | Required. Defines a character position, where the entity starts in the training phrase text (0-indexed). |
|
end | int32 | Required. Defines a character position + 1, where the entity ends in the training phrase. Example: "Meet you tomorrow" -> Entity(entity_type_display_name="sys.date", start=9, end=17) |
|
parameter_name | string | Optional. The unique parameter identifier in format
`projects/ |
|
parameter_display_name | string | Optional. The parameter name. |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a wrapper around a collection of intents.
Field | Type | Label | Description |
intents | Intent | repeated | A collection of intents. |
This message contains sorting of an intent
Field | Type | Label | Description |
sorting_field | IntentSorting.IntentSortingField |
|
|
sorting_mode | SortingMode |
|
This message is a request to get an intent tag
Field | Type | Label | Description |
intent_name | string | The path of the intent. Format: |
|
tags | string | repeated | Intent tags for this intent to operate on |
The request message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
Field | Type | Label | Description |
parent | string | Required. The agent to list all intents from. Format: |
|
language_code | string | Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. |
|
intent_view | IntentView | Optional. The resource view to apply to the returned intent. |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
filter_by_category | IntentCategory | Optional. Applies a filter to the list. Default, no filter. |
|
sort_by_field | IntentSorting | Optional. Defines the sorting of the list. Default, no sorting. |
|
filter_by_tags | string | repeated | Optional. Applies a filter to the list by tags. Default, no filter. |
The response message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
Field | Type | Label | Description |
intents | Intent | repeated | The list of agent intents. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no
more results in the list.
Format: `current_index- |
The request message for TrainingPhraseRequest
Field | Type | Label | Description |
intent_name | string | Required. The agent to list all intents from. Format: |
|
language_code | string | Optional. The language code used to filter out prompts. |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
The response message for ListTrainingPhrase
Field | Type | Label | Description |
parameters | Intent.Parameter | repeated | The list of parameters. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no
more results in the list.
Format: `current_index- |
The request message for ResponseMessageRequest
Field | Type | Label | Description |
intent_name | string | Required. The agent to list all intents from. Format: |
|
language_code | string | Optional. The language to list response messages, parameters and rich messages for. If not specified, the agent's default language is used. |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
The response message for ListResponseMessage
Field | Type | Label | Description |
response_messages | Intent.Message | repeated | The list of response messages. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no
more results in the list.
Format: `current_index- |
The request message for TrainingPhraseRequest
Field | Type | Label | Description |
intent_name | string | Required. The agent to list all intents from. Format: |
|
language_code | string | Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
The response message for ListTrainingPhrase
Field | Type | Label | Description |
training_phrases | Intent.TrainingPhrase | repeated | The list of training phrases. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no
more results in the list.
Format: `current_index- |
The request message for TrainingPhraseRequest
Field | Type | Label | Description |
parent | string | Required. The name of the agent to delete all entities types for. Format:
`projects/ |
|
language_code | string | Optional. The language code used to filter out prompts. |
|
intent_ids | string | repeated | Optional. List of intent uuids to filter by. Only training phrases that have this intent uuid will be returned If not passed, returns all |
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
This message contains a list of training phrases filtered by intent ids, language code and parent passed through the request
Field | Type | Label | Description |
training_phrases | string | repeated | List of user_says values. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Optional. The next_page_token value returned from a previous list request.
Format: `current_index- |
This message containing the training phrases status
Field | Type | Label | Description |
training_phrase | Intent.TrainingPhrase |
|
|
error_message | string |
|
The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent].
Field | Type | Label | Description |
intent | Intent | Required. The intent to update. Format: |
|
language_code | string | Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [More than a dozen languages](https://dialogflow.com/docs/reference/language) are supported. Note: languages must be enabled in the agent, before they can be used. |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
|
intent_view | IntentView | Optional. The resource view to apply to the returned intent. |
Structure of status of an Intent
Name | Number | Description |
ACTIVE | 0 | |
INACTIVE | 1 |
Represents different platforms that a rich message can be intended for.
Name | Number | Description |
PLATFORM_UNSPECIFIED | 0 | Not specified. |
1 | Facebook. |
|
SLACK | 2 | Slack. |
TELEGRAM | 3 | Telegram. |
KIK | 4 | Kik. |
SKYPE | 5 | Skype. |
LINE | 6 | Line. |
VIBER | 7 | Viber. |
ACTIONS_ON_GOOGLE | 8 | Actions on Google. When using Actions on Google, you can choose one of the specific Intent.Message types that mention support for Actions on Google, or you can use the advanced Intent.Message.payload field. The payload field provides access to AoG features not available in the specific message types. If using the Intent.Message.payload field, it should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) { "expectUserResponse": true, "isSsml": false, "noInputPrompts": [], "richResponse": { "items": [ { "simpleResponse": { "displayText": "hi", "textToSpeech": "hello" } } ], "suggestions": [ { "title": "Say this" }, { "title": "or this" } ] }, "systemIntent": { "data": { "@type": "type.googleapis.com/google.actions.v2.OptionValueSpec", "listSelect": { "items": [ { "optionInfo": { "key": "key1", "synonyms": [ "key one" ] }, "title": "must not be empty, but unique" }, { "optionInfo": { "key": "key2", "synonyms": [ "key two" ] }, "title": "must not be empty, but unique" } ] } }, "intent": "actions.intent.OPTION" } } |
PLACEHOLDER_1 | 9 | |
PLACEHOLDER_2 | 10 | |
PLACEHOLDER_3 | 11 | |
PLACEHOLDER_4 | 12 | |
PLACEHOLDER_5 | 13 | |
PLACEHOLDER_6 | 14 | |
PLACEHOLDER_7 | 15 | |
PLACEHOLDER_8 | 16 | |
PLACEHOLDER_9 | 17 | |
PLACEHOLDER_10 | 18 | |
PLACEHOLDER_11 | 19 | |
PLACEHOLDER_12 | 20 | |
PLACEHOLDER_13 | 21 | |
PLACEHOLDER_14 | 22 | |
PLACEHOLDER_15 | 23 | |
PLACEHOLDER_16 | 24 | |
PLACEHOLDER_17 | 25 | |
PLACEHOLDER_18 | 26 | |
PLACEHOLDER_19 | 27 | |
PLACEHOLDER_20 | 28 |
Represents different types of training phrases.
Name | Number | Description |
TYPE_UNSPECIFIED | 0 | Not specified. This value should never be used. |
EXAMPLE | 1 | Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types. |
TEMPLATE | 2 | Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. |
Represents the different states that webhooks can be in.
Name | Number | Description |
WEBHOOK_STATE_UNSPECIFIED | 0 | Webhook is disabled in the agent and in the intent. |
WEBHOOK_STATE_ENABLED | 1 | Webhook is enabled in the agent and in the intent. |
WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING | 2 | Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook. |
Represents the type of intents to filter by in the "List Intents" request
Name | Number | Description |
ALL_INTENTS | 0 | represent all intents |
DEFAULT_INTENTS | 1 | represent the default intents |
USER_DEFINED_INTENTS | 2 | represent the user defined (custom) intents |
DATE_EXPIRED_INTENTS | 3 | represents the intents that had its end_date elapsed |
DATE_ACTIVE_INTENTS | 4 | represents the intents that its start_date began but had not yet expired |
DATE_UPCOMING_INTENTS | 5 | represent the intents that are still expecting its start_date to begin |
Structure of intent sorting field
Name | Number | Description |
NO_INTENT_SORTING | 0 | |
SORT_INTENT_BY_NAME | 1 | |
SORT_INTENT_BY_CREATION_DATE | 2 | |
SORT_INTENT_BY_LAST_UPDATED | 3 | |
SORT_INTENT_BY_USERSAYS_COUNT | 4 | |
SORT_INTENT_BY_START_DATE | 5 | |
SORT_INTENT_BY_END_DATE | 6 |
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.
Name | Number | Description |
INTENT_VIEW_UNSPECIFIED | 0 | Same as INTENT_VIEW_FULL |
INTENT_VIEW_FULL | 1 | All fields are populated. |
INTENT_VIEW_PARTIAL | 2 | The only nested structures populated are Contexts and Training phrases. The Training phrases field is populated with only a few entries and no annotations. |
INTENT_VIEW_SHALLOW | 3 | All nested structures are not populated (no training phrases, nor contexts, nor parameters, ...) |
INTENT_VIEW_MINIMUM | 4 | Minimum view including only intent UUID and intent display name |
Represents the metadata of the long-running operation that can be a parent operation for sub-operations or
can be a sub-operation itself
Field | Type | Label | Description |
status | OperationMetadata.Status | long-running operation status code |
|
parent_operation_name | string | optional parent operation name |
|
sub_operation_names | string | repeated | list of the sub-operations' names of the operation |
create_time | google.protobuf.Timestamp | the time the operation was submitted. |
|
start_time | google.protobuf.Timestamp | the time operation processing started. |
|
end_time | google.protobuf.Timestamp | the time operation processing completed. |
|
is_cancellation_requested | bool | indicates whether a request to cancel this operation has been made. |
|
cancel_command | string | command executed at cancel operation |
|
user_id_created | string | id of the user who created the operation |
|
user_id_cancelled | string | id of the user who cancelled the operation |
|
project_parent | string | project parent name, e.g. "projects/pepper/agent" |
|
operation_type | OperationMetadata.OperationType | operation type |
|
host_name | string | name of the host where the operation was executed |
|
num_reruns | int32 | number of times the operation was re-run |
|
max_num_reruns | int32 | maximum number of re-runs in case the operation fails |
|
description | string | description, normally needed for sub operations when type is OPERATION_TYPE_UNSPECIFIED |
|
log | string | repeated | The log output of an operation |
log_limit | int32 | The log output of an operation limited to the last x log entries |
|
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Type of operation. It can be creating, importing, exporting, deleting, restoring, building cache,
training or exporting benchmark an agent
Name | Number | Description |
OPERATION_TYPE_UNSPECIFIED | 0 | unspecified operation type |
CREATE_AGENT | 1 | create a new agent with specified configuration |
IMPORT_AGENT | 2 | import agent from a zip file |
EXPORT_AGENT | 3 | export agent to a zip file |
DELETE_AGENT | 4 | delete agent |
RESTORE_AGENT | 5 | restore agent |
BUILD_AGENT_CACHE | 6 | build agent cache |
TRAIN_AGENT | 7 | train agent |
EXPORT_BENCHMARK_AGENT | 8 | export benchmark agent to a zip file |
INDEX_AGENT | 9 | force loading agent data for full text search |
Structure to set status of operation. An operation may not be started if NOT_STARTED is set, in
progress if IN_PROGRESS, finished if DONE, interrupted if CANCELED or failed if FAILED.
Name | Number | Description |
STATUS_UNSPECIFIED | 0 | unspecified status code |
NOT_STARTED | 1 | operation haven't started yet |
IN_PROGRESS | 2 | operation currently in progress |
DONE | 3 | operation has completed without any error |
CANCELLED | 4 | operation has completed with cancellation by user |
FAILED | 5 | operation has completed with errors |
Manages long-running operations with an API service.
When an API method normally takes long time to complete, it can be designed
to return [Operation][ondewo.nlu.Operation] to the client, and the client can use this
interface to receive the real response asynchronously by polling the
operation resource, or pass the operation resource to another API (such as
Google Cloud Pub/Sub API) to receive the response. Any API service that
returns long-running operations should implement the `Operations` interface
so developers can have a consistent client experience.
rpc ListOperations (ListOperationsRequest) returns (ListOperationsResponse)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
rpc GetOperation (GetOperationRequest) returns (Operation)Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
rpc DeleteOperation (DeleteOperationRequest) returns (.google.protobuf.Empty)Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
rpc CancelOperation (CancelOperationRequest) returns (.google.protobuf.Empty)Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use [Operations.GetOperation][ondewo.nlu.Operations.GetOperation] or other methods to verify whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][ondewo.nlu.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
Method Name | Method | Pattern | Body |
ListOperations | GET | /v1/{name=operations} | |
GetOperation | GET | /v1/{name=operations/**} | |
DeleteOperation | DELETE | /v1/{name=operations/**} | |
CancelOperation | POST | /v1/{name=operations/**}:cancel | * |
The request message for [Operations.CancelOperation][ondewo.nlu.Operations.CancelOperation].
Field | Type | Label | Description |
name | string | The name of the operation resource to be cancelled. |
The request message for [Operations.DeleteOperation][ondewo.nlu.Operations.DeleteOperation].
Field | Type | Label | Description |
name | string | The name of the operation resource to be deleted. |
The request message for [Operations.GetOperation][ondewo.nlu.Operations.GetOperation].
Field | Type | Label | Description |
name | string | The name of the operation resource. |
The request message for [Operations.ListOperations][ondewo.nlu.Operations.ListOperations].
Field | Type | Label | Description |
name | string | The name of the operation collection. |
|
filter | string | The standard list filter. |
|
page_size | int32 | The standard list page size. |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
operation_filter | OperationFilter | Optional. A filter to narrow the response down to operations of interest. |
The response message for [Operations.ListOperations][ondewo.nlu.Operations.ListOperations].
Field | Type | Label | Description |
operations | Operation | repeated | A list of operations that matches the specified filter in the request. |
next_page_token | string | The standard List next-page token. |
This resource represents a long-running operation that is the result of a
network API call.
Field | Type | Label | Description |
name | string | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. |
|
metadata | OperationMetadata | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
|
done | bool | If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. |
|
error | google.rpc.Status | The error result of the operation in case of failure or cancellation. |
|
response | google.protobuf.Any | The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
This message contains an operation filter
Field | Type | Label | Description |
project_parents | string | repeated | An operationFilter can be used in some requests to return only operations matching certain filter conditions. All fields below are optional. Multiple fields specified at the same time are chained via OR. Match operations with any of the following project parents. |
statuses | OperationMetadata.Status | repeated | Match operation which had any of the following operation statuses. |
types | OperationMetadata.OperationType | repeated | Match operation which had any of the following operation types. |
start_time | google.protobuf.Timestamp | The time operation processing started. |
|
end_time | google.protobuf.Timestamp | The time operation processing completed. |
|
user_ids | string | repeated | Match operation which had any of the following user_ids. |
Project roles
rpc CreateProjectRole (CreateProjectRoleRequest) returns (ProjectRole)Creates a project role by creating the knowledge base master
rpc GetProjectRole (GetProjectRoleRequest) returns (ProjectRole)Creates a project role by getting the knowledge base master
rpc DeleteProjectRole (DeleteProjectRoleRequest) returns (.google.protobuf.Empty)Deletes project role
rpc UpdateProjectRole (UpdateProjectRoleRequest) returns (ProjectRole)Updates project role
rpc ListProjectRoles (ListProjectRolesRequest) returns (ListProjectRolesResponse)List project roles
Method Name | Method | Pattern | Body |
CreateProjectRole | POST | /v2/{parent=projects/*/agent}/project_roles | * |
GetProjectRole | GET | /v2/{parent=projects/*/agent}/project_roles/{role_id=*} | |
DeleteProjectRole | DELETE | /v2/{parent=projects/*/agent}/project_roles/{role_id=*} | |
UpdateProjectRole | PATCH | /v2/{parent=projects/*/agent}/project_roles | * |
ListProjectRoles | GET | /v2/{parent=projects/*/agent}/project_roles |
This message is a request to create project role
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
role | ProjectRole | If the role_id is not provided, an incremental value will be assigned The "name" and "role_type" are mandatory values The permissions all default to False if not provided specifically |
|
project_role_view | ProjectRoleView | Optional. specify the view of the created project role, PROJECT_ROLE_VIEW_FULL by default |
This message is a request to delete project role
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
role_id | uint32 | role is identified by role id, if empty will throw an error in the backend |
This message is a request to get project role
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
role_id | uint32 | role is identified by role id |
|
role_name | string | role can also be uniquely identified by its name |
|
project_role_view | ProjectRoleView | Optional. specify the view of the project role, PROJECT_ROLE_VIEW_FULL by default |
This message is a request to list project role
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
page_token | string | Optional: The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings: * "" (empty string) - Retrieves the first page. * "current_index-0--page_size-20" - Retrieves the first page with a page size of 20. * "current_index-1--page_size-20" - Retrieves the second page with a page size of 20. Index starts at 0. Examples of valid page token strings: * "" * "current_index-0--page_size-20" * "current_index-1--page_size-20" * "current_index-10--page_size-20" Examples of invalid page token strings: * "1" * "current_index-0--page_size-20" * "current_index--1--page_size-20" * "current_index1--page_size-20" * "current_index-1--page_size--20" |
|
project_role_view | ProjectRoleView | Optional. specify the view of the project roles, PROJECT_ROLE_VIEW_FULL by default |
This message is a response of listing project role
Field | Type | Label | Description |
project_roles | ProjectRole | repeated | The list of project roles. There will be a maximum number of items returned based on the page_token field in the request. |
next_page_token | string | Token to retrieve the next page of results, or empty if there are no more results in the list. |
Project Role messages
Field | Type | Label | Description |
role_id | uint32 | unique identifier of the role |
|
name | string | unique name of the role |
|
permissions | string | repeated | defines the permissions for the given role (the strings can be gotten from the ListProjectPermissions) |
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
This message is a request to update project role
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
role | ProjectRole | role_id in the Role message should be given, if empty will throw an error in the backend other fields in the Role are optional. Only the fields to be updated should be provided |
|
update_mask | google.protobuf.FieldMask | Optional. The mask to control which fields get updated. |
|
project_role_view | ProjectRoleView | Optional. specify the view of the updated project role, PROJECT_ROLE_VIEW_FULL by default |
Structure of project role
Name | Number | Description |
PROJECT_UNSPECIFIED | 0 | These roles have permissions valid only on a specific project unspecified, default value depends on endpoint |
PROJECT_USER | 1 | read-only access |
PROJECT_EXECUTOR | 2 | permissions of PROJECT_USER + execution rights (detect intent, extract entities, train, etc) |
PROJECT_DEVELOPER | 3 | permissions of PROJECT_EXECUTOR + CRUD rights |
PROJECT_ADMIN | 4 | this role can do everything. The creator of a project is set automatically as PROJECT_ADMIN of it. |
PROJECT_INACTIVE | 5 | This role can do nothing. Used to set a user as inactive inside a project |
Structure of project role view
Name | Number | Description |
PROJECT_ROLE_VIEW_UNSPECIFIED | 0 | The view depends on the endpoint: * CreateProjectRole: FULL * GetProjectRole: FULL * UpdateProjectRole: FULL * ListProjectRoles: FULL |
PROJECT_ROLE_VIEW_SHALLOW | 1 | only role ID and name fields are populated |
PROJECT_ROLE_VIEW_FULL | 2 | all fields including permissions are populated |
Project Root Statistics
rpc GetIntentCount (GetIntentCountRequest) returns (StatResponse)Returns the intent count within a project
rpc GetEntityTypeCount (GetEntityTypeCountRequest) returns (StatResponse)Returns the entity types count within a project
rpc GetUserCount (GetProjectStatRequest) returns (StatResponse)Returns the users count within a project
rpc GetSessionCount (GetProjectStatRequest) returns (StatResponse)Returns the sessions count within a project
rpc GetTrainingPhraseCount (GetProjectElementStatRequest) returns (StatResponse)Returns the training phrases count within a project
rpc GetResponseCount (GetProjectElementStatRequest) returns (StatResponse)Returns the responses count within a project
rpc GetEntityValueCount (GetProjectElementStatRequest) returns (StatResponse)Returns the entity value count within a project
rpc GetEntitySynonymCount (GetProjectElementStatRequest) returns (StatResponse)Returns the entity synonyms count within a project
Method Name | Method | Pattern | Body |
GetIntentCount | GET | /{parent=projects/*/agent}/intents:count | |
GetEntityTypeCount | GET | /{parent=projects/*/agent}/entityTypes:count | |
GetUserCount | GET | /{parent=projects/*/agent}/users:count | |
GetSessionCount | GET | /{parent=projects/*/agent}/sessions:count | |
GetTrainingPhraseCount | GET | /{name=projects/*/agent/intents/*}/trainingPhrases:count | |
GetResponseCount | GET | /{name=projects/*/agent/intents/*}/responses:count | |
GetEntityValueCount | GET | /{name=projects/*/agent/entityTypes/*}/entities:count | |
GetEntitySynonymCount | GET | /{name=projects/*/agent/entityTypes/*/entityValues/*}/entitySynonyms:count |
Request to get entity type count
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
filter_by_category | EntityTypeCategory | Optional. Applies a filter to the list to be counted. Default, no filter. |
Request to get the intent count
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
filter_by_category | IntentCategory | Optional. Applies a filter to the list to be counted. Default, no filter. |
Request to get project element statistics
Field | Type | Label | Description |
name | string | Required. The name/path of the concept to get the statistic from.
Example:
* `projects/ |
|
language_code | string |
|
Request to get project statistics
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
Server project statistics
rpc GetProjectCount (.google.protobuf.Empty) returns (StatResponse)Returns the count of projects in the CAI server
rpc GetUserProjectCount (GetUserProjectCountRequest) returns (StatResponse)Returns the count of projects of a user
rpc GetUserCount (.google.protobuf.Empty) returns (StatResponse)Returns the users count within a project
Method Name | Method | Pattern | Body |
GetProjectCount | GET | /projects:count | |
GetUserProjectCount | GET | /users/{user_identifier=*}/projects:count | |
GetUserCount | GET | /users:count |
Request to get user project count
Field | Type | Label | Description |
user_id | string | Required. The ID of the User to count the projects from |
A session represents an interaction with a user. You retrieve user input
and pass it to the [DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
[StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method to determine
user intent and respond.
rpc DetectIntent (DetectIntentRequest) returns (DetectIntentResponse)Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
rpc StreamingDetectIntent (stream StreamingDetectIntentRequest) returns (stream StreamingDetectIntentResponse)Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
rpc ListSessions (ListSessionsRequest) returns (ListSessionsResponse)SESSION RELATED ENDPOINTS *** // ListSessions: returns list of sessions from ondewo-kb; by default returns only session IDs
rpc GetSession (GetSessionRequest) returns (Session)GetSession: returns a session(=conversation) from ondewo-kb
rpc CreateSession (CreateSessionRequest) returns (Session)CreateSession: creates and returns a session(=conversation) from ondewo-kb
rpc TrackSessionStep (TrackSessionStepRequest) returns (Session)TrackSessionStep: append to an existing session; creates it if not existing
rpc DeleteSession (DeleteSessionRequest) returns (.google.protobuf.Empty)DeleteSession: delete a session(=conversation) from ondewo-kb (for testing only)
rpc ListSessionLabels (ListSessionLabelsRequest) returns (ListSessionLabelsResponse)SESSION-LABEL RELATED ENDPOINTS *** //
rpc ListSessionLabelsOfAllSessions (ListSessionLabelsOfAllSessionsRequest) returns (ListSessionLabelsResponse)
rpc ListLanguageCodesOfAllSessions (ListLanguageCodesOfAllSessionsRequest) returns (ListLanguageCodesResponse)
rpc ListMatchedIntentsOfAllSessions (ListMatchedIntentsOfAllSessionsRequest) returns (ListMatchedIntentsResponse)
rpc ListMatchedEntityTypesOfAllSessions (ListMatchedEntityTypesOfAllSessionsRequest) returns (ListMatchedEntityTypesResponse)
rpc ListUserIdsOfAllSessions (ListUserIdsOfAllSessionsRequest) returns (ListUserIdsResponse)
rpc ListIdentifiedUserIdsOfAllSessions (ListIdentifiedUserIdsOfAllSessionsRequest) returns (ListIdentifiedUserIdsResponse)
rpc ListTagsOfAllSessions (ListTagsOfAllSessionsRequest) returns (ListTagsResponse)
rpc ListInputContextsOfAllSessions (ListInputContextsOfAllSessionsRequest) returns (ListInputContextsResponse)
rpc ListOutputContextsOfAllSessions (ListOutputContextsOfAllSessionsRequest) returns (ListOutputContextsResponse)
rpc ListPlatformsOfAllSessions (ListPlatformsOfAllSessionsRequest) returns (ListPlatformsResponse)
rpc ListAccountIdsOfAllSessions (ListAccountIdsOfAllSessionsRequest) returns (ListAccountIdsResponse)
rpc ListPropertyIdsOfAllSessions (ListPropertyIdsOfAllSessionsRequest) returns (ListPropertyIdsResponse)
rpc ListDatastreamIdsOfAllSessions (ListDatastreamIdsOfAllSessionsRequest) returns (ListDatastreamIdsResponse)
rpc ListOriginIdsOfAllSessions (ListOriginIdsOfAllSessionsRequest) returns (ListOriginIdsResponse)
rpc AddSessionLabels (AddSessionLabelsRequest) returns (Session)
rpc DeleteSessionLabels (DeleteSessionLabelsRequest) returns (Session)
rpc AddSessionComment (AddSessionCommentRequest) returns (Comment)
rpc DeleteSessionComments (DeleteSessionCommentsRequest) returns (Session)
rpc UpdateSessionComments (UpdateSessionCommentsRequest) returns (Session)
rpc ListSessionComments (ListSessionCommentsRequest) returns (ListSessionCommentsResponse)
rpc ListSessionReviews (ListSessionReviewsRequest) returns (ListSessionReviewsResponse)SESSION-REVIEW RELATED ENDPOINTS *** // ListSessionReviews: returns list of session reviews from ondewo-kb; by default only returns session review IDs
rpc GetSessionReview (GetSessionReviewRequest) returns (SessionReview)GetSessionReview: returns a session-review from ondewo-kb or computes the first review if none exists
rpc GetLatestSessionReview (GetLatestSessionReviewRequest) returns (SessionReview)GetLatestSessionReview: returns a session-review from ondewo-kb or computes the first review if none exists
rpc CreateSessionReview (CreateSessionReviewRequest) returns (SessionReview)CreateSessionReview: persist a session review in ondewo-kb as a side effect: also update training data in ondewo-cai
rpc GetAudioFiles (GetAudioFilesRequest) returns (GetAudioFilesResponse)RPC to get audio files based on specified criteria. Retrieves information about audio files associated with specific sessions. Returns a response containing details of the requested audio files.
rpc AddAudioFiles (AddAudioFilesRequest) returns (AddAudioFilesResponse)RPC to add audio files to a session. Adds new audio files to the specified session, providing details about each file. Returns a response containing information about the added audio files.
rpc DeleteAudioFiles (DeleteAudioFilesRequest) returns (DeleteAudioFilesResponse)RPC to delete specified audio files. Deletes audio files associated with specific sessions based on unique identifiers. Returns an empty response indicating the successful deletion of the specified audio files.
rpc GetAudioFileOfSession (GetAudioFileOfSessionRequest) returns (AudioFileResource)RPC to get a consolidated audio file for a specific session. Retrieves a single audio file that combines all audio files associated with the specified session. Returns details of the consolidated audio file.
rpc ListAudioFiles (ListAudioFilesRequest) returns (ListAudioFilesResponse)RPC to get a list audio files for a specific session. Retrieves a single audio file that combines all audio files associated with the specified session.
Method Name | Method | Pattern | Body |
DetectIntent | POST | /v2/{session=projects/*/agent/sessions/*}:detectIntent | * |
ListSessions | GET | /v2/{parent=projects/*/agent}/sessions | |
GetSession | GET | /v2/{session_id=projects/*/agent/sessions/*} | |
CreateSession | POST | /v2/{parent=projects/*/agent}/sessions | * |
TrackSessionStep | POST | /v2/{session_id=projects/*/agent/sessions/*}:trackSessionStep | * |
DeleteSession | DELETE | /v2/{session_id=projects/*/agent/sessions/*} | |
ListSessionLabels | GET | /v2/{session_id=projects/*/agent/sessions/*}/labels | |
ListSessionLabelsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/labels | |
ListLanguageCodesOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/language_codes | |
ListMatchedIntentsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/matched_intents | |
ListMatchedEntityTypesOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/matched_entity_types | |
ListUserIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/user_ids | |
ListIdentifiedUserIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/identified_user_ids | |
ListTagsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/tags | |
ListInputContextsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/input_contexts | |
ListOutputContextsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/output_contexts | |
ListPlatformsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/platforms | |
ListAccountIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/account_ids | |
ListPropertyIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/property_ids | |
ListDatastreamIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/datastream_ids | |
ListOriginIdsOfAllSessions | GET | /v2/{parent=projects/*/agent}/sessions/origin_ids | |
AddSessionLabels | POST | /v2/{session_id=projects/*/agent/sessions/*}/labels:add | * |
DeleteSessionLabels | POST | /v2/{session_id=projects/*/agent/sessions/*}/labels:delete | * |
AddSessionComment | POST | /v2/{session_id=projects/*/agent/sessions/*}/comments:add | * |
DeleteSessionComments | POST | /v2/{session_id=projects/*/agent/sessions/*}/comments:delete | * |
UpdateSessionComments | POST | /v2/{session_id=projects/*/agent/sessions/*}/comments:update | * |
ListSessionComments | GET | /v2/{session_id=projects/*/agent/sessions/*}/reviews | |
ListSessionReviews | GET | /v2/{session_id=projects/*/agent/sessions/*}/reviews | |
GetSessionReview | GET | /v2/{session_review_id=projects/*/agent/sessions/*/reviews/*} | |
GetLatestSessionReview | GET | /v2/{session_id=projects/*/agent/sessions/*}/reviews:getLatestSessionReview | |
CreateSessionReview | POST | /v2/{session_id=projects/*/agent/sessions/*}:createSessionReview | * |
This message is a request to add the audio files specified
Field | Type | Label | Description |
parent | string | Required. The project of this agent. Format: |
|
session_id | string | The unique identifier of the session for which the audio files should be listed Format: |
|
audio_file_resources | AudioFileResource | repeated | AudioFileResources to be added |
This message is a request to add the audio files specified
Field | Type | Label | Description |
audio_file_resources | AudioFileResource | repeated | The unique identifier of the audio files for a specific session. Format: |
error_message | string | error message if there are any. |
This message is a request to add a comment to a session
Field | Type | Label | Description |
session_id | string | The id of the session |
|
comment | Comment | The comment to add to the session |
This message is a request to add session labels
Field | Type | Label | Description |
session_id | string | The id of the session |
|
labels | string | repeated | The labels to add to the session |
Field | Type | Label | Description |
name | string | The unique identifier of the session for which the latest review should be returned Format: |
|
bytes | bytes | Bytes of the audio file |
|
language | string | Language of the audio file |
|
duration_in_s | float | Duration in seconds and milliseconds of the audio file |
|
sample_rate | int32 | sample rate of the audio |
|
audio_file_resource_type | AudioFileResourceType | File type of an audio resource |
|
transcriptions | S2tTranscription | repeated | transcriptions of the user input sorted by score. A transcription can be from a speech-to-text system or a human |
created_at | google.protobuf.Timestamp | Creation date and time. Read-only field. |
|
modified_at | google.protobuf.Timestamp | Modification date and time. Read-only field. |
|
created_by | string | User id in form of a valid UUID. |
|
modified_by | string | User id in form of a valid UUID. |
Message used to filter sessions based on contextual information
Field | Type | Label | Description |
context_name | string | name of the context |
|
key | string | name of the key of the context parameter |
|
value | string | value of the parameter |
|
operator | ComparisonOperator |
|
This message is a request to create a session
Field | Type | Label | Description |
parent | string | Required. The project that the agent to fetch is associated with. Format: |
|
session_uuid | string | The unique UUID of a Session Format: UUID Version 4, e.g. 2f59fad2-06bc-4730-9920-d3148f28f357 Optional. If not provided, it will be auto-generated |
|
labels | string | repeated | Optional. labels for the session. |
contexts | Context | repeated | Optional. The collection of contexts to be activated before this query is executed. |
SESSION-REVIEW RELATED MESSAGES *** //
Field | Type | Label | Description |
session_id | string | The unique identifier for the session under review Format: |
|
parent_review_id | string | Optional: The unique identifier of the parent review Format: |
|
session_review | SessionReview | The reviews for all steps in the session |
|
session_review_view | SessionReview.View |
|
This message is a request to the delete audio files specified
Field | Type | Label | Description |
parent | string | Required. The project of this agent. Format: |
|
names | string | repeated | The unique identifier of the audio file of the specific session Format: |
This message is a request to the delete audio files specified
Field | Type | Label | Description |
names | string | repeated | The unique identifier of the audio file of the specific session Format: |
error_message | string | error message if there are any. |
This message is a request to delete a session comment
Field | Type | Label | Description |
session_id | string | The id of the session |
|
comment_names | string | repeated | The comment names to delete from the session |
This message is a request to delete session labels
Field | Type | Label | Description |
session_id | string | The id of the session |
|
labels | string | repeated | The labels to delete from the session |
This message is a request to delete a session
Field | Type | Label | Description |
session_id | string | Required. The session to be deleted Format: |
The request to detect user's intent.
Field | Type | Label | Description |
session | string | Required. The name of the session this query is sent to. Format:
`projects/ |
|
query_params | QueryParameters | Optional. The parameters of this query. |
|
query_input | QueryInput | Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. |
|
input_audio | bytes | Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data. |
The message returned from the DetectIntent method.
Field | Type | Label | Description |
response_id | string | The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. |
|
query_result | QueryResult | The results of the conversational query or event processing. |
|
webhook_status | google.rpc.Status | Specifies the status of the webhook request. `webhook_status` is never populated in webhook requests. |
This message contains a detected intent
Field | Type | Label | Description |
intent | Intent | intent |
|
score | float | score of intent detection |
|
algorithm | string | intent detection algorithm |
|
fulfillment_messages | Intent.Message | repeated | collection of rich messages to present to the user This field is set only for the first detected intent. For the rest of the intents the messages are not resolved and the raw messages for the current language code are available in self.intent.messages |
required_param_missing | bool | This field is set to: - `true` if the matched intent has required parameters and not all of the required parameter values have been collected. - `false` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. |
Events allow for matching intents by event name instead of the natural
language input. For instance, input ` 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?”`. Required. The unique identifier of the event. Optional. The collection of parameters associated with the event. Required. The language of this query. See [Language
Support](https://dialogflow.com/docs/languages) for a list of the
currently supported language codes. Note that queries in the same session
do not necessarily need to specify the same language. This message is a request to get one one file combining all audios of a specific session Required. The project of this agent.
Format: The unique identifier of the session for which the audio files should be combined
Format: Represents the options for views of resources This message is a request to get audio files specified Required. The project of this agent.
Format: The unique identifier of the audio file of the specific session
Format: Represents the options for views of resources Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" sorting mode This message is a request to retrieve the audio files specified The unique identifier of the audio file for a specific session.
Format: error message if there are any. Token to retrieve the next page of results, or empty if there are no more results in the list This message is a request to get latest session review The unique identifier of the session for which the latest review should be returned
Format: An enum specifying the amount of information to be returned for the desired session review This message is a request to get a session The session to be returned
Format: whether to return a full or sparse view; if unspecified full view is returned Optional. The mask to control which fields will be filled with data.
Example: path=["session_info.duration_in_s_min"] This message is a request to get session review The unique identifier of the session review to be returned Instructs the speech recognizer how to process the audio content. Required. Audio encoding of the audio content to process. Required. Sample rate (in Hertz) of the audio content sent in the query.
Refer to [Cloud Speech API documentation](/speech/docs/basics) for more
details. Required. The language of the supplied audio. Dialogflow does not do
translations. See [Language
Support](https://dialogflow.com/docs/languages) for a list of the
currently supported language codes. Note that queries in the same session
do not necessarily need to specify the same language. Optional. The collection of phrase hints which are used to boost accuracy
of speech recognition.
Refer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints)
for more details. request to list all account_ids of all sessions The parent for which the account_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session account_ids The account_ids of the session This message is a request to list all available audio files of a session Required. The project of this agent.
Format: Optional: The unique identifier of the session for which the audio files should be listed
Format: Represents the options for views of resources Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" sorting mode This message is a request to retrieve the audio files specified The requested audio files .
Format: Token to retrieve the next page of results, or empty if there are no more results in the list error message if there are any. request to list all datastream_ids of all sessions The parent for which the datastream_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session datastream_ids The datastream_ids of the session request to list all identified_user_ids of all sessions The parent for which the identified_user_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session identified_user_ids The identified_user_ids of the session request to list all input_contexts of all sessions The parent for which the input_contexts for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session input_contexts The input_contexts ids of the session request to list all language codes of all sessions The parent for which the language_codes for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session language_codes The language_codes of the session request to list all matched_entity_types of all sessions The parent for which the matched_entity_types for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session matched_entity_types The matched_entity_types of the session request to list all matched_intents of all sessions The parent for which the matched_intents for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session matched_intents The matched_intents of the session request to list all origin_ids of all sessions The parent for which the origin_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session origin_ids The origin_ids of the session request to list all output_contexts of all sessions The parent for which the output_contexts for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session output_contexts The output_contexts ids of the session request to list all labels of all sessions The parent for which the platforms for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session platforms The platforms of the session request to list all property_ids of all sessions The parent for which the property_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session property_ids The property_ids of the session This message is a request to list comments of a session The unique identifier for the session for which reviews should be listed
Format: Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" This message is a request to list comments of a session The comments of a specific session
Format: Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" request to list all labels of all sessions The parent for which the labels for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a request to list session labels The id of the session This message is a response of listing session labels The labels of the session This message is a request to list session reviews The unique identifier for the session for which reviews should be listed
Format: An enum specifying the amount of information to be returned per session review Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" This message is a response of listing session reviews The requested session reviews Token to retrieve the next page of results, or empty if there are no more results in the list This message is a request to list sessions Required. The project that the agent to fetch is associated with.
Format: An enum specifying the amount of information to be returned per session Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" Optional. A filter to narrow the response down to sessions of interest. Optional. The mask to control which fields will be filled with data.
Example: path=["session_info.duration_in_s_min"] This message is a response including the listing of sessions The requested sessions Token to retrieve the next page of results, or empty if there are no more results in the list request to list all tags of all sessions The parent for which the tags for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session tags The tags of the session request to list all user_ids of all sessions The parent for which the user_ids for all sessions should be listed
Format: Optional. A filter to narrow the response down to sessions of interest. This message is a response of listing session user_ids The user_ids of the session Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text,. 3. An event that specifies which intent to trigger. Instructs the speech recognizer how to process the speech audio. The natural language text to be processed. The event to be processed. Represents the parameters of the conversational query. Optional. The time zone of this conversational query from the
[time zone database](https://www.iana.org/time-zones), e.g.,
America/New_York, Europe/Paris. If not provided, the time zone specified in
agent settings is used. Optional. The geo location of this conversational query. Optional. The collection of contexts to be activated before this query is
executed. Optional. Specifies whether to delete all contexts in the current session
before the new ones are activated. Optional. This field can be used to pass custom data into the webhook
associated with the agent. Arbitrary JSON objects are supported.
key: labels associated to this request Only messages for the specified Intent.Message.Platform platforms are sent to the user in the
Id of the account, e.g. Company Ondewo Id of the property of the account, e.g. Domain ondewo.com
This field can also be used for a customized tracking id or tag id Id of the datastream of the property of the account, e.g. Subdomain sub1.ondewo.com or sub2.ondewo.com
This field can also be used for a customized tracking id or tag id Id of the the origin of the user request
For a phone bot, this is the phone number +123456789 the user called (Note: This is not the user's phone number)
For a chatbot or voicebot on the web, this is the URL on which the bo, e.g. https://ondewo.com/webchat
For a voice assistant device, this is the device-id or the app id
This field can also be used for a customized tracking id or tag id
https://aim-develop.ondewo.com/ Id of the "identified user" e.g. for a chatbot the email address or for a phone bot the phone number of the user
This field can also be used for a customized tracking id or tag id transcriptions of the user input sorted by score Represents the result of conversational query or event processing. The original conversational query text:
- If natural language text was provided as input, `query_text` contains
a copy of the input.
- If natural language speech audio was provided as input, `query_text`
contains the speech recognition result. If speech recognizer produced
multiple alternatives, a particular one is picked.
- If an event was provided as input, `query_text` is not set. The Speech recognition confidence between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. The default of 0.0 is a sentinel value indicating that confidence
was not set.
You should not rely on this field as it isn't guaranteed to be accurate, or
even set. In particular this field isn't set in Webhook calls and for
StreamingDetectIntent since the streaming endpoint has separate confidence
estimates per portion of the audio in StreamingRecognitionResult. The action name from the matched intent. The collection of extracted parameters. This field is set to:
- `false` if the matched intent has required parameters and not all of
the required parameter values have been collected.
- `true` if all required parameter values have been collected, or if the
matched intent doesn't contain any required parameters. The text to be pronounced to the user or shown on the screen. The collection of rich messages to present to the user. If the query was fulfilled by a webhook call, this field is set to the
value of the `source` field returned in the webhook response. If the query was fulfilled by a webhook call, this field is set to the
value of the `payload` field returned in the webhook response. The collection of output contexts. If applicable,
`output_contexts.parameters` contains entries with name
` The intent that matched the conversational query. Some, not
all fields are filled in this message, including but not limited to:
`name`, `display_name` and `webhook_state`. The intent detection confidence. Values range from 0.0
(completely uncertain) to 1.0 (completely certain). The user input gets pre-processed by spelling correction, stop word removal etc. This property holds
the string that is passed to the entity recognition and intent detection The free-form diagnostic info. For example, this field
could contain webhook call latency. The language that was triggered during intent detection.
See [Language Support](https://dialogflow.com/docs/reference/language)
for a list of the currently supported language codes. Represents a speech-to-text transcription. resource name of the transcription The transcribed text content. Optional. A confidence score associated with the transcription.
The score indicates the level of confidence in the accuracy of the transcription.
It is a floating-point number, typically ranging from 0.0 (low confidence) to 1.0 (high confidence). Optional. The detected language of the transcription.
The language is represented by a string following language codes (e.g., "en" for English, "es" for Spanish). the resource name of the audio file of the transcription Optional. pipeline used for transcription. A pipeline ID. Example: "pipeline_1" Optional. Duration in seconds for transcription Whether a speech-to-text engine or a human has transcribed the audio Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. Session of a user interaction The unique identifier of the session
Format: The list of all the steps of the session session information Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. This message contains a session filter A SessionFilter can be used in some requests to return only sessions matching certain filter conditions.
All fields below are optional. Multiple fields specified at the same time are chained via AND.
Match only sessions with all of the following language_codes Match only sessions during which all of the following intents were detected
NOTE: only name and display name fields are used for comparison Match only sessions during which all of the following entity types were recognized
NOTE: only name and display name fields are used for comparison Match only sessions where the minimum confidence for intent detection along the session falls
in the following range. Defaults to -1 if not set. Match only sessions where the minimum confidence for intent detection along the session falls
in the following range. Defaults to +1 if not set. Match only sessions where the minimum confidence for entity recognition along the session falls
in the following range. Defaults to -1 if not set. Match only sessions where the minimum confidence for entity recognition along the session falls
in the following range. Defaults to +1 if not set. Match only sessions whose time range falls within the following range (in UNIX epochs).
Defaults to 0 if not set. Match only sessions whose time range falls within the following range (in UNIX epochs).
Defaults to current epoch if not set Match only sessions for which the number of turns (interaction steps) falls in the following range
Defaults to 0 if not set. Match only sessions for which the number of turns (interaction steps) falls in the following range
Defaults to MAXINT if not set. Match only session which have all of the following labels assigned Match only session which had all of the following user_ids interacting with them. Match only session which have all of the following intent tags assigned Match only sessions whose IDs are specified here Match only sessions whose session info contains at least one step having all the contexts specified here
The input contexts are pre-conditions for detecting intents The output contexts are the result of the intent matching and track the contextual state of a conversation Match only sessions for which the duration in seconds are larger or equal Match only sessions for which the duration in seconds are smaller or equal Match only sessions for which the duration in minutes are larger or equal Match only sessions for which the duration in minutes are smaller or equal Match only sessions for which the duration in minutes rounded are larger or equal Match only sessions for which the duration in minutes rounded are smaller or equal Match only sessions for which the duration in 15 seconds rounded are larger or equal Match only sessions for which the duration in 15 seconds rounded are smaller or equal Match only sessions for which the duration in 30 seconds rounded are larger or equal Match only sessions for which the duration in 30 seconds rounded are smaller or equal Match only sessions for which the duration in 45 seconds rounded are larger or equal Match only sessions for which the duration in 45 seconds rounded are smaller or equal Match only sessions for which the started_time_slot_per_hour (e.g. 08:00) are larger or equal Match only sessions for which the started_time_slot_per_hour (e.g. 14:00) are smaller or equal Match only sessions for which the started_time_slot_per_quarter_hour (e.g. 08:00) are larger or equal Match only sessions for which the started_time_slot_per_quarter_hour (e.g. 14:00) are smaller or equal Match only sessions for which the started_time_slot_per_half_hour (e.g. 08:00) are larger or equal Match only sessions for which the started_time_slot_per_half_hour (e.g. 14:00) are smaller or equal Match only sessions for which the started_time_slot_per_day_phase (e.g. 08:00) are larger or equal Match only sessions for which the started_time_slot_per_day_phase (e.g. 14:00) are smaller or equal Match only sessions for which the started_time_slot_per_minute (e.g. 08:00) are larger or equal Match only sessions for which the started_time_slot_per_minute (e.g. 14:00) are smaller or equal Match only sessions for which the duration in seconds rounded are larger or equal Match only sessions for which the duration in seconds rounded are smaller or equal Messages for each of the Intent.Message.Platform were sent to the user Ids of the account, e.g. Company Ondewo,
This field can also be used for customized tracking ids or tag ids Ids of the property of the account, e.g. Domain ondewo.com
This field can also be used for customized tracking ids or tag ids Ids of the datastream of the property of the account, e.g. Subdomain sub1.ondewo.com or sub2.ondewo.com
This field can also be used for customized tracking ids or tag ids Ids of the the origin of the user request
For a phone bot, this is the phone number +123456789 the user called (Note: This is not the user's phone number)
For a chatbot or voicebot on the web, this is the URL on which the bo, e.g. https://ondewo.com/webchat
For a voice assistant device, this is the device-id or the app id Ids of the "identified user" e.g. for a chatbot the email address or for a phone bot the phone number of the user Match only sessions for which the duration in 60 seconds rounded are larger or equal Match only sessions for which the duration in 60 seconds rounded are smaller or equal This message contains information about session A SessionInfo contains some general information about a session.
This information can be returned inside a Session object for consumption by a client.
Or it can be used by the backend to check whether the Session matches a given SessionFilter.
All fields below are optional. Multiple fields specified at the same time are chained
The language codes used in the given session. A list of intents which have been matched A list of entity types which have been matched The minimum confidence for intent recognition along the session The minimum confidence for entity recognition along the session The earliest date of the given session (in UNIX epochs), i.e. the time of the first interaction of a user
in the given session The latest date of the given session (in UNIX epochs), i.e. the time of the last interaction of a user
in the given session The number of turns (interaction steps) in the given session The list of labels of the given session The user_ids of the users which were interacting within the given session The list of intent tags in the given session The input contexts that are matched in the given session. The name of the context here is the short name
and not the full URL name including the project parent The output contexts that are matched in the given session. The name of the context here is the short name
and not the full URL name including the project parent duration in seconds duration in minutes duration in minutes rounded duration in 15 seconds intervals rounded duration in 30 seconds intervals rounded duration in 45 seconds intervals rounded started_time_slot_per_hour (e.g. 08:00) started_time_slot_per_quarter_hour (e.g. 08:00) started_time_slot_per_half_hour (e.g. 08:00) started_time_slot_per_day_phase (e.g. 14:00) started_time_slot_per_minute (e.g. 14:00) duration in seconds rounded Messages for each of the Intent.Message.Platform were sent to the user Ids of the account, e.g. Company Ondewo,
This field can also be used for customized tracking ids or tag ids Ids of the property of the account, e.g. Domain ondewo.com
This field can also be used for customized tracking ids or tag ids Ids of the datastream of the property of the account, e.g. Subdomain sub1.ondewo.com or sub2.ondewo.com
This field can also be used for customized tracking ids or tag ids Ids of the the origin of the user request
For a phone bot, this is the phone number +123456789 the user called (Note: This is not the user's phone number)
For a chatbot or voicebot on the web, this is the URL on which the bo, e.g. https://ondewo.com/webchat
For a voice assistant device, this is the device-id or the app id Ids of the "identified user" e.g. for a chatbot the email address or for a phone bot the phone number of the user duration in 60 seconds intervals rounded comments about a session The list of contexts of each step collected in an outer list This message contains a session review The unique identifier for the given review
Format: The reviews for all steps in the session Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. This message contains a session review step The unique identifier for the given review step
Format: The user says with markup of the detected entity types after the preprocessing such as spelling correction,
stopword removal etc. has been applied.
This string represents what has been passed to the entity recognition and intent detection algorithms. The language code Unique detected intents ordered by descending confidence The contexts which were active at the beginning of this step The output contexts of this step User input without any pre-processing applied Messages for each of the Intent.Message.Platform were sent to the user Timestamp of session review step Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. audio file resources associated with the session review step SessionStep is a single user interaction as part of a session The unique identifier for the given review
Format: The detect intent request of the session step The detect intent response of the session step The contexts which were active at the beginning of this step Timestamp of session step Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. audio file resources associated with the session step The top-level message sent by the client to the `StreamingDetectIntent` method. Multiple request messages should be sent in order: 1. The first message must contain `session`, `query_input` plus optionally `query_params` and/or `single_utterance`. The message must not contain `input_audio`. 2. If `query_input` was set to a streaming input audio config, all subsequent messages must contain only `input_audio`. Otherwise, finish the request stream. Required. The name of the session the query is sent to.
Format of the session name:
`projects/ Optional. The parameters of this query. Required. The input specification. It can be set to:
1. an audio config which instructs the speech recognizer how to process
the speech audio,
2. a conversational query in the form of text, or
3. an event that specifies which intent to trigger. Optional. If `false` (default), recognition does not cease until the
client closes the stream.
If `true`, the recognizer will detect a single spoken utterance in input
audio. Recognition ceases when it detects the audio's voice has
stopped or paused. In this case, once a detected intent is received, the
client should close the stream and start a new request with a new stream as
needed.
This setting is ignored when `query_input` is a piece of text or an event. Optional. The input audio content to be recognized. Must be sent if
`query_input` was set to a streaming input audio config. The complete audio
over all streaming messages must not exceed 1 minute. The top-level message returned from the `StreamingDetectIntent` method. Multiple response messages can be returned in order: 1. If the input was set to streaming audio, the first one or more messages contain `recognition_result`. Each `recognition_result` represents a more complete transcript of what the user said. The last `recognition_result` has `is_final` set to `true`. 2. The next message contains `response_id`, `query_result` and optionally `webhook_status` if a WebHook was called. The unique identifier of the response. It can be used to
locate a response in the training example set or for reporting issues. The result of speech recognition. The result of the conversational query or event processing. Specifies the status of the webhook request. 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. Example: 1. transcript: "tube" 2. transcript: "to be a" 3. transcript: "to be" 4. transcript: "to be or not to be" is_final: true 5. transcript: " that's" 6. transcript: " that is" 7. recognition_event_type: `RECOGNITION_EVENT_END_OF_SINGLE_UTTERANCE` 8. transcript: " that is the question" is_final: true Only two of the responses contain final results (#4 and #8 indicated by `is_final: true`). Concatenating these generates the full transcript: "to be or not to be that is the question". In each response we populate: * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`. * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `event_type`. Type of the result message. Transcript text representing the words that the user spoke.
Populated if and only if `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. The default of 0.0 is a sentinel value indicating `confidence` was not set.
If `false`, the `StreamingRecognitionResult` represents an
interim result that may change. If `true`, the recognizer will not return
any further hypotheses about this piece of the audio. May only be populated
for `event_type` = `RECOGNITION_EVENT_TRANSCRIPT`. The Speech confidence between 0.0 and 1.0 for the current portion of audio.
A higher number indicates an estimated greater likelihood that the
recognized words are correct. The default of 0.0 is a sentinel value
indicating that confidence was not set.
This field is typically only provided if `is_final` is true and you should
not rely on it being accurate or even set. Represents the natural language text to be processed. Required. The UTF-8 encoded natural language text to be processed.
Text length must not exceed 256 bytes. Required. The language of this conversational query. See [Language
Support](https://dialogflow.com/docs/languages) for a list of the
currently supported language codes. Note that queries in the same session
do not necessarily need to specify the same language. TrackSessionStepRequest stores a session step into the session The unique identifier for the given review
Format: The session step to be added Defines which fields of the session should be returned in the response This message is a request to update a session comment The id of the session The comment of a session to be updated Audio encoding of the audio content sent in the conversational query request. Refer to the [Cloud Speech API documentation](/speech/docs/basics) for more details. Not specified. Uncompressed 16-bit signed little-endian samples (Linear PCM). [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio
Codec) is the recommended encoding because it is lossless (therefore
recognition is not compromised) and requires only about half the
bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and
24-bit samples, however, not all fields in `STREAMINFO` are supported. 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000. Adaptive Multi-Rate wideband codec. `sample_rate_hertz` must be 16000. Opus encoded audio frames in Ogg container
([OggOpus](https://wiki.xiph.org/OggOpus)).
`sample_rate_hertz` must be 16000. Although the use of lossy encodings is not recommended, if a very low
bitrate encoding is required, `OGG_OPUS` is highly preferred over
Speex encoding. The [Speex](https://speex.org/) encoding supported by
Dialogflow API has a header byte in each block, as in MIME type
`audio/x-speex-with-header-byte`.
It is a variant of the RTP Speex encoding defined in
[RFC 5574](https://tools.ietf.org/html/rfc5574).
The stream is a sequence of blocks, one block per RTP packet. Each block
starts with a byte containing the length of the block, in bytes, followed
by one or more frames of Speex data, padded to an integral number of
bytes (octets) as specified in RFC 5574. In other words, each RTP header
is replaced with a single byte containing the block length. Only Speex
wideband is supported. `sample_rate_hertz` must be 16000. File type of an audio resource Unspecified audio file type Audio file from text to speech Audio file from speech to text Audio file from speech to text and text to speech Type of operator to compare equal operator greater operator, e.g. for numbers, dates, and strings greater or equal operator, e.g. for numbers, dates, and strings less or equal operator, e.g. for numbers, dates, and strings contains operator, e.g. part of string, or one of the elements in an iterable such as set or list starts with operator for string comparison only ends with operator for string comparison only Represents the options for views of resources. Resource view not specified All fields are populated including bytes e.g., for audio files Fields include metadata but no bytes Minimum view only without bytes and metadata Represents the options for views of a session. A session can be a sizable object. Therefore, we provide a resource view that does not return all data Endpoints decide whether to return the full or the sparse view All fields are populated. Only some fields are populated in the response. Represents the options for views of a session_review. A session_review can be a sizable object. Therefore, we provide a resource view that does not return all data Endpoints decide whether to return the full or the sparse view All fields are populated. Only some fields are populated in the response. Type of the response message. Not specified. Should never be used. Message contains a (possibly partial) transcript. Event indicates that the server has detected the end of the user's speech
utterance and expects no additional speech. Therefore, the server will
not process additional audio (although it may subsequently return
additional results). The client should stop sending additional audio
data, half-close the gRPC connection, and wait for any additional results
until the server closes the gRPC connection. This message is only sent if
`single_utterance` was set to `true`, and is not used otherwise. unspecified Automatic transcription by a speech to text system Manual human transcription gRPC service for managing users and server roles. Request to create server role If the role_id is not provided, an incremental value will be assigned
The "name" and "role_type" are mandatory values
The permissions all default to False if not provided specifically Request to create user user_id in the User message should be given, if empty will throw an error in the backend password Request to delete all user preferences with an optional filter substring. The name of the user.
Format: Optional: Only delete keys that match the provided regular expression.
If user does not add regex_filter, then all user preferences will be deleted
Example:
Only delete keys starting with DE: Request to delete server role role is identified by role id, if empty will throw an error in the backend Request to delete specific user preferences. The name of the user.
Format: List of keys to delete from user preferences. Optional: In addition to the keys specified also include all Response to delete specific user preferences. The name of the user.
Format: List of keys to delete from user preferences. error message if there are any. Request to delete user user is identified by user id, if empty will throw an error in the backend Request to get server role role is identified by role id role can also be uniquely identified by its name Request to get user preferences. The name of the user.
Format: Specific keys to retrieve from user preferences.
If keys are specified multiple times then only one KeyValue pair is returned Optional: In addition to the keys specified also include all Response containing user preferences. The name of the user.
Format: List of key-value pairs representing user preferences. error message if there are any. Request to get user the user is identified by user id the user can identified by their email Server permissions Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" Response containing list of server permissions The list of server permissions. There will be a maximum number of items
returned based on the page_token field in the request. Token to retrieve the next page of results, or empty if there are no
more results in the list. Request to list server roles Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" Response containing list of server roles The list of server roles. There will be a maximum number of items
returned based on the page_token field in the request. Token to retrieve the next page of results, or empty if there are no
more results in the list. Response containing list of users The list of server roles. There will be a maximum number of items
returned based on the page_token field in the request. Token to retrieve the next page of results, or empty if there are no
more results in the list. Request to list all user preferences for a specific user. The name of the user.
Format: Optional: Only list keys that match the provided regular expression Response containing a list of user preferences for a specific user with an optional filter substring. The name of the user. List of key-value pairs representing user preferences. error message if there are any. Request to list user Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" Response containing list of users The list of users. There will be a maximum number of items
returned based on the page_token field in the request. Token to retrieve the next page of results, or empty if there are no
more results in the list. Authentication messages user email user password This message is a response of logging user object - user_id must be there authentication token after successful login of the user to access NLU services Server Role messages unique identifier of the role unique name of the role defines the permissions for the given role (the strings can be gotten from the ListServerPermissions) Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. Request to set or update user preferences. The name of the user.
Format: List of key-value pairs to set or update. Response to set or update user preferences. The name of the user.
Format: List of keys to delete from user preferences. error message if there are any. Request to update server role role_id in the Role message should be given, if empty will throw an error in the backend
other fields in the Role are optional. Only the fields to be updated should be provided Optional. The mask to control which fields get updated. Request to update user user_id in the User message should be given, if empty will throw an error in the backend
password and other fields in the User are optional. Only the fields to be updated should be provided Password of the user Optional. The mask to control which fields get updated. this message contains all the fields that required for user db when creating user user_id is empty, then it will be generated on creation time on backend Optional field display_name is the name that will be used on the frontend to interact with the user
it shouldn't be unique. If not provided user_name will also be used as display name server role type of the given user. If nothing is provided, the user is set to USER (minimum access) user e-mail should be a valid e-mail and unique user profile picture Creation date and time. Read-only field. Modification date and time. Read-only field. User id in form of a valid UUID. User id in form of a valid UUID. This message contains information about user user object If in GetUser, ListUser requests UserView is FULL, then the mapping is additionally provided
of parent of the project and corresponding ProjectRole of the user Structure of server role unspecified server role read-only access SERVER_USER's permissions + CRUD of projects and Users this role can do everything this role can do nothing. Used to set a user as inactive in the server. This is collection of utility endpoints, intended to language-independent operations, such as code checks, regex checks, etc. Holds a collection of utility functions Request message to AddTrainingPhraseFromCSV rpc Required. The agent to list all intents from.
Format: Required. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Required. Contents of the .csv file containing training phrases to be added to the intents Optional. Whether or not to extract entities for the new training phrases Optional. Before new training phrases are added to their corresponding intent,
they are cleaned with cleaning scripts. These cleaning scripts remove certain special characters,
if they are found at the beginning of the text or if they appear in annotations.
Overrides the default: '.,;!?:' Optional. Options for the training phrase cleaner to override the default settings Optional. Number of threads used to accomplish the task Request message to AddTrainingPhrase rpc Required. The agent to list all intents from.
Format: Required. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Required. List of training phrases to be added to the intent Optional. Whether or not to extract entities for the new training phrases Optional. Characters to be recognized as special characters for cleaning
the training phrases. Overrides the default: '.,;!?:' Optional. Options for the training phrase cleaner to override the default settings Optional. Number of threads used to accomplish the task Message that contains the new training phrase, together with the intent display name and, optionally the entity annotations Required. New training phrase to be added Required. Corresponding display name of the intent Optional. Entity annotations Response message to AddTrainingPhrase rpc Required. If something goes wrong, error messages will be conveyed via a repeated string Request to clean the entity types Required. The agent to list all intents from.
Format: Optional. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Optional. Characters to be recognized as special characters for cleaning.
Overrides the default: '.,;!?:' Optional. List of substring that shall not be cleaned/deleted.
Example: ['St.', 'U.S.', 'sys.', '24.12.', 'Nr.', 'TelNr.'] Optional. Entity type that contain more than max_entity_count_update entities will
not be cleaned. Relevant for auto-generated entity values (e.g. City Names)
Default = 10000 Optional. List of strings or regexes. Entity types will be deleted if their display
name matches an element of this list
Example: ['sys.ignore.'] -> would delete entity types with display names sys.ignore.* Required. Do not apply changes to the database if set to True Optional. Number of threads used to accomplish the task Response from entity type cleaner Required. List of updated entity types Optional. List of updated entity types Optional. List of updates performed on entity types Optional. List of the deleted entity types The request to clean the all intents. Required. The agent to list all intents from.
Format: Optional. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Optional. Characters to be recognized as special characters for cleaning.
Overrides the default: '.,;!?:' Optional. List of substring that shall not be cleaned/deleted.
Example: ['St.', 'U.S.', 'sys.', '24.12.', 'Nr.', 'TelNr.']
Default = None Required. Do not apply changes to the database if set to True Optional. Options for the cleaning of the training phrases. Optional. Options for re-annotation of entities (default = REANNOTATE_NEVER) Optional. Number of threads used to accomplish the task Response corresponding to the CleanAllIntents Request Required. List of updates performed on intents Optional. List of updates applied to intents Request to clean a single entity type Required. The agent to list all intents from.
Format: Required. The name of the entity_type Optional. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Optional. Characters to be recognized as special characters for cleaning.
Overrides the default: '.,;!?:' Optional. List of substring that shall not be cleaned/deleted.
Example: ['St.', 'U.S.', 'sys.', '24.12.', 'Nr.', 'TelNr.'] Optional. Entity type that contain more than max_entity_count_update entities will
not be cleaned. Relevant for auto-generated entity values (e.g. City Names)
Default = 10000 Required. Do not apply changes to the database if set to True Response from entity type cleaner Required. The cleaned entity type Optional. The updated entity type The request message to clean a single intents. Required. The agent to list all intents from.
Format: Required. The name of the intent.
Format: Optional. The language to list training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
Note: languages must be enabled in the agent before they can be used. Optional. Characters to be recognized as special characters for cleaning.
Overrides the default: '.,;!?:' Optional. List of substring that shall not be cleaned/deleted.
Example: ['St.', 'U.S.', 'sys.', '24.12.', 'Nr.', 'TelNr.']
Default = None Required. Do not apply changes to the database if set to True Optional. Options for the cleaning of the training phrases. Optional. Options for re-annotation of entities (default = REANNOTATE_NEVER) The response message to clean a single intents. Required. Cleaned Intent Optional. Updates applied to intent Stores updates applied to an entity type The entity type name List of the updated entities Stores updates applied to an entity Updates made to the entity value Updates made to the entity synonyms Stores updates applied to an intent The display name of the intent List of the updated training phrases List of the deleted parameters Message to track the updates made to a training phrase Stores updates of training phrases Stores updates of entity strings Stores re-annotated entity strings Will be switched to True if at least one update has been performed Message to keep track of updated strings New version of the string Old version of the string Options for cleaning the training phrases Whether or not to delete repeated whitespaces Whether of not to delete leading special characters Whether of not to delete trailing special characters Validation request for entity type values Response of the entity type validation List of error message from the validation The request to validate regexes. String containing the regex. The response of the regex validation Error messages Encapsulates entity re-annotation options Never re-annotate training phrases Always re-annotate training phrases Re-annotate training phrases if there are no annotations Re-annotate if training phrases have been deleted Re-annotate if there are no annotations or if training phrases have been deleted service to send requests to a webhook server The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.CreateSessionEntityType]. Required. The agent to list all intents from.
Format: Required. The session entity type to create. Required. The session to create a session entity type for.
Format: The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.DeleteSessionEntityType]. Required. The name of the entity type to delete. Format:
`projects/ The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.GetSessionEntityType]. Required. The name of the session entity type. Format:
`projects/ The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes]. Required. The session to list all session entity types from.
Format: `projects/ Optional. The maximum number of items to return in a single page. By
default 100 and at most 1000. Optional: The page token to support pagination.
Pagination allows you to retrieve a large result set in smaller, more manageable portions.
The page token is a string representing the current index and page size.
Valid page token strings:
* "" (empty string) - Retrieves the first page.
* "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
* "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.
Index starts at 0.
Examples of valid page token strings:
* ""
* "current_index-0--page_size-20"
* "current_index-1--page_size-20"
* "current_index-10--page_size-20"
Examples of invalid page token strings:
* "1"
* "current_index-0--page_size-20"
* "current_index--1--page_size-20"
* "current_index1--page_size-20"
* "current_index-1--page_size--20" The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes]. The list of session entity types. There will be a maximum number of items
returned based on the page_size field in the request. Token to retrieve the next page of results, or empty if there are no
more results in the list. Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. The source of this request, e.g., `google`, `facebook`, `slack` or other "platforms". .
Used to identify the "platform" Optional. This field is set to the value of the `QueryParameters.payload`
field passed in the request. Some integrations that query an
agent may provide additional data in the payload.
In particular this can be of the form:
request sent for webhook ping session ID for webhook ping This message is a response of pinging This is the response message of a Ping request.
It's purpose is to report the reachability of a Webhook server. 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). Required. The unique identifier of this session entity type. Format:
`projects/ Required. Indicates whether the additional data should override or
supplement the custom entity type definition. Required. The collection of entities associated with this session entity
type. The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.UpdateSessionEntityType]. Required. The session entity type to update. Optional. The mask to control which fields get updated. The request message for a webhook call. The unique identifier of the response. Contains the same value as
`[Streaming]DetectIntentResponse.response_id`. The result of the conversational query or event processing. Contains the
same value as `[Streaming]DetectIntentResponse.query_result`. Optional. The contents of the original request that was passed to
`[Streaming]DetectIntent` call. The unique identifier of detectIntent request session.
Can be used to identify end-user inside webhook implementation.
Format: Optional. The headers of the request message The response message for a webhook call. Optional. The text to be shown on the screen. This value is passed directly
to `QueryResult.fulfillment_text`. Optional. The collection of rich messages to present to the user. This
value is passed directly to `QueryResult.fulfillment_messages`. Optional. This value is passed directly to `QueryResult.webhook_source`. Optional. This value is passed directly to `QueryResult.webhook_payload`.
See the related `fulfillment_messages[i].payload field`, which may be used
as an alternative to this field.
This field can be used for Actions on Google responses.
It should have a structure similar to the JSON message shown here. For more
information, see
[Actions on Google Webhook
Format](https://developers.google.com/actions/dialogflow/webhook)
Optional. The collection of output contexts. This value is passed directly
to `QueryResult.output_contexts`. Optional. Makes the platform immediately invoke another `DetectIntent` call
internally with the specified event as input. Optional. Additional session entity types to replace or extend developer
entity types with. The entity synonyms apply to all languages and persist
for the session. Setting this data from a webhook overwrites
the session entity types that have been set using `detectIntent` method. The types of modifications for a session entity type. Not specified. This value should be never used. The collection of session entities overrides the collection of entities
in the corresponding custom entity type. The collection of session entities extends the collection of entities in
the corresponding custom 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
[EntityTypes.GetEntityType][google.cloud.dialogflow.v2.EntityTypes.GetEntityType]
on the custom entity type and merge. Speech-to-text service AcousticModels contains information about different types of acoustic models. Type of the acoustic model. Configuration for the Wav2Vec model. Configuration for the Wav2Vec model using Triton. Configuration for the Whisper model. Configuration for the Whisper model using Triton. AddDataToUserLanguageModelRequest is used to request the addition of data to a user-specific language model. Name of the language model to which to add data. Example: "user_lm_1" Zip file containing data in the form of text files.
Example: A zip file with text files containing sentences or phrases in the target language. CkptFile contains information about checkpoint files. Path to the checkpoint file. CreateUserLanguageModelRequest is used to request the creation of a new user-specific language model. Name of the language model to create. Example: "user_lm_1" DeleteUserLanguageModelRequest is used to request the deletion of a user-specific language model. Name of the language model to delete. Example: "user_lm_1" LanguageModelPipelineId contains information about a pipeline and its available language models. A pipeline ID. Example: "pipeline_1" A list of all available language models for the corresponding pipeline ID. Example: ["model_1", "model_2"] LanguageModels contains information about language models. Path to the directory of language models. Beam size for the search algorithm. Default language model to be selected if none is given. Weight for the language model scorer (alpha). Weight for the word insertion penalty (beta). Request message to list available domains. Optionally also filters can be set. Filter for languages Filter for pipeline owner Response message to list available domains domains available. Example: ["medical", "finance"] ListS2tLanguageModelsRequest is used to request a list of available language models for specified pipelines. List of pipeline IDs to retrieve their available language models.
Example: ["pipeline_1", "pipeline_2"] ListS2tLanguageModelsResponse is used to return the available language models for specified pipelines. Response is a list of LanguageModelPipelineId, where each element contains a pipeline ID and its associated
language models.
Example: [{pipeline_id: "pipeline_1", model_names: ["model_1", "model_2"]}, {pipeline_id: "pipeline_2",
model_names: ["model_3"]}] ListS2tLanguagesRequest is used to request a list of available languages. Optionally, filters can be set. Filter for domains. Example: ["medical", "finance"] Filter for pipeline owners.
Example: ["ondewo", "partner_company"] Response message to list available languages available languages Request to list all speech-to-text pipelines. Optionally also filter criteria can be set Filter for languages Filter for pipeline owners Filter for domains If true, return only registered pipelines.
Default false: return registered and persisted (from config files) configs. ListS2tPipelinesResponse is used to return a list of all speech-to-text pipelines. A list of Speech2TextConfig message instances containing the configuration of each pipeline.
Example: [{id: "pipeline_1", description: {language: "en"}, active: true, ...}, {id: "pipeline_2",
description: {language: "fr"}, active: true, ...}] Logging contains configuration for logging. Type of logging. Path for logging. PostProcessing contains the configuration for post-processing. List of names of active post-processors. Post-processor configurations. Configuration of the post-processing options Whether to use spelling correction Whether to disable normalization Post-processing configuration specifying the active post-processors in the pipeline, as well as their individual
configuration. If not set, all values are replaced by the ones in current pipeline. PostProcessors contains configurations for post-processors. Configuration of the SymSpell spelling correction. Configuration of the normalization object. PtFiles contains information about PT files. Path to the PT files. Step for the PT files. Pyannote contains configuration for the Pyannote voice activity detection model. Library: [pyannote-audio](https://github.com/pyannote/pyannote-audio/blob/develop/tutorials/voice_activity_detection.ipynb) Full name of the Pyannote model. Minimum audio size for processing. Fill inactive regions shorter than that many seconds.
Example [notebook](https://github.com/pyannote/pyannote-audio/blob/develop/tutorials/voice_activity_detection.ipynb) Remove active regions shorter than that many seconds
Example [notebook](https://github.com/pyannote/pyannote-audio/blob/develop/tutorials/voice_activity_detection.ipynb) Host name of triton inference server that serves the Pyannote model Port number of triton inference server that serves the Pyannote model S2TDescription contains descriptive information about the speech-to-text pipeline. Language of the speech-to-text system. Owner of the pipeline. Domain of the speech-to-text system. Comments about the system. S2TGetServiceInfoResponse is used to return version information about the speech-to-text service. Version number based on semantic versioning, e.g. "4.2.0". S2TInference contains information about inference models used in the speech-to-text pipeline. Configuration for the acoustic models. Configuration for the language models. Configuration for the inference backend. S2TNormalization contains configuration for the speech-to-text normalization. Language for normalization of transcriptions. List of names of active normalizations. The pipeline id for a specific pipeline configuration id of the model that will generate audio Speech2TextConfig is a configuration message for the speech-to-text pipeline Unique identifier for the configuration. Description of the speech-to-text system. Indicates if the configuration is active. Configuration for inference models. Configuration for the streaming server. Configuration for voice activity detection. Configuration for post-processing. Configuration for logging. StreamingServer contains information about the streaming server. Hostname of the streaming server. Port number of the streaming server. Output style for the streaming server. Configuration for streaming speech recognition. StreamingSpeechRecognition contains information about streaming speech recognition settings. Indicates whether to transcribe non-final results. Decoding method for speech recognition. Sampling rate for audio input. Minimum audio chunk size for processing. Timeout between audio chunks; if exceeded, the stream will be stopped. SymSpell contains configuration for the SymSpell spelling correction. Path to the dictionary used by symspell The maximal edit-distance to consider for spelling correction (affects performance - bigger number
takes longer to process!) The length (number of characters) of the prefix to consider for filtering TrainUserLanguageModelRequest is used to request the training of a user-specific language model. Name of the language model to train. Example: "user_lm_1" Order n of the ngram. Example: 3 (for trigram model) A request to transcribe an audio file wav file to transcribe The configuration to override the default configuration The response message for a transcribe file request List of transcriptions with confidence level The time the transcription took id of the transcribed audio file Configuration for a request to transcribe audio Required. id of the pipeline (model setup) that will generate audio Optional. decoding type Name of the language model The postprocessing options The utterance detection options Voice activity detection with pyannote The transcribe return options Optional. Specify language of transcription to return Optional. Specify task of s2t model, e.g. 'transcribe' and 'translate' Request to transcribe an audio stream wav file to transcribe if it's the final chunk of the stream The configuration to override the default configuration Whether or not to mute the audio signal. Defaults to false. The response message of a stream transcription List of transcriptions with confidence level The time the transcription took Whether or not this transcription is final (transcribed texts might change if transcription is
started before the end of an utterance). is audio bytes of the utterance in response audio bytes of the transcribed utterance is it a start of the utterance id of the transcribed audio file The configuration for the transcription The transcription message The transcribed text The corresponding confidence score. The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are correct. List of the words of transcription with their confidence scores and probable alternatives List of alternative transcriptions, confidence scores, words timings and alternative words The alternative transcribed text The corresponding confidence score to the alternative transcript. A list of word-specific information for each recognized word, including word timings, confidence score of
the word and alternative words. Configuration of the return values of a transcribe request should server make response indicating that the beginning of the speech was detected should s2t server return audio bytes of transcribed utterance Whether or not to return confidence scores Whether or not to return alternative results from beam-search Optional. Number of alternative transcriptions results from beam-search or greedy-search Whether or not to return alternative results from beam-search Optional. Number of alternative words to results Optional. Whether or not to return timestamps of start and end of the words. Only used in TranscribeFile. Configuration of the options to detect utterances Return also immediate transcription results if time between audio chunks exceeds next_chunk_timeout, stream will be stopped VoiceActivityDetection contains information about voice activity detection settings. Indicates if voice activity detection is active. Sampling rate for voice activity detection. Configuration for the Pyannote model. Wav2Vec contains information about the Wav2Vec model. Path to the model. Indicates if GPU is used. Wav2VecTriton contains information about the Wav2Vec model using Triton. Path to the processor. Name of the Triton model. Version of the Triton model. Timeout for checking model status. Host name of triton inference server that serves the Wav2VecTriton model Port number of triton inference server that serves the Wav2VecTriton model Whisper contains information about the Whisper model. Path to the model. Indicates if GPU is used. Default language of the model. Default task of the model. WhisperTriton contains information about the Whisper model using Triton. Path to the processor. Name of the Triton model. Version of the Triton model. Timeout for checking model status. Default language of the model. Default task of the model. E.g., transcribe, translate, etc. Host name of triton inference server that serves the WhisperTriton model Port number of triton inference server that serves the WhisperTriton model The recognized word corresponding to this set of information. The corresponding confidence score to the alternative word. WordDetail provides word-specific information for recognized words. The start time of the spoken word relative to the beginning of the audio.
The accuracy of the time offset can vary, and this is an experimental feature. The end time of the spoken word relative to the beginning of the audio.
The accuracy of the time offset can vary, and this is an experimental feature. The recognized word corresponding to this set of information. The corresponding confidence score to the word. List of alternative words and confidence scores of each. The decoding configuration decoding will be defined by the pipeline config greedy decoding will be used independently on pipeline config beam search will be used independently on pipeline config beam search without LM head, to configure decoding mode for seq2seq models. Not set Run pytorch model Run flax model Text2Speech service provides endpoints for text-to-speech generation. Apodization message contains settings for apodization postprocessing. The duration of apodization in seconds. BatchSynthesizeRequest message is used to send a batch request for synthesis. Repeated field holding individual synthesis requests that make up the batch request. BatchSynthesizeResponse message is used to store the responses for a batch synthesis request. Repeated field holding individual synthesis responses that correspond to the input requests in the batch. Caching message contains settings for caching. Flag indicating whether caching is active. The maximum size of the memory cache. The sampling rate for caching. Flag indicating whether to load cache. Flag indicating whether to save cache. The directory path to save the cache. CompositeInference message combines text-to-mel and mel-to-audio inference settings. Text-to-mel inference settings. Mel-to-audio inference settings. CreateCustomPhonemizerRequest message represents the request for creating a custom phonemizer. The prefix for the custom phonemizer ID. Repeated field of Map messages representing word-to-phoneme mappings. CustomPhonemizerProto message represents a custom phonemizer. The ID of the custom phonemizer. Repeated field of Map messages representing word-to-phoneme mappings. GlowTTS message contains settings for the GlowTTS inference. The batch size for inference. Flag indicating whether to use GPU for inference. The length scale for inference. The noise scale for inference. The path to the GlowTTS model. Repeated field containing the cleaners for text normalization. The path to the parameter configuration. GlowTTSTriton message contains settings for the GlowTTS Triton inference. The batch size for inference. The length scale for inference. The noise scale for inference. Repeated field containing the cleaners for text normalization. The maximum text length allowed. The path to the parameter configuration. The name of the Triton model. The host of the Triton inference server which servers the model. The port of the Triton inference server which servers the model. HiFiGan message contains settings for the HiFiGan inference. Flag indicating whether to use GPU for inference. The batch size for inference. The path to the HiFiGan configuration. The path to the HiFiGan model. HiFiGanTriton message contains settings for the HiFiGan Triton inference. The path to the HiFiGan Triton configuration. The name of the Triton model. The host of the Triton inference server which servers the model. The port of the Triton inference server which servers the model. ListCustomPhonemizerRequest message represents the request for listing custom phonemizers. Repeated field of pipeline IDs to filter the list of custom phonemizers. ListCustomPhonemizerResponse message represents the response for listing custom phonemizers. Repeated field of CustomPhonemizerProto messages representing the custom phonemizers. Domain Request representation. The request message for ListT2sDomains. Filter domains of pipelines by attributed in request. Optional. Define the speaker sex. Optional. Define the pipeline owner/ owners. Optional. Define the speaker name/ names. Optional. Define the language/ languages. Domains Response representation. The response message for ListT2sDomains. Required. Define the domain/ domains that satisfy/ies
the specifications in the ListT2sDomainsRequest. Language Request representation. The request message for ListT2sLanguages. Filter languages of pipelines by attributed in request. Optional. Define the speaker sex. Optional. Define the pipeline owner/ owners. Optional. Define the speaker name/ names. Optional. Define the domain/ domains. Language Response representation. The response message for ListT2sLanguages. Required. Define the language/ languages that satisfy/ies
the specifications in the ListT2sLanguagesRequest. Pipeline Request representation. The request message for ListT2sPipelines. Filter pipelines by attributed in request. Optional. Define the language/ languages. Optional. Define the speaker sex. Optional. Define the pipeline owner/ owners. Optional. Define the speaker name/ names. Optional. Define the domain/ domains. Pipeline Response representation. The response message for ListT2sPipelines. Required. Representation of a list of pipelines configurations.
Retrieved by ListT2sPipelines, containing the configurations of
pipelines with the specifications received in the ListT2sPipelinesRequest. Logmnse message contains settings for Logmnse postprocessing. The initial noise value. The window size. The noise threshold. Map message represents a word-to-phoneme mapping in a custom phonemizer. The word to be mapped. The phoneme groups associated with the word. MbMelganTriton message contains settings for the MbMelgan Triton inference. The path to the MbMelgan Triton configuration. The path to the MbMelgan statistics. The name of the Triton model. The host of the Triton inference server which servers the model. The port of the Triton inference server which servers the model. Mel2Audio message contains settings for mel-to-audio inference. The type of mel-to-audio inference. MbMelgan Triton inference settings. HiFiGan inference settings. HiFiGan Triton inference settings. NormalizeTextRequest message is used to request text normalization. The ID of the text-to-speech pipeline. The text to be normalized. NormalizeTextResponse message is used to store the normalized text response. The normalized text. PhonemizerId message represents the ID of a phonemizer. The ID of the phonemizer. Postprocessing message contains settings for postprocessing. The duration of silence in seconds. Repeated field containing pipeline names. Logmnse postprocessing settings. Wiener postprocessing settings. Apodization postprocessing settings. Represents a Configuration for the text to speech conversion. Required. Represents the pipeline id of the model configuration that will be used. Optional. This parameter is used for time stretching which is the process of
changing the speed or duration of an audio.
It should be much more than 1.0. O is not a valid number for this variable.
The default value is 1. Optional. Defines the noise in the generated audio.
It should be between 0.0 and 1.
The default value is 0.0 Optional. Defines the sample rate of the generated wav file.
The default value is 22050. Optional. Defines the pulse-code modulation of the wav file.
The default value is PCM_16. Optional. Defines the format of the desired audio.
The default value is wav. Optional. Define if cache should be used or not.
The default value is False. Optional. Define what normalizer to synthesize the text with.
The default value is the language of the pipeline. SingleInference message inference settings of text2audio models. Text-to-audio inference settings. Represents a Synthesize Request. A Synthesize Request contains the information need to perform a text to speech conversion. Required. Represents the text that will be transformed to speech.
Synthesize text: Examples to modulate the voice based on SSML tags and Arpabet phonemes: Required. Represents the specifications needed to do the text to speech transformation. Represents a Synthesize Response. A Synthesize Request contains the converted text to audio and the requested configuration. Required. Represents the pipeline id of the model configuration that will be used. Required. Generated file with the parameters described in request. Required. Time to generate audio. Required. Audio length. Required. Text from which audio was generated. Required. Configuration from which audio was generated. Optional. Normalized text. T2SCustomLengthScales message contains custom length scales for text types. The custom length scale for general text. The custom length scale for email text. The custom length scale for URL text. The custom length scale for phone number text. The custom length scale for spelled-out text. The custom length scale for spelled-out text with names. The custom length scale for long callsigns. The custom length scale for short callsigns. T2SDescription message is used to describe the text-to-speech service. The language supported by the service. The owner of the text-to-speech pipeline. Additional comments or notes. The name of the speaker. The domain or context of the service. Version information of the service version number T2SInference message is used to specify the text-to-speech inference settings. The type of inference. Composite inference settings. Single inference settings. Caching settings. Represents the configuration for text-to-speech normalization. The language for which the normalization is applied. The pipeline(s) used for normalization. The ID of the custom phonemizer, if used. Custom length scales for different text types. The mapping for Arpabet phonemes. The mapping for numeric expressions. The mapping for callsigns. Pipeline Id representation. Used in the creation, deletion and getter of pipelines. Required. Defines the id of the pipeline. Text2Audio message contains settings for text-to-audio inference. The type of text-to-audio inference. Vits inference settings. Vits Triton inference settings. Text2Mel message contains settings for text-to-mel inference. The type of text-to-mel inference. GlowTTS inference settings. GlowTTS Triton inference settings. Configuration of text-to-speech models representation. Required. Defines the id of the pipeline. Required. Defines the description of the pipeline representation. Required. Defines if the pipeline is active or inactive. Required. Defines he inference of the pipeline representation. Required. Defines the normalization process of the pipeline representation. Required. Defines the postprocessing process of the pipeline representation. UpdateCustomPhonemizerRequest message represents the request for updating a custom phonemizer. The ID of the custom phonemizer to be updated. The update method. Repeated field of Map messages representing word-to-phoneme mappings. The batch size for inference. Flag indicating whether to use GPU for inference. The length scale for inference. The noise scale for inference. The path to the Vits model. Repeated field containing the cleaners for text normalization. The path to the parameter configuration. VitsTriton message contains settings for the Vits Triton inference. The batch size for inference. The length scale for inference. The noise scale for inference. Repeated field containing the cleaners for text normalization. The maximum text length allowed. The path to the parameter configuration. The name of the Triton model. The host of the Triton inference server which servers the model. The port of the Triton inference server which servers the model. Wiener message contains settings for Wiener postprocessing. The frame length. The LPC order. The number of iterations. The alpha value. The threshold value. AudioFormat enum represents various audio file formats for storing digital audio data. Waveform Audio File Format (WAV) Free Lossless Audio Codec (FLAC) Core Audio Format (CAF) MPEG Audio Layer III (MP3) Advanced Audio Coding (AAC) Ogg Vorbis (OGG) Windows Media Audio (WMA) Represents a pulse-code modulation technique. 16-bit pulse-code modulation. 24-bit pulse-code modulation. 32-bit pulse-code modulation. Signed 8-bit pulse-code modulation. Unsigned 8-bit pulse-code modulation. Floating-point (32-bit) pulse-code modulation. Floating-point (64-bit) pulse-code modulation. The update method to be used. Add new words, replacing existing ones. Add new words if they are not already present. Replace all words in the phonemizer with new ones.
Field Type Label Description
name
string
parameters
google.protobuf.Struct
language_code
string
GetAudioFileOfSessionRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>/<
resource_view
ResourceView
GetAudioFilesRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
names
string
repeated
projects/<project_uuid>/agent/sessions/<session_uuid>/audios/<audio_uuid>
resource_view
ResourceView
page_token
string
sorting_mode
SortingMode
GetAudioFilesResponse
Field Type Label Description
audio_files
AudioFileResource
repeated
projects/<project_uuid>/agent/sessions/<session_uuid>/audios/<audio_uuid>
error_message
string
next_page_token
string
GetLatestSessionReviewRequest
Field Type Label Description
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>
session_review_view
SessionReview.View
GetSessionRequest
Field Type Label Description
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>
session_view
Session.View
field_mask
google.protobuf.FieldMask
GetSessionReviewRequest
Field Type Label Description
session_review_id
string
session_review_view
SessionReview.View
InputAudioConfig
Field Type Label Description
audio_encoding
AudioEncoding
sample_rate_hertz
int32
language_code
string
phrase_hints
string
repeated
ListAccountIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListAccountIdsResponse
Field Type Label Description
account_ids
string
repeated
ListAudioFilesRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>/<
resource_view
ResourceView
page_token
string
sorting_mode
SortingMode
ListAudioFilesResponse
Field Type Label Description
audio_files
AudioFileResource
repeated
projects/<project_uuid>/agent/sessions/<session_uuid>/audios/<audio_uuid>
next_page_token
string
error_message
string
ListDatastreamIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListDatastreamIdsResponse
Field Type Label Description
datastream_ids
string
repeated
ListIdentifiedUserIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListIdentifiedUserIdsResponse
Field Type Label Description
identified_user_ids
string
repeated
ListInputContextsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListInputContextsResponse
Field Type Label Description
input_contexts
string
repeated
ListLanguageCodesOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListLanguageCodesResponse
Field Type Label Description
language_codes
string
repeated
ListMatchedEntityTypesOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListMatchedEntityTypesResponse
Field Type Label Description
matched_entity_types
string
repeated
ListMatchedIntentsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListMatchedIntentsResponse
Field Type Label Description
matched_intents
string
repeated
ListOriginIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListOriginIdsResponse
Field Type Label Description
origin_ids
string
repeated
ListOutputContextsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListOutputContextsResponse
Field Type Label Description
output_contexts
string
repeated
ListPlatformsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListPlatformsResponse
Field Type Label Description
platforms
string
repeated
ListPropertyIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListPropertyIdsResponse
Field Type Label Description
property_ids
string
repeated
ListSessionCommentsRequest
Field Type Label Description
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>
page_token
string
ListSessionCommentsResponse
Field Type Label Description
comment
Comment
repeated
projects/<project_uuid>/agent/sessions/<session_uuid>/comments/<comment_uuid>
page_token
string
ListSessionLabelsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListSessionLabelsRequest
Field Type Label Description
session_id
string
ListSessionLabelsResponse
Field Type Label Description
labels
string
repeated
ListSessionReviewsRequest
Field Type Label Description
session_id
string
projects/<project_uuid>/agent/sessions/<session_uuid>
session_review_view
SessionReview.View
page_token
string
ListSessionReviewsResponse
Field Type Label Description
session_reviews
SessionReview
repeated
next_page_token
string
ListSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agents
session_view
Session.View
page_token
string
session_filter
SessionFilter
field_mask
google.protobuf.FieldMask
ListSessionsResponse
Field Type Label Description
sessions
Session
repeated
next_page_token
string
ListTagsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListTagsResponse
Field Type Label Description
tags
string
repeated
ListUserIdsOfAllSessionsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_filter
SessionFilter
ListUserIdsResponse
Field Type Label Description
user_ids
string
repeated
QueryInput
Field Type Label Description
audio_config
InputAudioConfig
text
TextInput
event
EventInput
QueryParameters
Field Type Label Description
time_zone
string
geo_location
google.type.LatLng
contexts
Context
repeated
reset_contexts
bool
payload
google.protobuf.Struct
language=LanguageCode.de.value
key:timestamp=time.time()
key:source='https://ondewo.com'
key:configuration='config_example_123'
labels
string
repeated
platforms
Intent.Message.Platform
repeated
DetectIntentResponse
account_id
string
property_id
string
datastream_id
string
origin_id
string
identified_user_id
string
transcriptions
S2tTranscription
repeated
QueryResult
Field Type Label Description
query_text
string
speech_recognition_confidence
float
action
string
parameters
google.protobuf.Struct
all_required_params_present
bool
fulfillment_text
string
fulfillment_messages
Intent.Message
repeated
webhook_source
string
webhook_payload
google.protobuf.Struct
output_contexts
Context
repeated
intent
Intent
intent_detection_confidence
float
query_text_original
string
diagnostic_info
google.protobuf.Struct
language_code
string
S2tTranscription
Field Type Label Description
name
string
text
string
score
float
language_code
string
audio_resource_name
string
pipeline_id
string
duration_in_s
float
transcription_type
TranscriptionType
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
Session
Field Type Label Description
name
string
projects/<project_uuid>/agent/sessions/<session_uuid>
session_steps
SessionStep
repeated
session_info
SessionInfo
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
SessionFilter
Field Type Label Description
language_codes
string
repeated
matched_intents
Intent
repeated
matched_entity_types
EntityType
repeated
min_intents_confidence_min
float
min_intents_confidence_max
float
min_entity_types_confidence_min
float
min_entity_types_confidence_max
float
earliest
double
latest
double
min_number_turns
int32
max_number_turns
int32
labels
string
repeated
user_ids
string
repeated
intent_tags
string
repeated
session_ids
string
repeated
input_contexts
Context
repeated
output_contexts
Context
repeated
duration_in_s_min
float
duration_in_s_max
float
duration_in_m_min
float
duration_in_m_max
float
duration_in_m_rounded_min
float
duration_in_m_rounded_max
float
duration_interval_15s_rounded_min
float
duration_interval_15s_rounded_max
float
duration_interval_30s_rounded_min
float
duration_interval_30s_rounded_max
float
duration_interval_45s_rounded_min
float
duration_interval_45s_rounded_max
float
started_time_slot_per_hour_min
string
started_time_slot_per_hour_max
string
started_time_slot_per_quarter_hour_min
string
started_time_slot_per_quarter_hour_max
string
started_time_slot_per_half_hour_min
string
started_time_slot_per_half_hour_max
string
started_time_slot_per_day_phase_min
string
started_time_slot_per_day_phase_max
string
started_time_slot_per_minute_min
string
started_time_slot_per_minute_max
string
duration_in_s_rounded_min
float
duration_in_s_rounded_max
float
platforms
Intent.Message.Platform
repeated
account_ids
string
repeated
property_ids
string
repeated
datastream_ids
string
repeated
origin_ids
string
repeated
identified_user_ids
string
repeated
duration_interval_60s_rounded_min
float
duration_interval_60s_rounded_max
float
SessionInfo
Field Type Label Description
language_codes
string
repeated
matched_intents
Intent
repeated
matched_entity_types
EntityType
repeated
min_intents_confidence
float
min_entity_types_confidence
float
earliest
double
latest
double
number_turns
int32
labels
string
repeated
user_ids
string
repeated
intent_tags
string
repeated
input_context_steps
SessionInfo.ContextSteps
repeated
output_context_steps
SessionInfo.ContextSteps
repeated
duration_in_s
float
duration_in_m
float
duration_in_m_rounded
float
duration_interval_15s_rounded
float
duration_interval_30s_rounded
float
duration_interval_45s_rounded
float
started_time_slot_per_hour
string
started_time_slot_per_quarter_hour
string
started_time_slot_per_half_hour
string
started_time_slot_per_day_phase
string
started_time_slot_per_minute
string
duration_in_s_rounded
float
platforms
Intent.Message.Platform
repeated
account_ids
string
repeated
property_ids
string
repeated
datastream_ids
string
repeated
origin_ids
string
repeated
identified_user_ids
string
repeated
duration_interval_60s_rounded
float
parent_comment
Comment
repeated
SessionInfo.ContextSteps
Field Type Label Description
contexts
Context
repeated
SessionReview
Field Type Label Description
name
string
projects/<project_uuid>/agent/sessions/<session_uuid>/reviews/<session_review_uuid>
session_review_steps
SessionReviewStep
repeated
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
SessionReviewStep
Field Type Label Description
name
string
projects/<project_uuid>/agent/sessions/<session_uuid>/reviews/<review_uuid>/sessionreviewsteps/<session_review_step_uuid>
annotated_usersays
Intent.TrainingPhrase
language_code
string
detected_intents
DetectedIntent
repeated
contexts
Context
repeated
contexts_out
Context
repeated
query_text_original
string
platforms
Intent.Message.Platform
repeated
timestamp
google.protobuf.Timestamp
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
audio_file_resources
AudioFileResource
repeated
SessionStep
Field Type Label Description
name
string
projects/<project_uuid>/agent/sessions/<session_uuid>/steps/<session_step_uuid>
detect_intent_request
DetectIntentRequest
detect_intent_response
DetectIntentResponse
contexts
Context
repeated
timestamp
google.protobuf.Timestamp
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
audio_file_resources
AudioFileResource
repeated
StreamingDetectIntentRequest
Field Type Label Description
session
string
query_params
QueryParameters
query_input
QueryInput
single_utterance
bool
input_audio
bytes
StreamingDetectIntentResponse
Field Type Label Description
response_id
string
recognition_result
StreamingRecognitionResult
query_result
QueryResult
webhook_status
google.rpc.Status
StreamingRecognitionResult
Field Type Label Description
message_type
StreamingRecognitionResult.MessageType
transcript
string
is_final
bool
confidence
float
TextInput
Field Type Label Description
text
string
language_code
string
TrackSessionStepRequest
Field Type Label Description
session_id
string
. projects/<project_uuid>/agent/sessions/<session_uuid>/steps/<session_step_uuid>
session_step
SessionStep
session_view
Session.View
UpdateSessionCommentsRequest
Field Type Label Description
session_id
string
comment
Comment
AudioEncoding
Name Number Description
AUDIO_ENCODING_UNSPECIFIED
0
AUDIO_ENCODING_LINEAR_16
1
AUDIO_ENCODING_FLAC
2
AUDIO_ENCODING_MULAW
3
AUDIO_ENCODING_AMR
4
AUDIO_ENCODING_AMR_WB
5
AUDIO_ENCODING_OGG_OPUS
6
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE
7
AudioFileResourceType
Name Number Description
AUDIO_FILE_RESOURCE_TYPE_UNSPECIFIED
0
AUDIO_FILE_RESOURCE_TYPE_T2S
1
AUDIO_FILE_RESOURCE_TYPE_S2T
2
AUDIO_FILE_RESOURCE_TYPE_S2T_AND_T2S
3
ComparisonOperator
Name Number Description
EQUAL
0
GREATER
1
GREATER_OR_EQUAL
2
LESS_OR_EQUAL
3
CONTAINS
4
STARTS_WITH
5
ENDS_WITH
6
ResourceView
Name Number Description
RESOURCE_VIEW_UNSPECIFIED
0
RESOURCE_VIEW_FULL
1
RESOURCE_VIEW_PARTIAL
2
RESOURCE_VIEW_MINIMUM
3
Session.View
Name Number Description
VIEW_UNSPECIFIED
0
VIEW_FULL
1
VIEW_SPARSE
2
SessionReview.View
Name Number Description
VIEW_UNSPECIFIED
0
VIEW_FULL
1
VIEW_SPARSE
2
StreamingRecognitionResult.MessageType
Name Number Description
MESSAGE_TYPE_UNSPECIFIED
0
TRANSCRIPT
1
END_OF_SINGLE_UTTERANCE
2
TranscriptionType
Name Number Description
TRANSCRIPTION_TYPE_UNSPECIFIED
0
TRANSCRIPTION_TYPE_S2T
1
TRANSCRIPTION_TYPE_HUMAN
2
ondewo/nlu/user.proto
Top
Users
CreateUser
rpc CreateUser (CreateUserRequest) returns (User)
Creates a user.
GetUser
rpc GetUser (GetUserRequest) returns (User)
Retrieves a user by identifier.
GetUserInfo
rpc GetUserInfo (GetUserRequest) returns (UserInfo)
Retrieves user information by identifier.
DeleteUser
rpc DeleteUser (GetUserRequest) returns (.google.protobuf.Empty)
Deletes a user by identifier.
UpdateUser
rpc UpdateUser (UpdateUserRequest) returns (User)
Updates a user.
ListUsers
rpc ListUsers (ListUsersRequest) returns (ListUsersResponse)
Lists users.
ListUserInfos
rpc ListUserInfos (ListUsersRequest) returns (ListUserInfosResponse)
Lists user information.
CreateServerRole
rpc CreateServerRole (CreateServerRoleRequest) returns (ServerRole)
Creates a server role.
GetServerRole
rpc GetServerRole (GetServerRoleRequest) returns (ServerRole)
Retrieves a server role by ID.
DeleteServerRole
rpc DeleteServerRole (DeleteServerRoleRequest) returns (.google.protobuf.Empty)
Deletes a server role by ID.
UpdateServerRole
rpc UpdateServerRole (UpdateServerRoleRequest) returns (ServerRole)
Updates a server role.
ListServerRoles
rpc ListServerRoles (ListServerRolesRequest) returns (ListServerRolesResponse)
Lists server roles.
ListServerPermissions
rpc ListServerPermissions (ListServerPermissionsRequest) returns (ListServerPermissionsResponse)
Lists server permissions.
Login
rpc Login (LoginRequest) returns (LoginResponse)
Requests login.
CheckLogin
rpc CheckLogin (.google.protobuf.Empty) returns (.google.protobuf.Empty)
Checks login.
ListNotifications
rpc ListNotifications (ListNotificationsRequest) returns (ListNotificationsResponse)
Lists notifications based on specified filters.
SetNotificationsFlaggedStatus
rpc SetNotificationsFlaggedStatus (SetNotificationsFlaggedStatusRequest) returns (ListNotificationsResponse)
Sets the flagged status for multiple notifications.
SetNotificationsReadStatus
rpc SetNotificationsReadStatus (SetNotificationsReadStatusRequest) returns (ListNotificationsResponse)
Sets the read status for multiple notifications.
GetUserPreferences
rpc GetUserPreferences (GetUserPreferencesRequest) returns (GetUserPreferencesResponse)
Retrieves user preferences based on the provided request.
SetUserPreferences
rpc SetUserPreferences (SetUserPreferencesRequest) returns (SetUserPreferencesResponse)
Sets or updates user preferences based on the provided request.
DeleteUserPreferences
rpc DeleteUserPreferences (DeleteUserPreferencesRequest) returns (DeleteUserPreferencesResponse)
Deletes specific user preferences based on the provided request.
DeleteAllUserPreferences
rpc DeleteAllUserPreferences (DeleteAllUserPreferencesRequest) returns (DeleteUserPreferencesResponse)
Deletes all user preferences for a specific user, optionally filtered by a substring.
Methods with HTTP bindings
Method Name
Method
Pattern
Body
CreateUser
POST
/v2/users
*
GetUser
GET
/v2/users/{user_identifier=*}
GetUserInfo
GET
/v2/user_infos/{user_identifier=*}
DeleteUser
DELETE
/v2/users/{user_identifier=*}
UpdateUser
PATCH
/v2/users
*
ListUsers
GET
/v2/users
ListUserInfos
GET
/v2/users_infos
CreateServerRole
POST
/v2/server_roles
*
GetServerRole
GET
/v2/server_roles/{role_id=*}
DeleteServerRole
DELETE
/v2/server_roles/{role_id=*}
UpdateServerRole
PATCH
/v2/server_roles
*
ListServerRoles
GET
/v2/server_roles
ListServerPermissions
GET
/v2/server_permissions
Login
POST
/v2/login
*
CheckLogin
DELETE
/v2/check_login
CreateServerRoleRequest
Field Type Label Description
role
ServerRole
CreateUserRequest
Field Type Label Description
user
User
password
string
DeleteAllUserPreferencesRequest
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
regex_filter
string
^DE_
Only delete keys matching: .*user.*
DeleteServerRoleRequest
Field Type Label Description
role_id
uint32
DeleteUserPreferencesRequest
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
keys
string
repeated
regex_include
string
keys
that match the provided
regex_include
regular expression.
If user does not add regex_filter, then only the keys specified in the keys field are deleted.
If both, a key in the keys field and in the regex_include is matched then the key is deleted without raising an error. DeleteUserPreferencesResponse
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
keys
string
repeated
error_message
string
DeleteUserRequest
Field Type Label Description
user_id
string
GetServerRoleRequest
Field Type Label Description
role_id
uint32
role_name
string
GetUserPreferencesRequest
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
keys
string
repeated
regex_include
string
keys
that match the provided
regex_include
regular expression.
If user does not add regex_filter, then only the keys specified in the keys field are returned.
If both, a key in the keys field and in the regex_include will be matched than only a single
KeyValuePair
is returned. GetUserPreferencesResponse
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
key_value_pairs
KeyValuePair
repeated
error_message
string
GetUserRequest
Field Type Label Description
user_id
string
user_email
string
ListServerPermissionsRequest
Field Type Label Description
page_token
string
ListServerPermissionsResponse
Field Type Label Description
permissions
string
repeated
next_page_token
string
ListServerRolesRequest
Field Type Label Description
page_token
string
ListServerRolesResponse
Field Type Label Description
server_roles
ServerRole
repeated
next_page_token
string
ListUserInfosResponse
Field Type Label Description
users
UserInfo
repeated
next_page_token
string
ListUserPreferencesRequest
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
regex_filter
string
ListUserPreferencesResponse
Field Type Label Description
user_name
string
key_value_pairs
KeyValuePair
repeated
error_message
string
ListUsersRequest
Field Type Label Description
page_token
string
ListUsersResponse
Field Type Label Description
users
User
repeated
next_page_token
string
LoginRequest
Field Type Label Description
user_email
string
password
string
LoginResponse
Field Type Label Description
user
User
auth_token
string
ServerRole
Field Type Label Description
role_id
uint32
name
string
permissions
string
repeated
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
SetUserPreferencesRequest
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
key_value_pairs
KeyValuePair
repeated
SetUserPreferencesResponse
Field Type Label Description
user_name
string
projects/<project_uuid>/agent/users/<user_uuid>
keys
string
repeated
error_message
string
UpdateServerRoleRequest
Field Type Label Description
role
ServerRole
update_mask
google.protobuf.FieldMask
UpdateUserRequest
Field Type Label Description
user
User
password
string
update_mask
google.protobuf.FieldMask
User
Field Type Label Description
user_id
string
display_name
string
server_role_id
uint32
user_email
string
user_profile_picture
bytes
created_at
google.protobuf.Timestamp
modified_at
google.protobuf.Timestamp
created_by
string
modified_by
string
UserInfo
Field Type Label Description
user
User
project_roles
UserInfo.ProjectRolesEntry
repeated
UserInfo.ProjectRolesEntry
Field Type Label Description
key
string
value
ProjectRole
DefaultServerRole
Name Number Description
SERVER_UNSPECIFIED
0
SERVER_USER
1
SERVER_MANAGER
2
SERVER_ADMIN
3
SERVER_INACTIVE
4
ondewo/nlu/utility.proto
Top
Utilities
ValidateRegex
rpc ValidateRegex (ValidateRegexRequest) returns (ValidateRegexResponse)
Validates the validity of python regexes
ValidateEmbeddedRegex
rpc ValidateEmbeddedRegex (ValidateEmbeddedRegexRequest) returns (ValidateEmbeddedRegexResponse)
Validate that entity types with group references have synonyms with
capturing groups.
CleanAllIntents
rpc CleanAllIntents (CleanAllIntentsRequest) returns (CleanAllIntentsResponse)
Cleans all intent training phrases and entity annotations of parent
CleanIntent
rpc CleanIntent (CleanIntentRequest) returns (CleanIntentResponse)
Cleans single intent training phrases and entity annotations
CleanAllEntityTypes
rpc CleanAllEntityTypes (CleanAllEntityTypesRequest) returns (CleanAllEntityTypesResponse)
Cleans all entity types of parent
CleanEntityType
rpc CleanEntityType (CleanEntityTypeRequest) returns (CleanEntityTypeResponse)
Cleans entity type
AddTrainingPhrases
rpc AddTrainingPhrases (AddTrainingPhrasesRequest) returns (AddTrainingPhrasesResponse)
Creates new training phrases corresponding to intent specified by its intent display name
AddTrainingPhrasesFromCSV
rpc AddTrainingPhrasesFromCSV (AddTrainingPhrasesFromCSVRequest) returns (AddTrainingPhrasesResponse)
Creates new training phrases corresponding to intent specified by its intent display name from csv file
AddTrainingPhrasesFromCSVRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
language_code
string
csv_contents
bytes
extract_entities
bool
special_characters
string
training_phrase_cleaner_options
TrainingPhraseCleanerOptions
number_of_workers
int32
AddTrainingPhrasesRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
language_code
string
training_phrase_list
AddTrainingPhrasesRequest.TrainingPhraseForIntent
repeated
extract_entities
bool
special_characters
string
training_phrase_cleaner_options
TrainingPhraseCleanerOptions
number_of_workers
int32
AddTrainingPhrasesRequest.TrainingPhraseForIntent
Field Type Label Description
training_phrase
string
intent_display_name
string
entities
Intent.TrainingPhrase.Entity
repeated
AddTrainingPhrasesResponse
Field Type Label Description
error_messages
string
repeated
CleanAllEntityTypesRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
language_code
string
special_characters
string
substring_white_list
string
repeated
max_entity_count_update
int32
forbidden_entity_type_patterns
string
repeated
dry_run
bool
number_of_workers
int32
CleanAllEntityTypesResponse
Field Type Label Description
cleaned_entity_types
EntityType
repeated
deleted_entity_types
EntityType
repeated
entity_type_updates
EntityTypeUpdate
repeated
entity_type_deletions
EntityTypeUpdate
repeated
CleanAllIntentsRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
language_code
string
special_characters
string
substring_white_list
string
repeated
dry_run
bool
training_phrase_cleaner_options
TrainingPhraseCleanerOptions
reannotate_entities_options
ReannotateEntitiesOptions
number_of_workers
int32
CleanAllIntentsResponse
Field Type Label Description
cleaned_intents
Intent
repeated
intent_update_list
IntentUpdate
repeated
CleanEntityTypeRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
entity_type_name
string
language_code
string
special_characters
string
substring_white_list
string
repeated
max_entity_count_update
int32
dry_run
bool
CleanEntityTypeResponse
Field Type Label Description
cleaned_entity_type
EntityType
entity_type_update
EntityTypeUpdate
CleanIntentRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
intent_name
string
projects/<project_uuid>/agent/intents/<intent_uuid>
language_code
string
special_characters
string
substring_white_list
string
repeated
dry_run
bool
training_phrase_cleaner_options
TrainingPhraseCleanerOptions
reannotate_entities_options
ReannotateEntitiesOptions
CleanIntentResponse
Field Type Label Description
cleaned_intent
Intent
intent_update
IntentUpdate
EntityTypeUpdate
Field Type Label Description
entity_type_name
string
values_update_list
EntityTypeUpdate.EntityUpdate
repeated
EntityTypeUpdate.EntityUpdate
Field Type Label Description
entity_value_update
StringUpdate
entity_synonym_updates
StringUpdate
repeated
IntentUpdate
Field Type Label Description
intent_display_name
string
training_phrase_update_list
IntentUpdate.TrainingPhraseUpdate
repeated
deleted_parameters
string
repeated
IntentUpdate.TrainingPhraseUpdate
Field Type Label Description
training_phrase_update
StringUpdate
entity_updates
StringUpdate
repeated
entities_reannotated
string
repeated
contains_update_variable
bool
StringUpdate
Field Type Label Description
new
string
old
string
TrainingPhraseCleanerOptions
Field Type Label Description
delete_repeated_whitespaces
bool
delete_leading_special_characters
bool
delete_trailing_special_characters
bool
ValidateEmbeddedRegexRequest
Field Type Label Description
entity_type
EntityType.Entity
ValidateEmbeddedRegexResponse
Field Type Label Description
error_messages
string
repeated
ValidateRegexRequest
Field Type Label Description
regex
string
ValidateRegexResponse
Field Type Label Description
error_messages
string
repeated
ReannotateEntitiesOptions
Name Number Description
REANNOTATE_NEVER
0
REANNOTATE_ALWAYS
1
REANNOTATE_IF_EMPTY
2
REANNOTATE_AFTER_DELETION
3
REANNOTATE_IF_EMPTY_OR_AFTER_DELETION
4
ondewo/nlu/webhook.proto
Top
Webhook
ResponseRefinement
rpc ResponseRefinement (WebhookRequest) returns (WebhookResponse)
send a request for /response_refinement/ to the webhook server
fulfillment messages can be overwritten by the webhook server
SlotFilling
rpc SlotFilling (WebhookRequest) returns (WebhookResponse)
send a request for /slot_filling/ to the webhook server
parameter values can be provided &
context information can be changed by the webhook server
Ping
rpc Ping (PingRequest) returns (PingResponse)
send a Ping to the webhook server to verify server health
will return True if http status_code==200 is detected in the response
CreateSessionEntityType
rpc CreateSessionEntityType (CreateSessionEntityTypeRequest) returns (SessionEntityType)
Creates a session entity type.
If the specified session entity type already exists, overrides the session
entity type.
This method doesn't work with Google Assistant integration.
Contact Dialogflow support if you need to use session entities
with Google Assistant integration.
UpdateSessionEntityType
rpc UpdateSessionEntityType (UpdateSessionEntityTypeRequest) returns (SessionEntityType)
Updates the specified session entity type.
This method doesn't work with Google Assistant integration.
Contact Dialogflow support if you need to use session entities
with Google Assistant integration.
DeleteSessionEntityType
rpc DeleteSessionEntityType (DeleteSessionEntityTypeRequest) returns (.google.protobuf.Empty)
Deletes the specified session entity type.
This method doesn't work with Google Assistant integration.
Contact Dialogflow support if you need to use session entities
with Google Assistant integration.
Methods with HTTP bindings
Method Name
Method
Pattern
Body
ResponseRefinement
POST
/{session=projects/*/agent/sessions/*}:responseRefinement
*
SlotFilling
POST
/{session=projects/*/agent/sessions/*}:slotFilling
*
Ping
GET
/projects/*/agent/webhook:ping
CreateSessionEntityTypeRequest
Field Type Label Description
parent
string
projects/<project_uuid>/agent
session_entity_type
SessionEntityType
session_id
string
or
projects/<project_uuid>/agents/sessions/<session_uuid>
`projects/projects/<project_uuid>/agents/sessions/<session_uuid>
projects/<project_uuid>/agents/sessions/<session_uuid>
DeleteSessionEntityTypeRequest
Field Type Label Description
name
string
GetSessionEntityTypeRequest
Field Type Label Description
name
string
ListSessionEntityTypesRequest
Field Type Label Description
parent
string
page_size
int32
page_token
string
ListSessionEntityTypesResponse
Field Type Label Description
session_entity_types
SessionEntityType
repeated
next_page_token
string
OriginalDetectIntentRequest
Field Type Label Description
source
string
payload
google.protobuf.Struct
{
"a": {
"b": "c"
}
}
PingRequest
Field Type Label Description
session
string
PingResponse
Field Type Label Description
is_reachable
bool
SessionEntityType
Field Type Label Description
name
string
entity_override_mode
SessionEntityType.EntityOverrideMode
entities
EntityType.Entity
repeated
UpdateSessionEntityTypeRequest
Field Type Label Description
session_entity_type
SessionEntityType
update_mask
google.protobuf.FieldMask
WebhookRequest
Field Type Label Description
response_id
string
query_result
QueryResult
original_detect_intent_request
OriginalDetectIntentRequest
session
string
projects/<project_uuid>/agent/sessions/<session_uuid>
headers
google.protobuf.Struct
WebhookResponse
Field Type Label Description
fulfillment_text
string
fulfillment_messages
Intent.Message
repeated
source
string
payload
google.protobuf.Struct
{
"google": {
"expectUserResponse": true,
"richResponse": {
"items": [
{
"simpleResponse": {
"textToSpeech": "this is a simple response"
}
}
]
}
}
}
output_contexts
Context
repeated
followup_event_input
EventInput
session_entity_types
SessionEntityType
repeated
SessionEntityType.EntityOverrideMode
Name Number Description
ENTITY_OVERRIDE_MODE_UNSPECIFIED
0
ENTITY_OVERRIDE_MODE_OVERRIDE
1
ENTITY_OVERRIDE_MODE_SUPPLEMENT
2
ondewo/s2t/speech-to-text.proto
Top
Speech2Text
TranscribeFile
rpc TranscribeFile (TranscribeFileRequest) returns (TranscribeFileResponse)
Transcribes an audio file
TranscribeStream
rpc TranscribeStream (stream TranscribeStreamRequest) returns (stream TranscribeStreamResponse)
Transcribes an audio stream.
GetS2tPipeline
rpc GetS2tPipeline (S2tPipelineId) returns (Speech2TextConfig)
Gets a speech to text pipeline corresponding to the id specified in S2tPipelineId. If no corresponding id is
found, raises ModuleNotFoundError in server.
CreateS2tPipeline
rpc CreateS2tPipeline (Speech2TextConfig) returns (S2tPipelineId)
Creates a new speech to text pipeline from a Speech2TextConfig and registers the new pipeline in the server.
DeleteS2tPipeline
rpc DeleteS2tPipeline (S2tPipelineId) returns (.google.protobuf.Empty)
Deletes a pipeline corresponding to the id parsed in S2TPipelineId. If no corresponding id is
found, raises ModuleNotFoundError in server.
UpdateS2tPipeline
rpc UpdateS2tPipeline (Speech2TextConfig) returns (.google.protobuf.Empty)
Updates a pipeline with the id specified in Speech2TextConfig with the new config. If no corresponding id is
found, raises ModuleNotFoundError in server.
ListS2tPipelines
rpc ListS2tPipelines (ListS2tPipelinesRequest) returns (ListS2tPipelinesResponse)
Lists all speech to text pipelines.
ListS2tLanguages
rpc ListS2tLanguages (ListS2tLanguagesRequest) returns (ListS2tLanguagesResponse)
Returns a message containing a list of all languages for which there exist pipelines.
ListS2tDomains
rpc ListS2tDomains (ListS2tDomainsRequest) returns (ListS2tDomainsResponse)
Returns a message containing a list of all domains for which there exist pipelines.
GetServiceInfo
rpc GetServiceInfo (.google.protobuf.Empty) returns (S2TGetServiceInfoResponse)
Returns a message containing the version of the running speech to text server.
ListS2tLanguageModels
rpc ListS2tLanguageModels (ListS2tLanguageModelsRequest) returns (ListS2tLanguageModelsResponse)
Given a list of pipeline ids, returns a list of LanguageModelPipelineId messages containing the pipeline
id and a list of the language models loaded in the pipeline.
CreateUserLanguageModel
rpc CreateUserLanguageModel (CreateUserLanguageModelRequest) returns (.google.protobuf.Empty)
Create a user language model.
DeleteUserLanguageModel
rpc DeleteUserLanguageModel (DeleteUserLanguageModelRequest) returns (.google.protobuf.Empty)
Delete a user language model.
AddDataToUserLanguageModel
rpc AddDataToUserLanguageModel (AddDataToUserLanguageModelRequest) returns (.google.protobuf.Empty)
Add data to a user language model.
TrainUserLanguageModel
rpc TrainUserLanguageModel (TrainUserLanguageModelRequest) returns (.google.protobuf.Empty)
Train a user language model.
AcousticModels
Field Type Label Description
type
string
wav2vec
Wav2Vec
wav2vec_triton
Wav2VecTriton
whisper
Whisper
whisper_triton
WhisperTriton
AddDataToUserLanguageModelRequest
Field Type Label Description
language_model_name
string
zipped_data
bytes
CkptFile
Field Type Label Description
path
string
CreateUserLanguageModelRequest
Field Type Label Description
language_model_name
string
DeleteUserLanguageModelRequest
Field Type Label Description
language_model_name
string
LanguageModelPipelineId
Field Type Label Description
pipeline_id
string
model_names
string
repeated
LanguageModels
Field Type Label Description
path
string
beam_size
int64
default_lm
string
beam_search_scorer_alpha
float
beam_search_scorer_beta
float
ListS2tDomainsRequest
Field Type Label Description
languages
string
repeated
pipeline_owners
string
repeated
ListS2tDomainsResponse
Field Type Label Description
domains
string
repeated
ListS2tLanguageModelsRequest
Field Type Label Description
ids
string
repeated
ListS2tLanguageModelsResponse
Field Type Label Description
lm_pipeline_ids
LanguageModelPipelineId
repeated
ListS2tLanguagesRequest
Field Type Label Description
domains
string
repeated
pipeline_owners
string
repeated
ListS2tLanguagesResponse
Field Type Label Description
languages
string
repeated
ListS2tPipelinesRequest
Field Type Label Description
languages
string
repeated
pipeline_owners
string
repeated
domains
string
repeated
registered_only
bool
ListS2tPipelinesResponse
Field Type Label Description
pipeline_configs
Speech2TextConfig
repeated
Logging
Field Type Label Description
type
string
path
string
PostProcessing
Field Type Label Description
pipeline
string
repeated
post_processors
PostProcessors
PostProcessingOptions
Field Type Label Description
spelling_correction
bool
normalize
bool
config
PostProcessing
PostProcessors
Field Type Label Description
sym_spell
SymSpell
normalization
S2TNormalization
PtFiles
Field Type Label Description
path
string
step
string
Pyannote
Field Type Label Description
model_name
string
min_audio_size
int64
min_duration_off
float
min_duration_on
float
triton_server_host
string
triton_server_port
int64
S2TDescription
Field Type Label Description
language
string
pipeline_owner
string
domain
string
comments
string
S2TGetServiceInfoResponse
Field Type Label Description
version
string
S2TInference
Field Type Label Description
acoustic_models
AcousticModels
language_models
LanguageModels
inference_backend
InferenceBackend
S2TNormalization
Field Type Label Description
language
string
pipeline
string
repeated
S2tPipelineId
Field Type Label Description
id
string
Speech2TextConfig
Field Type Label Description
id
string
description
S2TDescription
active
bool
inference
S2TInference
streaming_server
StreamingServer
voice_activity_detection
VoiceActivityDetection
post_processing
PostProcessing
logging
Logging
StreamingServer
Field Type Label Description
host
string
port
int64
output_style
string
streaming_speech_recognition
StreamingSpeechRecognition
StreamingSpeechRecognition
Field Type Label Description
transcribe_not_final
bool
decoding_method
string
sampling_rate
int64
min_audio_chunk_size
int64
next_chunk_timeout
float
SymSpell
Field Type Label Description
dict_path
string
max_dictionary_edit_distance
int64
prefix_length
int64
TrainUserLanguageModelRequest
Field Type Label Description
language_model_name
string
order
int64
TranscribeFileRequest
Field Type Label Description
audio_file
bytes
config
TranscribeRequestConfig
TranscribeFileResponse
Field Type Label Description
transcriptions
Transcription
repeated
time
float
audio_uuid
string
TranscribeRequestConfig
Field Type Label Description
s2t_pipeline_id
string
decoding
Decoding
language_model_name
string
post_processing
PostProcessingOptions
utterance_detection
UtteranceDetectionOptions
pyannote
Pyannote
return_options
TranscriptionReturnOptions
language
string
optional
task
string
optional
TranscribeStreamRequest
Field Type Label Description
audio_chunk
bytes
end_of_stream
bool
config
TranscribeRequestConfig
mute_audio
bool
TranscribeStreamResponse
Field Type Label Description
transcriptions
Transcription
repeated
time
float
final
bool
return_audio
bool
audio
bytes
utterance_start
bool
audio_uuid
string
config
TranscribeRequestConfig
Transcription
Field Type Label Description
transcription
string
confidence_score
float
words
WordDetail
repeated
alternatives
TranscriptionAlternative
repeated
TranscriptionAlternative
Field Type Label Description
transcript
string
confidence
float
words
WordDetail
repeated
TranscriptionReturnOptions
Field Type Label Description
return_start_of_speech
bool
return_audio
bool
return_confidence_score
bool
return_alternative_transcriptions
bool
return_alternative_transcriptions_nr
int32
return_alternative_words
bool
return_alternative_words_nr
int32
return_word_timing
bool
UtteranceDetectionOptions
Field Type Label Description
transcribe_not_final
bool
next_chunk_timeout
float
VoiceActivityDetection
Field Type Label Description
active
string
sampling_rate
int64
pyannote
Pyannote
Wav2Vec
Field Type Label Description
model_path
string
use_gpu
bool
Wav2VecTriton
Field Type Label Description
processor_path
string
triton_model_name
string
triton_model_version
string
check_status_timeout
int64
triton_server_host
string
triton_server_port
int64
Whisper
Field Type Label Description
model_path
string
use_gpu
bool
language
string
task
string
WhisperTriton
Field Type Label Description
processor_path
string
triton_model_name
string
triton_model_version
string
check_status_timeout
int64
language
string
task
string
triton_server_host
string
triton_server_port
int64
WordAlternative
Field Type Label Description
word
string
confidence
float
WordDetail
Field Type Label Description
start_time
float
end_time
float
word
string
confidence
float
word_alternatives
WordAlternative
repeated
Decoding
Name Number Description
DEFAULT
0
GREEDY
1
BEAM_SEARCH_WITH_LM
2
BEAM_SEARCH
3
InferenceBackend
Name Number Description
INFERENCE_BACKEND_UNKNOWN
0
INFERENCE_BACKEND_PYTORCH
1
INFERENCE_BACKEND_FLAX
2
ondewo/t2s/text-to-speech.proto
Top
Text2Speech
Synthesize
rpc Synthesize (SynthesizeRequest) returns (SynthesizeResponse)
Synthesize RPC
Synthesizes a specific text sent in the request with the provided configuration requirements
and retrieves a response that includes the synthesized text as audio and the requested configuration.
BatchSynthesize
rpc BatchSynthesize (BatchSynthesizeRequest) returns (BatchSynthesizeResponse)
BatchSynthesize RPC
Performs batch synthesis by accepting a batch of synthesis requests and returning a batch response.
This can be more efficient for generating predictions on the AI model in bulk.
NormalizeText
rpc NormalizeText (NormalizeTextRequest) returns (NormalizeTextResponse)
NormalizeText RPC
Normalizes a text according to the specific pipeline's normalization rules.
GetT2sPipeline
rpc GetT2sPipeline (T2sPipelineId) returns (Text2SpeechConfig)
GetT2sPipeline RPC
Retrieves the configuration of the specified text-to-speech pipeline.
CreateT2sPipeline
rpc CreateT2sPipeline (Text2SpeechConfig) returns (T2sPipelineId)
CreateT2sPipeline RPC
Creates a new text-to-speech pipeline with the provided configuration and returns its pipeline ID.
DeleteT2sPipeline
rpc DeleteT2sPipeline (T2sPipelineId) returns (.google.protobuf.Empty)
DeleteT2sPipeline RPC
Deletes the specified text-to-speech pipeline.
UpdateT2sPipeline
rpc UpdateT2sPipeline (Text2SpeechConfig) returns (.google.protobuf.Empty)
UpdateT2sPipeline RPC
Updates the specified text-to-speech pipeline with the given configuration.
ListT2sPipelines
rpc ListT2sPipelines (ListT2sPipelinesRequest) returns (ListT2sPipelinesResponse)
ListT2sPipelines RPC
Retrieves a list of text-to-speech pipelines based on specific requirements.
ListT2sLanguages
rpc ListT2sLanguages (ListT2sLanguagesRequest) returns (ListT2sLanguagesResponse)
ListT2sLanguages RPC
Retrieves a list of languages available based on specific configuration requirements.
ListT2sDomains
rpc ListT2sDomains (ListT2sDomainsRequest) returns (ListT2sDomainsResponse)
ListT2sDomains RPC
Retrieves a list of domains available based on specific configuration requirements.
GetServiceInfo
rpc GetServiceInfo (.google.protobuf.Empty) returns (T2SGetServiceInfoResponse)
GetServiceInfo RPC
Retrieves the version information of the running text-to-speech server.
GetCustomPhonemizer
rpc GetCustomPhonemizer (PhonemizerId) returns (CustomPhonemizerProto)
GetCustomPhonemizer RPC
Retrieves a custom phonemizer based on the provided PhonemizerId.
CreateCustomPhonemizer
rpc CreateCustomPhonemizer (CreateCustomPhonemizerRequest) returns (PhonemizerId)
CreateCustomPhonemizer RPC
Creates a custom phonemizer based on the provided CreateCustomPhonemizerRequest.
Returns the PhonemizerId associated with the created custom phonemizer.
DeleteCustomPhonemizer
rpc DeleteCustomPhonemizer (PhonemizerId) returns (.google.protobuf.Empty)
DeleteCustomPhonemizer RPC
Deletes a custom phonemizer based on the provided PhonemizerId.
Returns an Empty response upon successful deletion.
UpdateCustomPhonemizer
rpc UpdateCustomPhonemizer (UpdateCustomPhonemizerRequest) returns (CustomPhonemizerProto)
UpdateCustomPhonemizer RPC
Updates the specified custom phonemizer with the provided configuration.
ListCustomPhonemizer
rpc ListCustomPhonemizer (ListCustomPhonemizerRequest) returns (ListCustomPhonemizerResponse)
ListCustomPhonemizer RPC
Retrieves a list of custom phonemizers based on specific requirements.
Apodization
Field Type Label Description
apodization_secs
float
BatchSynthesizeRequest
Field Type Label Description
batch_request
SynthesizeRequest
repeated
BatchSynthesizeResponse
Field Type Label Description
batch_response
SynthesizeResponse
repeated
Caching
Field Type Label Description
active
bool
memory_cache_max_size
int64
sampling_rate
int64
load_cache
bool
save_cache
bool
cache_save_dir
string
CompositeInference
Field Type Label Description
text2mel
Text2Mel
mel2audio
Mel2Audio
CreateCustomPhonemizerRequest
Field Type Label Description
prefix
string
maps
Map
repeated
CustomPhonemizerProto
Field Type Label Description
id
string
maps
Map
repeated
GlowTTS
Field Type Label Description
batch_size
int64
use_gpu
bool
length_scale
float
noise_scale
float
path
string
cleaners
string
repeated
param_config_path
string
GlowTTSTriton
Field Type Label Description
batch_size
int64
length_scale
float
noise_scale
float
cleaners
string
repeated
max_text_length
int64
param_config_path
string
triton_model_name
string
triton_server_host
string
triton_server_port
int64
HiFiGan
Field Type Label Description
use_gpu
bool
batch_size
int64
config_path
string
model_path
string
HiFiGanTriton
Field Type Label Description
config_path
string
triton_model_name
string
triton_server_host
string
triton_server_port
int64
ListCustomPhonemizerRequest
Field Type Label Description
pipeline_ids
string
repeated
ListCustomPhonemizerResponse
Field Type Label Description
phonemizers
CustomPhonemizerProto
repeated
ListT2sDomainsRequest
Field Type Label Description
speaker_sexes
string
repeated
pipeline_owners
string
repeated
speaker_names
string
repeated
languages
string
repeated
ListT2sDomainsResponse
Field Type Label Description
domains
string
repeated
ListT2sLanguagesRequest
Field Type Label Description
speaker_sexes
string
repeated
pipeline_owners
string
repeated
speaker_names
string
repeated
domains
string
repeated
ListT2sLanguagesResponse
Field Type Label Description
languages
string
repeated
ListT2sPipelinesRequest
Field Type Label Description
languages
string
repeated
speaker_sexes
string
repeated
pipeline_owners
string
repeated
speaker_names
string
repeated
domains
string
repeated
ListT2sPipelinesResponse
Field Type Label Description
pipelines
Text2SpeechConfig
repeated
Logmnse
Field Type Label Description
initial_noise
int64
window_size
int64
noise_threshold
float
Map
Field Type Label Description
word
string
phoneme_groups
string
MbMelganTriton
Field Type Label Description
config_path
string
stats_path
string
triton_model_name
string
triton_server_host
string
triton_server_port
int64
Mel2Audio
Field Type Label Description
type
string
mb_melgan_triton
MbMelganTriton
hifi_gan
HiFiGan
hifi_gan_triton
HiFiGanTriton
NormalizeTextRequest
Field Type Label Description
t2s_pipeline_id
string
text
string
NormalizeTextResponse
Field Type Label Description
normalized_text
string
PhonemizerId
Field Type Label Description
id
string
Postprocessing
Field Type Label Description
silence_secs
float
pipeline
string
repeated
logmmse
Logmnse
wiener
Wiener
apodization
Apodization
RequestConfig
Field Type Label Description
t2s_pipeline_id
string
length_scale
float
noise_scale
float
sample_rate
int32
pcm
Pcm
audio_format
AudioFormat
use_cache
bool
normalizer
string
SingleInference
Field Type Label Description
text2audio
Text2Audio
SynthesizeRequest
Field Type Label Description
text
string
Hello, how are you?
- SSML Tag Email: <say-as interpret-as="phone">+12354321</say-as>
- SSML Tag URL: <say-as interpret-as="email">voices@ondewo.com</say-as>
- SSML Tag Spell: <say-as interpret-as="url">ondewo.com/en/</say-as>
- SSML Tag Spell With Names: <say-as interpret-as="spell">AP732</say-as>
- SSML Tag Callsigns Short: <say-as interpret-as="spell-with-names">AHO32</say-as>
- SSML Tag Callsigns Long: <say-as interpret-as="callsign-short">AUA439</say-as>
- SSML Tag Break Tag: <say-as interpret-as="callsign-long">AAL439</say-as>
- Arpabet Phonemes: I am going to take a 2 seconds break
Hello I am {AE2 L EH0 G Z AE1 N D R AH0}
config
RequestConfig
SynthesizeResponse
Field Type Label Description
audio_uuid
string
audio
bytes
generation_time
float
audio_length
float
text
string
config
RequestConfig
normalized_text
string
T2SCustomLengthScales
Field Type Label Description
text
float
email
float
url
float
phone
float
spell
float
spell_with_names
float
callsign_long
float
callsign_short
float
T2SDescription
Field Type Label Description
language
string
speaker_sex
string
pipeline_owner
string
comments
string
speaker_name
string
domain
string
T2SGetServiceInfoResponse
Field Type Label Description
version
string
T2SInference
Field Type Label Description
type
string
composite_inference
CompositeInference
single_inference
SingleInference
caching
Caching
T2SNormalization
Field Type Label Description
language
string
pipeline
string
repeated
custom_phonemizer_id
string
custom_length_scales
T2SCustomLengthScales
arpabet_mapping
string
numeric_mapping
string
callsigns_mapping
string
T2sPipelineId
Field Type Label Description
id
string
Text2Audio
Field Type Label Description
type
string
vits
Vits
vits_triton
VitsTriton
Text2Mel
Field Type Label Description
type
string
glow_tts
GlowTTS
glow_tts_triton
GlowTTSTriton
Text2SpeechConfig
Field Type Label Description
id
string
description
T2SDescription
active
bool
inference
T2SInference
normalization
T2SNormalization
postprocessing
Postprocessing
UpdateCustomPhonemizerRequest
Field Type Label Description
id
string
update_method
UpdateCustomPhonemizerRequest.UpdateMethod
maps
Map
repeated
Vits
Field Type Label Description
batch_size
int64
use_gpu
bool
length_scale
float
noise_scale
float
path
string
cleaners
string
repeated
param_config_path
string
VitsTriton
Field Type Label Description
batch_size
int64
length_scale
float
noise_scale
float
cleaners
string
repeated
max_text_length
int64
param_config_path
string
triton_model_name
string
triton_server_host
string
triton_server_port
int64
Wiener
Field Type Label Description
frame_len
int64
lpc_order
int64
iterations
int64
alpha
float
thresh
float
AudioFormat
Name Number Description
wav
0
flac
1
caf
2
mp3
3
aac
4
ogg
5
wma
6
Pcm
Name Number Description
PCM_16
0
PCM_24
1
PCM_32
2
PCM_S8
3
PCM_U8
4
FLOAT
5
DOUBLE
6
UpdateCustomPhonemizerRequest.UpdateMethod
Name Number Description
extend_hard
0
extend_soft
1
replace
2
Scalar Value Types
.proto Type Notes C++ Java Python Go C# PHP Ruby
double
double
double
float
float64
double
float
Float
float
float
float
float
float32
float
float
Float
int32
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
int64
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
int64
long
int/long
int64
long
integer/string
Bignum
uint32
Uses variable-length encoding.
uint32
int
int/long
uint32
uint
integer
Bignum or Fixnum (as required)
uint64
Uses variable-length encoding.
uint64
long
int/long
uint64
ulong
integer/string
Bignum or Fixnum (as required)
sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
int64
long
int/long
int64
long
integer/string
Bignum
fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28.
uint32
int
int
uint32
uint
integer
Bignum or Fixnum (as required)
fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56.
uint64
long
int/long
uint64
ulong
integer/string
Bignum
sfixed32
Always four bytes.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
sfixed64
Always eight bytes.
int64
long
int/long
int64
long
integer/string
Bignum
bool
bool
boolean
boolean
bool
bool
boolean
TrueClass/FalseClass
string
A string must always contain UTF-8 encoded or 7-bit ASCII text.
string
String
str/unicode
string
string
string
String (UTF-8)
bytes
May contain any arbitrary sequence of bytes.
string
ByteString
str
[]byte
ByteString
string
String (ASCII-8BIT)