Constants
AgentService_ListApps_FullMethodName, AgentService_GetApp_FullMethodName, AgentService_CreateApp_FullMethodName, AgentService_UpdateApp_FullMethodName, AgentService_DeleteApp_FullMethodName, AgentService_ExportApp_FullMethodName, AgentService_ImportApp_FullMethodName, AgentService_ListAgents_FullMethodName, AgentService_GetAgent_FullMethodName, AgentService_CreateAgent_FullMethodName, AgentService_UpdateAgent_FullMethodName, AgentService_DeleteAgent_FullMethodName, AgentService_ListExamples_FullMethodName, AgentService_GetExample_FullMethodName, AgentService_CreateExample_FullMethodName, AgentService_UpdateExample_FullMethodName, AgentService_DeleteExample_FullMethodName, AgentService_ListTools_FullMethodName, AgentService_GetTool_FullMethodName, AgentService_ListConversations_FullMethodName, AgentService_GetConversation_FullMethodName, AgentService_DeleteConversation_FullMethodName, AgentService_BatchDeleteConversations_FullMethodName, AgentService_CreateTool_FullMethodName, AgentService_UpdateTool_FullMethodName, AgentService_DeleteTool_FullMethodName, AgentService_ListGuardrails_FullMethodName, AgentService_GetGuardrail_FullMethodName, AgentService_CreateGuardrail_FullMethodName, AgentService_UpdateGuardrail_FullMethodName, AgentService_DeleteGuardrail_FullMethodName, AgentService_ListDeployments_FullMethodName, AgentService_GetDeployment_FullMethodName, AgentService_CreateDeployment_FullMethodName, AgentService_UpdateDeployment_FullMethodName, AgentService_DeleteDeployment_FullMethodName, AgentService_ListToolsets_FullMethodName, AgentService_GetToolset_FullMethodName, AgentService_CreateToolset_FullMethodName, AgentService_UpdateToolset_FullMethodName, AgentService_DeleteToolset_FullMethodName, AgentService_ListAppVersions_FullMethodName, AgentService_GetAppVersion_FullMethodName, AgentService_CreateAppVersion_FullMethodName, AgentService_DeleteAppVersion_FullMethodName, AgentService_RestoreAppVersion_FullMethodName, AgentService_ListChangelogs_FullMethodName, AgentService_GetChangelog_FullMethodName
const (
AgentService_ListApps_FullMethodName = "/google.cloud.ces.v1.AgentService/ListApps"
AgentService_GetApp_FullMethodName = "/google.cloud.ces.v1.AgentService/GetApp"
AgentService_CreateApp_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateApp"
AgentService_UpdateApp_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateApp"
AgentService_DeleteApp_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteApp"
AgentService_ExportApp_FullMethodName = "/google.cloud.ces.v1.AgentService/ExportApp"
AgentService_ImportApp_FullMethodName = "/google.cloud.ces.v1.AgentService/ImportApp"
AgentService_ListAgents_FullMethodName = "/google.cloud.ces.v1.AgentService/ListAgents"
AgentService_GetAgent_FullMethodName = "/google.cloud.ces.v1.AgentService/GetAgent"
AgentService_CreateAgent_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateAgent"
AgentService_UpdateAgent_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateAgent"
AgentService_DeleteAgent_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteAgent"
AgentService_ListExamples_FullMethodName = "/google.cloud.ces.v1.AgentService/ListExamples"
AgentService_GetExample_FullMethodName = "/google.cloud.ces.v1.AgentService/GetExample"
AgentService_CreateExample_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateExample"
AgentService_UpdateExample_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateExample"
AgentService_DeleteExample_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteExample"
AgentService_ListTools_FullMethodName = "/google.cloud.ces.v1.AgentService/ListTools"
AgentService_GetTool_FullMethodName = "/google.cloud.ces.v1.AgentService/GetTool"
AgentService_ListConversations_FullMethodName = "/google.cloud.ces.v1.AgentService/ListConversations"
AgentService_GetConversation_FullMethodName = "/google.cloud.ces.v1.AgentService/GetConversation"
AgentService_DeleteConversation_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteConversation"
AgentService_BatchDeleteConversations_FullMethodName = "/google.cloud.ces.v1.AgentService/BatchDeleteConversations"
AgentService_CreateTool_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateTool"
AgentService_UpdateTool_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateTool"
AgentService_DeleteTool_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteTool"
AgentService_ListGuardrails_FullMethodName = "/google.cloud.ces.v1.AgentService/ListGuardrails"
AgentService_GetGuardrail_FullMethodName = "/google.cloud.ces.v1.AgentService/GetGuardrail"
AgentService_CreateGuardrail_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateGuardrail"
AgentService_UpdateGuardrail_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateGuardrail"
AgentService_DeleteGuardrail_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteGuardrail"
AgentService_ListDeployments_FullMethodName = "/google.cloud.ces.v1.AgentService/ListDeployments"
AgentService_GetDeployment_FullMethodName = "/google.cloud.ces.v1.AgentService/GetDeployment"
AgentService_CreateDeployment_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateDeployment"
AgentService_UpdateDeployment_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateDeployment"
AgentService_DeleteDeployment_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteDeployment"
AgentService_ListToolsets_FullMethodName = "/google.cloud.ces.v1.AgentService/ListToolsets"
AgentService_GetToolset_FullMethodName = "/google.cloud.ces.v1.AgentService/GetToolset"
AgentService_CreateToolset_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateToolset"
AgentService_UpdateToolset_FullMethodName = "/google.cloud.ces.v1.AgentService/UpdateToolset"
AgentService_DeleteToolset_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteToolset"
AgentService_ListAppVersions_FullMethodName = "/google.cloud.ces.v1.AgentService/ListAppVersions"
AgentService_GetAppVersion_FullMethodName = "/google.cloud.ces.v1.AgentService/GetAppVersion"
AgentService_CreateAppVersion_FullMethodName = "/google.cloud.ces.v1.AgentService/CreateAppVersion"
AgentService_DeleteAppVersion_FullMethodName = "/google.cloud.ces.v1.AgentService/DeleteAppVersion"
AgentService_RestoreAppVersion_FullMethodName = "/google.cloud.ces.v1.AgentService/RestoreAppVersion"
AgentService_ListChangelogs_FullMethodName = "/google.cloud.ces.v1.AgentService/ListChangelogs"
AgentService_GetChangelog_FullMethodName = "/google.cloud.ces.v1.AgentService/GetChangelog"
)SessionService_RunSession_FullMethodName, SessionService_StreamRunSession_FullMethodName, SessionService_BidiRunSession_FullMethodName
const (
SessionService_RunSession_FullMethodName = "/google.cloud.ces.v1.SessionService/RunSession"
SessionService_StreamRunSession_FullMethodName = "/google.cloud.ces.v1.SessionService/StreamRunSession"
SessionService_BidiRunSession_FullMethodName = "/google.cloud.ces.v1.SessionService/BidiRunSession"
)ToolService_ExecuteTool_FullMethodName, ToolService_RetrieveToolSchema_FullMethodName, ToolService_RetrieveTools_FullMethodName
const (
ToolService_ExecuteTool_FullMethodName = "/google.cloud.ces.v1.ToolService/ExecuteTool"
ToolService_RetrieveToolSchema_FullMethodName = "/google.cloud.ces.v1.ToolService/RetrieveToolSchema"
ToolService_RetrieveTools_FullMethodName = "/google.cloud.ces.v1.ToolService/RetrieveTools"
)WidgetService_GenerateChatToken_FullMethodName
const (
WidgetService_GenerateChatToken_FullMethodName = "/google.cloud.ces.v1.WidgetService/GenerateChatToken"
)Variables
ExportAppRequest_ExportFormat_name, ExportAppRequest_ExportFormat_value
var (
ExportAppRequest_ExportFormat_name = map[int32]string{
0: "EXPORT_FORMAT_UNSPECIFIED",
1: "JSON",
2: "YAML",
}
ExportAppRequest_ExportFormat_value = map[string]int32{
"EXPORT_FORMAT_UNSPECIFIED": 0,
"JSON": 1,
"YAML": 2,
}
)Enum value maps for ExportAppRequest_ExportFormat.
ImportAppRequest_ImportOptions_ConflictResolutionStrategy_name, ImportAppRequest_ImportOptions_ConflictResolutionStrategy_value
var (
ImportAppRequest_ImportOptions_ConflictResolutionStrategy_name = map[int32]string{
0: "CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED",
1: "REPLACE",
2: "OVERWRITE",
}
ImportAppRequest_ImportOptions_ConflictResolutionStrategy_value = map[string]int32{
"CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED": 0,
"REPLACE": 1,
"OVERWRITE": 2,
}
)Enum value maps for ImportAppRequest_ImportOptions_ConflictResolutionStrategy.
TransferRule_Direction_name, TransferRule_Direction_value
var (
TransferRule_Direction_name = map[int32]string{
0: "DIRECTION_UNSPECIFIED",
1: "PARENT_TO_CHILD",
2: "CHILD_TO_PARENT",
}
TransferRule_Direction_value = map[string]int32{
"DIRECTION_UNSPECIFIED": 0,
"PARENT_TO_CHILD": 1,
"CHILD_TO_PARENT": 2,
}
)Enum value maps for TransferRule_Direction.
App_ToolExecutionMode_name, App_ToolExecutionMode_value
var (
App_ToolExecutionMode_name = map[int32]string{
0: "TOOL_EXECUTION_MODE_UNSPECIFIED",
1: "PARALLEL",
2: "SEQUENTIAL",
}
App_ToolExecutionMode_value = map[string]int32{
"TOOL_EXECUTION_MODE_UNSPECIFIED": 0,
"PARALLEL": 1,
"SEQUENTIAL": 2,
}
)Enum value maps for App_ToolExecutionMode.
AmbientSoundConfig_PrebuiltAmbientNoise_name, AmbientSoundConfig_PrebuiltAmbientNoise_value
var (
AmbientSoundConfig_PrebuiltAmbientNoise_name = map[int32]string{
0: "PREBUILT_AMBIENT_NOISE_UNSPECIFIED",
1: "RETAIL_STORE",
2: "CONVENTION_HALL",
3: "OUTDOOR",
}
AmbientSoundConfig_PrebuiltAmbientNoise_value = map[string]int32{
"PREBUILT_AMBIENT_NOISE_UNSPECIFIED": 0,
"RETAIL_STORE": 1,
"CONVENTION_HALL": 2,
"OUTDOOR": 3,
}
)Enum value maps for AmbientSoundConfig_PrebuiltAmbientNoise.
ErrorHandlingSettings_ErrorHandlingStrategy_name, ErrorHandlingSettings_ErrorHandlingStrategy_value
var (
ErrorHandlingSettings_ErrorHandlingStrategy_name = map[int32]string{
0: "ERROR_HANDLING_STRATEGY_UNSPECIFIED",
1: "NONE",
2: "FALLBACK_RESPONSE",
3: "END_SESSION",
}
ErrorHandlingSettings_ErrorHandlingStrategy_value = map[string]int32{
"ERROR_HANDLING_STRATEGY_UNSPECIFIED": 0,
"NONE": 1,
"FALLBACK_RESPONSE": 2,
"END_SESSION": 3,
}
)Enum value maps for ErrorHandlingSettings_ErrorHandlingStrategy.
EvaluationMetricsThresholds_HallucinationMetricBehavior_name, EvaluationMetricsThresholds_HallucinationMetricBehavior_value
var (
EvaluationMetricsThresholds_HallucinationMetricBehavior_name = map[int32]string{
0: "HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED",
1: "DISABLED",
2: "ENABLED",
}
EvaluationMetricsThresholds_HallucinationMetricBehavior_value = map[string]int32{
"HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED": 0,
"DISABLED": 1,
"ENABLED": 2,
}
)Enum value maps for EvaluationMetricsThresholds_HallucinationMetricBehavior.
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel_name, EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel_value
var (
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel_name = map[int32]string{
0: "SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED",
1: "TEXT",
2: "AUDIO",
}
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel_value = map[string]int32{
"SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED": 0,
"TEXT": 1,
"AUDIO": 2,
}
)Enum value maps for EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel.
EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior_name, EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior_value
var (
EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior_name = map[int32]string{
0: "EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED",
1: "FAIL",
2: "ALLOW",
}
EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior_value = map[string]int32{
"EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED": 0,
"FAIL": 1,
"ALLOW": 2,
}
)Enum value maps for EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior.
DataStoreSettings_Engine_Type_name, DataStoreSettings_Engine_Type_value
var (
DataStoreSettings_Engine_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ENGINE_TYPE_SEARCH",
2: "ENGINE_TYPE_CHAT",
}
DataStoreSettings_Engine_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ENGINE_TYPE_SEARCH": 1,
"ENGINE_TYPE_CHAT": 2,
}
)Enum value maps for DataStoreSettings_Engine_Type.
ApiKeyConfig_RequestLocation_name, ApiKeyConfig_RequestLocation_value
var (
ApiKeyConfig_RequestLocation_name = map[int32]string{
0: "REQUEST_LOCATION_UNSPECIFIED",
1: "HEADER",
2: "QUERY_STRING",
}
ApiKeyConfig_RequestLocation_value = map[string]int32{
"REQUEST_LOCATION_UNSPECIFIED": 0,
"HEADER": 1,
"QUERY_STRING": 2,
}
)Enum value maps for ApiKeyConfig_RequestLocation.
OAuthConfig_OauthGrantType_name, OAuthConfig_OauthGrantType_value
var (
OAuthConfig_OauthGrantType_name = map[int32]string{
0: "OAUTH_GRANT_TYPE_UNSPECIFIED",
1: "CLIENT_CREDENTIAL",
}
OAuthConfig_OauthGrantType_value = map[string]int32{
"OAUTH_GRANT_TYPE_UNSPECIFIED": 0,
"CLIENT_CREDENTIAL": 1,
}
)Enum value maps for OAuthConfig_OauthGrantType.
ExecutionType_name, ExecutionType_value
var (
ExecutionType_name = map[int32]string{
0: "EXECUTION_TYPE_UNSPECIFIED",
1: "SYNCHRONOUS",
2: "ASYNCHRONOUS",
}
ExecutionType_value = map[string]int32{
"EXECUTION_TYPE_UNSPECIFIED": 0,
"SYNCHRONOUS": 1,
"ASYNCHRONOUS": 2,
}
)Enum value maps for ExecutionType.
ChannelProfile_ChannelType_name, ChannelProfile_ChannelType_value
var (
ChannelProfile_ChannelType_name = map[int32]string{
0: "UNKNOWN",
2: "WEB_UI",
3: "API",
4: "TWILIO",
5: "GOOGLE_TELEPHONY_PLATFORM",
6: "CONTACT_CENTER_AS_A_SERVICE",
7: "FIVE9",
8: "CONTACT_CENTER_INTEGRATION",
}
ChannelProfile_ChannelType_value = map[string]int32{
"UNKNOWN": 0,
"WEB_UI": 2,
"API": 3,
"TWILIO": 4,
"GOOGLE_TELEPHONY_PLATFORM": 5,
"CONTACT_CENTER_AS_A_SERVICE": 6,
"FIVE9": 7,
"CONTACT_CENTER_INTEGRATION": 8,
}
)Enum value maps for ChannelProfile_ChannelType.
ChannelProfile_PersonaProperty_Persona_name, ChannelProfile_PersonaProperty_Persona_value
var (
ChannelProfile_PersonaProperty_Persona_name = map[int32]string{
0: "UNKNOWN",
1: "CONCISE",
2: "CHATTY",
}
ChannelProfile_PersonaProperty_Persona_value = map[string]int32{
"UNKNOWN": 0,
"CONCISE": 1,
"CHATTY": 2,
}
)Enum value maps for ChannelProfile_PersonaProperty_Persona.
ChannelProfile_WebWidgetConfig_Modality_name, ChannelProfile_WebWidgetConfig_Modality_value
var (
ChannelProfile_WebWidgetConfig_Modality_name = map[int32]string{
0: "MODALITY_UNSPECIFIED",
1: "CHAT_AND_VOICE",
2: "VOICE_ONLY",
3: "CHAT_ONLY",
4: "CHAT_VOICE_AND_VIDEO",
}
ChannelProfile_WebWidgetConfig_Modality_value = map[string]int32{
"MODALITY_UNSPECIFIED": 0,
"CHAT_AND_VOICE": 1,
"VOICE_ONLY": 2,
"CHAT_ONLY": 3,
"CHAT_VOICE_AND_VIDEO": 4,
}
)Enum value maps for ChannelProfile_WebWidgetConfig_Modality.
ChannelProfile_WebWidgetConfig_Theme_name, ChannelProfile_WebWidgetConfig_Theme_value
var (
ChannelProfile_WebWidgetConfig_Theme_name = map[int32]string{
0: "THEME_UNSPECIFIED",
1: "LIGHT",
2: "DARK",
}
ChannelProfile_WebWidgetConfig_Theme_value = map[string]int32{
"THEME_UNSPECIFIED": 0,
"LIGHT": 1,
"DARK": 2,
}
)Enum value maps for ChannelProfile_WebWidgetConfig_Theme.
Action_EntityOperation_OperationType_name, Action_EntityOperation_OperationType_value
var (
Action_EntityOperation_OperationType_name = map[int32]string{
0: "OPERATION_TYPE_UNSPECIFIED",
1: "LIST",
2: "GET",
3: "CREATE",
4: "UPDATE",
5: "DELETE",
}
Action_EntityOperation_OperationType_value = map[string]int32{
"OPERATION_TYPE_UNSPECIFIED": 0,
"LIST": 1,
"GET": 2,
"CREATE": 3,
"UPDATE": 4,
"DELETE": 5,
}
)Enum value maps for Action_EntityOperation_OperationType.
Conversation_ChannelType_name, Conversation_ChannelType_value
var (
Conversation_ChannelType_name = map[int32]string{
0: "CHANNEL_TYPE_UNSPECIFIED",
1: "TEXT",
2: "AUDIO",
3: "MULTIMODAL",
}
Conversation_ChannelType_value = map[string]int32{
"CHANNEL_TYPE_UNSPECIFIED": 0,
"TEXT": 1,
"AUDIO": 2,
"MULTIMODAL": 3,
}
)Enum value maps for Conversation_ChannelType.
Conversation_Source_name, Conversation_Source_value
var (
Conversation_Source_name = map[int32]string{
0: "SOURCE_UNSPECIFIED",
1: "LIVE",
2: "SIMULATOR",
3: "EVAL",
}
Conversation_Source_value = map[string]int32{
"SOURCE_UNSPECIFIED": 0,
"LIVE": 1,
"SIMULATOR": 2,
"EVAL": 3,
}
)Enum value maps for Conversation_Source.
Conversation_InputType_name, Conversation_InputType_value
var (
Conversation_InputType_name = map[int32]string{
0: "INPUT_TYPE_UNSPECIFIED",
1: "INPUT_TYPE_TEXT",
2: "INPUT_TYPE_AUDIO",
3: "INPUT_TYPE_IMAGE",
4: "INPUT_TYPE_BLOB",
5: "INPUT_TYPE_TOOL_RESPONSE",
6: "INPUT_TYPE_VARIABLES",
}
Conversation_InputType_value = map[string]int32{
"INPUT_TYPE_UNSPECIFIED": 0,
"INPUT_TYPE_TEXT": 1,
"INPUT_TYPE_AUDIO": 2,
"INPUT_TYPE_IMAGE": 3,
"INPUT_TYPE_BLOB": 4,
"INPUT_TYPE_TOOL_RESPONSE": 5,
"INPUT_TYPE_VARIABLES": 6,
}
)Enum value maps for Conversation_InputType.
DataStore_DataStoreType_name, DataStore_DataStoreType_value
var (
DataStore_DataStoreType_name = map[int32]string{
0: "DATA_STORE_TYPE_UNSPECIFIED",
1: "PUBLIC_WEB",
2: "UNSTRUCTURED",
3: "FAQ",
4: "CONNECTOR",
}
DataStore_DataStoreType_value = map[string]int32{
"DATA_STORE_TYPE_UNSPECIFIED": 0,
"PUBLIC_WEB": 1,
"UNSTRUCTURED": 2,
"FAQ": 3,
"CONNECTOR": 4,
}
)Enum value maps for DataStore_DataStoreType.
DataStore_DocumentProcessingMode_name, DataStore_DocumentProcessingMode_value
var (
DataStore_DocumentProcessingMode_name = map[int32]string{
0: "DOCUMENT_PROCESSING_MODE_UNSPECIFIED",
1: "DOCUMENTS",
2: "CHUNKS",
}
DataStore_DocumentProcessingMode_value = map[string]int32{
"DOCUMENT_PROCESSING_MODE_UNSPECIFIED": 0,
"DOCUMENTS": 1,
"CHUNKS": 2,
}
)Enum value maps for DataStore_DocumentProcessingMode.
DataStoreTool_FilterParameterBehavior_name, DataStoreTool_FilterParameterBehavior_value
var (
DataStoreTool_FilterParameterBehavior_name = map[int32]string{
0: "FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED",
2: "ALWAYS_INCLUDE",
3: "NEVER_INCLUDE",
}
DataStoreTool_FilterParameterBehavior_value = map[string]int32{
"FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED": 0,
"ALWAYS_INCLUDE": 2,
"NEVER_INCLUDE": 3,
}
)Enum value maps for DataStoreTool_FilterParameterBehavior.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name, DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value
var (
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_name = map[int32]string{
0: "ATTRIBUTE_TYPE_UNSPECIFIED",
1: "NUMERICAL",
2: "FRESHNESS",
}
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType_value = map[string]int32{
"ATTRIBUTE_TYPE_UNSPECIFIED": 0,
"NUMERICAL": 1,
"FRESHNESS": 2,
}
)Enum value maps for DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name, DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value
var (
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_name = map[int32]string{
0: "INTERPOLATION_TYPE_UNSPECIFIED",
1: "LINEAR",
}
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType_value = map[string]int32{
"INTERPOLATION_TYPE_UNSPECIFIED": 0,
"LINEAR": 1,
}
)Enum value maps for DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.
DataStoreTool_ModalityConfig_ModalityType_name, DataStoreTool_ModalityConfig_ModalityType_value
var (
DataStoreTool_ModalityConfig_ModalityType_name = map[int32]string{
0: "MODALITY_TYPE_UNSPECIFIED",
1: "TEXT",
2: "AUDIO",
}
DataStoreTool_ModalityConfig_ModalityType_value = map[string]int32{
"MODALITY_TYPE_UNSPECIFIED": 0,
"TEXT": 1,
"AUDIO": 2,
}
)Enum value maps for DataStoreTool_ModalityConfig_ModalityType.
FileSearchTool_CorpusType_name, FileSearchTool_CorpusType_value
var (
FileSearchTool_CorpusType_name = map[int32]string{
0: "CORPUS_TYPE_UNSPECIFIED",
1: "USER_OWNED",
2: "FULLY_MANAGED",
}
FileSearchTool_CorpusType_value = map[string]int32{
"CORPUS_TYPE_UNSPECIFIED": 0,
"USER_OWNED": 1,
"FULLY_MANAGED": 2,
}
)Enum value maps for FileSearchTool_CorpusType.
Guardrail_ContentFilter_MatchType_name, Guardrail_ContentFilter_MatchType_value
var (
Guardrail_ContentFilter_MatchType_name = map[int32]string{
0: "MATCH_TYPE_UNSPECIFIED",
1: "SIMPLE_STRING_MATCH",
2: "WORD_BOUNDARY_STRING_MATCH",
3: "REGEXP_MATCH",
}
Guardrail_ContentFilter_MatchType_value = map[string]int32{
"MATCH_TYPE_UNSPECIFIED": 0,
"SIMPLE_STRING_MATCH": 1,
"WORD_BOUNDARY_STRING_MATCH": 2,
"REGEXP_MATCH": 3,
}
)Enum value maps for Guardrail_ContentFilter_MatchType.
Guardrail_LlmPolicy_PolicyScope_name, Guardrail_LlmPolicy_PolicyScope_value
var (
Guardrail_LlmPolicy_PolicyScope_name = map[int32]string{
0: "POLICY_SCOPE_UNSPECIFIED",
1: "USER_QUERY",
2: "AGENT_RESPONSE",
3: "USER_QUERY_AND_AGENT_RESPONSE",
}
Guardrail_LlmPolicy_PolicyScope_value = map[string]int32{
"POLICY_SCOPE_UNSPECIFIED": 0,
"USER_QUERY": 1,
"AGENT_RESPONSE": 2,
"USER_QUERY_AND_AGENT_RESPONSE": 3,
}
)Enum value maps for Guardrail_LlmPolicy_PolicyScope.
Guardrail_ModelSafety_HarmCategory_name, Guardrail_ModelSafety_HarmCategory_value
var (
Guardrail_ModelSafety_HarmCategory_name = map[int32]string{
0: "HARM_CATEGORY_UNSPECIFIED",
1: "HARM_CATEGORY_HATE_SPEECH",
2: "HARM_CATEGORY_DANGEROUS_CONTENT",
3: "HARM_CATEGORY_HARASSMENT",
4: "HARM_CATEGORY_SEXUALLY_EXPLICIT",
}
Guardrail_ModelSafety_HarmCategory_value = map[string]int32{
"HARM_CATEGORY_UNSPECIFIED": 0,
"HARM_CATEGORY_HATE_SPEECH": 1,
"HARM_CATEGORY_DANGEROUS_CONTENT": 2,
"HARM_CATEGORY_HARASSMENT": 3,
"HARM_CATEGORY_SEXUALLY_EXPLICIT": 4,
}
)Enum value maps for Guardrail_ModelSafety_HarmCategory.
Guardrail_ModelSafety_HarmBlockThreshold_name, Guardrail_ModelSafety_HarmBlockThreshold_value
var (
Guardrail_ModelSafety_HarmBlockThreshold_name = map[int32]string{
0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
1: "BLOCK_LOW_AND_ABOVE",
2: "BLOCK_MEDIUM_AND_ABOVE",
3: "BLOCK_ONLY_HIGH",
4: "BLOCK_NONE",
5: "OFF",
}
Guardrail_ModelSafety_HarmBlockThreshold_value = map[string]int32{
"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
"BLOCK_LOW_AND_ABOVE": 1,
"BLOCK_MEDIUM_AND_ABOVE": 2,
"BLOCK_ONLY_HIGH": 3,
"BLOCK_NONE": 4,
"OFF": 5,
}
)Enum value maps for Guardrail_ModelSafety_HarmBlockThreshold.
Schema_Type_name, Schema_Type_value
var (
Schema_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "STRING",
2: "INTEGER",
3: "NUMBER",
4: "BOOLEAN",
5: "OBJECT",
6: "ARRAY",
}
Schema_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"STRING": 1,
"INTEGER": 2,
"NUMBER": 3,
"BOOLEAN": 4,
"OBJECT": 5,
"ARRAY": 6,
}
)Enum value maps for Schema_Type.
EndpointControlPolicy_EnforcementScope_name, EndpointControlPolicy_EnforcementScope_value
var (
EndpointControlPolicy_EnforcementScope_name = map[int32]string{
0: "ENFORCEMENT_SCOPE_UNSPECIFIED",
1: "VPCSC_ONLY",
2: "ALWAYS",
}
EndpointControlPolicy_EnforcementScope_value = map[string]int32{
"ENFORCEMENT_SCOPE_UNSPECIFIED": 0,
"VPCSC_ONLY": 1,
"ALWAYS": 2,
}
)Enum value maps for EndpointControlPolicy_EnforcementScope.
AudioEncoding_name, AudioEncoding_value
var (
AudioEncoding_name = map[int32]string{
0: "AUDIO_ENCODING_UNSPECIFIED",
1: "LINEAR16",
2: "MULAW",
3: "ALAW",
}
AudioEncoding_value = map[string]int32{
"AUDIO_ENCODING_UNSPECIFIED": 0,
"LINEAR16": 1,
"MULAW": 2,
"ALAW": 3,
}
)Enum value maps for AudioEncoding.
WidgetTool_WidgetType_name, WidgetTool_WidgetType_value
var (
WidgetTool_WidgetType_name = map[int32]string{
0: "WIDGET_TYPE_UNSPECIFIED",
1: "CUSTOM",
2: "PRODUCT_CAROUSEL",
3: "PRODUCT_DETAILS",
4: "QUICK_ACTIONS",
5: "PRODUCT_COMPARISON",
6: "ADVANCED_PRODUCT_DETAILS",
7: "SHORT_FORM",
8: "OVERALL_SATISFACTION",
9: "ORDER_SUMMARY",
10: "APPOINTMENT_DETAILS",
11: "APPOINTMENT_SCHEDULER",
12: "CONTACT_FORM",
}
WidgetTool_WidgetType_value = map[string]int32{
"WIDGET_TYPE_UNSPECIFIED": 0,
"CUSTOM": 1,
"PRODUCT_CAROUSEL": 2,
"PRODUCT_DETAILS": 3,
"QUICK_ACTIONS": 4,
"PRODUCT_COMPARISON": 5,
"ADVANCED_PRODUCT_DETAILS": 6,
"SHORT_FORM": 7,
"OVERALL_SATISFACTION": 8,
"ORDER_SUMMARY": 9,
"APPOINTMENT_DETAILS": 10,
"APPOINTMENT_SCHEDULER": 11,
"CONTACT_FORM": 12,
}
)Enum value maps for WidgetTool_WidgetType.
WidgetTool_DataMapping_Mode_name, WidgetTool_DataMapping_Mode_value
var (
WidgetTool_DataMapping_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "FIELD_MAPPING",
2: "PYTHON_SCRIPT",
}
WidgetTool_DataMapping_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"FIELD_MAPPING": 1,
"PYTHON_SCRIPT": 2,
}
)Enum value maps for WidgetTool_DataMapping_Mode.
AgentService_ServiceDesc
var AgentService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.ces.v1.AgentService",
HandlerType: (*AgentServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListApps",
Handler: _AgentService_ListApps_Handler,
},
{
MethodName: "GetApp",
Handler: _AgentService_GetApp_Handler,
},
{
MethodName: "CreateApp",
Handler: _AgentService_CreateApp_Handler,
},
{
MethodName: "UpdateApp",
Handler: _AgentService_UpdateApp_Handler,
},
{
MethodName: "DeleteApp",
Handler: _AgentService_DeleteApp_Handler,
},
{
MethodName: "ExportApp",
Handler: _AgentService_ExportApp_Handler,
},
{
MethodName: "ImportApp",
Handler: _AgentService_ImportApp_Handler,
},
{
MethodName: "ListAgents",
Handler: _AgentService_ListAgents_Handler,
},
{
MethodName: "GetAgent",
Handler: _AgentService_GetAgent_Handler,
},
{
MethodName: "CreateAgent",
Handler: _AgentService_CreateAgent_Handler,
},
{
MethodName: "UpdateAgent",
Handler: _AgentService_UpdateAgent_Handler,
},
{
MethodName: "DeleteAgent",
Handler: _AgentService_DeleteAgent_Handler,
},
{
MethodName: "ListExamples",
Handler: _AgentService_ListExamples_Handler,
},
{
MethodName: "GetExample",
Handler: _AgentService_GetExample_Handler,
},
{
MethodName: "CreateExample",
Handler: _AgentService_CreateExample_Handler,
},
{
MethodName: "UpdateExample",
Handler: _AgentService_UpdateExample_Handler,
},
{
MethodName: "DeleteExample",
Handler: _AgentService_DeleteExample_Handler,
},
{
MethodName: "ListTools",
Handler: _AgentService_ListTools_Handler,
},
{
MethodName: "GetTool",
Handler: _AgentService_GetTool_Handler,
},
{
MethodName: "ListConversations",
Handler: _AgentService_ListConversations_Handler,
},
{
MethodName: "GetConversation",
Handler: _AgentService_GetConversation_Handler,
},
{
MethodName: "DeleteConversation",
Handler: _AgentService_DeleteConversation_Handler,
},
{
MethodName: "BatchDeleteConversations",
Handler: _AgentService_BatchDeleteConversations_Handler,
},
{
MethodName: "CreateTool",
Handler: _AgentService_CreateTool_Handler,
},
{
MethodName: "UpdateTool",
Handler: _AgentService_UpdateTool_Handler,
},
{
MethodName: "DeleteTool",
Handler: _AgentService_DeleteTool_Handler,
},
{
MethodName: "ListGuardrails",
Handler: _AgentService_ListGuardrails_Handler,
},
{
MethodName: "GetGuardrail",
Handler: _AgentService_GetGuardrail_Handler,
},
{
MethodName: "CreateGuardrail",
Handler: _AgentService_CreateGuardrail_Handler,
},
{
MethodName: "UpdateGuardrail",
Handler: _AgentService_UpdateGuardrail_Handler,
},
{
MethodName: "DeleteGuardrail",
Handler: _AgentService_DeleteGuardrail_Handler,
},
{
MethodName: "ListDeployments",
Handler: _AgentService_ListDeployments_Handler,
},
{
MethodName: "GetDeployment",
Handler: _AgentService_GetDeployment_Handler,
},
{
MethodName: "CreateDeployment",
Handler: _AgentService_CreateDeployment_Handler,
},
{
MethodName: "UpdateDeployment",
Handler: _AgentService_UpdateDeployment_Handler,
},
{
MethodName: "DeleteDeployment",
Handler: _AgentService_DeleteDeployment_Handler,
},
{
MethodName: "ListToolsets",
Handler: _AgentService_ListToolsets_Handler,
},
{
MethodName: "GetToolset",
Handler: _AgentService_GetToolset_Handler,
},
{
MethodName: "CreateToolset",
Handler: _AgentService_CreateToolset_Handler,
},
{
MethodName: "UpdateToolset",
Handler: _AgentService_UpdateToolset_Handler,
},
{
MethodName: "DeleteToolset",
Handler: _AgentService_DeleteToolset_Handler,
},
{
MethodName: "ListAppVersions",
Handler: _AgentService_ListAppVersions_Handler,
},
{
MethodName: "GetAppVersion",
Handler: _AgentService_GetAppVersion_Handler,
},
{
MethodName: "CreateAppVersion",
Handler: _AgentService_CreateAppVersion_Handler,
},
{
MethodName: "DeleteAppVersion",
Handler: _AgentService_DeleteAppVersion_Handler,
},
{
MethodName: "RestoreAppVersion",
Handler: _AgentService_RestoreAppVersion_Handler,
},
{
MethodName: "ListChangelogs",
Handler: _AgentService_ListChangelogs_Handler,
},
{
MethodName: "GetChangelog",
Handler: _AgentService_GetChangelog_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/ces/v1/agent_service.proto",
}AgentService_ServiceDesc is the grpc.ServiceDesc for AgentService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_ces_v1_agent_proto
var File_google_cloud_ces_v1_agent_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_agent_service_proto
var File_google_cloud_ces_v1_agent_service_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_agent_tool_proto
var File_google_cloud_ces_v1_agent_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_agent_transfers_proto
var File_google_cloud_ces_v1_agent_transfers_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_app_proto
var File_google_cloud_ces_v1_app_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_app_version_proto
var File_google_cloud_ces_v1_app_version_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_auth_proto
var File_google_cloud_ces_v1_auth_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_bigquery_export_proto
var File_google_cloud_ces_v1_bigquery_export_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_changelog_proto
var File_google_cloud_ces_v1_changelog_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_client_function_proto
var File_google_cloud_ces_v1_client_function_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_common_proto
var File_google_cloud_ces_v1_common_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_connector_tool_proto
var File_google_cloud_ces_v1_connector_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_connector_toolset_proto
var File_google_cloud_ces_v1_connector_toolset_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_conversation_proto
var File_google_cloud_ces_v1_conversation_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_data_store_proto
var File_google_cloud_ces_v1_data_store_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_data_store_tool_proto
var File_google_cloud_ces_v1_data_store_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_deployment_proto
var File_google_cloud_ces_v1_deployment_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_example_proto
var File_google_cloud_ces_v1_example_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_fakes_proto
var File_google_cloud_ces_v1_fakes_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_file_search_tool_proto
var File_google_cloud_ces_v1_file_search_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_google_search_tool_proto
var File_google_cloud_ces_v1_google_search_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_guardrail_proto
var File_google_cloud_ces_v1_guardrail_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_mcp_tool_proto
var File_google_cloud_ces_v1_mcp_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_mcp_toolset_proto
var File_google_cloud_ces_v1_mcp_toolset_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_omnichannel_proto
var File_google_cloud_ces_v1_omnichannel_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_omnichannel_service_proto
var File_google_cloud_ces_v1_omnichannel_service_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_open_api_tool_proto
var File_google_cloud_ces_v1_open_api_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_open_api_toolset_proto
var File_google_cloud_ces_v1_open_api_toolset_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_python_function_proto
var File_google_cloud_ces_v1_python_function_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_schema_proto
var File_google_cloud_ces_v1_schema_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_search_suggestions_proto
var File_google_cloud_ces_v1_search_suggestions_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_security_settings_proto
var File_google_cloud_ces_v1_security_settings_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_session_service_proto
var File_google_cloud_ces_v1_session_service_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_system_tool_proto
var File_google_cloud_ces_v1_system_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_tool_proto
var File_google_cloud_ces_v1_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_tool_service_proto
var File_google_cloud_ces_v1_tool_service_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_toolset_proto
var File_google_cloud_ces_v1_toolset_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_toolset_tool_proto
var File_google_cloud_ces_v1_toolset_tool_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_widget_service_proto
var File_google_cloud_ces_v1_widget_service_proto protoreflect.FileDescriptorFile_google_cloud_ces_v1_widget_tool_proto
var File_google_cloud_ces_v1_widget_tool_proto protoreflect.FileDescriptorSessionService_ServiceDesc
var SessionService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.ces.v1.SessionService",
HandlerType: (*SessionServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "RunSession",
Handler: _SessionService_RunSession_Handler,
},
},
Streams: []grpc.StreamDesc{
{
StreamName: "StreamRunSession",
Handler: _SessionService_StreamRunSession_Handler,
ServerStreams: true,
},
{
StreamName: "BidiRunSession",
Handler: _SessionService_BidiRunSession_Handler,
ServerStreams: true,
ClientStreams: true,
},
},
Metadata: "google/cloud/ces/v1/session_service.proto",
}SessionService_ServiceDesc is the grpc.ServiceDesc for SessionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
ToolService_ServiceDesc
var ToolService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.ces.v1.ToolService",
HandlerType: (*ToolServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ExecuteTool",
Handler: _ToolService_ExecuteTool_Handler,
},
{
MethodName: "RetrieveToolSchema",
Handler: _ToolService_RetrieveToolSchema_Handler,
},
{
MethodName: "RetrieveTools",
Handler: _ToolService_RetrieveTools_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/ces/v1/tool_service.proto",
}ToolService_ServiceDesc is the grpc.ServiceDesc for ToolService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
WidgetService_ServiceDesc
var WidgetService_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.ces.v1.WidgetService",
HandlerType: (*WidgetServiceServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "GenerateChatToken",
Handler: _WidgetService_GenerateChatToken_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/ces/v1/widget_service.proto",
}WidgetService_ServiceDesc is the grpc.ServiceDesc for WidgetService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterAgentServiceServer
func RegisterAgentServiceServer(s grpc.ServiceRegistrar, srv AgentServiceServer)func RegisterSessionServiceServer
func RegisterSessionServiceServer(s grpc.ServiceRegistrar, srv SessionServiceServer)func RegisterToolServiceServer
func RegisterToolServiceServer(s grpc.ServiceRegistrar, srv ToolServiceServer)func RegisterWidgetServiceServer
func RegisterWidgetServiceServer(s grpc.ServiceRegistrar, srv WidgetServiceServer)Action
type Action struct {
// Specification for an action to configure for the tool to use.
//
// Types that are valid to be assigned to ActionSpec:
//
// *Action_ConnectionActionId
// *Action_EntityOperation_
ActionSpec isAction_ActionSpec `protobuf_oneof:"action_spec"`
// Optional. Entity fields to use as inputs for the operation.
// If no fields are specified, all fields of the Entity will be used.
InputFields []string `protobuf:"bytes,2,rep,name=input_fields,json=inputFields,proto3" json:"input_fields,omitempty"`
// Optional. Entity fields to return from the operation.
// If no fields are specified, all fields of the Entity will be returned.
OutputFields []string `protobuf:"bytes,3,rep,name=output_fields,json=outputFields,proto3" json:"output_fields,omitempty"`
// contains filtered or unexported fields
}Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
func (*Action) Descriptor
Deprecated: Use Action.ProtoReflect.Descriptor instead.
func (*Action) GetActionSpec
func (x *Action) GetActionSpec() isAction_ActionSpecfunc (*Action) GetConnectionActionId
func (*Action) GetEntityOperation
func (x *Action) GetEntityOperation() *Action_EntityOperationfunc (*Action) GetInputFields
func (*Action) GetOutputFields
func (*Action) ProtoMessage
func (*Action) ProtoMessage()func (*Action) ProtoReflect
func (x *Action) ProtoReflect() protoreflect.Messagefunc (*Action) Reset
func (x *Action) Reset()func (*Action) String
Action_ConnectionActionId
type Action_ConnectionActionId struct {
// ID of a Connection action for the tool to use.
ConnectionActionId string `protobuf:"bytes,4,opt,name=connection_action_id,json=connectionActionId,proto3,oneof"`
}Action_EntityOperation
type Action_EntityOperation struct {
// Required. ID of the entity.
EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
// Required. Operation to perform on the entity.
Operation Action_EntityOperation_OperationType `protobuf:"varint,2,opt,name=operation,proto3,enum=google.cloud.ces.v1.Action_EntityOperation_OperationType" json:"operation,omitempty"`
// contains filtered or unexported fields
}Entity CRUD operation specification.
func (*Action_EntityOperation) Descriptor
func (*Action_EntityOperation) Descriptor() ([]byte, []int)Deprecated: Use Action_EntityOperation.ProtoReflect.Descriptor instead.
func (*Action_EntityOperation) GetEntityId
func (x *Action_EntityOperation) GetEntityId() stringfunc (*Action_EntityOperation) GetOperation
func (x *Action_EntityOperation) GetOperation() Action_EntityOperation_OperationTypefunc (*Action_EntityOperation) ProtoMessage
func (*Action_EntityOperation) ProtoMessage()func (*Action_EntityOperation) ProtoReflect
func (x *Action_EntityOperation) ProtoReflect() protoreflect.Messagefunc (*Action_EntityOperation) Reset
func (x *Action_EntityOperation) Reset()func (*Action_EntityOperation) String
func (x *Action_EntityOperation) String() stringAction_EntityOperation_
type Action_EntityOperation_ struct {
// Entity operation configuration for the tool to use.
EntityOperation *Action_EntityOperation `protobuf:"bytes,5,opt,name=entity_operation,json=entityOperation,proto3,oneof"`
}Action_EntityOperation_OperationType
type Action_EntityOperation_OperationType int32The operation to perform on the entity.
Action_EntityOperation_OPERATION_TYPE_UNSPECIFIED, Action_EntityOperation_LIST, Action_EntityOperation_GET, Action_EntityOperation_CREATE, Action_EntityOperation_UPDATE, Action_EntityOperation_DELETE
const (
// Operation type unspecified. Invalid, ConnectorTool create/update
// will fail.
Action_EntityOperation_OPERATION_TYPE_UNSPECIFIED Action_EntityOperation_OperationType = 0
// List operation.
Action_EntityOperation_LIST Action_EntityOperation_OperationType = 1
// Get operation.
Action_EntityOperation_GET Action_EntityOperation_OperationType = 2
// Create operation.
Action_EntityOperation_CREATE Action_EntityOperation_OperationType = 3
// Update operation.
Action_EntityOperation_UPDATE Action_EntityOperation_OperationType = 4
// Delete operation.
Action_EntityOperation_DELETE Action_EntityOperation_OperationType = 5
)func (Action_EntityOperation_OperationType) Descriptor
func (Action_EntityOperation_OperationType) Descriptor() protoreflect.EnumDescriptorfunc (Action_EntityOperation_OperationType) Enum
func (x Action_EntityOperation_OperationType) Enum() *Action_EntityOperation_OperationTypefunc (Action_EntityOperation_OperationType) EnumDescriptor
func (Action_EntityOperation_OperationType) EnumDescriptor() ([]byte, []int)Deprecated: Use Action_EntityOperation_OperationType.Descriptor instead.
func (Action_EntityOperation_OperationType) Number
func (x Action_EntityOperation_OperationType) Number() protoreflect.EnumNumberfunc (Action_EntityOperation_OperationType) String
func (x Action_EntityOperation_OperationType) String() stringfunc (Action_EntityOperation_OperationType) Type
func (Action_EntityOperation_OperationType) Type() protoreflect.EnumTypeAgent
type Agent struct {
// The type of agent.
//
// Types that are valid to be assigned to AgentType:
//
// *Agent_LlmAgent_
// *Agent_RemoteDialogflowAgent_
AgentType isAgent_AgentType `protobuf_oneof:"agent_type"`
// Identifier. The unique identifier of the agent.
// Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the agent.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Human-readable description of the agent.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Configurations for the LLM model.
ModelSettings *ModelSettings `protobuf:"bytes,4,opt,name=model_settings,json=modelSettings,proto3" json:"model_settings,omitempty"`
// Optional. Instructions for the LLM model to guide the agent's behavior.
Instruction string `protobuf:"bytes,6,opt,name=instruction,proto3" json:"instruction,omitempty"`
// Optional. List of available tools for the agent.
// Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
Tools []string `protobuf:"bytes,7,rep,name=tools,proto3" json:"tools,omitempty"`
// Optional. List of child agents in the agent tree.
// Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
ChildAgents []string `protobuf:"bytes,8,rep,name=child_agents,json=childAgents,proto3" json:"child_agents,omitempty"`
// Optional. The callbacks to execute before the agent is called.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
BeforeAgentCallbacks []*Callback `protobuf:"bytes,18,rep,name=before_agent_callbacks,json=beforeAgentCallbacks,proto3" json:"before_agent_callbacks,omitempty"`
// Optional. The callbacks to execute after the agent is called.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
AfterAgentCallbacks []*Callback `protobuf:"bytes,19,rep,name=after_agent_callbacks,json=afterAgentCallbacks,proto3" json:"after_agent_callbacks,omitempty"`
// Optional. The callbacks to execute before the model is called. If there are
// multiple calls to the model, the callback will be executed multiple times.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
BeforeModelCallbacks []*Callback `protobuf:"bytes,20,rep,name=before_model_callbacks,json=beforeModelCallbacks,proto3" json:"before_model_callbacks,omitempty"`
// Optional. The callbacks to execute after the model is called. If there are
// multiple calls to the model, the callback will be executed multiple times.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
AfterModelCallbacks []*Callback `protobuf:"bytes,21,rep,name=after_model_callbacks,json=afterModelCallbacks,proto3" json:"after_model_callbacks,omitempty"`
// Optional. The callbacks to execute before the tool is invoked. If there are
// multiple tool invocations, the callback will be executed multiple times.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
BeforeToolCallbacks []*Callback `protobuf:"bytes,22,rep,name=before_tool_callbacks,json=beforeToolCallbacks,proto3" json:"before_tool_callbacks,omitempty"`
// Optional. The callbacks to execute after the tool is invoked. If there are
// multiple tool invocations, the callback will be executed multiple times.
// The provided callbacks are executed sequentially in the exact order they
// are given in the list. If a callback returns an overridden response,
// execution stops and any remaining callbacks are skipped.
AfterToolCallbacks []*Callback `protobuf:"bytes,23,rep,name=after_tool_callbacks,json=afterToolCallbacks,proto3" json:"after_tool_callbacks,omitempty"`
// Output only. Timestamp when the agent was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the agent was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Optional. List of guardrails for the agent.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
Guardrails []string `protobuf:"bytes,17,rep,name=guardrails,proto3" json:"guardrails,omitempty"`
// Etag used to ensure the object hasn't changed during a read-modify-write
// operation. If the etag is empty, the update will overwrite any concurrent
// changes.
Etag string `protobuf:"bytes,24,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. List of toolsets for the agent.
Toolsets []*Agent_AgentToolset `protobuf:"bytes,28,rep,name=toolsets,proto3" json:"toolsets,omitempty"`
// Output only. If the agent is generated by the LLM assistant, this field
// contains a descriptive summary of the generation.
GeneratedSummary string `protobuf:"bytes,29,opt,name=generated_summary,json=generatedSummary,proto3" json:"generated_summary,omitempty"`
// Optional. Agent transfer rules.
// If multiple rules match, the first one in the list will be used.
TransferRules []*TransferRule `protobuf:"bytes,30,rep,name=transfer_rules,json=transferRules,proto3" json:"transfer_rules,omitempty"`
// contains filtered or unexported fields
}An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.
func (*Agent) Descriptor
Deprecated: Use Agent.ProtoReflect.Descriptor instead.
func (*Agent) GetAfterAgentCallbacks
func (*Agent) GetAfterModelCallbacks
func (*Agent) GetAfterToolCallbacks
func (*Agent) GetAgentType
func (x *Agent) GetAgentType() isAgent_AgentTypefunc (*Agent) GetBeforeAgentCallbacks
func (*Agent) GetBeforeModelCallbacks
func (*Agent) GetBeforeToolCallbacks
func (*Agent) GetChildAgents
func (*Agent) GetCreateTime
func (x *Agent) GetCreateTime() *timestamppb.Timestampfunc (*Agent) GetDescription
func (*Agent) GetDisplayName
func (*Agent) GetEtag
func (*Agent) GetGeneratedSummary
func (*Agent) GetGuardrails
func (*Agent) GetInstruction
func (*Agent) GetLlmAgent
func (x *Agent) GetLlmAgent() *Agent_LlmAgentfunc (*Agent) GetModelSettings
func (x *Agent) GetModelSettings() *ModelSettingsfunc (*Agent) GetName
func (*Agent) GetRemoteDialogflowAgent
func (x *Agent) GetRemoteDialogflowAgent() *Agent_RemoteDialogflowAgentfunc (*Agent) GetTools
func (*Agent) GetToolsets
func (x *Agent) GetToolsets() []*Agent_AgentToolsetfunc (*Agent) GetTransferRules
func (x *Agent) GetTransferRules() []*TransferRulefunc (*Agent) GetUpdateTime
func (x *Agent) GetUpdateTime() *timestamppb.Timestampfunc (*Agent) ProtoMessage
func (*Agent) ProtoMessage()func (*Agent) ProtoReflect
func (x *Agent) ProtoReflect() protoreflect.Messagefunc (*Agent) Reset
func (x *Agent) Reset()func (*Agent) String
AgentServiceClient
type AgentServiceClient interface {
// Lists apps in the given project and location.
ListApps(ctx context.Context, in *ListAppsRequest, opts ...grpc.CallOption) (*ListAppsResponse, error)
// Gets details of the specified app.
GetApp(ctx context.Context, in *GetAppRequest, opts ...grpc.CallOption) (*App, error)
// Creates a new app in the given project and location.
CreateApp(ctx context.Context, in *CreateAppRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the specified app.
UpdateApp(ctx context.Context, in *UpdateAppRequest, opts ...grpc.CallOption) (*App, error)
// Deletes the specified app.
DeleteApp(ctx context.Context, in *DeleteAppRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Exports the specified app.
ExportApp(ctx context.Context, in *ExportAppRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Imports the specified app.
ImportApp(ctx context.Context, in *ImportAppRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists agents in the given app.
ListAgents(ctx context.Context, in *ListAgentsRequest, opts ...grpc.CallOption) (*ListAgentsResponse, error)
// Gets details of the specified agent.
GetAgent(ctx context.Context, in *GetAgentRequest, opts ...grpc.CallOption) (*Agent, error)
// Creates a new agent in the given app.
CreateAgent(ctx context.Context, in *CreateAgentRequest, opts ...grpc.CallOption) (*Agent, error)
// Updates the specified agent.
UpdateAgent(ctx context.Context, in *UpdateAgentRequest, opts ...grpc.CallOption) (*Agent, error)
// Deletes the specified agent.
DeleteAgent(ctx context.Context, in *DeleteAgentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists examples in the given app.
ListExamples(ctx context.Context, in *ListExamplesRequest, opts ...grpc.CallOption) (*ListExamplesResponse, error)
// Gets details of the specified example.
GetExample(ctx context.Context, in *GetExampleRequest, opts ...grpc.CallOption) (*Example, error)
// Creates a new example in the given app.
CreateExample(ctx context.Context, in *CreateExampleRequest, opts ...grpc.CallOption) (*Example, error)
// Updates the specified example.
UpdateExample(ctx context.Context, in *UpdateExampleRequest, opts ...grpc.CallOption) (*Example, error)
// Deletes the specified example.
DeleteExample(ctx context.Context, in *DeleteExampleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists tools in the given app.
ListTools(ctx context.Context, in *ListToolsRequest, opts ...grpc.CallOption) (*ListToolsResponse, error)
// Gets details of the specified tool.
GetTool(ctx context.Context, in *GetToolRequest, opts ...grpc.CallOption) (*Tool, error)
// Lists conversations in the given app.
ListConversations(ctx context.Context, in *ListConversationsRequest, opts ...grpc.CallOption) (*ListConversationsResponse, error)
// Gets details of the specified conversation.
GetConversation(ctx context.Context, in *GetConversationRequest, opts ...grpc.CallOption) (*Conversation, error)
// Deletes the specified conversation.
DeleteConversation(ctx context.Context, in *DeleteConversationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Batch deletes the specified conversations.
BatchDeleteConversations(ctx context.Context, in *BatchDeleteConversationsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a new tool in the given app.
CreateTool(ctx context.Context, in *CreateToolRequest, opts ...grpc.CallOption) (*Tool, error)
// Updates the specified tool.
UpdateTool(ctx context.Context, in *UpdateToolRequest, opts ...grpc.CallOption) (*Tool, error)
// Deletes the specified tool.
DeleteTool(ctx context.Context, in *DeleteToolRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists guardrails in the given app.
ListGuardrails(ctx context.Context, in *ListGuardrailsRequest, opts ...grpc.CallOption) (*ListGuardrailsResponse, error)
// Gets details of the specified guardrail.
GetGuardrail(ctx context.Context, in *GetGuardrailRequest, opts ...grpc.CallOption) (*Guardrail, error)
// Creates a new guardrail in the given app.
CreateGuardrail(ctx context.Context, in *CreateGuardrailRequest, opts ...grpc.CallOption) (*Guardrail, error)
// Updates the specified guardrail.
UpdateGuardrail(ctx context.Context, in *UpdateGuardrailRequest, opts ...grpc.CallOption) (*Guardrail, error)
// Deletes the specified guardrail.
DeleteGuardrail(ctx context.Context, in *DeleteGuardrailRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists deployments in the given app.
ListDeployments(ctx context.Context, in *ListDeploymentsRequest, opts ...grpc.CallOption) (*ListDeploymentsResponse, error)
// Gets details of the specified deployment.
GetDeployment(ctx context.Context, in *GetDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// Creates a new deployment in the given app.
CreateDeployment(ctx context.Context, in *CreateDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// Updates the specified deployment.
UpdateDeployment(ctx context.Context, in *UpdateDeploymentRequest, opts ...grpc.CallOption) (*Deployment, error)
// Deletes the specified deployment.
DeleteDeployment(ctx context.Context, in *DeleteDeploymentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists toolsets in the given app.
ListToolsets(ctx context.Context, in *ListToolsetsRequest, opts ...grpc.CallOption) (*ListToolsetsResponse, error)
// Gets details of the specified toolset.
GetToolset(ctx context.Context, in *GetToolsetRequest, opts ...grpc.CallOption) (*Toolset, error)
// Creates a new toolset in the given app.
CreateToolset(ctx context.Context, in *CreateToolsetRequest, opts ...grpc.CallOption) (*Toolset, error)
// Updates the specified toolset.
UpdateToolset(ctx context.Context, in *UpdateToolsetRequest, opts ...grpc.CallOption) (*Toolset, error)
// Deletes the specified toolset.
DeleteToolset(ctx context.Context, in *DeleteToolsetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists all app versions in the given app.
ListAppVersions(ctx context.Context, in *ListAppVersionsRequest, opts ...grpc.CallOption) (*ListAppVersionsResponse, error)
// Gets details of the specified app version.
GetAppVersion(ctx context.Context, in *GetAppVersionRequest, opts ...grpc.CallOption) (*AppVersion, error)
// Creates a new app version in the given app.
CreateAppVersion(ctx context.Context, in *CreateAppVersionRequest, opts ...grpc.CallOption) (*AppVersion, error)
// Deletes the specified app version.
DeleteAppVersion(ctx context.Context, in *DeleteAppVersionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Restores the specified app version.
// This will create a new app version from the current draft app and overwrite
// the current draft with the specified app version.
RestoreAppVersion(ctx context.Context, in *RestoreAppVersionRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists the changelogs of the specified app.
ListChangelogs(ctx context.Context, in *ListChangelogsRequest, opts ...grpc.CallOption) (*ListChangelogsResponse, error)
// Gets the specified changelog.
GetChangelog(ctx context.Context, in *GetChangelogRequest, opts ...grpc.CallOption) (*Changelog, error)
}AgentServiceClient is the client API for AgentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewAgentServiceClient
func NewAgentServiceClient(cc grpc.ClientConnInterface) AgentServiceClientAgentServiceServer
type AgentServiceServer interface {
// Lists apps in the given project and location.
ListApps(context.Context, *ListAppsRequest) (*ListAppsResponse, error)
// Gets details of the specified app.
GetApp(context.Context, *GetAppRequest) (*App, error)
// Creates a new app in the given project and location.
CreateApp(context.Context, *CreateAppRequest) (*longrunningpb.Operation, error)
// Updates the specified app.
UpdateApp(context.Context, *UpdateAppRequest) (*App, error)
// Deletes the specified app.
DeleteApp(context.Context, *DeleteAppRequest) (*longrunningpb.Operation, error)
// Exports the specified app.
ExportApp(context.Context, *ExportAppRequest) (*longrunningpb.Operation, error)
// Imports the specified app.
ImportApp(context.Context, *ImportAppRequest) (*longrunningpb.Operation, error)
// Lists agents in the given app.
ListAgents(context.Context, *ListAgentsRequest) (*ListAgentsResponse, error)
// Gets details of the specified agent.
GetAgent(context.Context, *GetAgentRequest) (*Agent, error)
// Creates a new agent in the given app.
CreateAgent(context.Context, *CreateAgentRequest) (*Agent, error)
// Updates the specified agent.
UpdateAgent(context.Context, *UpdateAgentRequest) (*Agent, error)
// Deletes the specified agent.
DeleteAgent(context.Context, *DeleteAgentRequest) (*emptypb.Empty, error)
// Lists examples in the given app.
ListExamples(context.Context, *ListExamplesRequest) (*ListExamplesResponse, error)
// Gets details of the specified example.
GetExample(context.Context, *GetExampleRequest) (*Example, error)
// Creates a new example in the given app.
CreateExample(context.Context, *CreateExampleRequest) (*Example, error)
// Updates the specified example.
UpdateExample(context.Context, *UpdateExampleRequest) (*Example, error)
// Deletes the specified example.
DeleteExample(context.Context, *DeleteExampleRequest) (*emptypb.Empty, error)
// Lists tools in the given app.
ListTools(context.Context, *ListToolsRequest) (*ListToolsResponse, error)
// Gets details of the specified tool.
GetTool(context.Context, *GetToolRequest) (*Tool, error)
// Lists conversations in the given app.
ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)
// Gets details of the specified conversation.
GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)
// Deletes the specified conversation.
DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)
// Batch deletes the specified conversations.
BatchDeleteConversations(context.Context, *BatchDeleteConversationsRequest) (*longrunningpb.Operation, error)
// Creates a new tool in the given app.
CreateTool(context.Context, *CreateToolRequest) (*Tool, error)
// Updates the specified tool.
UpdateTool(context.Context, *UpdateToolRequest) (*Tool, error)
// Deletes the specified tool.
DeleteTool(context.Context, *DeleteToolRequest) (*emptypb.Empty, error)
// Lists guardrails in the given app.
ListGuardrails(context.Context, *ListGuardrailsRequest) (*ListGuardrailsResponse, error)
// Gets details of the specified guardrail.
GetGuardrail(context.Context, *GetGuardrailRequest) (*Guardrail, error)
// Creates a new guardrail in the given app.
CreateGuardrail(context.Context, *CreateGuardrailRequest) (*Guardrail, error)
// Updates the specified guardrail.
UpdateGuardrail(context.Context, *UpdateGuardrailRequest) (*Guardrail, error)
// Deletes the specified guardrail.
DeleteGuardrail(context.Context, *DeleteGuardrailRequest) (*emptypb.Empty, error)
// Lists deployments in the given app.
ListDeployments(context.Context, *ListDeploymentsRequest) (*ListDeploymentsResponse, error)
// Gets details of the specified deployment.
GetDeployment(context.Context, *GetDeploymentRequest) (*Deployment, error)
// Creates a new deployment in the given app.
CreateDeployment(context.Context, *CreateDeploymentRequest) (*Deployment, error)
// Updates the specified deployment.
UpdateDeployment(context.Context, *UpdateDeploymentRequest) (*Deployment, error)
// Deletes the specified deployment.
DeleteDeployment(context.Context, *DeleteDeploymentRequest) (*emptypb.Empty, error)
// Lists toolsets in the given app.
ListToolsets(context.Context, *ListToolsetsRequest) (*ListToolsetsResponse, error)
// Gets details of the specified toolset.
GetToolset(context.Context, *GetToolsetRequest) (*Toolset, error)
// Creates a new toolset in the given app.
CreateToolset(context.Context, *CreateToolsetRequest) (*Toolset, error)
// Updates the specified toolset.
UpdateToolset(context.Context, *UpdateToolsetRequest) (*Toolset, error)
// Deletes the specified toolset.
DeleteToolset(context.Context, *DeleteToolsetRequest) (*emptypb.Empty, error)
// Lists all app versions in the given app.
ListAppVersions(context.Context, *ListAppVersionsRequest) (*ListAppVersionsResponse, error)
// Gets details of the specified app version.
GetAppVersion(context.Context, *GetAppVersionRequest) (*AppVersion, error)
// Creates a new app version in the given app.
CreateAppVersion(context.Context, *CreateAppVersionRequest) (*AppVersion, error)
// Deletes the specified app version.
DeleteAppVersion(context.Context, *DeleteAppVersionRequest) (*emptypb.Empty, error)
// Restores the specified app version.
// This will create a new app version from the current draft app and overwrite
// the current draft with the specified app version.
RestoreAppVersion(context.Context, *RestoreAppVersionRequest) (*longrunningpb.Operation, error)
// Lists the changelogs of the specified app.
ListChangelogs(context.Context, *ListChangelogsRequest) (*ListChangelogsResponse, error)
// Gets the specified changelog.
GetChangelog(context.Context, *GetChangelogRequest) (*Changelog, error)
}AgentServiceServer is the server API for AgentService service. All implementations should embed UnimplementedAgentServiceServer for forward compatibility
AgentTool
type AgentTool struct {
// Required. The name of the agent tool.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Description of the tool's purpose.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The resource name of the root agent that is the entry point of
// the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
RootAgent string `protobuf:"bytes,3,opt,name=root_agent,json=rootAgent,proto3" json:"root_agent,omitempty"`
// contains filtered or unexported fields
}Represents a tool that allows the agent to call another agent.
func (*AgentTool) Descriptor
Deprecated: Use AgentTool.ProtoReflect.Descriptor instead.
func (*AgentTool) GetDescription
func (*AgentTool) GetName
func (*AgentTool) GetRootAgent
func (*AgentTool) ProtoMessage
func (*AgentTool) ProtoMessage()func (*AgentTool) ProtoReflect
func (x *AgentTool) ProtoReflect() protoreflect.Messagefunc (*AgentTool) Reset
func (x *AgentTool) Reset()func (*AgentTool) String
AgentTransfer
type AgentTransfer struct {
// Required. The agent to which the conversation is being transferred. The
// agent will handle the conversation from this point forward. Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
TargetAgent string `protobuf:"bytes,1,opt,name=target_agent,json=targetAgent,proto3" json:"target_agent,omitempty"`
// Output only. Display name of the agent.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// contains filtered or unexported fields
}Represents an event indicating the transfer of a conversation to a different agent.
func (*AgentTransfer) Descriptor
func (*AgentTransfer) Descriptor() ([]byte, []int)Deprecated: Use AgentTransfer.ProtoReflect.Descriptor instead.
func (*AgentTransfer) GetDisplayName
func (x *AgentTransfer) GetDisplayName() stringfunc (*AgentTransfer) GetTargetAgent
func (x *AgentTransfer) GetTargetAgent() stringfunc (*AgentTransfer) ProtoMessage
func (*AgentTransfer) ProtoMessage()func (*AgentTransfer) ProtoReflect
func (x *AgentTransfer) ProtoReflect() protoreflect.Messagefunc (*AgentTransfer) Reset
func (x *AgentTransfer) Reset()func (*AgentTransfer) String
func (x *AgentTransfer) String() stringAgent_AgentToolset
type Agent_AgentToolset struct {
// Required. The resource name of the toolset.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Toolset string `protobuf:"bytes,1,opt,name=toolset,proto3" json:"toolset,omitempty"`
// Optional. The tools IDs to filter the toolset.
ToolIds []string `protobuf:"bytes,4,rep,name=tool_ids,json=toolIds,proto3" json:"tool_ids,omitempty"`
// contains filtered or unexported fields
}A toolset with a selection of its tools.
func (*Agent_AgentToolset) Descriptor
func (*Agent_AgentToolset) Descriptor() ([]byte, []int)Deprecated: Use Agent_AgentToolset.ProtoReflect.Descriptor instead.
func (*Agent_AgentToolset) GetToolIds
func (x *Agent_AgentToolset) GetToolIds() []stringfunc (*Agent_AgentToolset) GetToolset
func (x *Agent_AgentToolset) GetToolset() stringfunc (*Agent_AgentToolset) ProtoMessage
func (*Agent_AgentToolset) ProtoMessage()func (*Agent_AgentToolset) ProtoReflect
func (x *Agent_AgentToolset) ProtoReflect() protoreflect.Messagefunc (*Agent_AgentToolset) Reset
func (x *Agent_AgentToolset) Reset()func (*Agent_AgentToolset) String
func (x *Agent_AgentToolset) String() stringAgent_LlmAgent
type Agent_LlmAgent struct {
// contains filtered or unexported fields
}Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.
func (*Agent_LlmAgent) Descriptor
func (*Agent_LlmAgent) Descriptor() ([]byte, []int)Deprecated: Use Agent_LlmAgent.ProtoReflect.Descriptor instead.
func (*Agent_LlmAgent) ProtoMessage
func (*Agent_LlmAgent) ProtoMessage()func (*Agent_LlmAgent) ProtoReflect
func (x *Agent_LlmAgent) ProtoReflect() protoreflect.Messagefunc (*Agent_LlmAgent) Reset
func (x *Agent_LlmAgent) Reset()func (*Agent_LlmAgent) String
func (x *Agent_LlmAgent) String() stringAgent_LlmAgent_
type Agent_LlmAgent_ struct {
// Optional. The default agent type.
LlmAgent *Agent_LlmAgent `protobuf:"bytes,26,opt,name=llm_agent,json=llmAgent,proto3,oneof"`
}Agent_RemoteDialogflowAgent
type Agent_RemoteDialogflowAgent struct {
// Required. The
// [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent)
// agent resource name.
// Format: `projects/{project}/locations/{location}/agents/{agent}`
Agent string `protobuf:"bytes,1,opt,name=agent,proto3" json:"agent,omitempty"`
// Optional. The flow ID of the flow in the Dialogflow agent.
FlowId string `protobuf:"bytes,2,opt,name=flow_id,json=flowId,proto3" json:"flow_id,omitempty"`
// Optional. The environment ID of the Dialogflow agent to be used for the
// agent execution. If not specified, the draft environment will be used.
EnvironmentId string `protobuf:"bytes,3,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
// Optional. The mapping of the app variables names to the Dialogflow
// session parameters names to be sent to the Dialogflow agent as input.
InputVariableMapping map[string]string `protobuf:"bytes,4,rep,name=input_variable_mapping,json=inputVariableMapping,proto3" json:"input_variable_mapping,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. The mapping of the Dialogflow session parameters names to the
// app variables names to be sent back to the CES agent after the Dialogflow
// agent execution ends.
OutputVariableMapping map[string]string `protobuf:"bytes,5,rep,name=output_variable_mapping,json=outputVariableMapping,proto3" json:"output_variable_mapping,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Indicates whether to respect the message-level interruption
// settings configured in the Dialogflow agent.
//
// * If false: all response messages from the Dialogflow agent follow the
// app-level barge-in settings.
// * If true: only response messages with
// [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text)
// set to true will be interruptable, all other messages follow the
// app-level barge-in settings.
RespectResponseInterruptionSettings bool `protobuf:"varint,6,opt,name=respect_response_interruption_settings,json=respectResponseInterruptionSettings,proto3" json:"respect_response_interruption_settings,omitempty"`
// contains filtered or unexported fields
}The agent which will transfer execution to a remote Dialogflow CX agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.
func (*Agent_RemoteDialogflowAgent) Descriptor
func (*Agent_RemoteDialogflowAgent) Descriptor() ([]byte, []int)Deprecated: Use Agent_RemoteDialogflowAgent.ProtoReflect.Descriptor instead.
func (*Agent_RemoteDialogflowAgent) GetAgent
func (x *Agent_RemoteDialogflowAgent) GetAgent() stringfunc (*Agent_RemoteDialogflowAgent) GetEnvironmentId
func (x *Agent_RemoteDialogflowAgent) GetEnvironmentId() stringfunc (*Agent_RemoteDialogflowAgent) GetFlowId
func (x *Agent_RemoteDialogflowAgent) GetFlowId() stringfunc (*Agent_RemoteDialogflowAgent) GetInputVariableMapping
func (x *Agent_RemoteDialogflowAgent) GetInputVariableMapping() map[string]stringfunc (*Agent_RemoteDialogflowAgent) GetOutputVariableMapping
func (x *Agent_RemoteDialogflowAgent) GetOutputVariableMapping() map[string]stringfunc (*Agent_RemoteDialogflowAgent) GetRespectResponseInterruptionSettings
func (x *Agent_RemoteDialogflowAgent) GetRespectResponseInterruptionSettings() boolfunc (*Agent_RemoteDialogflowAgent) ProtoMessage
func (*Agent_RemoteDialogflowAgent) ProtoMessage()func (*Agent_RemoteDialogflowAgent) ProtoReflect
func (x *Agent_RemoteDialogflowAgent) ProtoReflect() protoreflect.Messagefunc (*Agent_RemoteDialogflowAgent) Reset
func (x *Agent_RemoteDialogflowAgent) Reset()func (*Agent_RemoteDialogflowAgent) String
func (x *Agent_RemoteDialogflowAgent) String() stringAgent_RemoteDialogflowAgent_
type Agent_RemoteDialogflowAgent_ struct {
// Optional. The remote
// [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents)
// agent to be used for the agent execution. If this field is set, all other
// agent level properties will be ignored.
//
// Note: If the Dialogflow agent is in a different project from the app, you
// should grant `roles/dialogflow.client` to the CES service agent
// `service-AmbientSoundConfig
type AmbientSoundConfig struct {
// Ambient noise to be played with the synthesized agent response, to
// enhance the naturalness of the conversation.
//
// Types that are valid to be assigned to Source:
//
// *AmbientSoundConfig_PrebuiltAmbientNoise_
// *AmbientSoundConfig_GcsUri
// *AmbientSoundConfig_PrebuiltAmbientSound
Source isAmbientSoundConfig_Source `protobuf_oneof:"source"`
// Optional. Volume gain (in dB) of the normal native volume supported by
// ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of
// 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB)
// will play at approximately half the amplitude of the normal native signal
// amplitude. A value of +6.0 (dB) will play at approximately twice the
// amplitude of the normal native signal amplitude. We strongly recommend not
// to exceed +10 (dB) as there's usually no effective increase in loudness for
// any value greater than that.
VolumeGainDb float64 `protobuf:"fixed64,3,opt,name=volume_gain_db,json=volumeGainDb,proto3" json:"volume_gain_db,omitempty"`
// contains filtered or unexported fields
}Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.
func (*AmbientSoundConfig) Descriptor
func (*AmbientSoundConfig) Descriptor() ([]byte, []int)Deprecated: Use AmbientSoundConfig.ProtoReflect.Descriptor instead.
func (*AmbientSoundConfig) GetGcsUri
func (x *AmbientSoundConfig) GetGcsUri() stringfunc (*AmbientSoundConfig) GetPrebuiltAmbientNoise
func (x *AmbientSoundConfig) GetPrebuiltAmbientNoise() AmbientSoundConfig_PrebuiltAmbientNoiseDeprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
func (*AmbientSoundConfig) GetPrebuiltAmbientSound
func (x *AmbientSoundConfig) GetPrebuiltAmbientSound() stringfunc (*AmbientSoundConfig) GetSource
func (x *AmbientSoundConfig) GetSource() isAmbientSoundConfig_Sourcefunc (*AmbientSoundConfig) GetVolumeGainDb
func (x *AmbientSoundConfig) GetVolumeGainDb() float64func (*AmbientSoundConfig) ProtoMessage
func (*AmbientSoundConfig) ProtoMessage()func (*AmbientSoundConfig) ProtoReflect
func (x *AmbientSoundConfig) ProtoReflect() protoreflect.Messagefunc (*AmbientSoundConfig) Reset
func (x *AmbientSoundConfig) Reset()func (*AmbientSoundConfig) String
func (x *AmbientSoundConfig) String() stringAmbientSoundConfig_GcsUri
type AmbientSoundConfig_GcsUri struct {
// Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in
// [Cloud Storage](https://cloud.google.com/storage).
//
// Note: Please make sure the CES service agent
// `service-AmbientSoundConfig_PrebuiltAmbientNoise
type AmbientSoundConfig_PrebuiltAmbientNoise int32Prebuilt ambient noise.
AmbientSoundConfig_PREBUILT_AMBIENT_NOISE_UNSPECIFIED, AmbientSoundConfig_RETAIL_STORE, AmbientSoundConfig_CONVENTION_HALL, AmbientSoundConfig_OUTDOOR
const (
// Not specified.
AmbientSoundConfig_PREBUILT_AMBIENT_NOISE_UNSPECIFIED AmbientSoundConfig_PrebuiltAmbientNoise = 0
// Ambient noise of a retail store.
AmbientSoundConfig_RETAIL_STORE AmbientSoundConfig_PrebuiltAmbientNoise = 1
// Ambient noise of a convention hall.
AmbientSoundConfig_CONVENTION_HALL AmbientSoundConfig_PrebuiltAmbientNoise = 2
// Ambient noise of a street.
AmbientSoundConfig_OUTDOOR AmbientSoundConfig_PrebuiltAmbientNoise = 3
)func (AmbientSoundConfig_PrebuiltAmbientNoise) Descriptor
func (AmbientSoundConfig_PrebuiltAmbientNoise) Descriptor() protoreflect.EnumDescriptorfunc (AmbientSoundConfig_PrebuiltAmbientNoise) Enum
func (AmbientSoundConfig_PrebuiltAmbientNoise) EnumDescriptor
func (AmbientSoundConfig_PrebuiltAmbientNoise) EnumDescriptor() ([]byte, []int)Deprecated: Use AmbientSoundConfig_PrebuiltAmbientNoise.Descriptor instead.
func (AmbientSoundConfig_PrebuiltAmbientNoise) Number
func (x AmbientSoundConfig_PrebuiltAmbientNoise) Number() protoreflect.EnumNumberfunc (AmbientSoundConfig_PrebuiltAmbientNoise) String
func (x AmbientSoundConfig_PrebuiltAmbientNoise) String() stringfunc (AmbientSoundConfig_PrebuiltAmbientNoise) Type
func (AmbientSoundConfig_PrebuiltAmbientNoise) Type() protoreflect.EnumTypeAmbientSoundConfig_PrebuiltAmbientNoise_
type AmbientSoundConfig_PrebuiltAmbientNoise_ struct {
// Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of
// `prebuilt_ambient_sound`.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
PrebuiltAmbientNoise AmbientSoundConfig_PrebuiltAmbientNoise `protobuf:"varint,1,opt,name=prebuilt_ambient_noise,json=prebuiltAmbientNoise,proto3,enum=google.cloud.ces.v1.AmbientSoundConfig_PrebuiltAmbientNoise,oneof"`
}AmbientSoundConfig_PrebuiltAmbientSound
type AmbientSoundConfig_PrebuiltAmbientSound struct {
// Optional. Name of the prebuilt ambient sound.
// Valid values are:
// - "coffee_shop"
// - "keyboard"
// - "keypad"
// - "hum"
// - "office_1"
// - "office_2"
// - "office_3"
// - "room_1"
// - "room_2"
// - "room_3"
// - "room_4"
// - "room_5"
// - "air_conditioner"
PrebuiltAmbientSound string `protobuf:"bytes,4,opt,name=prebuilt_ambient_sound,json=prebuiltAmbientSound,proto3,oneof"`
}ApiAuthentication
type ApiAuthentication struct {
// The auth configuration.
//
// Types that are valid to be assigned to AuthConfig:
//
// *ApiAuthentication_ApiKeyConfig
// *ApiAuthentication_OauthConfig
// *ApiAuthentication_ServiceAgentIdTokenAuthConfig
// *ApiAuthentication_ServiceAccountAuthConfig
// *ApiAuthentication_BearerTokenConfig
AuthConfig isApiAuthentication_AuthConfig `protobuf_oneof:"auth_config"`
// contains filtered or unexported fields
}Authentication information required for API calls.
func (*ApiAuthentication) Descriptor
func (*ApiAuthentication) Descriptor() ([]byte, []int)Deprecated: Use ApiAuthentication.ProtoReflect.Descriptor instead.
func (*ApiAuthentication) GetApiKeyConfig
func (x *ApiAuthentication) GetApiKeyConfig() *ApiKeyConfigfunc (*ApiAuthentication) GetAuthConfig
func (x *ApiAuthentication) GetAuthConfig() isApiAuthentication_AuthConfigfunc (*ApiAuthentication) GetBearerTokenConfig
func (x *ApiAuthentication) GetBearerTokenConfig() *BearerTokenConfigfunc (*ApiAuthentication) GetOauthConfig
func (x *ApiAuthentication) GetOauthConfig() *OAuthConfigfunc (*ApiAuthentication) GetServiceAccountAuthConfig
func (x *ApiAuthentication) GetServiceAccountAuthConfig() *ServiceAccountAuthConfigfunc (*ApiAuthentication) GetServiceAgentIdTokenAuthConfig
func (x *ApiAuthentication) GetServiceAgentIdTokenAuthConfig() *ServiceAgentIdTokenAuthConfigfunc (*ApiAuthentication) ProtoMessage
func (*ApiAuthentication) ProtoMessage()func (*ApiAuthentication) ProtoReflect
func (x *ApiAuthentication) ProtoReflect() protoreflect.Messagefunc (*ApiAuthentication) Reset
func (x *ApiAuthentication) Reset()func (*ApiAuthentication) String
func (x *ApiAuthentication) String() stringApiAuthentication_ApiKeyConfig
type ApiAuthentication_ApiKeyConfig struct {
// Optional. Config for API key auth.
ApiKeyConfig *ApiKeyConfig `protobuf:"bytes,1,opt,name=api_key_config,json=apiKeyConfig,proto3,oneof"`
}ApiAuthentication_BearerTokenConfig
type ApiAuthentication_BearerTokenConfig struct {
// Optional. Config for bearer token auth.
BearerTokenConfig *BearerTokenConfig `protobuf:"bytes,5,opt,name=bearer_token_config,json=bearerTokenConfig,proto3,oneof"`
}ApiAuthentication_OauthConfig
type ApiAuthentication_OauthConfig struct {
// Optional. Config for OAuth.
OauthConfig *OAuthConfig `protobuf:"bytes,2,opt,name=oauth_config,json=oauthConfig,proto3,oneof"`
}ApiAuthentication_ServiceAccountAuthConfig
type ApiAuthentication_ServiceAccountAuthConfig struct {
// Optional. Config for service account authentication.
ServiceAccountAuthConfig *ServiceAccountAuthConfig `protobuf:"bytes,4,opt,name=service_account_auth_config,json=serviceAccountAuthConfig,proto3,oneof"`
}ApiAuthentication_ServiceAgentIdTokenAuthConfig
type ApiAuthentication_ServiceAgentIdTokenAuthConfig struct {
// Optional. Config for ID token auth generated from CES service agent.
ServiceAgentIdTokenAuthConfig *ServiceAgentIdTokenAuthConfig `protobuf:"bytes,3,opt,name=service_agent_id_token_auth_config,json=serviceAgentIdTokenAuthConfig,proto3,oneof"`
}ApiKeyConfig
type ApiKeyConfig struct {
// Required. The parameter name or the header name of the API key.
// E.g., If the API request is "https://example.com/act?X-Api-Key=Configurations for authentication with API key.
func (*ApiKeyConfig) Descriptor
func (*ApiKeyConfig) Descriptor() ([]byte, []int)Deprecated: Use ApiKeyConfig.ProtoReflect.Descriptor instead.
func (*ApiKeyConfig) GetApiKeySecretVersion
func (x *ApiKeyConfig) GetApiKeySecretVersion() stringfunc (*ApiKeyConfig) GetKeyName
func (x *ApiKeyConfig) GetKeyName() stringfunc (*ApiKeyConfig) GetRequestLocation
func (x *ApiKeyConfig) GetRequestLocation() ApiKeyConfig_RequestLocationfunc (*ApiKeyConfig) ProtoMessage
func (*ApiKeyConfig) ProtoMessage()func (*ApiKeyConfig) ProtoReflect
func (x *ApiKeyConfig) ProtoReflect() protoreflect.Messagefunc (*ApiKeyConfig) Reset
func (x *ApiKeyConfig) Reset()func (*ApiKeyConfig) String
func (x *ApiKeyConfig) String() stringApiKeyConfig_RequestLocation
type ApiKeyConfig_RequestLocation int32The location of the API key in the request.
ApiKeyConfig_REQUEST_LOCATION_UNSPECIFIED, ApiKeyConfig_HEADER, ApiKeyConfig_QUERY_STRING
const (
// Unspecified. This value should not be used.
ApiKeyConfig_REQUEST_LOCATION_UNSPECIFIED ApiKeyConfig_RequestLocation = 0
// Represents the key in http header.
ApiKeyConfig_HEADER ApiKeyConfig_RequestLocation = 1
// Represents the key in query string.
ApiKeyConfig_QUERY_STRING ApiKeyConfig_RequestLocation = 2
)func (ApiKeyConfig_RequestLocation) Descriptor
func (ApiKeyConfig_RequestLocation) Descriptor() protoreflect.EnumDescriptorfunc (ApiKeyConfig_RequestLocation) Enum
func (x ApiKeyConfig_RequestLocation) Enum() *ApiKeyConfig_RequestLocationfunc (ApiKeyConfig_RequestLocation) EnumDescriptor
func (ApiKeyConfig_RequestLocation) EnumDescriptor() ([]byte, []int)Deprecated: Use ApiKeyConfig_RequestLocation.Descriptor instead.
func (ApiKeyConfig_RequestLocation) Number
func (x ApiKeyConfig_RequestLocation) Number() protoreflect.EnumNumberfunc (ApiKeyConfig_RequestLocation) String
func (x ApiKeyConfig_RequestLocation) String() stringfunc (ApiKeyConfig_RequestLocation) Type
func (ApiKeyConfig_RequestLocation) Type() protoreflect.EnumTypeApp
type App struct {
// Identifier. The unique identifier of the app.
// Format: `projects/{project}/locations/{location}/apps/{app}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the app.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Human-readable description of the app.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Whether the app is pinned in the app list.
Pinned bool `protobuf:"varint,31,opt,name=pinned,proto3" json:"pinned,omitempty"`
// Optional. The root agent is the entry point of the app.
// Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
RootAgent string `protobuf:"bytes,4,opt,name=root_agent,json=rootAgent,proto3" json:"root_agent,omitempty"`
// Optional. Language settings of the app.
LanguageSettings *LanguageSettings `protobuf:"bytes,18,opt,name=language_settings,json=languageSettings,proto3" json:"language_settings,omitempty"`
// Optional. TimeZone settings of the app.
TimeZoneSettings *TimeZoneSettings `protobuf:"bytes,27,opt,name=time_zone_settings,json=timeZoneSettings,proto3" json:"time_zone_settings,omitempty"`
// Optional. Audio processing configuration of the app.
AudioProcessingConfig *AudioProcessingConfig `protobuf:"bytes,7,opt,name=audio_processing_config,json=audioProcessingConfig,proto3" json:"audio_processing_config,omitempty"`
// Optional. Logging settings of the app.
LoggingSettings *LoggingSettings `protobuf:"bytes,8,opt,name=logging_settings,json=loggingSettings,proto3" json:"logging_settings,omitempty"`
// Optional. Error handling settings of the app.
ErrorHandlingSettings *ErrorHandlingSettings `protobuf:"bytes,34,opt,name=error_handling_settings,json=errorHandlingSettings,proto3" json:"error_handling_settings,omitempty"`
// Optional. The default LLM model settings for the app.
// Individual resources (e.g. agents, guardrails) can override these
// configurations as needed.
ModelSettings *ModelSettings `protobuf:"bytes,13,opt,name=model_settings,json=modelSettings,proto3" json:"model_settings,omitempty"`
// Optional. The tool execution mode for the app. If not provided, will
// default to PARALLEL.
ToolExecutionMode App_ToolExecutionMode `protobuf:"varint,32,opt,name=tool_execution_mode,json=toolExecutionMode,proto3,enum=google.cloud.ces.v1.App_ToolExecutionMode" json:"tool_execution_mode,omitempty"`
// Optional. The evaluation thresholds for the app.
EvaluationMetricsThresholds *EvaluationMetricsThresholds `protobuf:"bytes,24,opt,name=evaluation_metrics_thresholds,json=evaluationMetricsThresholds,proto3" json:"evaluation_metrics_thresholds,omitempty"`
// Optional. The declarations of the variables.
VariableDeclarations []*App_VariableDeclaration `protobuf:"bytes,14,rep,name=variable_declarations,json=variableDeclarations,proto3" json:"variable_declarations,omitempty"`
// Output only. The declarations of predefined variables for the app.
PredefinedVariableDeclarations []*App_VariableDeclaration `protobuf:"bytes,28,rep,name=predefined_variable_declarations,json=predefinedVariableDeclarations,proto3" json:"predefined_variable_declarations,omitempty"`
// Optional. Instructions for all the agents in the app.
// You can use this instruction to set up a stable identity or personality
// across all the agents.
GlobalInstruction string `protobuf:"bytes,17,opt,name=global_instruction,json=globalInstruction,proto3" json:"global_instruction,omitempty"`
// Optional. List of guardrails for the app.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
Guardrails []string `protobuf:"bytes,10,rep,name=guardrails,proto3" json:"guardrails,omitempty"`
// Optional. The data store settings for the app.
DataStoreSettings *DataStoreSettings `protobuf:"bytes,15,opt,name=data_store_settings,json=dataStoreSettings,proto3" json:"data_store_settings,omitempty"`
// Optional. The default channel profile used by the app.
DefaultChannelProfile *ChannelProfile `protobuf:"bytes,22,opt,name=default_channel_profile,json=defaultChannelProfile,proto3" json:"default_channel_profile,omitempty"`
// Optional. Metadata about the app. This field can be used to store
// additional information relevant to the app's details or intended usages.
Metadata map[string]string `protobuf:"bytes,11,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Output only. Timestamp when the app was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the app was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Etag used to ensure the object hasn't changed during a
// read-modify-write operation. If the etag is empty, the update will
// overwrite any concurrent changes.
Etag string `protobuf:"bytes,12,opt,name=etag,proto3" json:"etag,omitempty"`
// Output only. Number of deployments in the app.
DeploymentCount int32 `protobuf:"varint,23,opt,name=deployment_count,json=deploymentCount,proto3" json:"deployment_count,omitempty"`
// Optional. The default client certificate settings for the app.
ClientCertificateSettings *ClientCertificateSettings `protobuf:"bytes,25,opt,name=client_certificate_settings,json=clientCertificateSettings,proto3" json:"client_certificate_settings,omitempty"`
// Optional. Indicates whether the app is locked for changes. If the app is
// locked, modifications to the app resources will be rejected.
Locked bool `protobuf:"varint,29,opt,name=locked,proto3" json:"locked,omitempty"`
// contains filtered or unexported fields
}An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.
func (*App) Descriptor
Deprecated: Use App.ProtoReflect.Descriptor instead.
func (*App) GetAudioProcessingConfig
func (x *App) GetAudioProcessingConfig() *AudioProcessingConfigfunc (*App) GetClientCertificateSettings
func (x *App) GetClientCertificateSettings() *ClientCertificateSettingsfunc (*App) GetCreateTime
func (x *App) GetCreateTime() *timestamppb.Timestampfunc (*App) GetDataStoreSettings
func (x *App) GetDataStoreSettings() *DataStoreSettingsfunc (*App) GetDefaultChannelProfile
func (x *App) GetDefaultChannelProfile() *ChannelProfilefunc (*App) GetDeploymentCount
func (*App) GetDescription
func (*App) GetDisplayName
func (*App) GetErrorHandlingSettings
func (x *App) GetErrorHandlingSettings() *ErrorHandlingSettingsfunc (*App) GetEtag
func (*App) GetEvaluationMetricsThresholds
func (x *App) GetEvaluationMetricsThresholds() *EvaluationMetricsThresholdsfunc (*App) GetGlobalInstruction
func (*App) GetGuardrails
func (*App) GetLanguageSettings
func (x *App) GetLanguageSettings() *LanguageSettingsfunc (*App) GetLocked
func (*App) GetLoggingSettings
func (x *App) GetLoggingSettings() *LoggingSettingsfunc (*App) GetMetadata
func (*App) GetModelSettings
func (x *App) GetModelSettings() *ModelSettingsfunc (*App) GetName
func (*App) GetPinned
func (*App) GetPredefinedVariableDeclarations
func (x *App) GetPredefinedVariableDeclarations() []*App_VariableDeclarationfunc (*App) GetRootAgent
func (*App) GetTimeZoneSettings
func (x *App) GetTimeZoneSettings() *TimeZoneSettingsfunc (*App) GetToolExecutionMode
func (x *App) GetToolExecutionMode() App_ToolExecutionModefunc (*App) GetUpdateTime
func (x *App) GetUpdateTime() *timestamppb.Timestampfunc (*App) GetVariableDeclarations
func (x *App) GetVariableDeclarations() []*App_VariableDeclarationfunc (*App) ProtoMessage
func (*App) ProtoMessage()func (*App) ProtoReflect
func (x *App) ProtoReflect() protoreflect.Messagefunc (*App) Reset
func (x *App) Reset()func (*App) String
AppSnapshot
type AppSnapshot struct {
// Optional. The basic settings for the app.
App *App `protobuf:"bytes,1,opt,name=app,proto3" json:"app,omitempty"`
// Optional. List of agents in the app.
Agents []*Agent `protobuf:"bytes,2,rep,name=agents,proto3" json:"agents,omitempty"`
// Optional. List of tools in the app.
Tools []*Tool `protobuf:"bytes,3,rep,name=tools,proto3" json:"tools,omitempty"`
// Optional. List of examples in the app.
Examples []*Example `protobuf:"bytes,4,rep,name=examples,proto3" json:"examples,omitempty"`
// Optional. List of guardrails in the app.
Guardrails []*Guardrail `protobuf:"bytes,5,rep,name=guardrails,proto3" json:"guardrails,omitempty"`
// Optional. List of toolsets in the app.
Toolsets []*Toolset `protobuf:"bytes,6,rep,name=toolsets,proto3" json:"toolsets,omitempty"`
// contains filtered or unexported fields
}A snapshot of the app.
func (*AppSnapshot) Descriptor
func (*AppSnapshot) Descriptor() ([]byte, []int)Deprecated: Use AppSnapshot.ProtoReflect.Descriptor instead.
func (*AppSnapshot) GetAgents
func (x *AppSnapshot) GetAgents() []*Agentfunc (*AppSnapshot) GetApp
func (x *AppSnapshot) GetApp() *Appfunc (*AppSnapshot) GetExamples
func (x *AppSnapshot) GetExamples() []*Examplefunc (*AppSnapshot) GetGuardrails
func (x *AppSnapshot) GetGuardrails() []*Guardrailfunc (*AppSnapshot) GetTools
func (x *AppSnapshot) GetTools() []*Toolfunc (*AppSnapshot) GetToolsets
func (x *AppSnapshot) GetToolsets() []*Toolsetfunc (*AppSnapshot) ProtoMessage
func (*AppSnapshot) ProtoMessage()func (*AppSnapshot) ProtoReflect
func (x *AppSnapshot) ProtoReflect() protoreflect.Messagefunc (*AppSnapshot) Reset
func (x *AppSnapshot) Reset()func (*AppSnapshot) String
func (x *AppSnapshot) String() stringAppVersion
type AppVersion struct {
// Identifier. The unique identifier of the app version.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The display name of the app version.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the app version.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Email of the user who created the app version.
Creator string `protobuf:"bytes,4,opt,name=creator,proto3" json:"creator,omitempty"`
// Output only. Timestamp when the app version was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The snapshot of the app when the version is created.
Snapshot *AppSnapshot `protobuf:"bytes,8,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// Output only. Etag used to ensure the object hasn't changed during a
// read-modify-write operation. If the etag is empty, the update will
// overwrite any concurrent changes.
Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.
func (*AppVersion) Descriptor
func (*AppVersion) Descriptor() ([]byte, []int)Deprecated: Use AppVersion.ProtoReflect.Descriptor instead.
func (*AppVersion) GetCreateTime
func (x *AppVersion) GetCreateTime() *timestamppb.Timestampfunc (*AppVersion) GetCreator
func (x *AppVersion) GetCreator() stringfunc (*AppVersion) GetDescription
func (x *AppVersion) GetDescription() stringfunc (*AppVersion) GetDisplayName
func (x *AppVersion) GetDisplayName() stringfunc (*AppVersion) GetEtag
func (x *AppVersion) GetEtag() stringfunc (*AppVersion) GetName
func (x *AppVersion) GetName() stringfunc (*AppVersion) GetSnapshot
func (x *AppVersion) GetSnapshot() *AppSnapshotfunc (*AppVersion) ProtoMessage
func (*AppVersion) ProtoMessage()func (*AppVersion) ProtoReflect
func (x *AppVersion) ProtoReflect() protoreflect.Messagefunc (*AppVersion) Reset
func (x *AppVersion) Reset()func (*AppVersion) String
func (x *AppVersion) String() stringApp_ToolExecutionMode
type App_ToolExecutionMode int32Defines the tool execution behavior if there are multiple tools being selected by the agent at the same time.
App_TOOL_EXECUTION_MODE_UNSPECIFIED, App_PARALLEL, App_SEQUENTIAL
const (
// Unspecified tool execution mode. Default to PARALLEL.
App_TOOL_EXECUTION_MODE_UNSPECIFIED App_ToolExecutionMode = 0
// If there are multiple tools being selected, they will be executed in
// parallel, with the same
// [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context).
App_PARALLEL App_ToolExecutionMode = 1
// If there are multiple tools being selected, they will be executed
// sequentially. The next tool will only be executed after the previous tool
// completes and it can see updated
// [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context)
// from the previous tool.
App_SEQUENTIAL App_ToolExecutionMode = 2
)func (App_ToolExecutionMode) Descriptor
func (App_ToolExecutionMode) Descriptor() protoreflect.EnumDescriptorfunc (App_ToolExecutionMode) Enum
func (x App_ToolExecutionMode) Enum() *App_ToolExecutionModefunc (App_ToolExecutionMode) EnumDescriptor
func (App_ToolExecutionMode) EnumDescriptor() ([]byte, []int)Deprecated: Use App_ToolExecutionMode.Descriptor instead.
func (App_ToolExecutionMode) Number
func (x App_ToolExecutionMode) Number() protoreflect.EnumNumberfunc (App_ToolExecutionMode) String
func (x App_ToolExecutionMode) String() stringfunc (App_ToolExecutionMode) Type
func (App_ToolExecutionMode) Type() protoreflect.EnumTypeApp_VariableDeclaration
type App_VariableDeclaration struct {
// Required. The name of the variable. The name must start with a letter or
// underscore and contain only letters, numbers, or underscores.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The description of the variable.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Required. The schema of the variable.
Schema *Schema `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
// contains filtered or unexported fields
}Defines the structure and metadata for a variable.
func (*App_VariableDeclaration) Descriptor
func (*App_VariableDeclaration) Descriptor() ([]byte, []int)Deprecated: Use App_VariableDeclaration.ProtoReflect.Descriptor instead.
func (*App_VariableDeclaration) GetDescription
func (x *App_VariableDeclaration) GetDescription() stringfunc (*App_VariableDeclaration) GetName
func (x *App_VariableDeclaration) GetName() stringfunc (*App_VariableDeclaration) GetSchema
func (x *App_VariableDeclaration) GetSchema() *Schemafunc (*App_VariableDeclaration) ProtoMessage
func (*App_VariableDeclaration) ProtoMessage()func (*App_VariableDeclaration) ProtoReflect
func (x *App_VariableDeclaration) ProtoReflect() protoreflect.Messagefunc (*App_VariableDeclaration) Reset
func (x *App_VariableDeclaration) Reset()func (*App_VariableDeclaration) String
func (x *App_VariableDeclaration) String() stringAudioEncoding
type AudioEncoding int32AudioEncoding specifies the encoding format for audio data.
AudioEncoding_AUDIO_ENCODING_UNSPECIFIED, AudioEncoding_LINEAR16, AudioEncoding_MULAW, AudioEncoding_ALAW
const (
// Unspecified audio encoding.
AudioEncoding_AUDIO_ENCODING_UNSPECIFIED AudioEncoding = 0
// 16-bit linear PCM audio encoding.
AudioEncoding_LINEAR16 AudioEncoding = 1
// 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AudioEncoding_MULAW AudioEncoding = 2
// 8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law.
AudioEncoding_ALAW AudioEncoding = 3
)func (AudioEncoding) Descriptor
func (AudioEncoding) Descriptor() protoreflect.EnumDescriptorfunc (AudioEncoding) Enum
func (x AudioEncoding) Enum() *AudioEncodingfunc (AudioEncoding) EnumDescriptor
func (AudioEncoding) EnumDescriptor() ([]byte, []int)Deprecated: Use AudioEncoding.Descriptor instead.
func (AudioEncoding) Number
func (x AudioEncoding) Number() protoreflect.EnumNumberfunc (AudioEncoding) String
func (x AudioEncoding) String() stringfunc (AudioEncoding) Type
func (AudioEncoding) Type() protoreflect.EnumTypeAudioProcessingConfig
type AudioProcessingConfig struct {
// Optional. Configuration of how the agent response should be synthesized,
// mapping from the language code to
// [SynthesizeSpeechConfig][google.cloud.ces.v1.SynthesizeSpeechConfig].
//
// If the configuration for the specified language code is not found, the
// configuration for the root language code will be used. For example, if the
// map contains "en-us" and "en", and the specified language code is "en-gb",
// then "en" configuration will be used.
//
// Note: Language code is case-insensitive.
SynthesizeSpeechConfigs map[string]*SynthesizeSpeechConfig `protobuf:"bytes,1,rep,name=synthesize_speech_configs,json=synthesizeSpeechConfigs,proto3" json:"synthesize_speech_configs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Configures the agent behavior for the user barge-in activities.
BargeInConfig *BargeInConfig `protobuf:"bytes,3,opt,name=barge_in_config,json=bargeInConfig,proto3" json:"barge_in_config,omitempty"`
// Optional. The duration of user inactivity (no speech or interaction) before
// the agent prompts the user for reengagement. If not set, the agent will not
// prompt the user for reengagement.
InactivityTimeout *durationpb.Duration `protobuf:"bytes,4,opt,name=inactivity_timeout,json=inactivityTimeout,proto3" json:"inactivity_timeout,omitempty"`
// Optional. Configuration for the ambient sound to be played with the
// synthesized agent response, to enhance the naturalness of the conversation.
AmbientSoundConfig *AmbientSoundConfig `protobuf:"bytes,5,opt,name=ambient_sound_config,json=ambientSoundConfig,proto3" json:"ambient_sound_config,omitempty"`
// contains filtered or unexported fields
}Configuration for how the input and output audio should be processed and delivered.
func (*AudioProcessingConfig) Descriptor
func (*AudioProcessingConfig) Descriptor() ([]byte, []int)Deprecated: Use AudioProcessingConfig.ProtoReflect.Descriptor instead.
func (*AudioProcessingConfig) GetAmbientSoundConfig
func (x *AudioProcessingConfig) GetAmbientSoundConfig() *AmbientSoundConfigfunc (*AudioProcessingConfig) GetBargeInConfig
func (x *AudioProcessingConfig) GetBargeInConfig() *BargeInConfigfunc (*AudioProcessingConfig) GetInactivityTimeout
func (x *AudioProcessingConfig) GetInactivityTimeout() *durationpb.Durationfunc (*AudioProcessingConfig) GetSynthesizeSpeechConfigs
func (x *AudioProcessingConfig) GetSynthesizeSpeechConfigs() map[string]*SynthesizeSpeechConfigfunc (*AudioProcessingConfig) ProtoMessage
func (*AudioProcessingConfig) ProtoMessage()func (*AudioProcessingConfig) ProtoReflect
func (x *AudioProcessingConfig) ProtoReflect() protoreflect.Messagefunc (*AudioProcessingConfig) Reset
func (x *AudioProcessingConfig) Reset()func (*AudioProcessingConfig) String
func (x *AudioProcessingConfig) String() stringAudioRecordingConfig
type AudioRecordingConfig struct {
// Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to
// store the session audio recordings. The URI must start with "gs://".
//
// Please choose a bucket location that meets your data residency
// requirements.
//
// Note: If the Cloud Storage bucket is in a different project from the app,
// you should grant `storage.objects.create` permission to the CES service
// agent `service-Configuration for how the audio interactions should be recorded.
func (*AudioRecordingConfig) Descriptor
func (*AudioRecordingConfig) Descriptor() ([]byte, []int)Deprecated: Use AudioRecordingConfig.ProtoReflect.Descriptor instead.
func (*AudioRecordingConfig) GetGcsBucket
func (x *AudioRecordingConfig) GetGcsBucket() stringfunc (*AudioRecordingConfig) GetGcsPathPrefix
func (x *AudioRecordingConfig) GetGcsPathPrefix() stringfunc (*AudioRecordingConfig) ProtoMessage
func (*AudioRecordingConfig) ProtoMessage()func (*AudioRecordingConfig) ProtoReflect
func (x *AudioRecordingConfig) ProtoReflect() protoreflect.Messagefunc (*AudioRecordingConfig) Reset
func (x *AudioRecordingConfig) Reset()func (*AudioRecordingConfig) String
func (x *AudioRecordingConfig) String() stringBargeInConfig
type BargeInConfig struct {
// Optional. Disables user barge-in while the agent is speaking. If true, user
// input during agent response playback will be ignored.
//
// Deprecated: `disable_barge_in` is deprecated in favor of
// [`disable_barge_in_control`][google.cloud.ces.v1.ChannelProfile.disable_barge_in_control]
// in ChannelProfile.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
DisableBargeIn bool `protobuf:"varint,1,opt,name=disable_barge_in,json=disableBargeIn,proto3" json:"disable_barge_in,omitempty"`
// Optional. If enabled, the agent will adapt its next response based on the
// assumption that the user hasn't heard the full preceding agent message.
// This should not be used in scenarios where agent responses are displayed
// visually.
BargeInAwareness bool `protobuf:"varint,2,opt,name=barge_in_awareness,json=bargeInAwareness,proto3" json:"barge_in_awareness,omitempty"`
// contains filtered or unexported fields
}Configuration for how the user barge-in activities should be handled.
func (*BargeInConfig) Descriptor
func (*BargeInConfig) Descriptor() ([]byte, []int)Deprecated: Use BargeInConfig.ProtoReflect.Descriptor instead.
func (*BargeInConfig) GetBargeInAwareness
func (x *BargeInConfig) GetBargeInAwareness() boolfunc (*BargeInConfig) GetDisableBargeIn
func (x *BargeInConfig) GetDisableBargeIn() boolDeprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
func (*BargeInConfig) ProtoMessage
func (*BargeInConfig) ProtoMessage()func (*BargeInConfig) ProtoReflect
func (x *BargeInConfig) ProtoReflect() protoreflect.Messagefunc (*BargeInConfig) Reset
func (x *BargeInConfig) Reset()func (*BargeInConfig) String
func (x *BargeInConfig) String() stringBatchDeleteConversationsRequest
type BatchDeleteConversationsRequest struct {
// Required. The resource name of the app to delete conversations from.
// Format:
// `projects/{project}/locations/{location}/apps/{app}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The resource names of the conversations to delete.
Conversations []string `protobuf:"bytes,2,rep,name=conversations,proto3" json:"conversations,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.BatchDeleteConversations][google.cloud.ces.v1.AgentService.BatchDeleteConversations].
func (*BatchDeleteConversationsRequest) Descriptor
func (*BatchDeleteConversationsRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchDeleteConversationsRequest.ProtoReflect.Descriptor instead.
func (*BatchDeleteConversationsRequest) GetConversations
func (x *BatchDeleteConversationsRequest) GetConversations() []stringfunc (*BatchDeleteConversationsRequest) GetParent
func (x *BatchDeleteConversationsRequest) GetParent() stringfunc (*BatchDeleteConversationsRequest) ProtoMessage
func (*BatchDeleteConversationsRequest) ProtoMessage()func (*BatchDeleteConversationsRequest) ProtoReflect
func (x *BatchDeleteConversationsRequest) ProtoReflect() protoreflect.Messagefunc (*BatchDeleteConversationsRequest) Reset
func (x *BatchDeleteConversationsRequest) Reset()func (*BatchDeleteConversationsRequest) String
func (x *BatchDeleteConversationsRequest) String() stringBatchDeleteConversationsResponse
type BatchDeleteConversationsResponse struct {
// The list of conversations that were successfully deleted.
DeletedConversations []string `protobuf:"bytes,1,rep,name=deleted_conversations,json=deletedConversations,proto3" json:"deleted_conversations,omitempty"`
// The list of conversations that failed to be deleted.
FailedConversations []string `protobuf:"bytes,2,rep,name=failed_conversations,json=failedConversations,proto3" json:"failed_conversations,omitempty"`
// Optional. A list of error messages associated with conversations that
// failed to be deleted.
ErrorMessages []string `protobuf:"bytes,3,rep,name=error_messages,json=errorMessages,proto3" json:"error_messages,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.BatchDeleteConversations][google.cloud.ces.v1.AgentService.BatchDeleteConversations].
func (*BatchDeleteConversationsResponse) Descriptor
func (*BatchDeleteConversationsResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchDeleteConversationsResponse.ProtoReflect.Descriptor instead.
func (*BatchDeleteConversationsResponse) GetDeletedConversations
func (x *BatchDeleteConversationsResponse) GetDeletedConversations() []stringfunc (*BatchDeleteConversationsResponse) GetErrorMessages
func (x *BatchDeleteConversationsResponse) GetErrorMessages() []stringfunc (*BatchDeleteConversationsResponse) GetFailedConversations
func (x *BatchDeleteConversationsResponse) GetFailedConversations() []stringfunc (*BatchDeleteConversationsResponse) ProtoMessage
func (*BatchDeleteConversationsResponse) ProtoMessage()func (*BatchDeleteConversationsResponse) ProtoReflect
func (x *BatchDeleteConversationsResponse) ProtoReflect() protoreflect.Messagefunc (*BatchDeleteConversationsResponse) Reset
func (x *BatchDeleteConversationsResponse) Reset()func (*BatchDeleteConversationsResponse) String
func (x *BatchDeleteConversationsResponse) String() stringBearerTokenConfig
type BearerTokenConfig struct {
// Required. The bearer token.
// Must be in the format `$context.variables.Configurations for authentication with a bearer token.
func (*BearerTokenConfig) Descriptor
func (*BearerTokenConfig) Descriptor() ([]byte, []int)Deprecated: Use BearerTokenConfig.ProtoReflect.Descriptor instead.
func (*BearerTokenConfig) GetToken
func (x *BearerTokenConfig) GetToken() stringfunc (*BearerTokenConfig) ProtoMessage
func (*BearerTokenConfig) ProtoMessage()func (*BearerTokenConfig) ProtoReflect
func (x *BearerTokenConfig) ProtoReflect() protoreflect.Messagefunc (*BearerTokenConfig) Reset
func (x *BearerTokenConfig) Reset()func (*BearerTokenConfig) String
func (x *BearerTokenConfig) String() stringBidiSessionClientMessage
type BidiSessionClientMessage struct {
// The type of the message.
//
// Types that are valid to be assigned to MessageType:
//
// *BidiSessionClientMessage_Config
// *BidiSessionClientMessage_RealtimeInput
MessageType isBidiSessionClientMessage_MessageType `protobuf_oneof:"message_type"`
// contains filtered or unexported fields
}The top-level message sent by the client for the [SessionService.BidiRunSession][google.cloud.ces.v1.SessionService.BidiRunSession] method.
func (*BidiSessionClientMessage) Descriptor
func (*BidiSessionClientMessage) Descriptor() ([]byte, []int)Deprecated: Use BidiSessionClientMessage.ProtoReflect.Descriptor instead.
func (*BidiSessionClientMessage) GetConfig
func (x *BidiSessionClientMessage) GetConfig() *SessionConfigfunc (*BidiSessionClientMessage) GetMessageType
func (x *BidiSessionClientMessage) GetMessageType() isBidiSessionClientMessage_MessageTypefunc (*BidiSessionClientMessage) GetRealtimeInput
func (x *BidiSessionClientMessage) GetRealtimeInput() *SessionInputfunc (*BidiSessionClientMessage) ProtoMessage
func (*BidiSessionClientMessage) ProtoMessage()func (*BidiSessionClientMessage) ProtoReflect
func (x *BidiSessionClientMessage) ProtoReflect() protoreflect.Messagefunc (*BidiSessionClientMessage) Reset
func (x *BidiSessionClientMessage) Reset()func (*BidiSessionClientMessage) String
func (x *BidiSessionClientMessage) String() stringBidiSessionClientMessage_Config
type BidiSessionClientMessage_Config struct {
// Optional. The initial config message for the session.
Config *SessionConfig `protobuf:"bytes,1,opt,name=config,proto3,oneof"`
}BidiSessionClientMessage_RealtimeInput
type BidiSessionClientMessage_RealtimeInput struct {
// Optional. Realtime input for the session.
RealtimeInput *SessionInput `protobuf:"bytes,2,opt,name=realtime_input,json=realtimeInput,proto3,oneof"`
}BidiSessionServerMessage
type BidiSessionServerMessage struct {
// The type of the message.
//
// Types that are valid to be assigned to MessageType:
//
// *BidiSessionServerMessage_SessionOutput
// *BidiSessionServerMessage_RecognitionResult
// *BidiSessionServerMessage_InterruptionSignal
// *BidiSessionServerMessage_EndSession
// *BidiSessionServerMessage_GoAway
MessageType isBidiSessionServerMessage_MessageType `protobuf_oneof:"message_type"`
// contains filtered or unexported fields
}The top-level message returned from [SessionService.BidiRunSession][google.cloud.ces.v1.SessionService.BidiRunSession] method.
func (*BidiSessionServerMessage) Descriptor
func (*BidiSessionServerMessage) Descriptor() ([]byte, []int)Deprecated: Use BidiSessionServerMessage.ProtoReflect.Descriptor instead.
func (*BidiSessionServerMessage) GetEndSession
func (x *BidiSessionServerMessage) GetEndSession() *EndSessionfunc (*BidiSessionServerMessage) GetGoAway
func (x *BidiSessionServerMessage) GetGoAway() *GoAwayfunc (*BidiSessionServerMessage) GetInterruptionSignal
func (x *BidiSessionServerMessage) GetInterruptionSignal() *InterruptionSignalfunc (*BidiSessionServerMessage) GetMessageType
func (x *BidiSessionServerMessage) GetMessageType() isBidiSessionServerMessage_MessageTypefunc (*BidiSessionServerMessage) GetRecognitionResult
func (x *BidiSessionServerMessage) GetRecognitionResult() *RecognitionResultfunc (*BidiSessionServerMessage) GetSessionOutput
func (x *BidiSessionServerMessage) GetSessionOutput() *SessionOutputfunc (*BidiSessionServerMessage) ProtoMessage
func (*BidiSessionServerMessage) ProtoMessage()func (*BidiSessionServerMessage) ProtoReflect
func (x *BidiSessionServerMessage) ProtoReflect() protoreflect.Messagefunc (*BidiSessionServerMessage) Reset
func (x *BidiSessionServerMessage) Reset()func (*BidiSessionServerMessage) String
func (x *BidiSessionServerMessage) String() stringBidiSessionServerMessage_EndSession
type BidiSessionServerMessage_EndSession struct {
// Optional. Indicates that the session has ended.
EndSession *EndSession `protobuf:"bytes,5,opt,name=end_session,json=endSession,proto3,oneof"`
}BidiSessionServerMessage_GoAway
type BidiSessionServerMessage_GoAway struct {
// Optional. Indicates that the server will disconnect soon and the client
// should half-close and restart the connection.
GoAway *GoAway `protobuf:"bytes,6,opt,name=go_away,json=goAway,proto3,oneof"`
}BidiSessionServerMessage_InterruptionSignal
type BidiSessionServerMessage_InterruptionSignal struct {
// Optional. Indicates the agent's audio response has been interrupted.
InterruptionSignal *InterruptionSignal `protobuf:"bytes,3,opt,name=interruption_signal,json=interruptionSignal,proto3,oneof"`
}BidiSessionServerMessage_RecognitionResult
type BidiSessionServerMessage_RecognitionResult struct {
// Optional. Realtime speech recognition result for the audio input.
RecognitionResult *RecognitionResult `protobuf:"bytes,2,opt,name=recognition_result,json=recognitionResult,proto3,oneof"`
}BidiSessionServerMessage_SessionOutput
type BidiSessionServerMessage_SessionOutput struct {
// Optional. Processing result from the CES agent.
SessionOutput *SessionOutput `protobuf:"bytes,1,opt,name=session_output,json=sessionOutput,proto3,oneof"`
}BigQueryExportSettings
type BigQueryExportSettings struct {
// Optional. Indicates whether the BigQuery export is enabled.
Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. The **project ID** of the BigQuery dataset to export the data to.
//
// Note: If the BigQuery dataset is in a different project from the app,
// you should grant `roles/bigquery.admin` role to the CES service agent
// `service-Settings to describe the BigQuery export behaviors for the app.
func (*BigQueryExportSettings) Descriptor
func (*BigQueryExportSettings) Descriptor() ([]byte, []int)Deprecated: Use BigQueryExportSettings.ProtoReflect.Descriptor instead.
func (*BigQueryExportSettings) GetDataset
func (x *BigQueryExportSettings) GetDataset() stringfunc (*BigQueryExportSettings) GetEnabled
func (x *BigQueryExportSettings) GetEnabled() boolfunc (*BigQueryExportSettings) GetProject
func (x *BigQueryExportSettings) GetProject() stringfunc (*BigQueryExportSettings) ProtoMessage
func (*BigQueryExportSettings) ProtoMessage()func (*BigQueryExportSettings) ProtoReflect
func (x *BigQueryExportSettings) ProtoReflect() protoreflect.Messagefunc (*BigQueryExportSettings) Reset
func (x *BigQueryExportSettings) Reset()func (*BigQueryExportSettings) String
func (x *BigQueryExportSettings) String() stringBlob
type Blob struct {
// Required. The IANA standard MIME type of the source data.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Required. Raw bytes of the blob.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}Represents a blob input or output in the conversation.
func (*Blob) Descriptor
Deprecated: Use Blob.ProtoReflect.Descriptor instead.
func (*Blob) GetData
func (*Blob) GetMimeType
func (*Blob) ProtoMessage
func (*Blob) ProtoMessage()func (*Blob) ProtoReflect
func (x *Blob) ProtoReflect() protoreflect.Messagefunc (*Blob) Reset
func (x *Blob) Reset()func (*Blob) String
Callback
type Callback struct {
// The callback to execute.
//
// Types that are valid to be assigned to Callback:
//
// *Callback_PythonCode
Callback isCallback_Callback `protobuf_oneof:"callback"`
// Optional. Human-readable description of the callback.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Whether the callback is disabled. Disabled callbacks are ignored
// by the agent.
Disabled bool `protobuf:"varint,2,opt,name=disabled,proto3" json:"disabled,omitempty"`
// Optional. If enabled, the callback will also be executed on intermediate
// model outputs. This setting only affects after model callback.
// **ENABLE WITH CAUTION**. Typically after model callback only needs to be
// executed after receiving all model responses. Enabling proactive execution
// may have negative implication on the execution cost and latency, and
// should only be enabled in rare situations.
ProactiveExecutionEnabled bool `protobuf:"varint,4,opt,name=proactive_execution_enabled,json=proactiveExecutionEnabled,proto3" json:"proactive_execution_enabled,omitempty"`
// contains filtered or unexported fields
}A callback defines the custom logic to be executed at various stages of agent interaction.
func (*Callback) Descriptor
Deprecated: Use Callback.ProtoReflect.Descriptor instead.
func (*Callback) GetCallback
func (x *Callback) GetCallback() isCallback_Callbackfunc (*Callback) GetDescription
func (*Callback) GetDisabled
func (*Callback) GetProactiveExecutionEnabled
func (*Callback) GetPythonCode
func (*Callback) ProtoMessage
func (*Callback) ProtoMessage()func (*Callback) ProtoReflect
func (x *Callback) ProtoReflect() protoreflect.Messagefunc (*Callback) Reset
func (x *Callback) Reset()func (*Callback) String
Callback_PythonCode
type Callback_PythonCode struct {
// Required. The python code to execute for the callback.
PythonCode string `protobuf:"bytes,1,opt,name=python_code,json=pythonCode,proto3,oneof"`
}Changelog
type Changelog struct {
// Identifier. The unique identifier of the changelog.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Email address of the change author.
Author string `protobuf:"bytes,2,opt,name=author,proto3" json:"author,omitempty"`
// Output only. Display name of the change. It typically should be the display
// name of the resource that was changed.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Description of the change. which typically captures the
// changed fields in the resource.
Description string `protobuf:"bytes,11,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The resource that was changed.
Resource string `protobuf:"bytes,4,opt,name=resource,proto3" json:"resource,omitempty"`
// Output only. The type of the resource that was changed.
ResourceType string `protobuf:"bytes,5,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
// Output only. The action that was performed on the resource.
Action string `protobuf:"bytes,6,opt,name=action,proto3" json:"action,omitempty"`
// Output only. The original resource before the change.
OriginalResource *structpb.Struct `protobuf:"bytes,7,opt,name=original_resource,json=originalResource,proto3" json:"original_resource,omitempty"`
// Output only. The new resource after the change.
NewResource *structpb.Struct `protobuf:"bytes,8,opt,name=new_resource,json=newResource,proto3" json:"new_resource,omitempty"`
// Output only. The dependent resources that were changed.
DependentResources []*structpb.Struct `protobuf:"bytes,9,rep,name=dependent_resources,json=dependentResources,proto3" json:"dependent_resources,omitempty"`
// Output only. The time when the change was made.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The monotonically increasing sequence number of the changelog.
SequenceNumber int64 `protobuf:"varint,12,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number,omitempty"`
// contains filtered or unexported fields
}Changelogs represent a change made to the app or to an resource within the app.
func (*Changelog) Descriptor
Deprecated: Use Changelog.ProtoReflect.Descriptor instead.
func (*Changelog) GetAction
func (*Changelog) GetAuthor
func (*Changelog) GetCreateTime
func (x *Changelog) GetCreateTime() *timestamppb.Timestampfunc (*Changelog) GetDependentResources
func (*Changelog) GetDescription
func (*Changelog) GetDisplayName
func (*Changelog) GetName
func (*Changelog) GetNewResource
func (*Changelog) GetOriginalResource
func (*Changelog) GetResource
func (*Changelog) GetResourceType
func (*Changelog) GetSequenceNumber
func (*Changelog) ProtoMessage
func (*Changelog) ProtoMessage()func (*Changelog) ProtoReflect
func (x *Changelog) ProtoReflect() protoreflect.Messagefunc (*Changelog) Reset
func (x *Changelog) Reset()func (*Changelog) String
ChannelProfile
type ChannelProfile struct {
// Optional. The unique identifier of the channel profile.
ProfileId string `protobuf:"bytes,1,opt,name=profile_id,json=profileId,proto3" json:"profile_id,omitempty"`
// Optional. The type of the channel profile.
ChannelType ChannelProfile_ChannelType `protobuf:"varint,3,opt,name=channel_type,json=channelType,proto3,enum=google.cloud.ces.v1.ChannelProfile_ChannelType" json:"channel_type,omitempty"`
// Optional. The persona property of the channel profile.
PersonaProperty *ChannelProfile_PersonaProperty `protobuf:"bytes,2,opt,name=persona_property,json=personaProperty,proto3" json:"persona_property,omitempty"`
// Optional. Whether to disable DTMF (dual-tone multi-frequency).
DisableDtmf bool `protobuf:"varint,4,opt,name=disable_dtmf,json=disableDtmf,proto3" json:"disable_dtmf,omitempty"`
// Optional. Whether to disable user barge-in control in the conversation.
// - **true**: User interruptions are disabled while the agent is speaking.
// - **false**: The agent retains automatic control over when the user can
// interrupt.
DisableBargeInControl bool `protobuf:"varint,5,opt,name=disable_barge_in_control,json=disableBargeInControl,proto3" json:"disable_barge_in_control,omitempty"`
// Optional. The configuration for the web widget.
WebWidgetConfig *ChannelProfile_WebWidgetConfig `protobuf:"bytes,7,opt,name=web_widget_config,json=webWidgetConfig,proto3" json:"web_widget_config,omitempty"`
// Optional. The noise suppression level of the channel profile.
// Available values are "low", "moderate", "high", "very_high".
NoiseSuppressionLevel string `protobuf:"bytes,8,opt,name=noise_suppression_level,json=noiseSuppressionLevel,proto3" json:"noise_suppression_level,omitempty"`
// contains filtered or unexported fields
}A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.
func (*ChannelProfile) Descriptor
func (*ChannelProfile) Descriptor() ([]byte, []int)Deprecated: Use ChannelProfile.ProtoReflect.Descriptor instead.
func (*ChannelProfile) GetChannelType
func (x *ChannelProfile) GetChannelType() ChannelProfile_ChannelTypefunc (*ChannelProfile) GetDisableBargeInControl
func (x *ChannelProfile) GetDisableBargeInControl() boolfunc (*ChannelProfile) GetDisableDtmf
func (x *ChannelProfile) GetDisableDtmf() boolfunc (*ChannelProfile) GetNoiseSuppressionLevel
func (x *ChannelProfile) GetNoiseSuppressionLevel() stringfunc (*ChannelProfile) GetPersonaProperty
func (x *ChannelProfile) GetPersonaProperty() *ChannelProfile_PersonaPropertyfunc (*ChannelProfile) GetProfileId
func (x *ChannelProfile) GetProfileId() stringfunc (*ChannelProfile) GetWebWidgetConfig
func (x *ChannelProfile) GetWebWidgetConfig() *ChannelProfile_WebWidgetConfigfunc (*ChannelProfile) ProtoMessage
func (*ChannelProfile) ProtoMessage()func (*ChannelProfile) ProtoReflect
func (x *ChannelProfile) ProtoReflect() protoreflect.Messagefunc (*ChannelProfile) Reset
func (x *ChannelProfile) Reset()func (*ChannelProfile) String
func (x *ChannelProfile) String() stringChannelProfile_ChannelType
type ChannelProfile_ChannelType int32The type of the channel profile.
ChannelProfile_UNKNOWN, ChannelProfile_WEB_UI, ChannelProfile_API, ChannelProfile_TWILIO, ChannelProfile_GOOGLE_TELEPHONY_PLATFORM, ChannelProfile_CONTACT_CENTER_AS_A_SERVICE, ChannelProfile_FIVE9, ChannelProfile_CONTACT_CENTER_INTEGRATION
const (
// Unknown channel type.
ChannelProfile_UNKNOWN ChannelProfile_ChannelType = 0
// Web UI channel.
ChannelProfile_WEB_UI ChannelProfile_ChannelType = 2
// API channel.
ChannelProfile_API ChannelProfile_ChannelType = 3
// Twilio channel.
ChannelProfile_TWILIO ChannelProfile_ChannelType = 4
// Google Telephony Platform channel.
ChannelProfile_GOOGLE_TELEPHONY_PLATFORM ChannelProfile_ChannelType = 5
// Contact Center as a Service (CCaaS) channel.
ChannelProfile_CONTACT_CENTER_AS_A_SERVICE ChannelProfile_ChannelType = 6
// Five9 channel.
ChannelProfile_FIVE9 ChannelProfile_ChannelType = 7
// Third party contact center integration channel.
ChannelProfile_CONTACT_CENTER_INTEGRATION ChannelProfile_ChannelType = 8
)func (ChannelProfile_ChannelType) Descriptor
func (ChannelProfile_ChannelType) Descriptor() protoreflect.EnumDescriptorfunc (ChannelProfile_ChannelType) Enum
func (x ChannelProfile_ChannelType) Enum() *ChannelProfile_ChannelTypefunc (ChannelProfile_ChannelType) EnumDescriptor
func (ChannelProfile_ChannelType) EnumDescriptor() ([]byte, []int)Deprecated: Use ChannelProfile_ChannelType.Descriptor instead.
func (ChannelProfile_ChannelType) Number
func (x ChannelProfile_ChannelType) Number() protoreflect.EnumNumberfunc (ChannelProfile_ChannelType) String
func (x ChannelProfile_ChannelType) String() stringfunc (ChannelProfile_ChannelType) Type
func (ChannelProfile_ChannelType) Type() protoreflect.EnumTypeChannelProfile_PersonaProperty
type ChannelProfile_PersonaProperty struct {
// Optional. The persona of the channel.
Persona ChannelProfile_PersonaProperty_Persona `protobuf:"varint,1,opt,name=persona,proto3,enum=google.cloud.ces.v1.ChannelProfile_PersonaProperty_Persona" json:"persona,omitempty"`
// contains filtered or unexported fields
}Represents the persona property of a channel.
func (*ChannelProfile_PersonaProperty) Descriptor
func (*ChannelProfile_PersonaProperty) Descriptor() ([]byte, []int)Deprecated: Use ChannelProfile_PersonaProperty.ProtoReflect.Descriptor instead.
func (*ChannelProfile_PersonaProperty) GetPersona
func (x *ChannelProfile_PersonaProperty) GetPersona() ChannelProfile_PersonaProperty_Personafunc (*ChannelProfile_PersonaProperty) ProtoMessage
func (*ChannelProfile_PersonaProperty) ProtoMessage()func (*ChannelProfile_PersonaProperty) ProtoReflect
func (x *ChannelProfile_PersonaProperty) ProtoReflect() protoreflect.Messagefunc (*ChannelProfile_PersonaProperty) Reset
func (x *ChannelProfile_PersonaProperty) Reset()func (*ChannelProfile_PersonaProperty) String
func (x *ChannelProfile_PersonaProperty) String() stringChannelProfile_PersonaProperty_Persona
type ChannelProfile_PersonaProperty_Persona int32The persona of the channel.
ChannelProfile_PersonaProperty_UNKNOWN, ChannelProfile_PersonaProperty_CONCISE, ChannelProfile_PersonaProperty_CHATTY
const (
// UNKNOWN persona.
ChannelProfile_PersonaProperty_UNKNOWN ChannelProfile_PersonaProperty_Persona = 0
// The agent keeps the responses concise and to the point
ChannelProfile_PersonaProperty_CONCISE ChannelProfile_PersonaProperty_Persona = 1
// The agent provides additional context, explanations, and details
ChannelProfile_PersonaProperty_CHATTY ChannelProfile_PersonaProperty_Persona = 2
)func (ChannelProfile_PersonaProperty_Persona) Descriptor
func (ChannelProfile_PersonaProperty_Persona) Descriptor() protoreflect.EnumDescriptorfunc (ChannelProfile_PersonaProperty_Persona) Enum
func (ChannelProfile_PersonaProperty_Persona) EnumDescriptor
func (ChannelProfile_PersonaProperty_Persona) EnumDescriptor() ([]byte, []int)Deprecated: Use ChannelProfile_PersonaProperty_Persona.Descriptor instead.
func (ChannelProfile_PersonaProperty_Persona) Number
func (x ChannelProfile_PersonaProperty_Persona) Number() protoreflect.EnumNumberfunc (ChannelProfile_PersonaProperty_Persona) String
func (x ChannelProfile_PersonaProperty_Persona) String() stringfunc (ChannelProfile_PersonaProperty_Persona) Type
func (ChannelProfile_PersonaProperty_Persona) Type() protoreflect.EnumTypeChannelProfile_WebWidgetConfig
type ChannelProfile_WebWidgetConfig struct {
// Optional. The modality of the web widget.
Modality ChannelProfile_WebWidgetConfig_Modality `protobuf:"varint,1,opt,name=modality,proto3,enum=google.cloud.ces.v1.ChannelProfile_WebWidgetConfig_Modality" json:"modality,omitempty"`
// Optional. The theme of the web widget.
Theme ChannelProfile_WebWidgetConfig_Theme `protobuf:"varint,2,opt,name=theme,proto3,enum=google.cloud.ces.v1.ChannelProfile_WebWidgetConfig_Theme" json:"theme,omitempty"`
// Optional. The title of the web widget.
WebWidgetTitle string `protobuf:"bytes,3,opt,name=web_widget_title,json=webWidgetTitle,proto3" json:"web_widget_title,omitempty"`
// Optional. The security settings of the web widget.
SecuritySettings *ChannelProfile_WebWidgetConfig_SecuritySettings `protobuf:"bytes,4,opt,name=security_settings,json=securitySettings,proto3" json:"security_settings,omitempty"`
// contains filtered or unexported fields
}Message for configuration for the web widget.
func (*ChannelProfile_WebWidgetConfig) Descriptor
func (*ChannelProfile_WebWidgetConfig) Descriptor() ([]byte, []int)Deprecated: Use ChannelProfile_WebWidgetConfig.ProtoReflect.Descriptor instead.
func (*ChannelProfile_WebWidgetConfig) GetModality
func (x *ChannelProfile_WebWidgetConfig) GetModality() ChannelProfile_WebWidgetConfig_Modalityfunc (*ChannelProfile_WebWidgetConfig) GetSecuritySettings
func (x *ChannelProfile_WebWidgetConfig) GetSecuritySettings() *ChannelProfile_WebWidgetConfig_SecuritySettingsfunc (*ChannelProfile_WebWidgetConfig) GetTheme
func (x *ChannelProfile_WebWidgetConfig) GetTheme() ChannelProfile_WebWidgetConfig_Themefunc (*ChannelProfile_WebWidgetConfig) GetWebWidgetTitle
func (x *ChannelProfile_WebWidgetConfig) GetWebWidgetTitle() stringfunc (*ChannelProfile_WebWidgetConfig) ProtoMessage
func (*ChannelProfile_WebWidgetConfig) ProtoMessage()func (*ChannelProfile_WebWidgetConfig) ProtoReflect
func (x *ChannelProfile_WebWidgetConfig) ProtoReflect() protoreflect.Messagefunc (*ChannelProfile_WebWidgetConfig) Reset
func (x *ChannelProfile_WebWidgetConfig) Reset()func (*ChannelProfile_WebWidgetConfig) String
func (x *ChannelProfile_WebWidgetConfig) String() stringChannelProfile_WebWidgetConfig_Modality
type ChannelProfile_WebWidgetConfig_Modality int32Modality of the web widget.
ChannelProfile_WebWidgetConfig_MODALITY_UNSPECIFIED, ChannelProfile_WebWidgetConfig_CHAT_AND_VOICE, ChannelProfile_WebWidgetConfig_VOICE_ONLY, ChannelProfile_WebWidgetConfig_CHAT_ONLY, ChannelProfile_WebWidgetConfig_CHAT_VOICE_AND_VIDEO
const (
// Unknown modality.
ChannelProfile_WebWidgetConfig_MODALITY_UNSPECIFIED ChannelProfile_WebWidgetConfig_Modality = 0
// Widget supports both chat and voice input.
ChannelProfile_WebWidgetConfig_CHAT_AND_VOICE ChannelProfile_WebWidgetConfig_Modality = 1
// Widget supports only voice input.
ChannelProfile_WebWidgetConfig_VOICE_ONLY ChannelProfile_WebWidgetConfig_Modality = 2
// Widget supports only chat input.
ChannelProfile_WebWidgetConfig_CHAT_ONLY ChannelProfile_WebWidgetConfig_Modality = 3
// Widget supports chat, voice, and video input.
ChannelProfile_WebWidgetConfig_CHAT_VOICE_AND_VIDEO ChannelProfile_WebWidgetConfig_Modality = 4
)func (ChannelProfile_WebWidgetConfig_Modality) Descriptor
func (ChannelProfile_WebWidgetConfig_Modality) Descriptor() protoreflect.EnumDescriptorfunc (ChannelProfile_WebWidgetConfig_Modality) Enum
func (ChannelProfile_WebWidgetConfig_Modality) EnumDescriptor
func (ChannelProfile_WebWidgetConfig_Modality) EnumDescriptor() ([]byte, []int)Deprecated: Use ChannelProfile_WebWidgetConfig_Modality.Descriptor instead.
func (ChannelProfile_WebWidgetConfig_Modality) Number
func (x ChannelProfile_WebWidgetConfig_Modality) Number() protoreflect.EnumNumberfunc (ChannelProfile_WebWidgetConfig_Modality) String
func (x ChannelProfile_WebWidgetConfig_Modality) String() stringfunc (ChannelProfile_WebWidgetConfig_Modality) Type
func (ChannelProfile_WebWidgetConfig_Modality) Type() protoreflect.EnumTypeChannelProfile_WebWidgetConfig_SecuritySettings
type ChannelProfile_WebWidgetConfig_SecuritySettings struct {
// Optional. Indicates whether public access to the web widget is enabled.
// If `true`, the web widget will be publicly accessible.
// If `false`, the web widget must be integrated with your own
// authentication and authorization system to return valid credentials for
// accessing the CES agent.
EnablePublicAccess bool `protobuf:"varint,1,opt,name=enable_public_access,json=enablePublicAccess,proto3" json:"enable_public_access,omitempty"`
// Optional. Indicates whether origin check for the web widget is enabled.
// If `true`, the web widget will check the origin of the website that
// loads the web widget and only allow it to be loaded in the same origin
// or any of the allowed origins.
EnableOriginCheck bool `protobuf:"varint,4,opt,name=enable_origin_check,json=enableOriginCheck,proto3" json:"enable_origin_check,omitempty"`
// Optional. The origins that are allowed to host the web widget. An
// origin is defined by RFC 6454. If empty, all origins are allowed. A
// maximum of 100 origins is allowed. Example: "https://example.com"
AllowedOrigins []string `protobuf:"bytes,2,rep,name=allowed_origins,json=allowedOrigins,proto3" json:"allowed_origins,omitempty"`
// Optional. Indicates whether reCAPTCHA verification for the web widget
// is enabled.
EnableRecaptcha bool `protobuf:"varint,3,opt,name=enable_recaptcha,json=enableRecaptcha,proto3" json:"enable_recaptcha,omitempty"`
// contains filtered or unexported fields
}Security settings for the web widget.
func (*ChannelProfile_WebWidgetConfig_SecuritySettings) Descriptor
func (*ChannelProfile_WebWidgetConfig_SecuritySettings) Descriptor() ([]byte, []int)Deprecated: Use ChannelProfile_WebWidgetConfig_SecuritySettings.ProtoReflect.Descriptor instead.
func (*ChannelProfile_WebWidgetConfig_SecuritySettings) GetAllowedOrigins
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) GetAllowedOrigins() []stringfunc (*ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnableOriginCheck
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnableOriginCheck() boolfunc (*ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnablePublicAccess
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnablePublicAccess() boolfunc (*ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnableRecaptcha
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) GetEnableRecaptcha() boolfunc (*ChannelProfile_WebWidgetConfig_SecuritySettings) ProtoMessage
func (*ChannelProfile_WebWidgetConfig_SecuritySettings) ProtoMessage()func (*ChannelProfile_WebWidgetConfig_SecuritySettings) ProtoReflect
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) ProtoReflect() protoreflect.Messagefunc (*ChannelProfile_WebWidgetConfig_SecuritySettings) Reset
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) Reset()func (*ChannelProfile_WebWidgetConfig_SecuritySettings) String
func (x *ChannelProfile_WebWidgetConfig_SecuritySettings) String() stringChannelProfile_WebWidgetConfig_Theme
type ChannelProfile_WebWidgetConfig_Theme int32Theme of the web widget.
ChannelProfile_WebWidgetConfig_THEME_UNSPECIFIED, ChannelProfile_WebWidgetConfig_LIGHT, ChannelProfile_WebWidgetConfig_DARK
const (
// Unknown theme.
ChannelProfile_WebWidgetConfig_THEME_UNSPECIFIED ChannelProfile_WebWidgetConfig_Theme = 0
// Light theme.
ChannelProfile_WebWidgetConfig_LIGHT ChannelProfile_WebWidgetConfig_Theme = 1
// Dark theme.
ChannelProfile_WebWidgetConfig_DARK ChannelProfile_WebWidgetConfig_Theme = 2
)func (ChannelProfile_WebWidgetConfig_Theme) Descriptor
func (ChannelProfile_WebWidgetConfig_Theme) Descriptor() protoreflect.EnumDescriptorfunc (ChannelProfile_WebWidgetConfig_Theme) Enum
func (x ChannelProfile_WebWidgetConfig_Theme) Enum() *ChannelProfile_WebWidgetConfig_Themefunc (ChannelProfile_WebWidgetConfig_Theme) EnumDescriptor
func (ChannelProfile_WebWidgetConfig_Theme) EnumDescriptor() ([]byte, []int)Deprecated: Use ChannelProfile_WebWidgetConfig_Theme.Descriptor instead.
func (ChannelProfile_WebWidgetConfig_Theme) Number
func (x ChannelProfile_WebWidgetConfig_Theme) Number() protoreflect.EnumNumberfunc (ChannelProfile_WebWidgetConfig_Theme) String
func (x ChannelProfile_WebWidgetConfig_Theme) String() stringfunc (ChannelProfile_WebWidgetConfig_Theme) Type
func (ChannelProfile_WebWidgetConfig_Theme) Type() protoreflect.EnumTypeChunk
type Chunk struct {
// Chunk data.
//
// Types that are valid to be assigned to Data:
//
// *Chunk_Text
// *Chunk_Transcript
// *Chunk_Blob
// *Chunk_Payload
// *Chunk_Image
// *Chunk_ToolCall
// *Chunk_ToolResponse
// *Chunk_AgentTransfer
// *Chunk_UpdatedVariables
// *Chunk_DefaultVariables
Data isChunk_Data `protobuf_oneof:"data"`
// contains filtered or unexported fields
}A chunk of content within a message.
func (*Chunk) Descriptor
Deprecated: Use Chunk.ProtoReflect.Descriptor instead.
func (*Chunk) GetAgentTransfer
func (x *Chunk) GetAgentTransfer() *AgentTransferfunc (*Chunk) GetBlob
func (*Chunk) GetData
func (x *Chunk) GetData() isChunk_Datafunc (*Chunk) GetDefaultVariables
func (*Chunk) GetImage
func (*Chunk) GetPayload
func (*Chunk) GetText
func (*Chunk) GetToolCall
func (*Chunk) GetToolResponse
func (x *Chunk) GetToolResponse() *ToolResponsefunc (*Chunk) GetTranscript
func (*Chunk) GetUpdatedVariables
func (*Chunk) ProtoMessage
func (*Chunk) ProtoMessage()func (*Chunk) ProtoReflect
func (x *Chunk) ProtoReflect() protoreflect.Messagefunc (*Chunk) Reset
func (x *Chunk) Reset()func (*Chunk) String
Chunk_AgentTransfer
type Chunk_AgentTransfer struct {
// Optional. Agent transfer event.
AgentTransfer *AgentTransfer `protobuf:"bytes,4,opt,name=agent_transfer,json=agentTransfer,proto3,oneof"`
}Chunk_Blob
type Chunk_Blob struct {
// Optional. Blob data.
Blob *Blob `protobuf:"bytes,7,opt,name=blob,proto3,oneof"`
}Chunk_DefaultVariables
type Chunk_DefaultVariables struct {
// A struct represents default variables at the start of the conversation,
// keyed by variable names.
DefaultVariables *structpb.Struct `protobuf:"bytes,10,opt,name=default_variables,json=defaultVariables,proto3,oneof"`
}Chunk_Image
type Chunk_Image struct {
// Optional. Image data.
Image *Image `protobuf:"bytes,5,opt,name=image,proto3,oneof"`
}Chunk_Payload
type Chunk_Payload struct {
// Optional. Custom payload data.
Payload *structpb.Struct `protobuf:"bytes,11,opt,name=payload,proto3,oneof"`
}Chunk_Text
type Chunk_Text struct {
// Optional. Text data.
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}Chunk_ToolCall
type Chunk_ToolCall struct {
// Optional. Tool execution request.
ToolCall *ToolCall `protobuf:"bytes,2,opt,name=tool_call,json=toolCall,proto3,oneof"`
}Chunk_ToolResponse
type Chunk_ToolResponse struct {
// Optional. Tool execution response.
ToolResponse *ToolResponse `protobuf:"bytes,3,opt,name=tool_response,json=toolResponse,proto3,oneof"`
}Chunk_Transcript
type Chunk_Transcript struct {
// Optional. Transcript associated with the audio.
Transcript string `protobuf:"bytes,9,opt,name=transcript,proto3,oneof"`
}Chunk_UpdatedVariables
type Chunk_UpdatedVariables struct {
// A struct represents variables that were updated in the conversation,
// keyed by variable names.
UpdatedVariables *structpb.Struct `protobuf:"bytes,8,opt,name=updated_variables,json=updatedVariables,proto3,oneof"`
}Citations
type Citations struct {
// List of cited pieces of information.
CitedChunks []*Citations_CitedChunk `protobuf:"bytes,1,rep,name=cited_chunks,json=citedChunks,proto3" json:"cited_chunks,omitempty"`
// contains filtered or unexported fields
}Citations associated with the agent response.
func (*Citations) Descriptor
Deprecated: Use Citations.ProtoReflect.Descriptor instead.
func (*Citations) GetCitedChunks
func (x *Citations) GetCitedChunks() []*Citations_CitedChunkfunc (*Citations) ProtoMessage
func (*Citations) ProtoMessage()func (*Citations) ProtoReflect
func (x *Citations) ProtoReflect() protoreflect.Messagefunc (*Citations) Reset
func (x *Citations) Reset()func (*Citations) String
Citations_CitedChunk
type Citations_CitedChunk struct {
// URI used for citation.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// Title of the cited document.
Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
// Text used for citation.
Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
// contains filtered or unexported fields
}Piece of cited information.
func (*Citations_CitedChunk) Descriptor
func (*Citations_CitedChunk) Descriptor() ([]byte, []int)Deprecated: Use Citations_CitedChunk.ProtoReflect.Descriptor instead.
func (*Citations_CitedChunk) GetText
func (x *Citations_CitedChunk) GetText() stringfunc (*Citations_CitedChunk) GetTitle
func (x *Citations_CitedChunk) GetTitle() stringfunc (*Citations_CitedChunk) GetUri
func (x *Citations_CitedChunk) GetUri() stringfunc (*Citations_CitedChunk) ProtoMessage
func (*Citations_CitedChunk) ProtoMessage()func (*Citations_CitedChunk) ProtoReflect
func (x *Citations_CitedChunk) ProtoReflect() protoreflect.Messagefunc (*Citations_CitedChunk) Reset
func (x *Citations_CitedChunk) Reset()func (*Citations_CitedChunk) String
func (x *Citations_CitedChunk) String() stringClientCertificateSettings
type ClientCertificateSettings struct {
// Required. The TLS certificate encoded in PEM format. This string must
// include the begin header and end footer lines.
TlsCertificate string `protobuf:"bytes,1,opt,name=tls_certificate,json=tlsCertificate,proto3" json:"tls_certificate,omitempty"`
// Required. The name of the SecretManager secret version resource storing the
// private key encoded in PEM format.
// Format: `projects/{project}/secrets/{secret}/versions/{version}`
PrivateKey string `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
// Optional. The name of the SecretManager secret version resource storing the
// passphrase to decrypt the private key. Should be left unset if the private
// key is not encrypted.
// Format: `projects/{project}/secrets/{secret}/versions/{version}`
Passphrase string `protobuf:"bytes,3,opt,name=passphrase,proto3" json:"passphrase,omitempty"`
// contains filtered or unexported fields
}Settings for custom client certificates.
func (*ClientCertificateSettings) Descriptor
func (*ClientCertificateSettings) Descriptor() ([]byte, []int)Deprecated: Use ClientCertificateSettings.ProtoReflect.Descriptor instead.
func (*ClientCertificateSettings) GetPassphrase
func (x *ClientCertificateSettings) GetPassphrase() stringfunc (*ClientCertificateSettings) GetPrivateKey
func (x *ClientCertificateSettings) GetPrivateKey() stringfunc (*ClientCertificateSettings) GetTlsCertificate
func (x *ClientCertificateSettings) GetTlsCertificate() stringfunc (*ClientCertificateSettings) ProtoMessage
func (*ClientCertificateSettings) ProtoMessage()func (*ClientCertificateSettings) ProtoReflect
func (x *ClientCertificateSettings) ProtoReflect() protoreflect.Messagefunc (*ClientCertificateSettings) Reset
func (x *ClientCertificateSettings) Reset()func (*ClientCertificateSettings) String
func (x *ClientCertificateSettings) String() stringClientFunction
type ClientFunction struct {
// Required. The function name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The function description.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The schema of the function parameters.
Parameters *Schema `protobuf:"bytes,3,opt,name=parameters,proto3" json:"parameters,omitempty"`
// Optional. The schema of the function response.
Response *Schema `protobuf:"bytes,4,opt,name=response,proto3" json:"response,omitempty"`
// contains filtered or unexported fields
}Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a [ToolResponse][google.cloud.ces.v1.ToolResponse] to continue the interaction with the agent.
func (*ClientFunction) Descriptor
func (*ClientFunction) Descriptor() ([]byte, []int)Deprecated: Use ClientFunction.ProtoReflect.Descriptor instead.
func (*ClientFunction) GetDescription
func (x *ClientFunction) GetDescription() stringfunc (*ClientFunction) GetName
func (x *ClientFunction) GetName() stringfunc (*ClientFunction) GetParameters
func (x *ClientFunction) GetParameters() *Schemafunc (*ClientFunction) GetResponse
func (x *ClientFunction) GetResponse() *Schemafunc (*ClientFunction) ProtoMessage
func (*ClientFunction) ProtoMessage()func (*ClientFunction) ProtoReflect
func (x *ClientFunction) ProtoReflect() protoreflect.Messagefunc (*ClientFunction) Reset
func (x *ClientFunction) Reset()func (*ClientFunction) String
func (x *ClientFunction) String() stringCloudLoggingSettings
type CloudLoggingSettings struct {
// Optional. Whether to enable Cloud Logging for the sessions.
EnableCloudLogging bool `protobuf:"varint,1,opt,name=enable_cloud_logging,json=enableCloudLogging,proto3" json:"enable_cloud_logging,omitempty"`
// contains filtered or unexported fields
}Settings to describe the Cloud Logging behaviors for the app.
func (*CloudLoggingSettings) Descriptor
func (*CloudLoggingSettings) Descriptor() ([]byte, []int)Deprecated: Use CloudLoggingSettings.ProtoReflect.Descriptor instead.
func (*CloudLoggingSettings) GetEnableCloudLogging
func (x *CloudLoggingSettings) GetEnableCloudLogging() boolfunc (*CloudLoggingSettings) ProtoMessage
func (*CloudLoggingSettings) ProtoMessage()func (*CloudLoggingSettings) ProtoReflect
func (x *CloudLoggingSettings) ProtoReflect() protoreflect.Messagefunc (*CloudLoggingSettings) Reset
func (x *CloudLoggingSettings) Reset()func (*CloudLoggingSettings) String
func (x *CloudLoggingSettings) String() stringCodeBlock
type CodeBlock struct {
// Required. Python code which will be invoked in tool fake mode.
// Expected Python function signature -
// To catch all tool calls:
//
// def fake_tool_call(tool: Tool, input: dict[str, Any],
// callback_context: CallbackContext) -> Optional[dict[str, Any]]:
//
// To catch a specific tool call:
//
// def fake_{tool_id}(tool: Tool, input: dict[str, Any],
// callback_context: CallbackContext) -> Optional[dict[str, Any]]:
//
// If the function returns None, the real tool will be invoked instead.
PythonCode string `protobuf:"bytes,1,opt,name=python_code,json=pythonCode,proto3" json:"python_code,omitempty"`
// contains filtered or unexported fields
}A code block to be executed instead of a real tool call.
func (*CodeBlock) Descriptor
Deprecated: Use CodeBlock.ProtoReflect.Descriptor instead.
func (*CodeBlock) GetPythonCode
func (*CodeBlock) ProtoMessage
func (*CodeBlock) ProtoMessage()func (*CodeBlock) ProtoReflect
func (x *CodeBlock) ProtoReflect() protoreflect.Messagefunc (*CodeBlock) Reset
func (x *CodeBlock) Reset()func (*CodeBlock) String
ConnectorTool
type ConnectorTool struct {
// Required. The full resource name of the referenced Integration Connectors
// Connection.
// Format:
// `projects/{project}/locations/{location}/connections/{connection}`
Connection string `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
// Required. Action for the tool to use.
Action *Action `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
// Optional. Configures how authentication is handled in Integration
// Connectors. By default, an admin authentication is passed in the
// Integration Connectors API requests. You can override it with a different
// end-user authentication config.
// **Note**: The Connection must have authentication override enabled in
// order to specify an EUC configuration here - otherwise, the ConnectorTool
// creation will fail. See
// https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
// for details.
AuthConfig *EndUserAuthConfig `protobuf:"bytes,3,opt,name=auth_config,json=authConfig,proto3" json:"auth_config,omitempty"`
// Optional. The name of the tool that can be used by the Agent to decide
// whether to call this ConnectorTool.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The description of the tool that can be used by the Agent to
// decide whether to call this ConnectorTool.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.
func (*ConnectorTool) Descriptor
func (*ConnectorTool) Descriptor() ([]byte, []int)Deprecated: Use ConnectorTool.ProtoReflect.Descriptor instead.
func (*ConnectorTool) GetAction
func (x *ConnectorTool) GetAction() *Actionfunc (*ConnectorTool) GetAuthConfig
func (x *ConnectorTool) GetAuthConfig() *EndUserAuthConfigfunc (*ConnectorTool) GetConnection
func (x *ConnectorTool) GetConnection() stringfunc (*ConnectorTool) GetDescription
func (x *ConnectorTool) GetDescription() stringfunc (*ConnectorTool) GetName
func (x *ConnectorTool) GetName() stringfunc (*ConnectorTool) ProtoMessage
func (*ConnectorTool) ProtoMessage()func (*ConnectorTool) ProtoReflect
func (x *ConnectorTool) ProtoReflect() protoreflect.Messagefunc (*ConnectorTool) Reset
func (x *ConnectorTool) Reset()func (*ConnectorTool) String
func (x *ConnectorTool) String() stringConnectorToolset
type ConnectorToolset struct {
// Required. The full resource name of the referenced Integration Connectors
// Connection.
// Format:
// `projects/{project}/locations/{location}/connections/{connection}`
Connection string `protobuf:"bytes,1,opt,name=connection,proto3" json:"connection,omitempty"`
// Optional. Configures how authentication is handled in Integration
// Connectors. By default, an admin authentication is passed in the
// Integration Connectors API requests. You can override it with a different
// end-user authentication config.
// **Note**: The Connection must have authentication override enabled in
// order to specify an EUC configuration here - otherwise, the Toolset
// creation will fail. See:
// https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
AuthConfig *EndUserAuthConfig `protobuf:"bytes,2,opt,name=auth_config,json=authConfig,proto3" json:"auth_config,omitempty"`
// Required. The list of connector actions/entity operations to generate tools
// for.
ConnectorActions []*Action `protobuf:"bytes,3,rep,name=connector_actions,json=connectorActions,proto3" json:"connector_actions,omitempty"`
// contains filtered or unexported fields
}A toolset that generates tools from an Integration Connectors Connection.
func (*ConnectorToolset) Descriptor
func (*ConnectorToolset) Descriptor() ([]byte, []int)Deprecated: Use ConnectorToolset.ProtoReflect.Descriptor instead.
func (*ConnectorToolset) GetAuthConfig
func (x *ConnectorToolset) GetAuthConfig() *EndUserAuthConfigfunc (*ConnectorToolset) GetConnection
func (x *ConnectorToolset) GetConnection() stringfunc (*ConnectorToolset) GetConnectorActions
func (x *ConnectorToolset) GetConnectorActions() []*Actionfunc (*ConnectorToolset) ProtoMessage
func (*ConnectorToolset) ProtoMessage()func (*ConnectorToolset) ProtoReflect
func (x *ConnectorToolset) ProtoReflect() protoreflect.Messagefunc (*ConnectorToolset) Reset
func (x *ConnectorToolset) Reset()func (*ConnectorToolset) String
func (x *ConnectorToolset) String() stringConversation
type Conversation struct {
// Identifier. The unique identifier of the conversation.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Timestamp when the conversation was created.
StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. Timestamp when the conversation was completed.
EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Required. The turns in the conversation.
Turns []*Conversation_Turn `protobuf:"bytes,6,rep,name=turns,proto3" json:"turns,omitempty"`
// Output only. The number of turns in the conversation.
TurnCount int32 `protobuf:"varint,7,opt,name=turn_count,json=turnCount,proto3" json:"turn_count,omitempty"`
// DEPRECATED. Please use
// [input_types][google.cloud.ces.v1.Conversation.input_types] instead.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/conversation.proto.
ChannelType Conversation_ChannelType `protobuf:"varint,8,opt,name=channel_type,json=channelType,proto3,enum=google.cloud.ces.v1.Conversation_ChannelType" json:"channel_type,omitempty"`
// Output only. Indicate the source of the conversation.
Source Conversation_Source `protobuf:"varint,9,opt,name=source,proto3,enum=google.cloud.ces.v1.Conversation_Source" json:"source,omitempty"`
// Output only. The input types of the conversation.
InputTypes []Conversation_InputType `protobuf:"varint,10,rep,packed,name=input_types,json=inputTypes,proto3,enum=google.cloud.ces.v1.Conversation_InputType" json:"input_types,omitempty"`
// Output only. The agent that initially handles the conversation. If not
// specified, the conversation is handled by the root agent. Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
EntryAgent string `protobuf:"bytes,11,opt,name=entry_agent,json=entryAgent,proto3" json:"entry_agent,omitempty"`
// Output only. The deployment of the app used for processing the
// conversation. Format:
// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Deployment string `protobuf:"bytes,12,opt,name=deployment,proto3" json:"deployment,omitempty"`
// Output only. The version of the app used for processing the conversation.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
AppVersion string `protobuf:"bytes,13,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
// Output only. The language code of the conversation.
LanguageCode string `protobuf:"bytes,14,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Deprecated. Use turns instead.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/conversation.proto.
Messages []*Message `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
// contains filtered or unexported fields
}A conversation represents an interaction between an end user and the CES app.
func (*Conversation) Descriptor
func (*Conversation) Descriptor() ([]byte, []int)Deprecated: Use Conversation.ProtoReflect.Descriptor instead.
func (*Conversation) GetAppVersion
func (x *Conversation) GetAppVersion() stringfunc (*Conversation) GetChannelType
func (x *Conversation) GetChannelType() Conversation_ChannelTypeDeprecated: Marked as deprecated in google/cloud/ces/v1/conversation.proto.
func (*Conversation) GetDeployment
func (x *Conversation) GetDeployment() stringfunc (*Conversation) GetEndTime
func (x *Conversation) GetEndTime() *timestamppb.Timestampfunc (*Conversation) GetEntryAgent
func (x *Conversation) GetEntryAgent() stringfunc (*Conversation) GetInputTypes
func (x *Conversation) GetInputTypes() []Conversation_InputTypefunc (*Conversation) GetLanguageCode
func (x *Conversation) GetLanguageCode() stringfunc (*Conversation) GetMessages
func (x *Conversation) GetMessages() []*MessageDeprecated: Marked as deprecated in google/cloud/ces/v1/conversation.proto.
func (*Conversation) GetName
func (x *Conversation) GetName() stringfunc (*Conversation) GetSource
func (x *Conversation) GetSource() Conversation_Sourcefunc (*Conversation) GetStartTime
func (x *Conversation) GetStartTime() *timestamppb.Timestampfunc (*Conversation) GetTurnCount
func (x *Conversation) GetTurnCount() int32func (*Conversation) GetTurns
func (x *Conversation) GetTurns() []*Conversation_Turnfunc (*Conversation) ProtoMessage
func (*Conversation) ProtoMessage()func (*Conversation) ProtoReflect
func (x *Conversation) ProtoReflect() protoreflect.Messagefunc (*Conversation) Reset
func (x *Conversation) Reset()func (*Conversation) String
func (x *Conversation) String() stringConversationLoggingSettings
type ConversationLoggingSettings struct {
// Optional. Whether to disable conversation logging for the sessions.
DisableConversationLogging bool `protobuf:"varint,1,opt,name=disable_conversation_logging,json=disableConversationLogging,proto3" json:"disable_conversation_logging,omitempty"`
// contains filtered or unexported fields
}Settings to describe the conversation logging behaviors for the app.
func (*ConversationLoggingSettings) Descriptor
func (*ConversationLoggingSettings) Descriptor() ([]byte, []int)Deprecated: Use ConversationLoggingSettings.ProtoReflect.Descriptor instead.
func (*ConversationLoggingSettings) GetDisableConversationLogging
func (x *ConversationLoggingSettings) GetDisableConversationLogging() boolfunc (*ConversationLoggingSettings) ProtoMessage
func (*ConversationLoggingSettings) ProtoMessage()func (*ConversationLoggingSettings) ProtoReflect
func (x *ConversationLoggingSettings) ProtoReflect() protoreflect.Messagefunc (*ConversationLoggingSettings) Reset
func (x *ConversationLoggingSettings) Reset()func (*ConversationLoggingSettings) String
func (x *ConversationLoggingSettings) String() stringConversation_ChannelType
type Conversation_ChannelType int32The channel type of the conversation.
Conversation_CHANNEL_TYPE_UNSPECIFIED, Conversation_TEXT, Conversation_AUDIO, Conversation_MULTIMODAL
const (
// Unspecified channel type.
Conversation_CHANNEL_TYPE_UNSPECIFIED Conversation_ChannelType = 0
// The conversation only contains text messages between the end user and the
// agent.
Conversation_TEXT Conversation_ChannelType = 1
// The conversation contains audio messages between the end user and the
// agent.
Conversation_AUDIO Conversation_ChannelType = 2
// The conversation multi-modal messages (e.g. image) between the end user
// and the agent.
Conversation_MULTIMODAL Conversation_ChannelType = 3
)func (Conversation_ChannelType) Descriptor
func (Conversation_ChannelType) Descriptor() protoreflect.EnumDescriptorfunc (Conversation_ChannelType) Enum
func (x Conversation_ChannelType) Enum() *Conversation_ChannelTypefunc (Conversation_ChannelType) EnumDescriptor
func (Conversation_ChannelType) EnumDescriptor() ([]byte, []int)Deprecated: Use Conversation_ChannelType.Descriptor instead.
func (Conversation_ChannelType) Number
func (x Conversation_ChannelType) Number() protoreflect.EnumNumberfunc (Conversation_ChannelType) String
func (x Conversation_ChannelType) String() stringfunc (Conversation_ChannelType) Type
func (Conversation_ChannelType) Type() protoreflect.EnumTypeConversation_InputType
type Conversation_InputType int32Type of the input message.
Conversation_INPUT_TYPE_UNSPECIFIED, Conversation_INPUT_TYPE_TEXT, Conversation_INPUT_TYPE_AUDIO, Conversation_INPUT_TYPE_IMAGE, Conversation_INPUT_TYPE_BLOB, Conversation_INPUT_TYPE_TOOL_RESPONSE, Conversation_INPUT_TYPE_VARIABLES
const (
// Unspecified input type.
Conversation_INPUT_TYPE_UNSPECIFIED Conversation_InputType = 0
// The input message is text.
Conversation_INPUT_TYPE_TEXT Conversation_InputType = 1
// The input message is audio.
Conversation_INPUT_TYPE_AUDIO Conversation_InputType = 2
// The input message is image.
Conversation_INPUT_TYPE_IMAGE Conversation_InputType = 3
// The input message is blob file.
Conversation_INPUT_TYPE_BLOB Conversation_InputType = 4
// The input message is client function tool response.
Conversation_INPUT_TYPE_TOOL_RESPONSE Conversation_InputType = 5
// The input message are variables.
Conversation_INPUT_TYPE_VARIABLES Conversation_InputType = 6
)func (Conversation_InputType) Descriptor
func (Conversation_InputType) Descriptor() protoreflect.EnumDescriptorfunc (Conversation_InputType) Enum
func (x Conversation_InputType) Enum() *Conversation_InputTypefunc (Conversation_InputType) EnumDescriptor
func (Conversation_InputType) EnumDescriptor() ([]byte, []int)Deprecated: Use Conversation_InputType.Descriptor instead.
func (Conversation_InputType) Number
func (x Conversation_InputType) Number() protoreflect.EnumNumberfunc (Conversation_InputType) String
func (x Conversation_InputType) String() stringfunc (Conversation_InputType) Type
func (Conversation_InputType) Type() protoreflect.EnumTypeConversation_Source
type Conversation_Source int32The source of the conversation.
Conversation_SOURCE_UNSPECIFIED, Conversation_LIVE, Conversation_SIMULATOR, Conversation_EVAL
const (
// Unspecified source.
Conversation_SOURCE_UNSPECIFIED Conversation_Source = 0
// The conversation is from the live end user.
Conversation_LIVE Conversation_Source = 1
// The conversation is from the simulator.
Conversation_SIMULATOR Conversation_Source = 2
// The conversation is from the evaluation.
Conversation_EVAL Conversation_Source = 3
)func (Conversation_Source) Descriptor
func (Conversation_Source) Descriptor() protoreflect.EnumDescriptorfunc (Conversation_Source) Enum
func (x Conversation_Source) Enum() *Conversation_Sourcefunc (Conversation_Source) EnumDescriptor
func (Conversation_Source) EnumDescriptor() ([]byte, []int)Deprecated: Use Conversation_Source.Descriptor instead.
func (Conversation_Source) Number
func (x Conversation_Source) Number() protoreflect.EnumNumberfunc (Conversation_Source) String
func (x Conversation_Source) String() stringfunc (Conversation_Source) Type
func (Conversation_Source) Type() protoreflect.EnumTypeConversation_Turn
type Conversation_Turn struct {
// Optional. List of messages in the conversation turn, including user
// input, agent responses and intermediate events during the processing.
Messages []*Message `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
// Optional. The root span of the action processing.
RootSpan *Span `protobuf:"bytes,2,opt,name=root_span,json=rootSpan,proto3" json:"root_span,omitempty"`
// contains filtered or unexported fields
}All information about a single turn in the conversation.
func (*Conversation_Turn) Descriptor
func (*Conversation_Turn) Descriptor() ([]byte, []int)Deprecated: Use Conversation_Turn.ProtoReflect.Descriptor instead.
func (*Conversation_Turn) GetMessages
func (x *Conversation_Turn) GetMessages() []*Messagefunc (*Conversation_Turn) GetRootSpan
func (x *Conversation_Turn) GetRootSpan() *Spanfunc (*Conversation_Turn) ProtoMessage
func (*Conversation_Turn) ProtoMessage()func (*Conversation_Turn) ProtoReflect
func (x *Conversation_Turn) ProtoReflect() protoreflect.Messagefunc (*Conversation_Turn) Reset
func (x *Conversation_Turn) Reset()func (*Conversation_Turn) String
func (x *Conversation_Turn) String() stringCreateAgentRequest
type CreateAgentRequest struct {
// Required. The resource name of the app to create an agent in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the agent, which will become the final
// component of the agent's resource name. If not provided, a unique ID will
// be automatically assigned for the agent.
AgentId string `protobuf:"bytes,2,opt,name=agent_id,json=agentId,proto3" json:"agent_id,omitempty"`
// Required. The agent to create.
Agent *Agent `protobuf:"bytes,3,opt,name=agent,proto3" json:"agent,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateAgent][google.cloud.ces.v1.AgentService.CreateAgent].
func (*CreateAgentRequest) Descriptor
func (*CreateAgentRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateAgentRequest.ProtoReflect.Descriptor instead.
func (*CreateAgentRequest) GetAgent
func (x *CreateAgentRequest) GetAgent() *Agentfunc (*CreateAgentRequest) GetAgentId
func (x *CreateAgentRequest) GetAgentId() stringfunc (*CreateAgentRequest) GetParent
func (x *CreateAgentRequest) GetParent() stringfunc (*CreateAgentRequest) ProtoMessage
func (*CreateAgentRequest) ProtoMessage()func (*CreateAgentRequest) ProtoReflect
func (x *CreateAgentRequest) ProtoReflect() protoreflect.Messagefunc (*CreateAgentRequest) Reset
func (x *CreateAgentRequest) Reset()func (*CreateAgentRequest) String
func (x *CreateAgentRequest) String() stringCreateAppRequest
type CreateAppRequest struct {
// Required. The resource name of the location to create an app in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the app, which will become the final component
// of the app's resource name. If not provided, a unique ID will be
// automatically assigned for the app.
AppId string `protobuf:"bytes,2,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
// Required. The app to create.
App *App `protobuf:"bytes,3,opt,name=app,proto3" json:"app,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateApp][google.cloud.ces.v1.AgentService.CreateApp].
func (*CreateAppRequest) Descriptor
func (*CreateAppRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateAppRequest.ProtoReflect.Descriptor instead.
func (*CreateAppRequest) GetApp
func (x *CreateAppRequest) GetApp() *Appfunc (*CreateAppRequest) GetAppId
func (x *CreateAppRequest) GetAppId() stringfunc (*CreateAppRequest) GetParent
func (x *CreateAppRequest) GetParent() stringfunc (*CreateAppRequest) ProtoMessage
func (*CreateAppRequest) ProtoMessage()func (*CreateAppRequest) ProtoReflect
func (x *CreateAppRequest) ProtoReflect() protoreflect.Messagefunc (*CreateAppRequest) Reset
func (x *CreateAppRequest) Reset()func (*CreateAppRequest) String
func (x *CreateAppRequest) String() stringCreateAppVersionRequest
type CreateAppVersionRequest struct {
// Required. The resource name of the app to create an app version in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the app version, which will become the final
// component of the app version's resource name. If not provided, a unique ID
// will be automatically assigned for the app version.
AppVersionId string `protobuf:"bytes,2,opt,name=app_version_id,json=appVersionId,proto3" json:"app_version_id,omitempty"`
// Required. The app version to create.
AppVersion *AppVersion `protobuf:"bytes,3,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateAppVersion][google.cloud.ces.v1.AgentService.CreateAppVersion]
func (*CreateAppVersionRequest) Descriptor
func (*CreateAppVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateAppVersionRequest.ProtoReflect.Descriptor instead.
func (*CreateAppVersionRequest) GetAppVersion
func (x *CreateAppVersionRequest) GetAppVersion() *AppVersionfunc (*CreateAppVersionRequest) GetAppVersionId
func (x *CreateAppVersionRequest) GetAppVersionId() stringfunc (*CreateAppVersionRequest) GetParent
func (x *CreateAppVersionRequest) GetParent() stringfunc (*CreateAppVersionRequest) ProtoMessage
func (*CreateAppVersionRequest) ProtoMessage()func (*CreateAppVersionRequest) ProtoReflect
func (x *CreateAppVersionRequest) ProtoReflect() protoreflect.Messagefunc (*CreateAppVersionRequest) Reset
func (x *CreateAppVersionRequest) Reset()func (*CreateAppVersionRequest) String
func (x *CreateAppVersionRequest) String() stringCreateDeploymentRequest
type CreateDeploymentRequest struct {
// Required. The parent app.
// Format:
// `projects/{project}/locations/{location}/apps/{app}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the deployment, which will become the final
// component of the deployment's resource name. If not provided, a unique ID
// will be automatically assigned for the deployment.
DeploymentId string `protobuf:"bytes,3,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
// Required. The deployment to create.
Deployment *Deployment `protobuf:"bytes,2,opt,name=deployment,proto3" json:"deployment,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateDeployment][google.cloud.ces.v1.AgentService.CreateDeployment].
func (*CreateDeploymentRequest) Descriptor
func (*CreateDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDeploymentRequest.ProtoReflect.Descriptor instead.
func (*CreateDeploymentRequest) GetDeployment
func (x *CreateDeploymentRequest) GetDeployment() *Deploymentfunc (*CreateDeploymentRequest) GetDeploymentId
func (x *CreateDeploymentRequest) GetDeploymentId() stringfunc (*CreateDeploymentRequest) GetParent
func (x *CreateDeploymentRequest) GetParent() stringfunc (*CreateDeploymentRequest) ProtoMessage
func (*CreateDeploymentRequest) ProtoMessage()func (*CreateDeploymentRequest) ProtoReflect
func (x *CreateDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*CreateDeploymentRequest) Reset
func (x *CreateDeploymentRequest) Reset()func (*CreateDeploymentRequest) String
func (x *CreateDeploymentRequest) String() stringCreateExampleRequest
type CreateExampleRequest struct {
// Required. The resource name of the app to create an example in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the example, which will become the final
// component of the example's resource name. If not provided, a unique ID will
// be automatically assigned for the example.
ExampleId string `protobuf:"bytes,2,opt,name=example_id,json=exampleId,proto3" json:"example_id,omitempty"`
// Required. The example to create.
Example *Example `protobuf:"bytes,3,opt,name=example,proto3" json:"example,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateExample][google.cloud.ces.v1.AgentService.CreateExample].
func (*CreateExampleRequest) Descriptor
func (*CreateExampleRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateExampleRequest.ProtoReflect.Descriptor instead.
func (*CreateExampleRequest) GetExample
func (x *CreateExampleRequest) GetExample() *Examplefunc (*CreateExampleRequest) GetExampleId
func (x *CreateExampleRequest) GetExampleId() stringfunc (*CreateExampleRequest) GetParent
func (x *CreateExampleRequest) GetParent() stringfunc (*CreateExampleRequest) ProtoMessage
func (*CreateExampleRequest) ProtoMessage()func (*CreateExampleRequest) ProtoReflect
func (x *CreateExampleRequest) ProtoReflect() protoreflect.Messagefunc (*CreateExampleRequest) Reset
func (x *CreateExampleRequest) Reset()func (*CreateExampleRequest) String
func (x *CreateExampleRequest) String() stringCreateGuardrailRequest
type CreateGuardrailRequest struct {
// Required. The resource name of the app to create a guardrail in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the guardrail, which will become the final
// component of the guardrail's resource name. If not provided, a unique ID
// will be automatically assigned for the guardrail.
GuardrailId string `protobuf:"bytes,2,opt,name=guardrail_id,json=guardrailId,proto3" json:"guardrail_id,omitempty"`
// Required. The guardrail to create.
Guardrail *Guardrail `protobuf:"bytes,3,opt,name=guardrail,proto3" json:"guardrail,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateGuardrail][google.cloud.ces.v1.AgentService.CreateGuardrail].
func (*CreateGuardrailRequest) Descriptor
func (*CreateGuardrailRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateGuardrailRequest.ProtoReflect.Descriptor instead.
func (*CreateGuardrailRequest) GetGuardrail
func (x *CreateGuardrailRequest) GetGuardrail() *Guardrailfunc (*CreateGuardrailRequest) GetGuardrailId
func (x *CreateGuardrailRequest) GetGuardrailId() stringfunc (*CreateGuardrailRequest) GetParent
func (x *CreateGuardrailRequest) GetParent() stringfunc (*CreateGuardrailRequest) ProtoMessage
func (*CreateGuardrailRequest) ProtoMessage()func (*CreateGuardrailRequest) ProtoReflect
func (x *CreateGuardrailRequest) ProtoReflect() protoreflect.Messagefunc (*CreateGuardrailRequest) Reset
func (x *CreateGuardrailRequest) Reset()func (*CreateGuardrailRequest) String
func (x *CreateGuardrailRequest) String() stringCreateToolRequest
type CreateToolRequest struct {
// Required. The resource name of the app to create a tool in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the tool, which will become the final component
// of the tool's resource name. If not provided, a unique ID will be
// automatically assigned for the tool.
ToolId string `protobuf:"bytes,2,opt,name=tool_id,json=toolId,proto3" json:"tool_id,omitempty"`
// Required. The tool to create.
Tool *Tool `protobuf:"bytes,3,opt,name=tool,proto3" json:"tool,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateTool][google.cloud.ces.v1.AgentService.CreateTool].
func (*CreateToolRequest) Descriptor
func (*CreateToolRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateToolRequest.ProtoReflect.Descriptor instead.
func (*CreateToolRequest) GetParent
func (x *CreateToolRequest) GetParent() stringfunc (*CreateToolRequest) GetTool
func (x *CreateToolRequest) GetTool() *Toolfunc (*CreateToolRequest) GetToolId
func (x *CreateToolRequest) GetToolId() stringfunc (*CreateToolRequest) ProtoMessage
func (*CreateToolRequest) ProtoMessage()func (*CreateToolRequest) ProtoReflect
func (x *CreateToolRequest) ProtoReflect() protoreflect.Messagefunc (*CreateToolRequest) Reset
func (x *CreateToolRequest) Reset()func (*CreateToolRequest) String
func (x *CreateToolRequest) String() stringCreateToolsetRequest
type CreateToolsetRequest struct {
// Required. The resource name of the app to create a toolset in.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ID to use for the toolset, which will become the final
// component of the toolset's resource name. If not provided, a unique ID will
// be automatically assigned for the toolset.
ToolsetId string `protobuf:"bytes,2,opt,name=toolset_id,json=toolsetId,proto3" json:"toolset_id,omitempty"`
// Required. The toolset to create.
Toolset *Toolset `protobuf:"bytes,3,opt,name=toolset,proto3" json:"toolset,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.CreateToolset][google.cloud.ces.v1.AgentService.CreateToolset].
func (*CreateToolsetRequest) Descriptor
func (*CreateToolsetRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateToolsetRequest.ProtoReflect.Descriptor instead.
func (*CreateToolsetRequest) GetParent
func (x *CreateToolsetRequest) GetParent() stringfunc (*CreateToolsetRequest) GetToolset
func (x *CreateToolsetRequest) GetToolset() *Toolsetfunc (*CreateToolsetRequest) GetToolsetId
func (x *CreateToolsetRequest) GetToolsetId() stringfunc (*CreateToolsetRequest) ProtoMessage
func (*CreateToolsetRequest) ProtoMessage()func (*CreateToolsetRequest) ProtoReflect
func (x *CreateToolsetRequest) ProtoReflect() protoreflect.Messagefunc (*CreateToolsetRequest) Reset
func (x *CreateToolsetRequest) Reset()func (*CreateToolsetRequest) String
func (x *CreateToolsetRequest) String() stringDataStore
type DataStore struct {
// Required. Full resource name of the DataStore.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The type of the data store. This field is readonly and
// populated by the server.
Type DataStore_DataStoreType `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.ces.v1.DataStore_DataStoreType" json:"type,omitempty"`
// Output only. The document processing mode for the data store connection.
// Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
DocumentProcessingMode DataStore_DocumentProcessingMode `protobuf:"varint,4,opt,name=document_processing_mode,json=documentProcessingMode,proto3,enum=google.cloud.ces.v1.DataStore_DocumentProcessingMode" json:"document_processing_mode,omitempty"`
// Output only. The display name of the data store.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Timestamp when the data store was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The connector config for the data store connection.
ConnectorConfig *DataStore_ConnectorConfig `protobuf:"bytes,7,opt,name=connector_config,json=connectorConfig,proto3" json:"connector_config,omitempty"`
// contains filtered or unexported fields
}A DataStore resource in Vertex AI Search.
func (*DataStore) Descriptor
Deprecated: Use DataStore.ProtoReflect.Descriptor instead.
func (*DataStore) GetConnectorConfig
func (x *DataStore) GetConnectorConfig() *DataStore_ConnectorConfigfunc (*DataStore) GetCreateTime
func (x *DataStore) GetCreateTime() *timestamppb.Timestampfunc (*DataStore) GetDisplayName
func (*DataStore) GetDocumentProcessingMode
func (x *DataStore) GetDocumentProcessingMode() DataStore_DocumentProcessingModefunc (*DataStore) GetName
func (*DataStore) GetType
func (x *DataStore) GetType() DataStore_DataStoreTypefunc (*DataStore) ProtoMessage
func (*DataStore) ProtoMessage()func (*DataStore) ProtoReflect
func (x *DataStore) ProtoReflect() protoreflect.Messagefunc (*DataStore) Reset
func (x *DataStore) Reset()func (*DataStore) String
DataStoreSettings
type DataStoreSettings struct {
// Output only. The engines for the app.
Engines []*DataStoreSettings_Engine `protobuf:"bytes,3,rep,name=engines,proto3" json:"engines,omitempty"`
// contains filtered or unexported fields
}Data store related settings for the app.
func (*DataStoreSettings) Descriptor
func (*DataStoreSettings) Descriptor() ([]byte, []int)Deprecated: Use DataStoreSettings.ProtoReflect.Descriptor instead.
func (*DataStoreSettings) GetEngines
func (x *DataStoreSettings) GetEngines() []*DataStoreSettings_Enginefunc (*DataStoreSettings) ProtoMessage
func (*DataStoreSettings) ProtoMessage()func (*DataStoreSettings) ProtoReflect
func (x *DataStoreSettings) ProtoReflect() protoreflect.Messagefunc (*DataStoreSettings) Reset
func (x *DataStoreSettings) Reset()func (*DataStoreSettings) String
func (x *DataStoreSettings) String() stringDataStoreSettings_Engine
type DataStoreSettings_Engine struct {
// Output only. The resource name of the engine.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The type of the engine.
Type DataStoreSettings_Engine_Type `protobuf:"varint,2,opt,name=type,proto3,enum=google.cloud.ces.v1.DataStoreSettings_Engine_Type" json:"type,omitempty"`
// contains filtered or unexported fields
}An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
func (*DataStoreSettings_Engine) Descriptor
func (*DataStoreSettings_Engine) Descriptor() ([]byte, []int)Deprecated: Use DataStoreSettings_Engine.ProtoReflect.Descriptor instead.
func (*DataStoreSettings_Engine) GetName
func (x *DataStoreSettings_Engine) GetName() stringfunc (*DataStoreSettings_Engine) GetType
func (x *DataStoreSettings_Engine) GetType() DataStoreSettings_Engine_Typefunc (*DataStoreSettings_Engine) ProtoMessage
func (*DataStoreSettings_Engine) ProtoMessage()func (*DataStoreSettings_Engine) ProtoReflect
func (x *DataStoreSettings_Engine) ProtoReflect() protoreflect.Messagefunc (*DataStoreSettings_Engine) Reset
func (x *DataStoreSettings_Engine) Reset()func (*DataStoreSettings_Engine) String
func (x *DataStoreSettings_Engine) String() stringDataStoreSettings_Engine_Type
type DataStoreSettings_Engine_Type int32The type of the engine. See the documentation available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType and https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.
DataStoreSettings_Engine_TYPE_UNSPECIFIED, DataStoreSettings_Engine_ENGINE_TYPE_SEARCH, DataStoreSettings_Engine_ENGINE_TYPE_CHAT
const (
// Unspecified engine type.
DataStoreSettings_Engine_TYPE_UNSPECIFIED DataStoreSettings_Engine_Type = 0
// The SOLUTION_TYPE_SEARCH engine for the app. All connector data stores
// added to the app will be added to this engine.
DataStoreSettings_Engine_ENGINE_TYPE_SEARCH DataStoreSettings_Engine_Type = 1
// Chat engine type.
// The SOLUTION_TYPE_CHAT engine for the app. All connector data stores
// added to the app will be added to this engine.
DataStoreSettings_Engine_ENGINE_TYPE_CHAT DataStoreSettings_Engine_Type = 2
)func (DataStoreSettings_Engine_Type) Descriptor
func (DataStoreSettings_Engine_Type) Descriptor() protoreflect.EnumDescriptorfunc (DataStoreSettings_Engine_Type) Enum
func (x DataStoreSettings_Engine_Type) Enum() *DataStoreSettings_Engine_Typefunc (DataStoreSettings_Engine_Type) EnumDescriptor
func (DataStoreSettings_Engine_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStoreSettings_Engine_Type.Descriptor instead.
func (DataStoreSettings_Engine_Type) Number
func (x DataStoreSettings_Engine_Type) Number() protoreflect.EnumNumberfunc (DataStoreSettings_Engine_Type) String
func (x DataStoreSettings_Engine_Type) String() stringfunc (DataStoreSettings_Engine_Type) Type
func (DataStoreSettings_Engine_Type) Type() protoreflect.EnumTypeDataStoreTool
type DataStoreTool struct {
// Defines the search source, either a single DataStore or an Engine.
//
// Types that are valid to be assigned to SearchSource:
//
// *DataStoreTool_DataStoreSource_
// *DataStoreTool_EngineSource_
SearchSource isDataStoreTool_SearchSource `protobuf_oneof:"search_source"`
// Required. The data store tool name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The tool description.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Boost specification to boost certain documents.
BoostSpecs []*DataStoreTool_BoostSpecs `protobuf:"bytes,8,rep,name=boost_specs,json=boostSpecs,proto3" json:"boost_specs,omitempty"`
// Optional. The modality configs for the data store.
ModalityConfigs []*DataStoreTool_ModalityConfig `protobuf:"bytes,9,rep,name=modality_configs,json=modalityConfigs,proto3" json:"modality_configs,omitempty"`
// Optional. The filter parameter behavior.
FilterParameterBehavior DataStoreTool_FilterParameterBehavior `protobuf:"varint,10,opt,name=filter_parameter_behavior,json=filterParameterBehavior,proto3,enum=google.cloud.ces.v1.DataStoreTool_FilterParameterBehavior" json:"filter_parameter_behavior,omitempty"`
// contains filtered or unexported fields
}Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
func (*DataStoreTool) Descriptor
func (*DataStoreTool) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool.ProtoReflect.Descriptor instead.
func (*DataStoreTool) GetBoostSpecs
func (x *DataStoreTool) GetBoostSpecs() []*DataStoreTool_BoostSpecsfunc (*DataStoreTool) GetDataStoreSource
func (x *DataStoreTool) GetDataStoreSource() *DataStoreTool_DataStoreSourcefunc (*DataStoreTool) GetDescription
func (x *DataStoreTool) GetDescription() stringfunc (*DataStoreTool) GetEngineSource
func (x *DataStoreTool) GetEngineSource() *DataStoreTool_EngineSourcefunc (*DataStoreTool) GetFilterParameterBehavior
func (x *DataStoreTool) GetFilterParameterBehavior() DataStoreTool_FilterParameterBehaviorfunc (*DataStoreTool) GetModalityConfigs
func (x *DataStoreTool) GetModalityConfigs() []*DataStoreTool_ModalityConfigfunc (*DataStoreTool) GetName
func (x *DataStoreTool) GetName() stringfunc (*DataStoreTool) GetSearchSource
func (x *DataStoreTool) GetSearchSource() isDataStoreTool_SearchSourcefunc (*DataStoreTool) ProtoMessage
func (*DataStoreTool) ProtoMessage()func (*DataStoreTool) ProtoReflect
func (x *DataStoreTool) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool) Reset
func (x *DataStoreTool) Reset()func (*DataStoreTool) String
func (x *DataStoreTool) String() stringDataStoreTool_BoostSpec
type DataStoreTool_BoostSpec struct {
// Required. A list of boosting specifications.
ConditionBoostSpecs []*DataStoreTool_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`
// contains filtered or unexported fields
}Boost specification to boost certain documents.
func (*DataStoreTool_BoostSpec) Descriptor
func (*DataStoreTool_BoostSpec) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec.ProtoReflect.Descriptor instead.
func (*DataStoreTool_BoostSpec) GetConditionBoostSpecs
func (x *DataStoreTool_BoostSpec) GetConditionBoostSpecs() []*DataStoreTool_BoostSpec_ConditionBoostSpecfunc (*DataStoreTool_BoostSpec) ProtoMessage
func (*DataStoreTool_BoostSpec) ProtoMessage()func (*DataStoreTool_BoostSpec) ProtoReflect
func (x *DataStoreTool_BoostSpec) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_BoostSpec) Reset
func (x *DataStoreTool_BoostSpec) Reset()func (*DataStoreTool_BoostSpec) String
func (x *DataStoreTool_BoostSpec) String() stringDataStoreTool_BoostSpec_ConditionBoostSpec
type DataStoreTool_BoostSpec_ConditionBoostSpec struct {
// Required. An expression which specifies a boost condition. The syntax
// is the same as filter expression syntax. Currently, the only supported
// condition is a list of BCP-47 lang codes. Example: To boost suggestions
// in languages en or fr: (lang_code: ANY("en", "fr"))
Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
// Optional. Strength of the boost, which should be in [-1, 1]. Negative
// boost means demotion. Default is 0.0.
//
// Setting to 1.0 gives the suggestions a big promotion. However, it does
// not necessarily mean that the top result will be a boosted suggestion.
//
// Setting to -1.0 gives the suggestions a big demotion. However, other
// suggestions that are relevant might still be shown.
//
// Setting to 0.0 means no boost applied. The boosting condition is
// ignored.
Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
// Optional. Complex specification for custom ranking based on customer
// defined attribute value.
BoostControlSpec *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec `protobuf:"bytes,4,opt,name=boost_control_spec,json=boostControlSpec,proto3" json:"boost_control_spec,omitempty"`
// contains filtered or unexported fields
}Boost specification for a condition.
func (*DataStoreTool_BoostSpec_ConditionBoostSpec) Descriptor
func (*DataStoreTool_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.
func (*DataStoreTool_BoostSpec_ConditionBoostSpec) GetBoost
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) GetBoost() float32func (*DataStoreTool_BoostSpec_ConditionBoostSpec) GetBoostControlSpec
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) GetBoostControlSpec() *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpecfunc (*DataStoreTool_BoostSpec_ConditionBoostSpec) GetCondition
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) GetCondition() stringfunc (*DataStoreTool_BoostSpec_ConditionBoostSpec) ProtoMessage
func (*DataStoreTool_BoostSpec_ConditionBoostSpec) ProtoMessage()func (*DataStoreTool_BoostSpec_ConditionBoostSpec) ProtoReflect
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_BoostSpec_ConditionBoostSpec) Reset
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) Reset()func (*DataStoreTool_BoostSpec_ConditionBoostSpec) String
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec) String() stringDataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec
type DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec struct {
// Optional. The name of the field whose value will be used to determine
// the boost amount.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// Optional. The attribute type to be used to determine the boost
// amount. The attribute value can be derived from the field value of
// the specified field_name. In the case of numerical it is
// straightforward i.e. attribute_value = numerical_field_value. In the
// case of freshness however, attribute_value = (time.now() -
// datetime_field_value).
AttributeType DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType `protobuf:"varint,2,opt,name=attribute_type,json=attributeType,proto3,enum=google.cloud.ces.v1.DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType" json:"attribute_type,omitempty"`
// Optional. The interpolation type to be applied to connect the control
// points listed below.
InterpolationType DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType `protobuf:"varint,3,opt,name=interpolation_type,json=interpolationType,proto3,enum=google.cloud.ces.v1.DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType" json:"interpolation_type,omitempty"`
// Optional. The control points used to define the curve. The monotonic
// function (defined through the interpolation_type above) passes
// through the control points listed here.
ControlPoints []*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint `protobuf:"bytes,4,rep,name=control_points,json=controlPoints,proto3" json:"control_points,omitempty"`
// contains filtered or unexported fields
}Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec.ProtoReflect.Descriptor instead.
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetAttributeType() DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeTypefunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetControlPoints() []*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPointfunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetFieldName() stringfunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) GetInterpolationType() DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationTypefunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoMessage()func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) Reset()func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) String
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec) String() stringDataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType
type DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType int32The attribute(or function) for which the custom ranking is to be applied.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED, DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL, DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS
const (
// Unspecified AttributeType.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ATTRIBUTE_TYPE_UNSPECIFIED DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 0
// The value of the numerical field will be used to dynamically update
// the boost amount. In this case, the attribute_value (the x value)
// of the control point will be the actual value of the numerical
// field for which the boost_amount is specified.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_NUMERICAL DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 1
// For the freshness use case the attribute value will be the duration
// between the current time and the date in the datetime field
// specified. The value must be formatted as an XSD `dayTimeDuration`
// value (a restricted subset of an ISO 8601 duration value). The
// pattern for this is: `[nD][T[nH][nM][nS]]`.
// E.g. `5D`, `3DT12H30M`, `T24H`.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_FRESHNESS DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType = 2
)func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Descriptor() protoreflect.EnumDescriptorfunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum
func (x DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Enum() *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeTypefunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType.Descriptor instead.
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number
func (x DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Number() protoreflect.EnumNumberfunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) String
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_AttributeType) Type() protoreflect.EnumTypeDataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint
type DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint struct {
// Optional. Can be one of:
// 1. The numerical field value.
// 2. The duration spec for freshness:
// The value must be formatted as an XSD `dayTimeDuration` value (a
// restricted subset of an ISO 8601 duration value). The pattern for
// this is: `[nD][T[nH][nM][nS]]`.
AttributeValue string `protobuf:"bytes,1,opt,name=attribute_value,json=attributeValue,proto3" json:"attribute_value,omitempty"`
// Optional. The value between -1 to 1 by which to boost the score if
// the attribute_value evaluates to the value specified above.
BoostAmount float32 `protobuf:"fixed32,2,opt,name=boost_amount,json=boostAmount,proto3" json:"boost_amount,omitempty"`
// contains filtered or unexported fields
}The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint.ProtoReflect.Descriptor instead.
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetAttributeValue() stringfunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) GetBoostAmount() float32func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage
func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoMessage()func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) Reset()func (*DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String
func (x *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_ControlPoint) String() stringDataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType
type DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType int32The interpolation type to be applied. Default will be linear (Piecewise Linear).
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED, DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_LINEAR
const (
// Interpolation type is unspecified. In this case, it defaults to
// Linear.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_INTERPOLATION_TYPE_UNSPECIFIED DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 0
// Piecewise linear interpolation will be applied.
DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_LINEAR DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType = 1
)func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Descriptor() protoreflect.EnumDescriptorfunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum
func (x DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Enum() *DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationTypefunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType.Descriptor instead.
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number
func (x DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Number() protoreflect.EnumNumberfunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String
func (x DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) String() stringfunc (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type
func (DataStoreTool_BoostSpec_ConditionBoostSpec_BoostControlSpec_InterpolationType) Type() protoreflect.EnumTypeDataStoreTool_BoostSpecs
type DataStoreTool_BoostSpecs struct {
// Required. The Data Store where the boosting configuration is applied.
// Full resource name of DataStore, such as
// projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
DataStores []string `protobuf:"bytes,1,rep,name=data_stores,json=dataStores,proto3" json:"data_stores,omitempty"`
// Required. A list of boosting specifications.
Spec []*DataStoreTool_BoostSpec `protobuf:"bytes,2,rep,name=spec,proto3" json:"spec,omitempty"`
// contains filtered or unexported fields
}Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
func (*DataStoreTool_BoostSpecs) Descriptor
func (*DataStoreTool_BoostSpecs) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_BoostSpecs.ProtoReflect.Descriptor instead.
func (*DataStoreTool_BoostSpecs) GetDataStores
func (x *DataStoreTool_BoostSpecs) GetDataStores() []stringfunc (*DataStoreTool_BoostSpecs) GetSpec
func (x *DataStoreTool_BoostSpecs) GetSpec() []*DataStoreTool_BoostSpecfunc (*DataStoreTool_BoostSpecs) ProtoMessage
func (*DataStoreTool_BoostSpecs) ProtoMessage()func (*DataStoreTool_BoostSpecs) ProtoReflect
func (x *DataStoreTool_BoostSpecs) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_BoostSpecs) Reset
func (x *DataStoreTool_BoostSpecs) Reset()func (*DataStoreTool_BoostSpecs) String
func (x *DataStoreTool_BoostSpecs) String() stringDataStoreTool_DataStoreSource
type DataStoreTool_DataStoreSource struct {
// Optional. Filter specification for the DataStore.
// See:
// https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The data store.
DataStore *DataStore `protobuf:"bytes,4,opt,name=data_store,json=dataStore,proto3" json:"data_store,omitempty"`
// contains filtered or unexported fields
}Configuration for searching within a specific DataStore.
func (*DataStoreTool_DataStoreSource) Descriptor
func (*DataStoreTool_DataStoreSource) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_DataStoreSource.ProtoReflect.Descriptor instead.
func (*DataStoreTool_DataStoreSource) GetDataStore
func (x *DataStoreTool_DataStoreSource) GetDataStore() *DataStorefunc (*DataStoreTool_DataStoreSource) GetFilter
func (x *DataStoreTool_DataStoreSource) GetFilter() stringfunc (*DataStoreTool_DataStoreSource) ProtoMessage
func (*DataStoreTool_DataStoreSource) ProtoMessage()func (*DataStoreTool_DataStoreSource) ProtoReflect
func (x *DataStoreTool_DataStoreSource) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_DataStoreSource) Reset
func (x *DataStoreTool_DataStoreSource) Reset()func (*DataStoreTool_DataStoreSource) String
func (x *DataStoreTool_DataStoreSource) String() stringDataStoreTool_DataStoreSource_
type DataStoreTool_DataStoreSource_ struct {
// Optional. Search within a single specific DataStore.
DataStoreSource *DataStoreTool_DataStoreSource `protobuf:"bytes,3,opt,name=data_store_source,json=dataStoreSource,proto3,oneof"`
}DataStoreTool_EngineSource
type DataStoreTool_EngineSource struct {
// Required. Full resource name of the Engine.
// Format:
// `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
Engine string `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
// Optional. Use to target specific DataStores within the Engine.
// If empty, the search applies to all DataStores associated with the
// Engine.
DataStoreSources []*DataStoreTool_DataStoreSource `protobuf:"bytes,2,rep,name=data_store_sources,json=dataStoreSources,proto3" json:"data_store_sources,omitempty"`
// Optional. A filter applied to the search across the Engine. Not relevant
// and not used if 'data_store_sources' is provided. See:
// https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Configuration for searching within an Engine, potentially targeting specific DataStores.
func (*DataStoreTool_EngineSource) Descriptor
func (*DataStoreTool_EngineSource) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_EngineSource.ProtoReflect.Descriptor instead.
func (*DataStoreTool_EngineSource) GetDataStoreSources
func (x *DataStoreTool_EngineSource) GetDataStoreSources() []*DataStoreTool_DataStoreSourcefunc (*DataStoreTool_EngineSource) GetEngine
func (x *DataStoreTool_EngineSource) GetEngine() stringfunc (*DataStoreTool_EngineSource) GetFilter
func (x *DataStoreTool_EngineSource) GetFilter() stringfunc (*DataStoreTool_EngineSource) ProtoMessage
func (*DataStoreTool_EngineSource) ProtoMessage()func (*DataStoreTool_EngineSource) ProtoReflect
func (x *DataStoreTool_EngineSource) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_EngineSource) Reset
func (x *DataStoreTool_EngineSource) Reset()func (*DataStoreTool_EngineSource) String
func (x *DataStoreTool_EngineSource) String() stringDataStoreTool_EngineSource_
type DataStoreTool_EngineSource_ struct {
// Optional. Search within an Engine (potentially across multiple
// DataStores).
EngineSource *DataStoreTool_EngineSource `protobuf:"bytes,4,opt,name=engine_source,json=engineSource,proto3,oneof"`
}DataStoreTool_FilterParameterBehavior
type DataStoreTool_FilterParameterBehavior int32Filter parameter behavior.
DataStoreTool_FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED, DataStoreTool_ALWAYS_INCLUDE, DataStoreTool_NEVER_INCLUDE
const (
// Default filter behavior.
// Include filter parameter for connector datastores.
// For the rest of the datastore types, the filter input parameter is
// omitted.
DataStoreTool_FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED DataStoreTool_FilterParameterBehavior = 0
// Always include filter parameter for all datastore types.
DataStoreTool_ALWAYS_INCLUDE DataStoreTool_FilterParameterBehavior = 2
// The filter parameter is never included in the list of tool parameters,
// regardless of the datastore type.
DataStoreTool_NEVER_INCLUDE DataStoreTool_FilterParameterBehavior = 3
)func (DataStoreTool_FilterParameterBehavior) Descriptor
func (DataStoreTool_FilterParameterBehavior) Descriptor() protoreflect.EnumDescriptorfunc (DataStoreTool_FilterParameterBehavior) Enum
func (DataStoreTool_FilterParameterBehavior) EnumDescriptor
func (DataStoreTool_FilterParameterBehavior) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStoreTool_FilterParameterBehavior.Descriptor instead.
func (DataStoreTool_FilterParameterBehavior) Number
func (x DataStoreTool_FilterParameterBehavior) Number() protoreflect.EnumNumberfunc (DataStoreTool_FilterParameterBehavior) String
func (x DataStoreTool_FilterParameterBehavior) String() stringfunc (DataStoreTool_FilterParameterBehavior) Type
func (DataStoreTool_FilterParameterBehavior) Type() protoreflect.EnumTypeDataStoreTool_GroundingConfig
type DataStoreTool_GroundingConfig struct {
// Optional. The groundedness threshold of the answer based on the retrieved
// sources. The value has a configurable range of [1, 5]. The level is used
// to threshold the groundedness of the answer, meaning that all responses
// with a groundedness score below the threshold will fall back to returning
// relevant snippets only.
//
// For example, a level of 3 means that the groundedness score must be
// 3 or higher for the response to be returned.
GroundingLevel float32 `protobuf:"fixed32,1,opt,name=grounding_level,json=groundingLevel,proto3" json:"grounding_level,omitempty"`
// Optional. Whether grounding is disabled.
Disabled bool `protobuf:"varint,2,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}Grounding configuration.
func (*DataStoreTool_GroundingConfig) Descriptor
func (*DataStoreTool_GroundingConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_GroundingConfig.ProtoReflect.Descriptor instead.
func (*DataStoreTool_GroundingConfig) GetDisabled
func (x *DataStoreTool_GroundingConfig) GetDisabled() boolfunc (*DataStoreTool_GroundingConfig) GetGroundingLevel
func (x *DataStoreTool_GroundingConfig) GetGroundingLevel() float32func (*DataStoreTool_GroundingConfig) ProtoMessage
func (*DataStoreTool_GroundingConfig) ProtoMessage()func (*DataStoreTool_GroundingConfig) ProtoReflect
func (x *DataStoreTool_GroundingConfig) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_GroundingConfig) Reset
func (x *DataStoreTool_GroundingConfig) Reset()func (*DataStoreTool_GroundingConfig) String
func (x *DataStoreTool_GroundingConfig) String() stringDataStoreTool_ModalityConfig
type DataStoreTool_ModalityConfig struct {
// Required. The modality type.
ModalityType DataStoreTool_ModalityConfig_ModalityType `protobuf:"varint,1,opt,name=modality_type,json=modalityType,proto3,enum=google.cloud.ces.v1.DataStoreTool_ModalityConfig_ModalityType" json:"modality_type,omitempty"`
// Optional. The rewriter config.
RewriterConfig *DataStoreTool_RewriterConfig `protobuf:"bytes,2,opt,name=rewriter_config,json=rewriterConfig,proto3" json:"rewriter_config,omitempty"`
// Optional. The summarization config.
SummarizationConfig *DataStoreTool_SummarizationConfig `protobuf:"bytes,3,opt,name=summarization_config,json=summarizationConfig,proto3" json:"summarization_config,omitempty"`
// Optional. The grounding configuration.
GroundingConfig *DataStoreTool_GroundingConfig `protobuf:"bytes,4,opt,name=grounding_config,json=groundingConfig,proto3" json:"grounding_config,omitempty"`
// contains filtered or unexported fields
}If specified, will apply the given configuration for the specified modality.
func (*DataStoreTool_ModalityConfig) Descriptor
func (*DataStoreTool_ModalityConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_ModalityConfig.ProtoReflect.Descriptor instead.
func (*DataStoreTool_ModalityConfig) GetGroundingConfig
func (x *DataStoreTool_ModalityConfig) GetGroundingConfig() *DataStoreTool_GroundingConfigfunc (*DataStoreTool_ModalityConfig) GetModalityType
func (x *DataStoreTool_ModalityConfig) GetModalityType() DataStoreTool_ModalityConfig_ModalityTypefunc (*DataStoreTool_ModalityConfig) GetRewriterConfig
func (x *DataStoreTool_ModalityConfig) GetRewriterConfig() *DataStoreTool_RewriterConfigfunc (*DataStoreTool_ModalityConfig) GetSummarizationConfig
func (x *DataStoreTool_ModalityConfig) GetSummarizationConfig() *DataStoreTool_SummarizationConfigfunc (*DataStoreTool_ModalityConfig) ProtoMessage
func (*DataStoreTool_ModalityConfig) ProtoMessage()func (*DataStoreTool_ModalityConfig) ProtoReflect
func (x *DataStoreTool_ModalityConfig) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_ModalityConfig) Reset
func (x *DataStoreTool_ModalityConfig) Reset()func (*DataStoreTool_ModalityConfig) String
func (x *DataStoreTool_ModalityConfig) String() stringDataStoreTool_ModalityConfig_ModalityType
type DataStoreTool_ModalityConfig_ModalityType int32The modality type.
DataStoreTool_ModalityConfig_MODALITY_TYPE_UNSPECIFIED, DataStoreTool_ModalityConfig_TEXT, DataStoreTool_ModalityConfig_AUDIO
const (
// Unspecified modality type.
DataStoreTool_ModalityConfig_MODALITY_TYPE_UNSPECIFIED DataStoreTool_ModalityConfig_ModalityType = 0
// Text modality.
DataStoreTool_ModalityConfig_TEXT DataStoreTool_ModalityConfig_ModalityType = 1
// Audio modality.
DataStoreTool_ModalityConfig_AUDIO DataStoreTool_ModalityConfig_ModalityType = 2
)func (DataStoreTool_ModalityConfig_ModalityType) Descriptor
func (DataStoreTool_ModalityConfig_ModalityType) Descriptor() protoreflect.EnumDescriptorfunc (DataStoreTool_ModalityConfig_ModalityType) Enum
func (x DataStoreTool_ModalityConfig_ModalityType) Enum() *DataStoreTool_ModalityConfig_ModalityTypefunc (DataStoreTool_ModalityConfig_ModalityType) EnumDescriptor
func (DataStoreTool_ModalityConfig_ModalityType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStoreTool_ModalityConfig_ModalityType.Descriptor instead.
func (DataStoreTool_ModalityConfig_ModalityType) Number
func (x DataStoreTool_ModalityConfig_ModalityType) Number() protoreflect.EnumNumberfunc (DataStoreTool_ModalityConfig_ModalityType) String
func (x DataStoreTool_ModalityConfig_ModalityType) String() stringfunc (DataStoreTool_ModalityConfig_ModalityType) Type
func (DataStoreTool_ModalityConfig_ModalityType) Type() protoreflect.EnumTypeDataStoreTool_RewriterConfig
type DataStoreTool_RewriterConfig struct {
// Required. Configurations for the LLM model.
ModelSettings *ModelSettings `protobuf:"bytes,1,opt,name=model_settings,json=modelSettings,proto3" json:"model_settings,omitempty"`
// Optional. The prompt definition. If not set, default prompt will be used.
Prompt string `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
// Optional. Whether the rewriter is disabled.
Disabled bool `protobuf:"varint,3,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}Rewriter configuration.
func (*DataStoreTool_RewriterConfig) Descriptor
func (*DataStoreTool_RewriterConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_RewriterConfig.ProtoReflect.Descriptor instead.
func (*DataStoreTool_RewriterConfig) GetDisabled
func (x *DataStoreTool_RewriterConfig) GetDisabled() boolfunc (*DataStoreTool_RewriterConfig) GetModelSettings
func (x *DataStoreTool_RewriterConfig) GetModelSettings() *ModelSettingsfunc (*DataStoreTool_RewriterConfig) GetPrompt
func (x *DataStoreTool_RewriterConfig) GetPrompt() stringfunc (*DataStoreTool_RewriterConfig) ProtoMessage
func (*DataStoreTool_RewriterConfig) ProtoMessage()func (*DataStoreTool_RewriterConfig) ProtoReflect
func (x *DataStoreTool_RewriterConfig) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_RewriterConfig) Reset
func (x *DataStoreTool_RewriterConfig) Reset()func (*DataStoreTool_RewriterConfig) String
func (x *DataStoreTool_RewriterConfig) String() stringDataStoreTool_SummarizationConfig
type DataStoreTool_SummarizationConfig struct {
// Optional. Configurations for the LLM model.
ModelSettings *ModelSettings `protobuf:"bytes,1,opt,name=model_settings,json=modelSettings,proto3" json:"model_settings,omitempty"`
// Optional. The prompt definition. If not set, default prompt will be used.
Prompt string `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
// Optional. Whether summarization is disabled.
Disabled bool `protobuf:"varint,3,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}Summarization configuration.
func (*DataStoreTool_SummarizationConfig) Descriptor
func (*DataStoreTool_SummarizationConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStoreTool_SummarizationConfig.ProtoReflect.Descriptor instead.
func (*DataStoreTool_SummarizationConfig) GetDisabled
func (x *DataStoreTool_SummarizationConfig) GetDisabled() boolfunc (*DataStoreTool_SummarizationConfig) GetModelSettings
func (x *DataStoreTool_SummarizationConfig) GetModelSettings() *ModelSettingsfunc (*DataStoreTool_SummarizationConfig) GetPrompt
func (x *DataStoreTool_SummarizationConfig) GetPrompt() stringfunc (*DataStoreTool_SummarizationConfig) ProtoMessage
func (*DataStoreTool_SummarizationConfig) ProtoMessage()func (*DataStoreTool_SummarizationConfig) ProtoReflect
func (x *DataStoreTool_SummarizationConfig) ProtoReflect() protoreflect.Messagefunc (*DataStoreTool_SummarizationConfig) Reset
func (x *DataStoreTool_SummarizationConfig) Reset()func (*DataStoreTool_SummarizationConfig) String
func (x *DataStoreTool_SummarizationConfig) String() stringDataStore_ConnectorConfig
type DataStore_ConnectorConfig struct {
// Resource name of the collection the data store belongs to.
Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
// Display name of the collection the data store belongs to.
CollectionDisplayName string `protobuf:"bytes,2,opt,name=collection_display_name,json=collectionDisplayName,proto3" json:"collection_display_name,omitempty"`
// The name of the data source.
// Example: `salesforce`, `jira`, `confluence`, `bigquery`.
DataSource string `protobuf:"bytes,3,opt,name=data_source,json=dataSource,proto3" json:"data_source,omitempty"`
// contains filtered or unexported fields
}The connector config for the data store connection.
func (*DataStore_ConnectorConfig) Descriptor
func (*DataStore_ConnectorConfig) Descriptor() ([]byte, []int)Deprecated: Use DataStore_ConnectorConfig.ProtoReflect.Descriptor instead.
func (*DataStore_ConnectorConfig) GetCollection
func (x *DataStore_ConnectorConfig) GetCollection() stringfunc (*DataStore_ConnectorConfig) GetCollectionDisplayName
func (x *DataStore_ConnectorConfig) GetCollectionDisplayName() stringfunc (*DataStore_ConnectorConfig) GetDataSource
func (x *DataStore_ConnectorConfig) GetDataSource() stringfunc (*DataStore_ConnectorConfig) ProtoMessage
func (*DataStore_ConnectorConfig) ProtoMessage()func (*DataStore_ConnectorConfig) ProtoReflect
func (x *DataStore_ConnectorConfig) ProtoReflect() protoreflect.Messagefunc (*DataStore_ConnectorConfig) Reset
func (x *DataStore_ConnectorConfig) Reset()func (*DataStore_ConnectorConfig) String
func (x *DataStore_ConnectorConfig) String() stringDataStore_DataStoreType
type DataStore_DataStoreType int32The type of the data store.
DataStore_DATA_STORE_TYPE_UNSPECIFIED, DataStore_PUBLIC_WEB, DataStore_UNSTRUCTURED, DataStore_FAQ, DataStore_CONNECTOR
const (
// Not specified. This value indicates that the data store type is not
// specified, so it will not be used during search.
DataStore_DATA_STORE_TYPE_UNSPECIFIED DataStore_DataStoreType = 0
// A data store that contains public web content.
DataStore_PUBLIC_WEB DataStore_DataStoreType = 1
// A data store that contains unstructured private data.
DataStore_UNSTRUCTURED DataStore_DataStoreType = 2
// A data store that contains structured data used as FAQ.
DataStore_FAQ DataStore_DataStoreType = 3
// A data store that is a connector to a first-party or a third-party
// service.
DataStore_CONNECTOR DataStore_DataStoreType = 4
)func (DataStore_DataStoreType) Descriptor
func (DataStore_DataStoreType) Descriptor() protoreflect.EnumDescriptorfunc (DataStore_DataStoreType) Enum
func (x DataStore_DataStoreType) Enum() *DataStore_DataStoreTypefunc (DataStore_DataStoreType) EnumDescriptor
func (DataStore_DataStoreType) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStore_DataStoreType.Descriptor instead.
func (DataStore_DataStoreType) Number
func (x DataStore_DataStoreType) Number() protoreflect.EnumNumberfunc (DataStore_DataStoreType) String
func (x DataStore_DataStoreType) String() stringfunc (DataStore_DataStoreType) Type
func (DataStore_DataStoreType) Type() protoreflect.EnumTypeDataStore_DocumentProcessingMode
type DataStore_DocumentProcessingMode int32The document processing mode of the data store.
DataStore_DOCUMENT_PROCESSING_MODE_UNSPECIFIED, DataStore_DOCUMENTS, DataStore_CHUNKS
const (
// Not specified.
DataStore_DOCUMENT_PROCESSING_MODE_UNSPECIFIED DataStore_DocumentProcessingMode = 0
// Documents are processed as documents.
DataStore_DOCUMENTS DataStore_DocumentProcessingMode = 1
// Documents are converted to chunks.
DataStore_CHUNKS DataStore_DocumentProcessingMode = 2
)func (DataStore_DocumentProcessingMode) Descriptor
func (DataStore_DocumentProcessingMode) Descriptor() protoreflect.EnumDescriptorfunc (DataStore_DocumentProcessingMode) Enum
func (x DataStore_DocumentProcessingMode) Enum() *DataStore_DocumentProcessingModefunc (DataStore_DocumentProcessingMode) EnumDescriptor
func (DataStore_DocumentProcessingMode) EnumDescriptor() ([]byte, []int)Deprecated: Use DataStore_DocumentProcessingMode.Descriptor instead.
func (DataStore_DocumentProcessingMode) Number
func (x DataStore_DocumentProcessingMode) Number() protoreflect.EnumNumberfunc (DataStore_DocumentProcessingMode) String
func (x DataStore_DocumentProcessingMode) String() stringfunc (DataStore_DocumentProcessingMode) Type
func (DataStore_DocumentProcessingMode) Type() protoreflect.EnumTypeDeleteAgentRequest
type DeleteAgentRequest struct {
// Required. The resource name of the agent to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicates whether to forcefully delete the agent, even if it is
// still referenced by other app/agents/examples.
//
// * If `force = false`, the deletion fails if other agents/examples
// reference it.
// * If `force = true`, delete the agent and remove it from all referencing
// apps/agents/examples.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// Optional. The current etag of the agent. If an etag is not provided, the
// deletion will overwrite any concurrent changes. If an etag is provided and
// does not match the current etag of the agent, deletion will be blocked and
// an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteAgent][google.cloud.ces.v1.AgentService.DeleteAgent].
func (*DeleteAgentRequest) Descriptor
func (*DeleteAgentRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteAgentRequest.ProtoReflect.Descriptor instead.
func (*DeleteAgentRequest) GetEtag
func (x *DeleteAgentRequest) GetEtag() stringfunc (*DeleteAgentRequest) GetForce
func (x *DeleteAgentRequest) GetForce() boolfunc (*DeleteAgentRequest) GetName
func (x *DeleteAgentRequest) GetName() stringfunc (*DeleteAgentRequest) ProtoMessage
func (*DeleteAgentRequest) ProtoMessage()func (*DeleteAgentRequest) ProtoReflect
func (x *DeleteAgentRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteAgentRequest) Reset
func (x *DeleteAgentRequest) Reset()func (*DeleteAgentRequest) String
func (x *DeleteAgentRequest) String() stringDeleteAppRequest
type DeleteAppRequest struct {
// Required. The resource name of the app to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The current etag of the app. If an etag is not provided, the
// deletion will overwrite any concurrent changes. If an etag is provided and
// does not match the current etag of the app, deletion will be blocked and an
// ABORTED error will be returned.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteApp][google.cloud.ces.v1.AgentService.DeleteApp].
func (*DeleteAppRequest) Descriptor
func (*DeleteAppRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteAppRequest.ProtoReflect.Descriptor instead.
func (*DeleteAppRequest) GetEtag
func (x *DeleteAppRequest) GetEtag() stringfunc (*DeleteAppRequest) GetName
func (x *DeleteAppRequest) GetName() stringfunc (*DeleteAppRequest) ProtoMessage
func (*DeleteAppRequest) ProtoMessage()func (*DeleteAppRequest) ProtoReflect
func (x *DeleteAppRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteAppRequest) Reset
func (x *DeleteAppRequest) Reset()func (*DeleteAppRequest) String
func (x *DeleteAppRequest) String() stringDeleteAppVersionRequest
type DeleteAppVersionRequest struct {
// Required. The resource name of the app version to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The current etag of the app version. If an etag is not provided,
// the deletion will overwrite any concurrent changes. If an etag is provided
// and does not match the current etag of the app version, deletion will be
// blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteAppVersion][google.cloud.ces.v1.AgentService.DeleteAppVersion].
func (*DeleteAppVersionRequest) Descriptor
func (*DeleteAppVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteAppVersionRequest.ProtoReflect.Descriptor instead.
func (*DeleteAppVersionRequest) GetEtag
func (x *DeleteAppVersionRequest) GetEtag() stringfunc (*DeleteAppVersionRequest) GetName
func (x *DeleteAppVersionRequest) GetName() stringfunc (*DeleteAppVersionRequest) ProtoMessage
func (*DeleteAppVersionRequest) ProtoMessage()func (*DeleteAppVersionRequest) ProtoReflect
func (x *DeleteAppVersionRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteAppVersionRequest) Reset
func (x *DeleteAppVersionRequest) Reset()func (*DeleteAppVersionRequest) String
func (x *DeleteAppVersionRequest) String() stringDeleteConversationRequest
type DeleteConversationRequest struct {
// Required. The resource name of the conversation to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicate the source of the conversation. If not set, Source.Live
// will be applied by default.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/agent_service.proto.
Source Conversation_Source `protobuf:"varint,2,opt,name=source,proto3,enum=google.cloud.ces.v1.Conversation_Source" json:"source,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteConversation][google.cloud.ces.v1.AgentService.DeleteConversation].
func (*DeleteConversationRequest) Descriptor
func (*DeleteConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteConversationRequest.ProtoReflect.Descriptor instead.
func (*DeleteConversationRequest) GetName
func (x *DeleteConversationRequest) GetName() stringfunc (*DeleteConversationRequest) GetSource
func (x *DeleteConversationRequest) GetSource() Conversation_SourceDeprecated: Marked as deprecated in google/cloud/ces/v1/agent_service.proto.
func (*DeleteConversationRequest) ProtoMessage
func (*DeleteConversationRequest) ProtoMessage()func (*DeleteConversationRequest) ProtoReflect
func (x *DeleteConversationRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteConversationRequest) Reset
func (x *DeleteConversationRequest) Reset()func (*DeleteConversationRequest) String
func (x *DeleteConversationRequest) String() stringDeleteDeploymentRequest
type DeleteDeploymentRequest struct {
// Required. The name of the deployment to delete.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The etag of the deployment.
// If an etag is provided and does not match the current etag of the
// deployment, deletion will be blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteDeployment][google.cloud.ces.v1.AgentService.DeleteDeployment].
func (*DeleteDeploymentRequest) Descriptor
func (*DeleteDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteDeploymentRequest.ProtoReflect.Descriptor instead.
func (*DeleteDeploymentRequest) GetEtag
func (x *DeleteDeploymentRequest) GetEtag() stringfunc (*DeleteDeploymentRequest) GetName
func (x *DeleteDeploymentRequest) GetName() stringfunc (*DeleteDeploymentRequest) ProtoMessage
func (*DeleteDeploymentRequest) ProtoMessage()func (*DeleteDeploymentRequest) ProtoReflect
func (x *DeleteDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteDeploymentRequest) Reset
func (x *DeleteDeploymentRequest) Reset()func (*DeleteDeploymentRequest) String
func (x *DeleteDeploymentRequest) String() stringDeleteExampleRequest
type DeleteExampleRequest struct {
// Required. The resource name of the example to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The current etag of the example. If an etag is not provided, the
// deletion will overwrite any concurrent changes. If an etag is provided and
// does not match the current etag of the example, deletion will be blocked
// and an ABORTED error will be returned.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteExample][google.cloud.ces.v1.AgentService.DeleteExample].
func (*DeleteExampleRequest) Descriptor
func (*DeleteExampleRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteExampleRequest.ProtoReflect.Descriptor instead.
func (*DeleteExampleRequest) GetEtag
func (x *DeleteExampleRequest) GetEtag() stringfunc (*DeleteExampleRequest) GetName
func (x *DeleteExampleRequest) GetName() stringfunc (*DeleteExampleRequest) ProtoMessage
func (*DeleteExampleRequest) ProtoMessage()func (*DeleteExampleRequest) ProtoReflect
func (x *DeleteExampleRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteExampleRequest) Reset
func (x *DeleteExampleRequest) Reset()func (*DeleteExampleRequest) String
func (x *DeleteExampleRequest) String() stringDeleteGuardrailRequest
type DeleteGuardrailRequest struct {
// Required. The resource name of the guardrail to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicates whether to forcefully delete the guardrail, even if it
// is still referenced by app/agents.
//
// * If `force = false`, the deletion fails if any apps/agents still
// reference the guardrail.
// * If `force = true`, all existing references from apps/agents will be
// removed and the guardrail will be deleted.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// Optional. The current etag of the guardrail. If an etag is not provided,
// the deletion will overwrite any concurrent changes. If an etag is provided
// and does not match the current etag of the guardrail, deletion will be
// blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteGuardrail][google.cloud.ces.v1.AgentService.DeleteGuardrail].
func (*DeleteGuardrailRequest) Descriptor
func (*DeleteGuardrailRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteGuardrailRequest.ProtoReflect.Descriptor instead.
func (*DeleteGuardrailRequest) GetEtag
func (x *DeleteGuardrailRequest) GetEtag() stringfunc (*DeleteGuardrailRequest) GetForce
func (x *DeleteGuardrailRequest) GetForce() boolfunc (*DeleteGuardrailRequest) GetName
func (x *DeleteGuardrailRequest) GetName() stringfunc (*DeleteGuardrailRequest) ProtoMessage
func (*DeleteGuardrailRequest) ProtoMessage()func (*DeleteGuardrailRequest) ProtoReflect
func (x *DeleteGuardrailRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteGuardrailRequest) Reset
func (x *DeleteGuardrailRequest) Reset()func (*DeleteGuardrailRequest) String
func (x *DeleteGuardrailRequest) String() stringDeleteToolRequest
type DeleteToolRequest struct {
// Required. The resource name of the tool to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicates whether to forcefully delete the tool, even if it is
// still referenced by agents/examples.
//
// * If `force = false`, the deletion will fail if any agents still
// reference the tool.
// * If `force = true`, all existing references from agents will be removed
// and the tool will be deleted.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// Optional. The current etag of the tool. If an etag is not provided, the
// deletion will overwrite any concurrent changes. If an etag is provided and
// does not match the current etag of the tool, deletion will be blocked and
// an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteTool][google.cloud.ces.v1.AgentService.DeleteTool].
func (*DeleteToolRequest) Descriptor
func (*DeleteToolRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteToolRequest.ProtoReflect.Descriptor instead.
func (*DeleteToolRequest) GetEtag
func (x *DeleteToolRequest) GetEtag() stringfunc (*DeleteToolRequest) GetForce
func (x *DeleteToolRequest) GetForce() boolfunc (*DeleteToolRequest) GetName
func (x *DeleteToolRequest) GetName() stringfunc (*DeleteToolRequest) ProtoMessage
func (*DeleteToolRequest) ProtoMessage()func (*DeleteToolRequest) ProtoReflect
func (x *DeleteToolRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteToolRequest) Reset
func (x *DeleteToolRequest) Reset()func (*DeleteToolRequest) String
func (x *DeleteToolRequest) String() stringDeleteToolsetRequest
type DeleteToolsetRequest struct {
// Required. The resource name of the toolset to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicates whether to forcefully delete the toolset, even if it is
// still referenced by app/agents.
//
// * If `force = false`, the deletion fails if any agents still
// reference the toolset.
// * If `force = true`, all existing references from agents will be
// removed and the toolset will be deleted.
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// Optional. The current etag of the toolset. If an etag is not provided, the
// deletion will overwrite any concurrent changes. If an etag is provided and
// does not match the current etag of the toolset, deletion will be blocked
// and an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.DeleteToolset][google.cloud.ces.v1.AgentService.DeleteToolset].
func (*DeleteToolsetRequest) Descriptor
func (*DeleteToolsetRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteToolsetRequest.ProtoReflect.Descriptor instead.
func (*DeleteToolsetRequest) GetEtag
func (x *DeleteToolsetRequest) GetEtag() stringfunc (*DeleteToolsetRequest) GetForce
func (x *DeleteToolsetRequest) GetForce() boolfunc (*DeleteToolsetRequest) GetName
func (x *DeleteToolsetRequest) GetName() stringfunc (*DeleteToolsetRequest) ProtoMessage
func (*DeleteToolsetRequest) ProtoMessage()func (*DeleteToolsetRequest) ProtoReflect
func (x *DeleteToolsetRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteToolsetRequest) Reset
func (x *DeleteToolsetRequest) Reset()func (*DeleteToolsetRequest) String
func (x *DeleteToolsetRequest) String() stringDeployment
type Deployment struct {
// Identifier. The resource name of the deployment.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the deployment.
DisplayName string `protobuf:"bytes,8,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The resource name of the app version to deploy.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
// Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use
// the draft app.
AppVersion string `protobuf:"bytes,2,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
// Required. The channel profile used in the deployment.
ChannelProfile *ChannelProfile `protobuf:"bytes,3,opt,name=channel_profile,json=channelProfile,proto3" json:"channel_profile,omitempty"`
// Output only. Timestamp when this deployment was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when this deployment was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Etag used to ensure the object hasn't changed during a
// read-modify-write operation. If the etag is empty, the update will
// overwrite any concurrent changes.
Etag string `protobuf:"bytes,7,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
func (*Deployment) Descriptor
func (*Deployment) Descriptor() ([]byte, []int)Deprecated: Use Deployment.ProtoReflect.Descriptor instead.
func (*Deployment) GetAppVersion
func (x *Deployment) GetAppVersion() stringfunc (*Deployment) GetChannelProfile
func (x *Deployment) GetChannelProfile() *ChannelProfilefunc (*Deployment) GetCreateTime
func (x *Deployment) GetCreateTime() *timestamppb.Timestampfunc (*Deployment) GetDisplayName
func (x *Deployment) GetDisplayName() stringfunc (*Deployment) GetEtag
func (x *Deployment) GetEtag() stringfunc (*Deployment) GetName
func (x *Deployment) GetName() stringfunc (*Deployment) GetUpdateTime
func (x *Deployment) GetUpdateTime() *timestamppb.Timestampfunc (*Deployment) ProtoMessage
func (*Deployment) ProtoMessage()func (*Deployment) ProtoReflect
func (x *Deployment) ProtoReflect() protoreflect.Messagefunc (*Deployment) Reset
func (x *Deployment) Reset()func (*Deployment) String
func (x *Deployment) String() stringEndSession
type EndSession struct {
// Optional. Provides additional information about the end session signal,
// such as the reason for ending the session.
Metadata *structpb.Struct `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation.
The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.
func (*EndSession) Descriptor
func (*EndSession) Descriptor() ([]byte, []int)Deprecated: Use EndSession.ProtoReflect.Descriptor instead.
func (*EndSession) GetMetadata
func (x *EndSession) GetMetadata() *structpb.Structfunc (*EndSession) ProtoMessage
func (*EndSession) ProtoMessage()func (*EndSession) ProtoReflect
func (x *EndSession) ProtoReflect() protoreflect.Messagefunc (*EndSession) Reset
func (x *EndSession) Reset()func (*EndSession) String
func (x *EndSession) String() stringEndUserAuthConfig
type EndUserAuthConfig struct {
// The auth configuration.
//
// Types that are valid to be assigned to AuthConfig:
//
// *EndUserAuthConfig_Oauth2AuthCodeConfig_
// *EndUserAuthConfig_Oauth2JwtBearerConfig_
AuthConfig isEndUserAuthConfig_AuthConfig `protobuf_oneof:"auth_config"`
// contains filtered or unexported fields
}End-user authentication configuration used for Connection calls.
The field values must be the names of context variables in the format
$context.variables.<name_of_variable>.
func (*EndUserAuthConfig) Descriptor
func (*EndUserAuthConfig) Descriptor() ([]byte, []int)Deprecated: Use EndUserAuthConfig.ProtoReflect.Descriptor instead.
func (*EndUserAuthConfig) GetAuthConfig
func (x *EndUserAuthConfig) GetAuthConfig() isEndUserAuthConfig_AuthConfigfunc (*EndUserAuthConfig) GetOauth2AuthCodeConfig
func (x *EndUserAuthConfig) GetOauth2AuthCodeConfig() *EndUserAuthConfig_Oauth2AuthCodeConfigfunc (*EndUserAuthConfig) GetOauth2JwtBearerConfig
func (x *EndUserAuthConfig) GetOauth2JwtBearerConfig() *EndUserAuthConfig_Oauth2JwtBearerConfigfunc (*EndUserAuthConfig) ProtoMessage
func (*EndUserAuthConfig) ProtoMessage()func (*EndUserAuthConfig) ProtoReflect
func (x *EndUserAuthConfig) ProtoReflect() protoreflect.Messagefunc (*EndUserAuthConfig) Reset
func (x *EndUserAuthConfig) Reset()func (*EndUserAuthConfig) String
func (x *EndUserAuthConfig) String() stringEndUserAuthConfig_Oauth2AuthCodeConfig
type EndUserAuthConfig_Oauth2AuthCodeConfig struct {
// Required. Oauth token parameter name to pass through.
// Must be in the format `$context.variables.Oauth 2.0 Authorization Code authentication configuration.
func (*EndUserAuthConfig_Oauth2AuthCodeConfig) Descriptor
func (*EndUserAuthConfig_Oauth2AuthCodeConfig) Descriptor() ([]byte, []int)Deprecated: Use EndUserAuthConfig_Oauth2AuthCodeConfig.ProtoReflect.Descriptor instead.
func (*EndUserAuthConfig_Oauth2AuthCodeConfig) GetOauthToken
func (x *EndUserAuthConfig_Oauth2AuthCodeConfig) GetOauthToken() stringfunc (*EndUserAuthConfig_Oauth2AuthCodeConfig) ProtoMessage
func (*EndUserAuthConfig_Oauth2AuthCodeConfig) ProtoMessage()func (*EndUserAuthConfig_Oauth2AuthCodeConfig) ProtoReflect
func (x *EndUserAuthConfig_Oauth2AuthCodeConfig) ProtoReflect() protoreflect.Messagefunc (*EndUserAuthConfig_Oauth2AuthCodeConfig) Reset
func (x *EndUserAuthConfig_Oauth2AuthCodeConfig) Reset()func (*EndUserAuthConfig_Oauth2AuthCodeConfig) String
func (x *EndUserAuthConfig_Oauth2AuthCodeConfig) String() stringEndUserAuthConfig_Oauth2AuthCodeConfig_
type EndUserAuthConfig_Oauth2AuthCodeConfig_ struct {
// Oauth 2.0 Authorization Code authentication.
Oauth2AuthCodeConfig *EndUserAuthConfig_Oauth2AuthCodeConfig `protobuf:"bytes,2,opt,name=oauth2_auth_code_config,json=oauth2AuthCodeConfig,proto3,oneof"`
}EndUserAuthConfig_Oauth2JwtBearerConfig
type EndUserAuthConfig_Oauth2JwtBearerConfig struct {
// Required. Issuer parameter name to pass through.
// Must be in the format `$context.variables.JWT Profile Oauth 2.0 Authorization Grant authentication configuration.
func (*EndUserAuthConfig_Oauth2JwtBearerConfig) Descriptor
func (*EndUserAuthConfig_Oauth2JwtBearerConfig) Descriptor() ([]byte, []int)Deprecated: Use EndUserAuthConfig_Oauth2JwtBearerConfig.ProtoReflect.Descriptor instead.
func (*EndUserAuthConfig_Oauth2JwtBearerConfig) GetClientKey
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) GetClientKey() stringfunc (*EndUserAuthConfig_Oauth2JwtBearerConfig) GetIssuer
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) GetIssuer() stringfunc (*EndUserAuthConfig_Oauth2JwtBearerConfig) GetSubject
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) GetSubject() stringfunc (*EndUserAuthConfig_Oauth2JwtBearerConfig) ProtoMessage
func (*EndUserAuthConfig_Oauth2JwtBearerConfig) ProtoMessage()func (*EndUserAuthConfig_Oauth2JwtBearerConfig) ProtoReflect
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) ProtoReflect() protoreflect.Messagefunc (*EndUserAuthConfig_Oauth2JwtBearerConfig) Reset
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) Reset()func (*EndUserAuthConfig_Oauth2JwtBearerConfig) String
func (x *EndUserAuthConfig_Oauth2JwtBearerConfig) String() stringEndUserAuthConfig_Oauth2JwtBearerConfig_
type EndUserAuthConfig_Oauth2JwtBearerConfig_ struct {
// JWT Profile Oauth 2.0 Authorization Grant authentication.
Oauth2JwtBearerConfig *EndUserAuthConfig_Oauth2JwtBearerConfig `protobuf:"bytes,3,opt,name=oauth2_jwt_bearer_config,json=oauth2JwtBearerConfig,proto3,oneof"`
}EndpointControlPolicy
type EndpointControlPolicy struct {
// Optional. The scope in which this policy's allowed_origins list is
// enforced.
EnforcementScope EndpointControlPolicy_EnforcementScope `protobuf:"varint,1,opt,name=enforcement_scope,json=enforcementScope,proto3,enum=google.cloud.ces.v1.EndpointControlPolicy_EnforcementScope" json:"enforcement_scope,omitempty"`
// Optional. The allowed HTTP(s) origins that tools in the App are able to
// directly call. The enforcement depends on the value of
// enforcement_scope and the VPC-SC status of the project.
// If a port number is not provided, all ports will be allowed. Otherwise,
// the port number must match exactly. For example, "https://example.com"
// will match "https://example.com:443" and any other port.
// "https://example.com:443" will only match "https://example.com:443".
AllowedOrigins []string `protobuf:"bytes,2,rep,name=allowed_origins,json=allowedOrigins,proto3" json:"allowed_origins,omitempty"`
// contains filtered or unexported fields
}Defines project/location level endpoint control policy.
func (*EndpointControlPolicy) Descriptor
func (*EndpointControlPolicy) Descriptor() ([]byte, []int)Deprecated: Use EndpointControlPolicy.ProtoReflect.Descriptor instead.
func (*EndpointControlPolicy) GetAllowedOrigins
func (x *EndpointControlPolicy) GetAllowedOrigins() []stringfunc (*EndpointControlPolicy) GetEnforcementScope
func (x *EndpointControlPolicy) GetEnforcementScope() EndpointControlPolicy_EnforcementScopefunc (*EndpointControlPolicy) ProtoMessage
func (*EndpointControlPolicy) ProtoMessage()func (*EndpointControlPolicy) ProtoReflect
func (x *EndpointControlPolicy) ProtoReflect() protoreflect.Messagefunc (*EndpointControlPolicy) Reset
func (x *EndpointControlPolicy) Reset()func (*EndpointControlPolicy) String
func (x *EndpointControlPolicy) String() stringEndpointControlPolicy_EnforcementScope
type EndpointControlPolicy_EnforcementScope int32Defines the scope in which this policy's allowed_origins list is enforced.
EndpointControlPolicy_ENFORCEMENT_SCOPE_UNSPECIFIED, EndpointControlPolicy_VPCSC_ONLY, EndpointControlPolicy_ALWAYS
const (
// Unspecified. This policy will be treated as VPCSC_ONLY.
EndpointControlPolicy_ENFORCEMENT_SCOPE_UNSPECIFIED EndpointControlPolicy_EnforcementScope = 0
// This policy applies only when VPC-SC is active.
EndpointControlPolicy_VPCSC_ONLY EndpointControlPolicy_EnforcementScope = 1
// This policy ALWAYS applies, regardless of VPC-SC status.
EndpointControlPolicy_ALWAYS EndpointControlPolicy_EnforcementScope = 2
)func (EndpointControlPolicy_EnforcementScope) Descriptor
func (EndpointControlPolicy_EnforcementScope) Descriptor() protoreflect.EnumDescriptorfunc (EndpointControlPolicy_EnforcementScope) Enum
func (EndpointControlPolicy_EnforcementScope) EnumDescriptor
func (EndpointControlPolicy_EnforcementScope) EnumDescriptor() ([]byte, []int)Deprecated: Use EndpointControlPolicy_EnforcementScope.Descriptor instead.
func (EndpointControlPolicy_EnforcementScope) Number
func (x EndpointControlPolicy_EnforcementScope) Number() protoreflect.EnumNumberfunc (EndpointControlPolicy_EnforcementScope) String
func (x EndpointControlPolicy_EnforcementScope) String() stringfunc (EndpointControlPolicy_EnforcementScope) Type
func (EndpointControlPolicy_EnforcementScope) Type() protoreflect.EnumTypeErrorHandlingSettings
type ErrorHandlingSettings struct {
// Optional. The strategy to use for error handling.
ErrorHandlingStrategy ErrorHandlingSettings_ErrorHandlingStrategy `protobuf:"varint,1,opt,name=error_handling_strategy,json=errorHandlingStrategy,proto3,enum=google.cloud.ces.v1.ErrorHandlingSettings_ErrorHandlingStrategy" json:"error_handling_strategy,omitempty"`
// contains filtered or unexported fields
}Settings to describe how errors should be handled in the app.
func (*ErrorHandlingSettings) Descriptor
func (*ErrorHandlingSettings) Descriptor() ([]byte, []int)Deprecated: Use ErrorHandlingSettings.ProtoReflect.Descriptor instead.
func (*ErrorHandlingSettings) GetErrorHandlingStrategy
func (x *ErrorHandlingSettings) GetErrorHandlingStrategy() ErrorHandlingSettings_ErrorHandlingStrategyfunc (*ErrorHandlingSettings) ProtoMessage
func (*ErrorHandlingSettings) ProtoMessage()func (*ErrorHandlingSettings) ProtoReflect
func (x *ErrorHandlingSettings) ProtoReflect() protoreflect.Messagefunc (*ErrorHandlingSettings) Reset
func (x *ErrorHandlingSettings) Reset()func (*ErrorHandlingSettings) String
func (x *ErrorHandlingSettings) String() stringErrorHandlingSettings_ErrorHandlingStrategy
type ErrorHandlingSettings_ErrorHandlingStrategy int32Defines the strategy for handling errors.
ErrorHandlingSettings_ERROR_HANDLING_STRATEGY_UNSPECIFIED, ErrorHandlingSettings_NONE, ErrorHandlingSettings_FALLBACK_RESPONSE, ErrorHandlingSettings_END_SESSION
const (
// Unspecified error handling strategy.
ErrorHandlingSettings_ERROR_HANDLING_STRATEGY_UNSPECIFIED ErrorHandlingSettings_ErrorHandlingStrategy = 0
// No specific handling is enabled.
ErrorHandlingSettings_NONE ErrorHandlingSettings_ErrorHandlingStrategy = 1
// A fallback message will be returned to the user in case of
// system errors (e.g. LLM errors).
ErrorHandlingSettings_FALLBACK_RESPONSE ErrorHandlingSettings_ErrorHandlingStrategy = 2
// An [EndSession][google.cloud.ces.v1.EndSession] signal will be emitted in
// case of system errors (e.g. LLM errors).
ErrorHandlingSettings_END_SESSION ErrorHandlingSettings_ErrorHandlingStrategy = 3
)func (ErrorHandlingSettings_ErrorHandlingStrategy) Descriptor
func (ErrorHandlingSettings_ErrorHandlingStrategy) Descriptor() protoreflect.EnumDescriptorfunc (ErrorHandlingSettings_ErrorHandlingStrategy) Enum
func (x ErrorHandlingSettings_ErrorHandlingStrategy) Enum() *ErrorHandlingSettings_ErrorHandlingStrategyfunc (ErrorHandlingSettings_ErrorHandlingStrategy) EnumDescriptor
func (ErrorHandlingSettings_ErrorHandlingStrategy) EnumDescriptor() ([]byte, []int)Deprecated: Use ErrorHandlingSettings_ErrorHandlingStrategy.Descriptor instead.
func (ErrorHandlingSettings_ErrorHandlingStrategy) Number
func (x ErrorHandlingSettings_ErrorHandlingStrategy) Number() protoreflect.EnumNumberfunc (ErrorHandlingSettings_ErrorHandlingStrategy) String
func (x ErrorHandlingSettings_ErrorHandlingStrategy) String() stringfunc (ErrorHandlingSettings_ErrorHandlingStrategy) Type
func (ErrorHandlingSettings_ErrorHandlingStrategy) Type() protoreflect.EnumTypeEvaluationMetricsThresholds
type EvaluationMetricsThresholds struct {
// Optional. The golden evaluation metrics thresholds.
GoldenEvaluationMetricsThresholds *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds `protobuf:"bytes,1,opt,name=golden_evaluation_metrics_thresholds,json=goldenEvaluationMetricsThresholds,proto3" json:"golden_evaluation_metrics_thresholds,omitempty"`
// Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead.
// The hallucination metric behavior is currently used for golden evaluations.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
HallucinationMetricBehavior EvaluationMetricsThresholds_HallucinationMetricBehavior `protobuf:"varint,3,opt,name=hallucination_metric_behavior,json=hallucinationMetricBehavior,proto3,enum=google.cloud.ces.v1.EvaluationMetricsThresholds_HallucinationMetricBehavior" json:"hallucination_metric_behavior,omitempty"`
// Optional. The hallucination metric behavior for golden evaluations.
GoldenHallucinationMetricBehavior EvaluationMetricsThresholds_HallucinationMetricBehavior `protobuf:"varint,5,opt,name=golden_hallucination_metric_behavior,json=goldenHallucinationMetricBehavior,proto3,enum=google.cloud.ces.v1.EvaluationMetricsThresholds_HallucinationMetricBehavior" json:"golden_hallucination_metric_behavior,omitempty"`
// Optional. The hallucination metric behavior for scenario evaluations.
ScenarioHallucinationMetricBehavior EvaluationMetricsThresholds_HallucinationMetricBehavior `protobuf:"varint,4,opt,name=scenario_hallucination_metric_behavior,json=scenarioHallucinationMetricBehavior,proto3,enum=google.cloud.ces.v1.EvaluationMetricsThresholds_HallucinationMetricBehavior" json:"scenario_hallucination_metric_behavior,omitempty"`
// contains filtered or unexported fields
}Threshold settings for metrics in an Evaluation.
func (*EvaluationMetricsThresholds) Descriptor
func (*EvaluationMetricsThresholds) Descriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds.ProtoReflect.Descriptor instead.
func (*EvaluationMetricsThresholds) GetGoldenEvaluationMetricsThresholds
func (x *EvaluationMetricsThresholds) GetGoldenEvaluationMetricsThresholds() *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholdsfunc (*EvaluationMetricsThresholds) GetGoldenHallucinationMetricBehavior
func (x *EvaluationMetricsThresholds) GetGoldenHallucinationMetricBehavior() EvaluationMetricsThresholds_HallucinationMetricBehaviorfunc (*EvaluationMetricsThresholds) GetHallucinationMetricBehavior
func (x *EvaluationMetricsThresholds) GetHallucinationMetricBehavior() EvaluationMetricsThresholds_HallucinationMetricBehaviorDeprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
func (*EvaluationMetricsThresholds) GetScenarioHallucinationMetricBehavior
func (x *EvaluationMetricsThresholds) GetScenarioHallucinationMetricBehavior() EvaluationMetricsThresholds_HallucinationMetricBehaviorfunc (*EvaluationMetricsThresholds) ProtoMessage
func (*EvaluationMetricsThresholds) ProtoMessage()func (*EvaluationMetricsThresholds) ProtoReflect
func (x *EvaluationMetricsThresholds) ProtoReflect() protoreflect.Messagefunc (*EvaluationMetricsThresholds) Reset
func (x *EvaluationMetricsThresholds) Reset()func (*EvaluationMetricsThresholds) String
func (x *EvaluationMetricsThresholds) String() stringEvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds
type EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds struct {
// Optional. The turn level metrics thresholds.
TurnLevelMetricsThresholds *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds `protobuf:"bytes,1,opt,name=turn_level_metrics_thresholds,json=turnLevelMetricsThresholds,proto3" json:"turn_level_metrics_thresholds,omitempty"`
// Optional. The expectation level metrics thresholds.
ExpectationLevelMetricsThresholds *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds `protobuf:"bytes,2,opt,name=expectation_level_metrics_thresholds,json=expectationLevelMetricsThresholds,proto3" json:"expectation_level_metrics_thresholds,omitempty"`
// Optional. The tool matching settings. An
// extra tool call is a tool call that is present in the execution but does
// not match any tool call in the golden expectation.
ToolMatchingSettings *EvaluationMetricsThresholds_ToolMatchingSettings `protobuf:"bytes,3,opt,name=tool_matching_settings,json=toolMatchingSettings,proto3" json:"tool_matching_settings,omitempty"`
// contains filtered or unexported fields
}Settings for golden evaluations.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) Descriptor
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) Descriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds.ProtoReflect.Descriptor instead.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetExpectationLevelMetricsThresholds
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetExpectationLevelMetricsThresholds() *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholdsfunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetToolMatchingSettings
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetToolMatchingSettings() *EvaluationMetricsThresholds_ToolMatchingSettingsfunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetTurnLevelMetricsThresholds
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) GetTurnLevelMetricsThresholds() *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholdsfunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) ProtoMessage
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) ProtoMessage()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) ProtoReflect
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) ProtoReflect() protoreflect.Messagefunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) Reset
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) Reset()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) String
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds) String() stringEvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds
type EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds struct {
// Optional. The success threshold for individual tool invocation
// parameter correctness. Must be a float between 0 and 1. Default is 1.0.
ToolInvocationParameterCorrectnessThreshold *float32 `protobuf:"fixed32,1,opt,name=tool_invocation_parameter_correctness_threshold,json=toolInvocationParameterCorrectnessThreshold,proto3,oneof" json:"tool_invocation_parameter_correctness_threshold,omitempty"`
// contains filtered or unexported fields
}Expectation level metrics thresholds.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) Descriptor
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) Descriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds.ProtoReflect.Descriptor instead.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) GetToolInvocationParameterCorrectnessThreshold
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) GetToolInvocationParameterCorrectnessThreshold() float32func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) ProtoMessage
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) ProtoMessage()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) ProtoReflect
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) ProtoReflect() protoreflect.Messagefunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) Reset
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) Reset()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) String
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_ExpectationLevelMetricsThresholds) String() stringEvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds
type EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds struct {
// Optional. The success threshold for semantic similarity. Must be an
// integer between 0 and 4. Default is >= 3.
SemanticSimilaritySuccessThreshold *int32 `protobuf:"varint,1,opt,name=semantic_similarity_success_threshold,json=semanticSimilaritySuccessThreshold,proto3,oneof" json:"semantic_similarity_success_threshold,omitempty"`
// Optional. The success threshold for overall tool invocation
// correctness. Must be a float between 0 and 1. Default is 1.0.
OverallToolInvocationCorrectnessThreshold *float32 `protobuf:"fixed32,2,opt,name=overall_tool_invocation_correctness_threshold,json=overallToolInvocationCorrectnessThreshold,proto3,oneof" json:"overall_tool_invocation_correctness_threshold,omitempty"`
// Optional. The semantic similarity channel to use for evaluation.
SemanticSimilarityChannel EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel `protobuf:"varint,3,opt,name=semantic_similarity_channel,json=semanticSimilarityChannel,proto3,enum=google.cloud.ces.v1.EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel" json:"semantic_similarity_channel,omitempty"`
// contains filtered or unexported fields
}Turn level metrics thresholds.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) Descriptor
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) Descriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds.ProtoReflect.Descriptor instead.
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetOverallToolInvocationCorrectnessThreshold
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetOverallToolInvocationCorrectnessThreshold() float32func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetSemanticSimilarityChannel
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetSemanticSimilarityChannel() EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannelfunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetSemanticSimilaritySuccessThreshold
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) GetSemanticSimilaritySuccessThreshold() int32func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) ProtoMessage
func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) ProtoMessage()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) ProtoReflect
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) ProtoReflect() protoreflect.Messagefunc (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) Reset
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) Reset()func (*EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) String
func (x *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds) String() stringEvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel
type EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel int32Semantic similarity channel to use.
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED, EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_TEXT, EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_AUDIO
const (
// Metric unspecified. Defaults to TEXT.
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel = 0
// Use text semantic similarity.
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_TEXT EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel = 1
// Use audio semantic similarity.
EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_AUDIO EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel = 2
)func (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Descriptor
func (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Descriptor() protoreflect.EnumDescriptorfunc (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Enum
func (x EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Enum() *EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannelfunc (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) EnumDescriptor
func (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) EnumDescriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel.Descriptor instead.
func (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Number
func (x EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Number() protoreflect.EnumNumberfunc (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) String
func (x EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) String() stringfunc (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Type
func (EvaluationMetricsThresholds_GoldenEvaluationMetricsThresholds_TurnLevelMetricsThresholds_SemanticSimilarityChannel) Type() protoreflect.EnumTypeEvaluationMetricsThresholds_HallucinationMetricBehavior
type EvaluationMetricsThresholds_HallucinationMetricBehavior int32The hallucination metric behavior. Regardless of the behavior, the metric will always be calculated. The difference is that when disabled, the metric is not used to calculate the overall evaluation score.
EvaluationMetricsThresholds_HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED, EvaluationMetricsThresholds_DISABLED, EvaluationMetricsThresholds_ENABLED
const (
// Unspecified hallucination metric behavior.
EvaluationMetricsThresholds_HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED EvaluationMetricsThresholds_HallucinationMetricBehavior = 0
// Disable hallucination metric.
EvaluationMetricsThresholds_DISABLED EvaluationMetricsThresholds_HallucinationMetricBehavior = 1
// Enable hallucination metric.
EvaluationMetricsThresholds_ENABLED EvaluationMetricsThresholds_HallucinationMetricBehavior = 2
)func (EvaluationMetricsThresholds_HallucinationMetricBehavior) Descriptor
func (EvaluationMetricsThresholds_HallucinationMetricBehavior) Descriptor() protoreflect.EnumDescriptorfunc (EvaluationMetricsThresholds_HallucinationMetricBehavior) Enum
func (x EvaluationMetricsThresholds_HallucinationMetricBehavior) Enum() *EvaluationMetricsThresholds_HallucinationMetricBehaviorfunc (EvaluationMetricsThresholds_HallucinationMetricBehavior) EnumDescriptor
func (EvaluationMetricsThresholds_HallucinationMetricBehavior) EnumDescriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_HallucinationMetricBehavior.Descriptor instead.
func (EvaluationMetricsThresholds_HallucinationMetricBehavior) Number
func (x EvaluationMetricsThresholds_HallucinationMetricBehavior) Number() protoreflect.EnumNumberfunc (EvaluationMetricsThresholds_HallucinationMetricBehavior) String
func (x EvaluationMetricsThresholds_HallucinationMetricBehavior) String() stringfunc (EvaluationMetricsThresholds_HallucinationMetricBehavior) Type
EvaluationMetricsThresholds_ToolMatchingSettings
type EvaluationMetricsThresholds_ToolMatchingSettings struct {
// Optional. Behavior for extra tool calls.
// Defaults to FAIL.
ExtraToolCallBehavior EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior `protobuf:"varint,1,opt,name=extra_tool_call_behavior,json=extraToolCallBehavior,proto3,enum=google.cloud.ces.v1.EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior" json:"extra_tool_call_behavior,omitempty"`
// contains filtered or unexported fields
}Settings for matching tool calls.
func (*EvaluationMetricsThresholds_ToolMatchingSettings) Descriptor
func (*EvaluationMetricsThresholds_ToolMatchingSettings) Descriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_ToolMatchingSettings.ProtoReflect.Descriptor instead.
func (*EvaluationMetricsThresholds_ToolMatchingSettings) GetExtraToolCallBehavior
func (x *EvaluationMetricsThresholds_ToolMatchingSettings) GetExtraToolCallBehavior() EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehaviorfunc (*EvaluationMetricsThresholds_ToolMatchingSettings) ProtoMessage
func (*EvaluationMetricsThresholds_ToolMatchingSettings) ProtoMessage()func (*EvaluationMetricsThresholds_ToolMatchingSettings) ProtoReflect
func (x *EvaluationMetricsThresholds_ToolMatchingSettings) ProtoReflect() protoreflect.Messagefunc (*EvaluationMetricsThresholds_ToolMatchingSettings) Reset
func (x *EvaluationMetricsThresholds_ToolMatchingSettings) Reset()func (*EvaluationMetricsThresholds_ToolMatchingSettings) String
func (x *EvaluationMetricsThresholds_ToolMatchingSettings) String() stringEvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior
type EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior int32Defines the behavior when an extra tool call is encountered. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
EvaluationMetricsThresholds_ToolMatchingSettings_EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED, EvaluationMetricsThresholds_ToolMatchingSettings_FAIL, EvaluationMetricsThresholds_ToolMatchingSettings_ALLOW
const (
// Unspecified behavior. Defaults to FAIL.
EvaluationMetricsThresholds_ToolMatchingSettings_EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior = 0
// Fail the evaluation if an extra tool call is encountered.
EvaluationMetricsThresholds_ToolMatchingSettings_FAIL EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior = 1
// Allow the extra tool call.
EvaluationMetricsThresholds_ToolMatchingSettings_ALLOW EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior = 2
)func (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Descriptor
func (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Descriptor() protoreflect.EnumDescriptorfunc (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Enum
func (x EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Enum() *EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehaviorfunc (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) EnumDescriptor
func (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) EnumDescriptor() ([]byte, []int)Deprecated: Use EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior.Descriptor instead.
func (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Number
func (x EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Number() protoreflect.EnumNumberfunc (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) String
func (x EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) String() stringfunc (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Type
func (EvaluationMetricsThresholds_ToolMatchingSettings_ExtraToolCallBehavior) Type() protoreflect.EnumTypeEvent
type Event struct {
// Required. The name of the event.
Event string `protobuf:"bytes,1,opt,name=event,proto3" json:"event,omitempty"`
// contains filtered or unexported fields
}Event input.
func (*Event) Descriptor
Deprecated: Use Event.ProtoReflect.Descriptor instead.
func (*Event) GetEvent
func (*Event) ProtoMessage
func (*Event) ProtoMessage()func (*Event) ProtoReflect
func (x *Event) ProtoReflect() protoreflect.Messagefunc (*Event) Reset
func (x *Event) Reset()func (*Event) String
Example
type Example struct {
// Identifier. The unique identifier of the example.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the example.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Human-readable description of the example.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The agent that initially handles the conversation. If not
// specified, the example represents a conversation that is handled by the
// root agent. Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
EntryAgent string `protobuf:"bytes,4,opt,name=entry_agent,json=entryAgent,proto3" json:"entry_agent,omitempty"`
// Optional. The collection of messages that make up the conversation.
Messages []*Message `protobuf:"bytes,5,rep,name=messages,proto3" json:"messages,omitempty"`
// Output only. Timestamp when the example was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the example was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The example may become invalid if referencing resources are
// deleted. Invalid examples will not be used as few-shot examples.
Invalid bool `protobuf:"varint,8,opt,name=invalid,proto3" json:"invalid,omitempty"`
// Etag used to ensure the object hasn't changed during a read-modify-write
// operation. If the etag is empty, the update will overwrite any concurrent
// changes.
Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}An example represents a sample conversation between the user and the agent(s).
func (*Example) Descriptor
Deprecated: Use Example.ProtoReflect.Descriptor instead.
func (*Example) GetCreateTime
func (x *Example) GetCreateTime() *timestamppb.Timestampfunc (*Example) GetDescription
func (*Example) GetDisplayName
func (*Example) GetEntryAgent
func (*Example) GetEtag
func (*Example) GetInvalid
func (*Example) GetMessages
func (*Example) GetName
func (*Example) GetUpdateTime
func (x *Example) GetUpdateTime() *timestamppb.Timestampfunc (*Example) ProtoMessage
func (*Example) ProtoMessage()func (*Example) ProtoReflect
func (x *Example) ProtoReflect() protoreflect.Messagefunc (*Example) Reset
func (x *Example) Reset()func (*Example) String
ExecuteToolRequest
type ExecuteToolRequest struct {
// The identifier of the tool to execute. It could be either a persisted tool
// or a tool from a toolset.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *ExecuteToolRequest_Tool
// *ExecuteToolRequest_ToolsetTool
ToolIdentifier isExecuteToolRequest_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// Additional context to be provided for the tool execution
//
// Types that are valid to be assigned to ToolExecutionContext:
//
// *ExecuteToolRequest_Variables
// *ExecuteToolRequest_Context
ToolExecutionContext isExecuteToolRequest_ToolExecutionContext `protobuf_oneof:"tool_execution_context"`
// Required. The resource name of the app which the tool/toolset belongs to.
// Format: `projects/{project}/locations/{location}/apps/{app}`
Parent string `protobuf:"bytes,4,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The input parameters and values for the tool in JSON object
// format.
Args *structpb.Struct `protobuf:"bytes,2,opt,name=args,proto3" json:"args,omitempty"`
// contains filtered or unexported fields
}Request message for [ToolService.ExecuteTool][google.cloud.ces.v1.ToolService.ExecuteTool].
func (*ExecuteToolRequest) Descriptor
func (*ExecuteToolRequest) Descriptor() ([]byte, []int)Deprecated: Use ExecuteToolRequest.ProtoReflect.Descriptor instead.
func (*ExecuteToolRequest) GetArgs
func (x *ExecuteToolRequest) GetArgs() *structpb.Structfunc (*ExecuteToolRequest) GetContext
func (x *ExecuteToolRequest) GetContext() *structpb.Structfunc (*ExecuteToolRequest) GetParent
func (x *ExecuteToolRequest) GetParent() stringfunc (*ExecuteToolRequest) GetTool
func (x *ExecuteToolRequest) GetTool() stringfunc (*ExecuteToolRequest) GetToolExecutionContext
func (x *ExecuteToolRequest) GetToolExecutionContext() isExecuteToolRequest_ToolExecutionContextfunc (*ExecuteToolRequest) GetToolIdentifier
func (x *ExecuteToolRequest) GetToolIdentifier() isExecuteToolRequest_ToolIdentifierfunc (*ExecuteToolRequest) GetToolsetTool
func (x *ExecuteToolRequest) GetToolsetTool() *ToolsetToolfunc (*ExecuteToolRequest) GetVariables
func (x *ExecuteToolRequest) GetVariables() *structpb.Structfunc (*ExecuteToolRequest) ProtoMessage
func (*ExecuteToolRequest) ProtoMessage()func (*ExecuteToolRequest) ProtoReflect
func (x *ExecuteToolRequest) ProtoReflect() protoreflect.Messagefunc (*ExecuteToolRequest) Reset
func (x *ExecuteToolRequest) Reset()func (*ExecuteToolRequest) String
func (x *ExecuteToolRequest) String() stringExecuteToolRequest_Context
type ExecuteToolRequest_Context struct {
// Optional. The
// [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment
// for details) to be passed to the Python tool.
Context *structpb.Struct `protobuf:"bytes,6,opt,name=context,proto3,oneof"`
}ExecuteToolRequest_Tool
type ExecuteToolRequest_Tool struct {
// Optional. The name of the tool to execute.
// Format:
// projects/{project}/locations/{location}/apps/{app}/tools/{tool}
Tool string `protobuf:"bytes,1,opt,name=tool,proto3,oneof"`
}ExecuteToolRequest_ToolsetTool
type ExecuteToolRequest_ToolsetTool struct {
// Optional. The toolset tool to execute. Only one tool should match the
// predicate from the toolset. Otherwise, an error will be returned.
ToolsetTool *ToolsetTool `protobuf:"bytes,3,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}ExecuteToolRequest_Variables
type ExecuteToolRequest_Variables struct {
// Optional. The variables that are available for the tool execution.
Variables *structpb.Struct `protobuf:"bytes,5,opt,name=variables,proto3,oneof"`
}ExecuteToolResponse
type ExecuteToolResponse struct {
// The identifier of the tool that got executed.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *ExecuteToolResponse_Tool
// *ExecuteToolResponse_ToolsetTool
ToolIdentifier isExecuteToolResponse_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// The tool execution result in JSON object format.
// Use "output" key to specify tool response and "error" key to specify
// error details (if any). If "output" and "error" keys are not specified,
// then whole "response" is treated as tool execution result.
Response *structpb.Struct `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
// The variable values at the end of the tool execution.
Variables *structpb.Struct `protobuf:"bytes,4,opt,name=variables,proto3" json:"variables,omitempty"`
// contains filtered or unexported fields
}Response message for [ToolService.ExecuteTool][google.cloud.ces.v1.ToolService.ExecuteTool].
func (*ExecuteToolResponse) Descriptor
func (*ExecuteToolResponse) Descriptor() ([]byte, []int)Deprecated: Use ExecuteToolResponse.ProtoReflect.Descriptor instead.
func (*ExecuteToolResponse) GetResponse
func (x *ExecuteToolResponse) GetResponse() *structpb.Structfunc (*ExecuteToolResponse) GetTool
func (x *ExecuteToolResponse) GetTool() stringfunc (*ExecuteToolResponse) GetToolIdentifier
func (x *ExecuteToolResponse) GetToolIdentifier() isExecuteToolResponse_ToolIdentifierfunc (*ExecuteToolResponse) GetToolsetTool
func (x *ExecuteToolResponse) GetToolsetTool() *ToolsetToolfunc (*ExecuteToolResponse) GetVariables
func (x *ExecuteToolResponse) GetVariables() *structpb.Structfunc (*ExecuteToolResponse) ProtoMessage
func (*ExecuteToolResponse) ProtoMessage()func (*ExecuteToolResponse) ProtoReflect
func (x *ExecuteToolResponse) ProtoReflect() protoreflect.Messagefunc (*ExecuteToolResponse) Reset
func (x *ExecuteToolResponse) Reset()func (*ExecuteToolResponse) String
func (x *ExecuteToolResponse) String() stringExecuteToolResponse_Tool
type ExecuteToolResponse_Tool struct {
// The name of the tool that got executed.
// Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
Tool string `protobuf:"bytes,1,opt,name=tool,proto3,oneof"`
}ExecuteToolResponse_ToolsetTool
type ExecuteToolResponse_ToolsetTool struct {
// The toolset tool that got executed.
ToolsetTool *ToolsetTool `protobuf:"bytes,3,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}ExecutionType
type ExecutionType int32The execution type of the tool or toolset.
ExecutionType_EXECUTION_TYPE_UNSPECIFIED, ExecutionType_SYNCHRONOUS, ExecutionType_ASYNCHRONOUS
const (
// The execution type is unspecified. Defaults to `SYNCHRONOUS` if
// unspecified.
ExecutionType_EXECUTION_TYPE_UNSPECIFIED ExecutionType = 0
// The tool is executed synchronously. The session is blocked
// until the tool returns.
ExecutionType_SYNCHRONOUS ExecutionType = 1
// The tool is executed asynchronously. The session will
// continue while the tool is executing.
ExecutionType_ASYNCHRONOUS ExecutionType = 2
)func (ExecutionType) Descriptor
func (ExecutionType) Descriptor() protoreflect.EnumDescriptorfunc (ExecutionType) Enum
func (x ExecutionType) Enum() *ExecutionTypefunc (ExecutionType) EnumDescriptor
func (ExecutionType) EnumDescriptor() ([]byte, []int)Deprecated: Use ExecutionType.Descriptor instead.
func (ExecutionType) Number
func (x ExecutionType) Number() protoreflect.EnumNumberfunc (ExecutionType) String
func (x ExecutionType) String() stringfunc (ExecutionType) Type
func (ExecutionType) Type() protoreflect.EnumTypeExportAppRequest
type ExportAppRequest struct {
// Required. The resource name of the app to export.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The format to export the app in.
ExportFormat ExportAppRequest_ExportFormat `protobuf:"varint,2,opt,name=export_format,json=exportFormat,proto3,enum=google.cloud.ces.v1.ExportAppRequest_ExportFormat" json:"export_format,omitempty"`
// Optional. The [Google Cloud
// Storage](https://cloud.google.com/storage/docs/) URI to which to export the
// app. The format of this URI must be `gs://Request message for [AgentService.ExportApp][google.cloud.ces.v1.AgentService.ExportApp].
func (*ExportAppRequest) Descriptor
func (*ExportAppRequest) Descriptor() ([]byte, []int)Deprecated: Use ExportAppRequest.ProtoReflect.Descriptor instead.
func (*ExportAppRequest) GetAppVersion
func (x *ExportAppRequest) GetAppVersion() stringfunc (*ExportAppRequest) GetExportFormat
func (x *ExportAppRequest) GetExportFormat() ExportAppRequest_ExportFormatfunc (*ExportAppRequest) GetGcsUri
func (x *ExportAppRequest) GetGcsUri() stringfunc (*ExportAppRequest) GetName
func (x *ExportAppRequest) GetName() stringfunc (*ExportAppRequest) ProtoMessage
func (*ExportAppRequest) ProtoMessage()func (*ExportAppRequest) ProtoReflect
func (x *ExportAppRequest) ProtoReflect() protoreflect.Messagefunc (*ExportAppRequest) Reset
func (x *ExportAppRequest) Reset()func (*ExportAppRequest) String
func (x *ExportAppRequest) String() stringExportAppRequest_ExportFormat
type ExportAppRequest_ExportFormat int32Export format for the app.
ExportAppRequest_EXPORT_FORMAT_UNSPECIFIED, ExportAppRequest_JSON, ExportAppRequest_YAML
const (
// The export format is unspecified.
ExportAppRequest_EXPORT_FORMAT_UNSPECIFIED ExportAppRequest_ExportFormat = 0
// The export format is JSON.
ExportAppRequest_JSON ExportAppRequest_ExportFormat = 1
// The export format is YAML.
ExportAppRequest_YAML ExportAppRequest_ExportFormat = 2
)func (ExportAppRequest_ExportFormat) Descriptor
func (ExportAppRequest_ExportFormat) Descriptor() protoreflect.EnumDescriptorfunc (ExportAppRequest_ExportFormat) Enum
func (x ExportAppRequest_ExportFormat) Enum() *ExportAppRequest_ExportFormatfunc (ExportAppRequest_ExportFormat) EnumDescriptor
func (ExportAppRequest_ExportFormat) EnumDescriptor() ([]byte, []int)Deprecated: Use ExportAppRequest_ExportFormat.Descriptor instead.
func (ExportAppRequest_ExportFormat) Number
func (x ExportAppRequest_ExportFormat) Number() protoreflect.EnumNumberfunc (ExportAppRequest_ExportFormat) String
func (x ExportAppRequest_ExportFormat) String() stringfunc (ExportAppRequest_ExportFormat) Type
func (ExportAppRequest_ExportFormat) Type() protoreflect.EnumTypeExportAppResponse
type ExportAppResponse struct {
// The exported app.
//
// Types that are valid to be assigned to App:
//
// *ExportAppResponse_AppContent
// *ExportAppResponse_AppUri
App isExportAppResponse_App `protobuf_oneof:"app"`
// contains filtered or unexported fields
}Response message for [AgentService.ExportApp][google.cloud.ces.v1.AgentService.ExportApp].
func (*ExportAppResponse) Descriptor
func (*ExportAppResponse) Descriptor() ([]byte, []int)Deprecated: Use ExportAppResponse.ProtoReflect.Descriptor instead.
func (*ExportAppResponse) GetApp
func (x *ExportAppResponse) GetApp() isExportAppResponse_Appfunc (*ExportAppResponse) GetAppContent
func (x *ExportAppResponse) GetAppContent() []bytefunc (*ExportAppResponse) GetAppUri
func (x *ExportAppResponse) GetAppUri() stringfunc (*ExportAppResponse) ProtoMessage
func (*ExportAppResponse) ProtoMessage()func (*ExportAppResponse) ProtoReflect
func (x *ExportAppResponse) ProtoReflect() protoreflect.Messagefunc (*ExportAppResponse) Reset
func (x *ExportAppResponse) Reset()func (*ExportAppResponse) String
func (x *ExportAppResponse) String() stringExportAppResponse_AppContent
type ExportAppResponse_AppContent struct {
// App folder compressed as a zip file.
AppContent []byte `protobuf:"bytes,1,opt,name=app_content,json=appContent,proto3,oneof"`
}ExportAppResponse_AppUri
type ExportAppResponse_AppUri struct {
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
// to which the app was exported.
AppUri string `protobuf:"bytes,2,opt,name=app_uri,json=appUri,proto3,oneof"`
}ExpressionCondition
type ExpressionCondition struct {
// Required. The string representation of cloud.api.Expression condition.
Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
// contains filtered or unexported fields
}Expression condition based on session state.
func (*ExpressionCondition) Descriptor
func (*ExpressionCondition) Descriptor() ([]byte, []int)Deprecated: Use ExpressionCondition.ProtoReflect.Descriptor instead.
func (*ExpressionCondition) GetExpression
func (x *ExpressionCondition) GetExpression() stringfunc (*ExpressionCondition) ProtoMessage
func (*ExpressionCondition) ProtoMessage()func (*ExpressionCondition) ProtoReflect
func (x *ExpressionCondition) ProtoReflect() protoreflect.Messagefunc (*ExpressionCondition) Reset
func (x *ExpressionCondition) Reset()func (*ExpressionCondition) String
func (x *ExpressionCondition) String() stringFileSearchTool
type FileSearchTool struct {
// Optional. The type of the corpus. Default is FULLY_MANAGED.
CorpusType FileSearchTool_CorpusType `protobuf:"varint,3,opt,name=corpus_type,json=corpusType,proto3,enum=google.cloud.ces.v1.FileSearchTool_CorpusType" json:"corpus_type,omitempty"`
// Required. The tool name.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The tool description.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The corpus where files are stored.
// Format:
// projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
FileCorpus string `protobuf:"bytes,6,opt,name=file_corpus,json=fileCorpus,proto3" json:"file_corpus,omitempty"`
// contains filtered or unexported fields
}The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.
func (*FileSearchTool) Descriptor
func (*FileSearchTool) Descriptor() ([]byte, []int)Deprecated: Use FileSearchTool.ProtoReflect.Descriptor instead.
func (*FileSearchTool) GetCorpusType
func (x *FileSearchTool) GetCorpusType() FileSearchTool_CorpusTypefunc (*FileSearchTool) GetDescription
func (x *FileSearchTool) GetDescription() stringfunc (*FileSearchTool) GetFileCorpus
func (x *FileSearchTool) GetFileCorpus() stringfunc (*FileSearchTool) GetName
func (x *FileSearchTool) GetName() stringfunc (*FileSearchTool) ProtoMessage
func (*FileSearchTool) ProtoMessage()func (*FileSearchTool) ProtoReflect
func (x *FileSearchTool) ProtoReflect() protoreflect.Messagefunc (*FileSearchTool) Reset
func (x *FileSearchTool) Reset()func (*FileSearchTool) String
func (x *FileSearchTool) String() stringFileSearchTool_CorpusType
type FileSearchTool_CorpusType int32The type of the Vertex RAG corpus.
FileSearchTool_CORPUS_TYPE_UNSPECIFIED, FileSearchTool_USER_OWNED, FileSearchTool_FULLY_MANAGED
const (
// Unspecified corpus type.
FileSearchTool_CORPUS_TYPE_UNSPECIFIED FileSearchTool_CorpusType = 0
// The corpus is created and owned by the user.
FileSearchTool_USER_OWNED FileSearchTool_CorpusType = 1
// The corpus is created by the agent.
FileSearchTool_FULLY_MANAGED FileSearchTool_CorpusType = 2
)func (FileSearchTool_CorpusType) Descriptor
func (FileSearchTool_CorpusType) Descriptor() protoreflect.EnumDescriptorfunc (FileSearchTool_CorpusType) Enum
func (x FileSearchTool_CorpusType) Enum() *FileSearchTool_CorpusTypefunc (FileSearchTool_CorpusType) EnumDescriptor
func (FileSearchTool_CorpusType) EnumDescriptor() ([]byte, []int)Deprecated: Use FileSearchTool_CorpusType.Descriptor instead.
func (FileSearchTool_CorpusType) Number
func (x FileSearchTool_CorpusType) Number() protoreflect.EnumNumberfunc (FileSearchTool_CorpusType) String
func (x FileSearchTool_CorpusType) String() stringfunc (FileSearchTool_CorpusType) Type
func (FileSearchTool_CorpusType) Type() protoreflect.EnumTypeGenerateChatTokenRequest
type GenerateChatTokenRequest struct {
// Required. The session name to generate the chat token for.
// Format:
// projects/{project}/locations/{location}/apps/{app}/sessions/{session}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The deployment of the app to use for the session.
// Format:
// projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Deployment string `protobuf:"bytes,2,opt,name=deployment,proto3" json:"deployment,omitempty"`
// Optional. The reCAPTCHA token generated by the client-side chat widget.
RecaptchaToken string `protobuf:"bytes,3,opt,name=recaptcha_token,json=recaptchaToken,proto3" json:"recaptcha_token,omitempty"`
// Optional. Indicates if live handoff is enabled for the session.
LiveHandoffEnabled bool `protobuf:"varint,4,opt,name=live_handoff_enabled,json=liveHandoffEnabled,proto3" json:"live_handoff_enabled,omitempty"`
// contains filtered or unexported fields
}Request message for [WidgetService.GenerateChatToken][google.cloud.ces.v1.WidgetService.GenerateChatToken].
func (*GenerateChatTokenRequest) Descriptor
func (*GenerateChatTokenRequest) Descriptor() ([]byte, []int)Deprecated: Use GenerateChatTokenRequest.ProtoReflect.Descriptor instead.
func (*GenerateChatTokenRequest) GetDeployment
func (x *GenerateChatTokenRequest) GetDeployment() stringfunc (*GenerateChatTokenRequest) GetLiveHandoffEnabled
func (x *GenerateChatTokenRequest) GetLiveHandoffEnabled() boolfunc (*GenerateChatTokenRequest) GetName
func (x *GenerateChatTokenRequest) GetName() stringfunc (*GenerateChatTokenRequest) GetRecaptchaToken
func (x *GenerateChatTokenRequest) GetRecaptchaToken() stringfunc (*GenerateChatTokenRequest) ProtoMessage
func (*GenerateChatTokenRequest) ProtoMessage()func (*GenerateChatTokenRequest) ProtoReflect
func (x *GenerateChatTokenRequest) ProtoReflect() protoreflect.Messagefunc (*GenerateChatTokenRequest) Reset
func (x *GenerateChatTokenRequest) Reset()func (*GenerateChatTokenRequest) String
func (x *GenerateChatTokenRequest) String() stringGenerateChatTokenResponse
type GenerateChatTokenResponse struct {
// The session scoped token for chat widget to authenticate with Session APIs.
ChatToken string `protobuf:"bytes,1,opt,name=chat_token,json=chatToken,proto3" json:"chat_token,omitempty"`
// The time at which the chat token expires.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}Response message for [WidgetService.GenerateChatToken][google.cloud.ces.v1.WidgetService.GenerateChatToken].
func (*GenerateChatTokenResponse) Descriptor
func (*GenerateChatTokenResponse) Descriptor() ([]byte, []int)Deprecated: Use GenerateChatTokenResponse.ProtoReflect.Descriptor instead.
func (*GenerateChatTokenResponse) GetChatToken
func (x *GenerateChatTokenResponse) GetChatToken() stringfunc (*GenerateChatTokenResponse) GetExpireTime
func (x *GenerateChatTokenResponse) GetExpireTime() *timestamppb.Timestampfunc (*GenerateChatTokenResponse) ProtoMessage
func (*GenerateChatTokenResponse) ProtoMessage()func (*GenerateChatTokenResponse) ProtoReflect
func (x *GenerateChatTokenResponse) ProtoReflect() protoreflect.Messagefunc (*GenerateChatTokenResponse) Reset
func (x *GenerateChatTokenResponse) Reset()func (*GenerateChatTokenResponse) String
func (x *GenerateChatTokenResponse) String() stringGetAgentRequest
type GetAgentRequest struct {
// Required. The resource name of the agent to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetAgent][google.cloud.ces.v1.AgentService.GetAgent].
func (*GetAgentRequest) Descriptor
func (*GetAgentRequest) Descriptor() ([]byte, []int)Deprecated: Use GetAgentRequest.ProtoReflect.Descriptor instead.
func (*GetAgentRequest) GetName
func (x *GetAgentRequest) GetName() stringfunc (*GetAgentRequest) ProtoMessage
func (*GetAgentRequest) ProtoMessage()func (*GetAgentRequest) ProtoReflect
func (x *GetAgentRequest) ProtoReflect() protoreflect.Messagefunc (*GetAgentRequest) Reset
func (x *GetAgentRequest) Reset()func (*GetAgentRequest) String
func (x *GetAgentRequest) String() stringGetAppRequest
type GetAppRequest struct {
// Required. The resource name of the app to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetApp][google.cloud.ces.v1.AgentService.GetApp].
func (*GetAppRequest) Descriptor
func (*GetAppRequest) Descriptor() ([]byte, []int)Deprecated: Use GetAppRequest.ProtoReflect.Descriptor instead.
func (*GetAppRequest) GetName
func (x *GetAppRequest) GetName() stringfunc (*GetAppRequest) ProtoMessage
func (*GetAppRequest) ProtoMessage()func (*GetAppRequest) ProtoReflect
func (x *GetAppRequest) ProtoReflect() protoreflect.Messagefunc (*GetAppRequest) Reset
func (x *GetAppRequest) Reset()func (*GetAppRequest) String
func (x *GetAppRequest) String() stringGetAppVersionRequest
type GetAppVersionRequest struct {
// Required. The resource name of the app version to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetAppVersion][google.cloud.ces.v1.AgentService.GetAppVersion].
func (*GetAppVersionRequest) Descriptor
func (*GetAppVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use GetAppVersionRequest.ProtoReflect.Descriptor instead.
func (*GetAppVersionRequest) GetName
func (x *GetAppVersionRequest) GetName() stringfunc (*GetAppVersionRequest) ProtoMessage
func (*GetAppVersionRequest) ProtoMessage()func (*GetAppVersionRequest) ProtoReflect
func (x *GetAppVersionRequest) ProtoReflect() protoreflect.Messagefunc (*GetAppVersionRequest) Reset
func (x *GetAppVersionRequest) Reset()func (*GetAppVersionRequest) String
func (x *GetAppVersionRequest) String() stringGetChangelogRequest
type GetChangelogRequest struct {
// Required. The resource name of the changelog to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetChangelog][google.cloud.ces.v1.AgentService.GetChangelog].
func (*GetChangelogRequest) Descriptor
func (*GetChangelogRequest) Descriptor() ([]byte, []int)Deprecated: Use GetChangelogRequest.ProtoReflect.Descriptor instead.
func (*GetChangelogRequest) GetName
func (x *GetChangelogRequest) GetName() stringfunc (*GetChangelogRequest) ProtoMessage
func (*GetChangelogRequest) ProtoMessage()func (*GetChangelogRequest) ProtoReflect
func (x *GetChangelogRequest) ProtoReflect() protoreflect.Messagefunc (*GetChangelogRequest) Reset
func (x *GetChangelogRequest) Reset()func (*GetChangelogRequest) String
func (x *GetChangelogRequest) String() stringGetConversationRequest
type GetConversationRequest struct {
// Required. The resource name of the conversation to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Indicate the source of the conversation. If not set, all source
// will be searched.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/agent_service.proto.
Source Conversation_Source `protobuf:"varint,2,opt,name=source,proto3,enum=google.cloud.ces.v1.Conversation_Source" json:"source,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetConversation][google.cloud.ces.v1.AgentService.GetConversation].
func (*GetConversationRequest) Descriptor
func (*GetConversationRequest) Descriptor() ([]byte, []int)Deprecated: Use GetConversationRequest.ProtoReflect.Descriptor instead.
func (*GetConversationRequest) GetName
func (x *GetConversationRequest) GetName() stringfunc (*GetConversationRequest) GetSource
func (x *GetConversationRequest) GetSource() Conversation_SourceDeprecated: Marked as deprecated in google/cloud/ces/v1/agent_service.proto.
func (*GetConversationRequest) ProtoMessage
func (*GetConversationRequest) ProtoMessage()func (*GetConversationRequest) ProtoReflect
func (x *GetConversationRequest) ProtoReflect() protoreflect.Messagefunc (*GetConversationRequest) Reset
func (x *GetConversationRequest) Reset()func (*GetConversationRequest) String
func (x *GetConversationRequest) String() stringGetDeploymentRequest
type GetDeploymentRequest struct {
// Required. The name of the deployment.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetDeployment][google.cloud.ces.v1.AgentService.GetDeployment].
func (*GetDeploymentRequest) Descriptor
func (*GetDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDeploymentRequest.ProtoReflect.Descriptor instead.
func (*GetDeploymentRequest) GetName
func (x *GetDeploymentRequest) GetName() stringfunc (*GetDeploymentRequest) ProtoMessage
func (*GetDeploymentRequest) ProtoMessage()func (*GetDeploymentRequest) ProtoReflect
func (x *GetDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*GetDeploymentRequest) Reset
func (x *GetDeploymentRequest) Reset()func (*GetDeploymentRequest) String
func (x *GetDeploymentRequest) String() stringGetExampleRequest
type GetExampleRequest struct {
// Required. The resource name of the example to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetExample][google.cloud.ces.v1.AgentService.GetExample].
func (*GetExampleRequest) Descriptor
func (*GetExampleRequest) Descriptor() ([]byte, []int)Deprecated: Use GetExampleRequest.ProtoReflect.Descriptor instead.
func (*GetExampleRequest) GetName
func (x *GetExampleRequest) GetName() stringfunc (*GetExampleRequest) ProtoMessage
func (*GetExampleRequest) ProtoMessage()func (*GetExampleRequest) ProtoReflect
func (x *GetExampleRequest) ProtoReflect() protoreflect.Messagefunc (*GetExampleRequest) Reset
func (x *GetExampleRequest) Reset()func (*GetExampleRequest) String
func (x *GetExampleRequest) String() stringGetGuardrailRequest
type GetGuardrailRequest struct {
// Required. The resource name of the guardrail to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetGuardrail][google.cloud.ces.v1.AgentService.GetGuardrail].
func (*GetGuardrailRequest) Descriptor
func (*GetGuardrailRequest) Descriptor() ([]byte, []int)Deprecated: Use GetGuardrailRequest.ProtoReflect.Descriptor instead.
func (*GetGuardrailRequest) GetName
func (x *GetGuardrailRequest) GetName() stringfunc (*GetGuardrailRequest) ProtoMessage
func (*GetGuardrailRequest) ProtoMessage()func (*GetGuardrailRequest) ProtoReflect
func (x *GetGuardrailRequest) ProtoReflect() protoreflect.Messagefunc (*GetGuardrailRequest) Reset
func (x *GetGuardrailRequest) Reset()func (*GetGuardrailRequest) String
func (x *GetGuardrailRequest) String() stringGetToolRequest
type GetToolRequest struct {
// Required. The resource name of the tool to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetTool][google.cloud.ces.v1.AgentService.GetTool].
func (*GetToolRequest) Descriptor
func (*GetToolRequest) Descriptor() ([]byte, []int)Deprecated: Use GetToolRequest.ProtoReflect.Descriptor instead.
func (*GetToolRequest) GetName
func (x *GetToolRequest) GetName() stringfunc (*GetToolRequest) ProtoMessage
func (*GetToolRequest) ProtoMessage()func (*GetToolRequest) ProtoReflect
func (x *GetToolRequest) ProtoReflect() protoreflect.Messagefunc (*GetToolRequest) Reset
func (x *GetToolRequest) Reset()func (*GetToolRequest) String
func (x *GetToolRequest) String() stringGetToolsetRequest
type GetToolsetRequest struct {
// Required. The resource name of the toolset to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.GetToolset][google.cloud.ces.v1.AgentService.GetToolset].
func (*GetToolsetRequest) Descriptor
func (*GetToolsetRequest) Descriptor() ([]byte, []int)Deprecated: Use GetToolsetRequest.ProtoReflect.Descriptor instead.
func (*GetToolsetRequest) GetName
func (x *GetToolsetRequest) GetName() stringfunc (*GetToolsetRequest) ProtoMessage
func (*GetToolsetRequest) ProtoMessage()func (*GetToolsetRequest) ProtoReflect
func (x *GetToolsetRequest) ProtoReflect() protoreflect.Messagefunc (*GetToolsetRequest) Reset
func (x *GetToolsetRequest) Reset()func (*GetToolsetRequest) String
func (x *GetToolsetRequest) String() stringGoAway
type GoAway struct {
// contains filtered or unexported fields
}Indicates that the server will disconnect soon and the client should half-close and restart the connection.
func (*GoAway) Descriptor
Deprecated: Use GoAway.ProtoReflect.Descriptor instead.
func (*GoAway) ProtoMessage
func (*GoAway) ProtoMessage()func (*GoAway) ProtoReflect
func (x *GoAway) ProtoReflect() protoreflect.Messagefunc (*GoAway) Reset
func (x *GoAway) Reset()func (*GoAway) String
GoogleSearchSuggestions
type GoogleSearchSuggestions struct {
// Compliant HTML and CSS styling for search suggestions.
// The provided HTML and CSS automatically adapts to your device settings,
// displaying in either light or dark mode indicated by
// `@media(prefers-color-scheme)`.
Htmls []string `protobuf:"bytes,1,rep,name=htmls,proto3" json:"htmls,omitempty"`
// List of queries used to perform the google search along with the search
// result URIs forming the search suggestions.
WebSearchQueries []*WebSearchQuery `protobuf:"bytes,2,rep,name=web_search_queries,json=webSearchQueries,proto3" json:"web_search_queries,omitempty"`
// contains filtered or unexported fields
}Search suggestions from [Google Search Tool][google.cloud.ces.v1.GoogleSearchTool].
func (*GoogleSearchSuggestions) Descriptor
func (*GoogleSearchSuggestions) Descriptor() ([]byte, []int)Deprecated: Use GoogleSearchSuggestions.ProtoReflect.Descriptor instead.
func (*GoogleSearchSuggestions) GetHtmls
func (x *GoogleSearchSuggestions) GetHtmls() []stringfunc (*GoogleSearchSuggestions) GetWebSearchQueries
func (x *GoogleSearchSuggestions) GetWebSearchQueries() []*WebSearchQueryfunc (*GoogleSearchSuggestions) ProtoMessage
func (*GoogleSearchSuggestions) ProtoMessage()func (*GoogleSearchSuggestions) ProtoReflect
func (x *GoogleSearchSuggestions) ProtoReflect() protoreflect.Messagefunc (*GoogleSearchSuggestions) Reset
func (x *GoogleSearchSuggestions) Reset()func (*GoogleSearchSuggestions) String
func (x *GoogleSearchSuggestions) String() stringGoogleSearchTool
type GoogleSearchTool struct {
// Required. The name of the tool.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Description of the tool's purpose.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Content will be fetched directly from these URLs for context and
// grounding. Example: "https://example.com/path.html". A maximum of 20 URLs
// are allowed.
ContextUrls []string `protobuf:"bytes,3,rep,name=context_urls,json=contextUrls,proto3" json:"context_urls,omitempty"`
// Optional. Specifies domains to restrict search results to.
// Example: "example.com", "another.site". A maximum of 20 domains can be
// specified.
PreferredDomains []string `protobuf:"bytes,6,rep,name=preferred_domains,json=preferredDomains,proto3" json:"preferred_domains,omitempty"`
// Optional. List of domains to be excluded from the search results.
// Example: "example.com".
// A maximum of 2000 domains can be excluded.
ExcludeDomains []string `protobuf:"bytes,4,rep,name=exclude_domains,json=excludeDomains,proto3" json:"exclude_domains,omitempty"`
// Optional. Prompt instructions passed to planner on how the search results
// should be processed for text and voice.
PromptConfig *GoogleSearchTool_PromptConfig `protobuf:"bytes,5,opt,name=prompt_config,json=promptConfig,proto3" json:"prompt_config,omitempty"`
// contains filtered or unexported fields
}Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.
func (*GoogleSearchTool) Descriptor
func (*GoogleSearchTool) Descriptor() ([]byte, []int)Deprecated: Use GoogleSearchTool.ProtoReflect.Descriptor instead.
func (*GoogleSearchTool) GetContextUrls
func (x *GoogleSearchTool) GetContextUrls() []stringfunc (*GoogleSearchTool) GetDescription
func (x *GoogleSearchTool) GetDescription() stringfunc (*GoogleSearchTool) GetExcludeDomains
func (x *GoogleSearchTool) GetExcludeDomains() []stringfunc (*GoogleSearchTool) GetName
func (x *GoogleSearchTool) GetName() stringfunc (*GoogleSearchTool) GetPreferredDomains
func (x *GoogleSearchTool) GetPreferredDomains() []stringfunc (*GoogleSearchTool) GetPromptConfig
func (x *GoogleSearchTool) GetPromptConfig() *GoogleSearchTool_PromptConfigfunc (*GoogleSearchTool) ProtoMessage
func (*GoogleSearchTool) ProtoMessage()func (*GoogleSearchTool) ProtoReflect
func (x *GoogleSearchTool) ProtoReflect() protoreflect.Messagefunc (*GoogleSearchTool) Reset
func (x *GoogleSearchTool) Reset()func (*GoogleSearchTool) String
func (x *GoogleSearchTool) String() stringGoogleSearchTool_PromptConfig
type GoogleSearchTool_PromptConfig struct {
// Optional. Defines the prompt used for the system instructions when
// interacting with the agent in chat conversations. If not set, default
// prompt will be used.
TextPrompt string `protobuf:"bytes,1,opt,name=text_prompt,json=textPrompt,proto3" json:"text_prompt,omitempty"`
// Optional. Defines the prompt used for the system instructions when
// interacting with the agent in voice conversations. If not set, default
// prompt will be used.
VoicePrompt string `protobuf:"bytes,2,opt,name=voice_prompt,json=voicePrompt,proto3" json:"voice_prompt,omitempty"`
// contains filtered or unexported fields
}Prompt settings used by the model when processing or summarizing the google search results.
func (*GoogleSearchTool_PromptConfig) Descriptor
func (*GoogleSearchTool_PromptConfig) Descriptor() ([]byte, []int)Deprecated: Use GoogleSearchTool_PromptConfig.ProtoReflect.Descriptor instead.
func (*GoogleSearchTool_PromptConfig) GetTextPrompt
func (x *GoogleSearchTool_PromptConfig) GetTextPrompt() stringfunc (*GoogleSearchTool_PromptConfig) GetVoicePrompt
func (x *GoogleSearchTool_PromptConfig) GetVoicePrompt() stringfunc (*GoogleSearchTool_PromptConfig) ProtoMessage
func (*GoogleSearchTool_PromptConfig) ProtoMessage()func (*GoogleSearchTool_PromptConfig) ProtoReflect
func (x *GoogleSearchTool_PromptConfig) ProtoReflect() protoreflect.Messagefunc (*GoogleSearchTool_PromptConfig) Reset
func (x *GoogleSearchTool_PromptConfig) Reset()func (*GoogleSearchTool_PromptConfig) String
func (x *GoogleSearchTool_PromptConfig) String() stringGuardrail
type Guardrail struct {
// Guardrail type.
//
// Types that are valid to be assigned to GuardrailType:
//
// *Guardrail_ContentFilter_
// *Guardrail_LlmPromptSecurity_
// *Guardrail_LlmPolicy_
// *Guardrail_ModelSafety_
// *Guardrail_CodeCallback_
GuardrailType isGuardrail_GuardrailType `protobuf_oneof:"guardrail_type"`
// Identifier. The unique identifier of the guardrail.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the guardrail.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Description of the guardrail.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Whether the guardrail is enabled.
Enabled bool `protobuf:"varint,4,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Optional. Action to take when the guardrail is triggered.
Action *TriggerAction `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
// Output only. Timestamp when the guardrail was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the guardrail was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Etag used to ensure the object hasn't changed during a read-modify-write
// operation. If the etag is empty, the update will overwrite any concurrent
// changes.
Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Guardrail contains a list of checks and balances to keep the agents safe and secure.
func (*Guardrail) Descriptor
Deprecated: Use Guardrail.ProtoReflect.Descriptor instead.
func (*Guardrail) GetAction
func (x *Guardrail) GetAction() *TriggerActionfunc (*Guardrail) GetCodeCallback
func (x *Guardrail) GetCodeCallback() *Guardrail_CodeCallbackfunc (*Guardrail) GetContentFilter
func (x *Guardrail) GetContentFilter() *Guardrail_ContentFilterfunc (*Guardrail) GetCreateTime
func (x *Guardrail) GetCreateTime() *timestamppb.Timestampfunc (*Guardrail) GetDescription
func (*Guardrail) GetDisplayName
func (*Guardrail) GetEnabled
func (*Guardrail) GetEtag
func (*Guardrail) GetGuardrailType
func (x *Guardrail) GetGuardrailType() isGuardrail_GuardrailTypefunc (*Guardrail) GetLlmPolicy
func (x *Guardrail) GetLlmPolicy() *Guardrail_LlmPolicyfunc (*Guardrail) GetLlmPromptSecurity
func (x *Guardrail) GetLlmPromptSecurity() *Guardrail_LlmPromptSecurityfunc (*Guardrail) GetModelSafety
func (x *Guardrail) GetModelSafety() *Guardrail_ModelSafetyfunc (*Guardrail) GetName
func (*Guardrail) GetUpdateTime
func (x *Guardrail) GetUpdateTime() *timestamppb.Timestampfunc (*Guardrail) ProtoMessage
func (*Guardrail) ProtoMessage()func (*Guardrail) ProtoReflect
func (x *Guardrail) ProtoReflect() protoreflect.Messagefunc (*Guardrail) Reset
func (x *Guardrail) Reset()func (*Guardrail) String
Guardrail_CodeCallback
type Guardrail_CodeCallback struct {
// Optional. The callback to execute before the agent is called.
// Each callback function is expected to return a structure (e.g., a dict or
// object) containing at least:
// - 'decision': Either 'OK' or 'TRIGGER'.
// - 'reason': A string explaining the decision.
//
// A 'TRIGGER' decision may halt further processing.
BeforeAgentCallback *Callback `protobuf:"bytes,1,opt,name=before_agent_callback,json=beforeAgentCallback,proto3" json:"before_agent_callback,omitempty"`
// Optional. The callback to execute after the agent is called.
// Each callback function is expected to return a structure (e.g., a dict or
// object) containing at least:
// - 'decision': Either 'OK' or 'TRIGGER'.
// - 'reason': A string explaining the decision.
//
// A 'TRIGGER' decision may halt further processing.
AfterAgentCallback *Callback `protobuf:"bytes,2,opt,name=after_agent_callback,json=afterAgentCallback,proto3" json:"after_agent_callback,omitempty"`
// Optional. The callback to execute before the model is called. If there
// are multiple calls to the model, the callback will be executed multiple
// times. Each callback function is expected to return a structure (e.g., a
// dict or object) containing at least:
// - 'decision': Either 'OK' or 'TRIGGER'.
// - 'reason': A string explaining the decision.
//
// A 'TRIGGER' decision may halt further processing.
BeforeModelCallback *Callback `protobuf:"bytes,3,opt,name=before_model_callback,json=beforeModelCallback,proto3" json:"before_model_callback,omitempty"`
// Optional. The callback to execute after the model is called. If there are
// multiple calls to the model, the callback will be executed multiple
// times. Each callback function is expected to return a structure (e.g., a
// dict or object) containing at least:
// - 'decision': Either 'OK' or 'TRIGGER'.
// - 'reason': A string explaining the decision.
//
// A 'TRIGGER' decision may halt further processing.
AfterModelCallback *Callback `protobuf:"bytes,4,opt,name=after_model_callback,json=afterModelCallback,proto3" json:"after_model_callback,omitempty"`
// contains filtered or unexported fields
}Guardrail that blocks the conversation based on the code callbacks provided.
func (*Guardrail_CodeCallback) Descriptor
func (*Guardrail_CodeCallback) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_CodeCallback.ProtoReflect.Descriptor instead.
func (*Guardrail_CodeCallback) GetAfterAgentCallback
func (x *Guardrail_CodeCallback) GetAfterAgentCallback() *Callbackfunc (*Guardrail_CodeCallback) GetAfterModelCallback
func (x *Guardrail_CodeCallback) GetAfterModelCallback() *Callbackfunc (*Guardrail_CodeCallback) GetBeforeAgentCallback
func (x *Guardrail_CodeCallback) GetBeforeAgentCallback() *Callbackfunc (*Guardrail_CodeCallback) GetBeforeModelCallback
func (x *Guardrail_CodeCallback) GetBeforeModelCallback() *Callbackfunc (*Guardrail_CodeCallback) ProtoMessage
func (*Guardrail_CodeCallback) ProtoMessage()func (*Guardrail_CodeCallback) ProtoReflect
func (x *Guardrail_CodeCallback) ProtoReflect() protoreflect.Messagefunc (*Guardrail_CodeCallback) Reset
func (x *Guardrail_CodeCallback) Reset()func (*Guardrail_CodeCallback) String
func (x *Guardrail_CodeCallback) String() stringGuardrail_CodeCallback_
type Guardrail_CodeCallback_ struct {
// Optional. Guardrail that potentially blocks the conversation based on the
// result of the callback execution.
CodeCallback *Guardrail_CodeCallback `protobuf:"bytes,14,opt,name=code_callback,json=codeCallback,proto3,oneof"`
}Guardrail_ContentFilter
type Guardrail_ContentFilter struct {
// Optional. List of banned phrases. Applies to both user inputs and agent
// responses.
BannedContents []string `protobuf:"bytes,1,rep,name=banned_contents,json=bannedContents,proto3" json:"banned_contents,omitempty"`
// Optional. List of banned phrases. Applies only to user inputs.
BannedContentsInUserInput []string `protobuf:"bytes,2,rep,name=banned_contents_in_user_input,json=bannedContentsInUserInput,proto3" json:"banned_contents_in_user_input,omitempty"`
// Optional. List of banned phrases. Applies only to agent responses.
BannedContentsInAgentResponse []string `protobuf:"bytes,3,rep,name=banned_contents_in_agent_response,json=bannedContentsInAgentResponse,proto3" json:"banned_contents_in_agent_response,omitempty"`
// Required. Match type for the content filter.
MatchType Guardrail_ContentFilter_MatchType `protobuf:"varint,4,opt,name=match_type,json=matchType,proto3,enum=google.cloud.ces.v1.Guardrail_ContentFilter_MatchType" json:"match_type,omitempty"`
// Optional. If true, diacritics are ignored during matching.
DisregardDiacritics bool `protobuf:"varint,5,opt,name=disregard_diacritics,json=disregardDiacritics,proto3" json:"disregard_diacritics,omitempty"`
// contains filtered or unexported fields
}Guardrail that bans certain content from being used in the conversation.
func (*Guardrail_ContentFilter) Descriptor
func (*Guardrail_ContentFilter) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_ContentFilter.ProtoReflect.Descriptor instead.
func (*Guardrail_ContentFilter) GetBannedContents
func (x *Guardrail_ContentFilter) GetBannedContents() []stringfunc (*Guardrail_ContentFilter) GetBannedContentsInAgentResponse
func (x *Guardrail_ContentFilter) GetBannedContentsInAgentResponse() []stringfunc (*Guardrail_ContentFilter) GetBannedContentsInUserInput
func (x *Guardrail_ContentFilter) GetBannedContentsInUserInput() []stringfunc (*Guardrail_ContentFilter) GetDisregardDiacritics
func (x *Guardrail_ContentFilter) GetDisregardDiacritics() boolfunc (*Guardrail_ContentFilter) GetMatchType
func (x *Guardrail_ContentFilter) GetMatchType() Guardrail_ContentFilter_MatchTypefunc (*Guardrail_ContentFilter) ProtoMessage
func (*Guardrail_ContentFilter) ProtoMessage()func (*Guardrail_ContentFilter) ProtoReflect
func (x *Guardrail_ContentFilter) ProtoReflect() protoreflect.Messagefunc (*Guardrail_ContentFilter) Reset
func (x *Guardrail_ContentFilter) Reset()func (*Guardrail_ContentFilter) String
func (x *Guardrail_ContentFilter) String() stringGuardrail_ContentFilter_
type Guardrail_ContentFilter_ struct {
// Optional. Guardrail that bans certain content from being used in the
// conversation.
ContentFilter *Guardrail_ContentFilter `protobuf:"bytes,8,opt,name=content_filter,json=contentFilter,proto3,oneof"`
}Guardrail_ContentFilter_MatchType
type Guardrail_ContentFilter_MatchType int32Match type for the content filter.
Guardrail_ContentFilter_MATCH_TYPE_UNSPECIFIED, Guardrail_ContentFilter_SIMPLE_STRING_MATCH, Guardrail_ContentFilter_WORD_BOUNDARY_STRING_MATCH, Guardrail_ContentFilter_REGEXP_MATCH
const (
// Match type is not specified.
Guardrail_ContentFilter_MATCH_TYPE_UNSPECIFIED Guardrail_ContentFilter_MatchType = 0
// Content is matched for substrings character by character.
Guardrail_ContentFilter_SIMPLE_STRING_MATCH Guardrail_ContentFilter_MatchType = 1
// Content only matches if the pattern found in the text is
// surrounded by word delimiters. Banned phrases can also contain word
// delimiters.
Guardrail_ContentFilter_WORD_BOUNDARY_STRING_MATCH Guardrail_ContentFilter_MatchType = 2
// Content is matched using regular expression syntax.
Guardrail_ContentFilter_REGEXP_MATCH Guardrail_ContentFilter_MatchType = 3
)func (Guardrail_ContentFilter_MatchType) Descriptor
func (Guardrail_ContentFilter_MatchType) Descriptor() protoreflect.EnumDescriptorfunc (Guardrail_ContentFilter_MatchType) Enum
func (x Guardrail_ContentFilter_MatchType) Enum() *Guardrail_ContentFilter_MatchTypefunc (Guardrail_ContentFilter_MatchType) EnumDescriptor
func (Guardrail_ContentFilter_MatchType) EnumDescriptor() ([]byte, []int)Deprecated: Use Guardrail_ContentFilter_MatchType.Descriptor instead.
func (Guardrail_ContentFilter_MatchType) Number
func (x Guardrail_ContentFilter_MatchType) Number() protoreflect.EnumNumberfunc (Guardrail_ContentFilter_MatchType) String
func (x Guardrail_ContentFilter_MatchType) String() stringfunc (Guardrail_ContentFilter_MatchType) Type
func (Guardrail_ContentFilter_MatchType) Type() protoreflect.EnumTypeGuardrail_LlmPolicy
type Guardrail_LlmPolicy struct {
// Optional. When checking this policy, consider the last 'n' messages in
// the conversation. When not set a default value of 10 will be used.
MaxConversationMessages int32 `protobuf:"varint,1,opt,name=max_conversation_messages,json=maxConversationMessages,proto3" json:"max_conversation_messages,omitempty"`
// Optional. Model settings.
ModelSettings *ModelSettings `protobuf:"bytes,2,opt,name=model_settings,json=modelSettings,proto3" json:"model_settings,omitempty"`
// Required. Policy prompt.
Prompt string `protobuf:"bytes,3,opt,name=prompt,proto3" json:"prompt,omitempty"`
// Required. Defines when to apply the policy check during the conversation.
// If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the
// user input. When applying the policy to the agent response, additional
// latency will be introduced before the agent can respond.
PolicyScope Guardrail_LlmPolicy_PolicyScope `protobuf:"varint,4,opt,name=policy_scope,json=policyScope,proto3,enum=google.cloud.ces.v1.Guardrail_LlmPolicy_PolicyScope" json:"policy_scope,omitempty"`
// Optional. If an error occurs during the policy check, fail open and do
// not trigger the guardrail.
FailOpen bool `protobuf:"varint,5,opt,name=fail_open,json=failOpen,proto3" json:"fail_open,omitempty"`
// Optional. By default, the LLM policy check is bypassed for short
// utterances. Enabling this setting applies the policy check to all
// utterances, including those that would normally be skipped.
AllowShortUtterance bool `protobuf:"varint,6,opt,name=allow_short_utterance,json=allowShortUtterance,proto3" json:"allow_short_utterance,omitempty"`
// contains filtered or unexported fields
}Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.
func (*Guardrail_LlmPolicy) Descriptor
func (*Guardrail_LlmPolicy) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_LlmPolicy.ProtoReflect.Descriptor instead.
func (*Guardrail_LlmPolicy) GetAllowShortUtterance
func (x *Guardrail_LlmPolicy) GetAllowShortUtterance() boolfunc (*Guardrail_LlmPolicy) GetFailOpen
func (x *Guardrail_LlmPolicy) GetFailOpen() boolfunc (*Guardrail_LlmPolicy) GetMaxConversationMessages
func (x *Guardrail_LlmPolicy) GetMaxConversationMessages() int32func (*Guardrail_LlmPolicy) GetModelSettings
func (x *Guardrail_LlmPolicy) GetModelSettings() *ModelSettingsfunc (*Guardrail_LlmPolicy) GetPolicyScope
func (x *Guardrail_LlmPolicy) GetPolicyScope() Guardrail_LlmPolicy_PolicyScopefunc (*Guardrail_LlmPolicy) GetPrompt
func (x *Guardrail_LlmPolicy) GetPrompt() stringfunc (*Guardrail_LlmPolicy) ProtoMessage
func (*Guardrail_LlmPolicy) ProtoMessage()func (*Guardrail_LlmPolicy) ProtoReflect
func (x *Guardrail_LlmPolicy) ProtoReflect() protoreflect.Messagefunc (*Guardrail_LlmPolicy) Reset
func (x *Guardrail_LlmPolicy) Reset()func (*Guardrail_LlmPolicy) String
func (x *Guardrail_LlmPolicy) String() stringGuardrail_LlmPolicy_
type Guardrail_LlmPolicy_ struct {
// Optional. Guardrail that blocks the conversation if the LLM response is
// considered violating the policy based on the LLM classification.
LlmPolicy *Guardrail_LlmPolicy `protobuf:"bytes,10,opt,name=llm_policy,json=llmPolicy,proto3,oneof"`
}Guardrail_LlmPolicy_PolicyScope
type Guardrail_LlmPolicy_PolicyScope int32Defines when to apply the policy check during the conversation.
Guardrail_LlmPolicy_POLICY_SCOPE_UNSPECIFIED, Guardrail_LlmPolicy_USER_QUERY, Guardrail_LlmPolicy_AGENT_RESPONSE, Guardrail_LlmPolicy_USER_QUERY_AND_AGENT_RESPONSE
const (
// Policy scope is not specified.
Guardrail_LlmPolicy_POLICY_SCOPE_UNSPECIFIED Guardrail_LlmPolicy_PolicyScope = 0
// Policy check is triggered on user input.
Guardrail_LlmPolicy_USER_QUERY Guardrail_LlmPolicy_PolicyScope = 1
// Policy check is triggered on agent response. Applying this policy
// scope will introduce additional latency before the agent can respond.
Guardrail_LlmPolicy_AGENT_RESPONSE Guardrail_LlmPolicy_PolicyScope = 2
// Policy check is triggered on both user input and agent response.
// Applying this policy scope will introduce additional latency before
// the agent can respond.
Guardrail_LlmPolicy_USER_QUERY_AND_AGENT_RESPONSE Guardrail_LlmPolicy_PolicyScope = 3
)func (Guardrail_LlmPolicy_PolicyScope) Descriptor
func (Guardrail_LlmPolicy_PolicyScope) Descriptor() protoreflect.EnumDescriptorfunc (Guardrail_LlmPolicy_PolicyScope) Enum
func (x Guardrail_LlmPolicy_PolicyScope) Enum() *Guardrail_LlmPolicy_PolicyScopefunc (Guardrail_LlmPolicy_PolicyScope) EnumDescriptor
func (Guardrail_LlmPolicy_PolicyScope) EnumDescriptor() ([]byte, []int)Deprecated: Use Guardrail_LlmPolicy_PolicyScope.Descriptor instead.
func (Guardrail_LlmPolicy_PolicyScope) Number
func (x Guardrail_LlmPolicy_PolicyScope) Number() protoreflect.EnumNumberfunc (Guardrail_LlmPolicy_PolicyScope) String
func (x Guardrail_LlmPolicy_PolicyScope) String() stringfunc (Guardrail_LlmPolicy_PolicyScope) Type
func (Guardrail_LlmPolicy_PolicyScope) Type() protoreflect.EnumTypeGuardrail_LlmPromptSecurity
type Guardrail_LlmPromptSecurity struct {
// Defines the security configuration mode.
// The user must choose one of the following configurations.
//
// Types that are valid to be assigned to SecurityConfig:
//
// *Guardrail_LlmPromptSecurity_DefaultSettings
// *Guardrail_LlmPromptSecurity_CustomPolicy
SecurityConfig isGuardrail_LlmPromptSecurity_SecurityConfig `protobuf_oneof:"security_config"`
// Optional. Determines the behavior when the guardrail encounters an LLM
// error.
// - If true: the guardrail is bypassed.
// - If false (default): the guardrail triggers/blocks.
//
// Note: If a custom policy is provided, this field is ignored in favor
// of the policy's 'fail_open' configuration.
FailOpen bool `protobuf:"varint,3,opt,name=fail_open,json=failOpen,proto3" json:"fail_open,omitempty"`
// contains filtered or unexported fields
}Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.
func (*Guardrail_LlmPromptSecurity) Descriptor
func (*Guardrail_LlmPromptSecurity) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_LlmPromptSecurity.ProtoReflect.Descriptor instead.
func (*Guardrail_LlmPromptSecurity) GetCustomPolicy
func (x *Guardrail_LlmPromptSecurity) GetCustomPolicy() *Guardrail_LlmPolicyfunc (*Guardrail_LlmPromptSecurity) GetDefaultSettings
func (x *Guardrail_LlmPromptSecurity) GetDefaultSettings() *Guardrail_LlmPromptSecurity_DefaultSecuritySettingsfunc (*Guardrail_LlmPromptSecurity) GetFailOpen
func (x *Guardrail_LlmPromptSecurity) GetFailOpen() boolfunc (*Guardrail_LlmPromptSecurity) GetSecurityConfig
func (x *Guardrail_LlmPromptSecurity) GetSecurityConfig() isGuardrail_LlmPromptSecurity_SecurityConfigfunc (*Guardrail_LlmPromptSecurity) ProtoMessage
func (*Guardrail_LlmPromptSecurity) ProtoMessage()func (*Guardrail_LlmPromptSecurity) ProtoReflect
func (x *Guardrail_LlmPromptSecurity) ProtoReflect() protoreflect.Messagefunc (*Guardrail_LlmPromptSecurity) Reset
func (x *Guardrail_LlmPromptSecurity) Reset()func (*Guardrail_LlmPromptSecurity) String
func (x *Guardrail_LlmPromptSecurity) String() stringGuardrail_LlmPromptSecurity_
type Guardrail_LlmPromptSecurity_ struct {
// Optional. Guardrail that blocks the conversation if the prompt is
// considered unsafe based on the LLM classification.
LlmPromptSecurity *Guardrail_LlmPromptSecurity `protobuf:"bytes,9,opt,name=llm_prompt_security,json=llmPromptSecurity,proto3,oneof"`
}Guardrail_LlmPromptSecurity_CustomPolicy
type Guardrail_LlmPromptSecurity_CustomPolicy struct {
// Optional. Use a user-defined LlmPolicy to configure the security
// guardrail.
CustomPolicy *Guardrail_LlmPolicy `protobuf:"bytes,2,opt,name=custom_policy,json=customPolicy,proto3,oneof"`
}Guardrail_LlmPromptSecurity_DefaultSecuritySettings
type Guardrail_LlmPromptSecurity_DefaultSecuritySettings struct {
// Output only. The default prompt template used by the system.
// This field is for display purposes to show the user what prompt
// the system uses by default. It is OUTPUT_ONLY.
DefaultPromptTemplate string `protobuf:"bytes,1,opt,name=default_prompt_template,json=defaultPromptTemplate,proto3" json:"default_prompt_template,omitempty"`
// contains filtered or unexported fields
}Configuration for default system security settings.
func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) Descriptor
func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_LlmPromptSecurity_DefaultSecuritySettings.ProtoReflect.Descriptor instead.
func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) GetDefaultPromptTemplate
func (x *Guardrail_LlmPromptSecurity_DefaultSecuritySettings) GetDefaultPromptTemplate() stringfunc (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) ProtoMessage
func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) ProtoMessage()func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) ProtoReflect
func (x *Guardrail_LlmPromptSecurity_DefaultSecuritySettings) ProtoReflect() protoreflect.Messagefunc (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) Reset
func (x *Guardrail_LlmPromptSecurity_DefaultSecuritySettings) Reset()func (*Guardrail_LlmPromptSecurity_DefaultSecuritySettings) String
func (x *Guardrail_LlmPromptSecurity_DefaultSecuritySettings) String() stringGuardrail_LlmPromptSecurity_DefaultSettings
type Guardrail_LlmPromptSecurity_DefaultSettings struct {
// Optional. Use the system's predefined default security settings.
// To select this mode, include an empty 'default_settings' message
// in the request. The 'default_prompt_template' field within
// will be populated by the server in the response.
DefaultSettings *Guardrail_LlmPromptSecurity_DefaultSecuritySettings `protobuf:"bytes,1,opt,name=default_settings,json=defaultSettings,proto3,oneof"`
}Guardrail_ModelSafety
type Guardrail_ModelSafety struct {
// Required. List of safety settings.
SafetySettings []*Guardrail_ModelSafety_SafetySetting `protobuf:"bytes,1,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
// contains filtered or unexported fields
}Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.
func (*Guardrail_ModelSafety) Descriptor
func (*Guardrail_ModelSafety) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_ModelSafety.ProtoReflect.Descriptor instead.
func (*Guardrail_ModelSafety) GetSafetySettings
func (x *Guardrail_ModelSafety) GetSafetySettings() []*Guardrail_ModelSafety_SafetySettingfunc (*Guardrail_ModelSafety) ProtoMessage
func (*Guardrail_ModelSafety) ProtoMessage()func (*Guardrail_ModelSafety) ProtoReflect
func (x *Guardrail_ModelSafety) ProtoReflect() protoreflect.Messagefunc (*Guardrail_ModelSafety) Reset
func (x *Guardrail_ModelSafety) Reset()func (*Guardrail_ModelSafety) String
func (x *Guardrail_ModelSafety) String() stringGuardrail_ModelSafety_
type Guardrail_ModelSafety_ struct {
// Optional. Guardrail that blocks the conversation if the LLM response is
// considered unsafe based on the model safety settings.
ModelSafety *Guardrail_ModelSafety `protobuf:"bytes,13,opt,name=model_safety,json=modelSafety,proto3,oneof"`
}Guardrail_ModelSafety_HarmBlockThreshold
type Guardrail_ModelSafety_HarmBlockThreshold int32Probability based thresholds levels for blocking.
Guardrail_ModelSafety_HARM_BLOCK_THRESHOLD_UNSPECIFIED, Guardrail_ModelSafety_BLOCK_LOW_AND_ABOVE, Guardrail_ModelSafety_BLOCK_MEDIUM_AND_ABOVE, Guardrail_ModelSafety_BLOCK_ONLY_HIGH, Guardrail_ModelSafety_BLOCK_NONE, Guardrail_ModelSafety_OFF
const (
// Unspecified harm block threshold.
Guardrail_ModelSafety_HARM_BLOCK_THRESHOLD_UNSPECIFIED Guardrail_ModelSafety_HarmBlockThreshold = 0
// Block low threshold and above (i.e. block more).
Guardrail_ModelSafety_BLOCK_LOW_AND_ABOVE Guardrail_ModelSafety_HarmBlockThreshold = 1
// Block medium threshold and above.
Guardrail_ModelSafety_BLOCK_MEDIUM_AND_ABOVE Guardrail_ModelSafety_HarmBlockThreshold = 2
// Block only high threshold (i.e. block less).
Guardrail_ModelSafety_BLOCK_ONLY_HIGH Guardrail_ModelSafety_HarmBlockThreshold = 3
// Block none.
Guardrail_ModelSafety_BLOCK_NONE Guardrail_ModelSafety_HarmBlockThreshold = 4
// Turn off the safety filter.
Guardrail_ModelSafety_OFF Guardrail_ModelSafety_HarmBlockThreshold = 5
)func (Guardrail_ModelSafety_HarmBlockThreshold) Descriptor
func (Guardrail_ModelSafety_HarmBlockThreshold) Descriptor() protoreflect.EnumDescriptorfunc (Guardrail_ModelSafety_HarmBlockThreshold) Enum
func (Guardrail_ModelSafety_HarmBlockThreshold) EnumDescriptor
func (Guardrail_ModelSafety_HarmBlockThreshold) EnumDescriptor() ([]byte, []int)Deprecated: Use Guardrail_ModelSafety_HarmBlockThreshold.Descriptor instead.
func (Guardrail_ModelSafety_HarmBlockThreshold) Number
func (x Guardrail_ModelSafety_HarmBlockThreshold) Number() protoreflect.EnumNumberfunc (Guardrail_ModelSafety_HarmBlockThreshold) String
func (x Guardrail_ModelSafety_HarmBlockThreshold) String() stringfunc (Guardrail_ModelSafety_HarmBlockThreshold) Type
func (Guardrail_ModelSafety_HarmBlockThreshold) Type() protoreflect.EnumTypeGuardrail_ModelSafety_HarmCategory
type Guardrail_ModelSafety_HarmCategory int32Harm category.
Guardrail_ModelSafety_HARM_CATEGORY_UNSPECIFIED, Guardrail_ModelSafety_HARM_CATEGORY_HATE_SPEECH, Guardrail_ModelSafety_HARM_CATEGORY_DANGEROUS_CONTENT, Guardrail_ModelSafety_HARM_CATEGORY_HARASSMENT, Guardrail_ModelSafety_HARM_CATEGORY_SEXUALLY_EXPLICIT
const (
// The harm category is unspecified.
Guardrail_ModelSafety_HARM_CATEGORY_UNSPECIFIED Guardrail_ModelSafety_HarmCategory = 0
// The harm category is hate speech.
Guardrail_ModelSafety_HARM_CATEGORY_HATE_SPEECH Guardrail_ModelSafety_HarmCategory = 1
// The harm category is dangerous content.
Guardrail_ModelSafety_HARM_CATEGORY_DANGEROUS_CONTENT Guardrail_ModelSafety_HarmCategory = 2
// The harm category is harassment.
Guardrail_ModelSafety_HARM_CATEGORY_HARASSMENT Guardrail_ModelSafety_HarmCategory = 3
// The harm category is sexually explicit content.
Guardrail_ModelSafety_HARM_CATEGORY_SEXUALLY_EXPLICIT Guardrail_ModelSafety_HarmCategory = 4
)func (Guardrail_ModelSafety_HarmCategory) Descriptor
func (Guardrail_ModelSafety_HarmCategory) Descriptor() protoreflect.EnumDescriptorfunc (Guardrail_ModelSafety_HarmCategory) Enum
func (x Guardrail_ModelSafety_HarmCategory) Enum() *Guardrail_ModelSafety_HarmCategoryfunc (Guardrail_ModelSafety_HarmCategory) EnumDescriptor
func (Guardrail_ModelSafety_HarmCategory) EnumDescriptor() ([]byte, []int)Deprecated: Use Guardrail_ModelSafety_HarmCategory.Descriptor instead.
func (Guardrail_ModelSafety_HarmCategory) Number
func (x Guardrail_ModelSafety_HarmCategory) Number() protoreflect.EnumNumberfunc (Guardrail_ModelSafety_HarmCategory) String
func (x Guardrail_ModelSafety_HarmCategory) String() stringfunc (Guardrail_ModelSafety_HarmCategory) Type
func (Guardrail_ModelSafety_HarmCategory) Type() protoreflect.EnumTypeGuardrail_ModelSafety_SafetySetting
type Guardrail_ModelSafety_SafetySetting struct {
// Required. The harm category.
Category Guardrail_ModelSafety_HarmCategory `protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.ces.v1.Guardrail_ModelSafety_HarmCategory" json:"category,omitempty"`
// Required. The harm block threshold.
Threshold Guardrail_ModelSafety_HarmBlockThreshold `protobuf:"varint,2,opt,name=threshold,proto3,enum=google.cloud.ces.v1.Guardrail_ModelSafety_HarmBlockThreshold" json:"threshold,omitempty"`
// contains filtered or unexported fields
}Safety setting.
func (*Guardrail_ModelSafety_SafetySetting) Descriptor
func (*Guardrail_ModelSafety_SafetySetting) Descriptor() ([]byte, []int)Deprecated: Use Guardrail_ModelSafety_SafetySetting.ProtoReflect.Descriptor instead.
func (*Guardrail_ModelSafety_SafetySetting) GetCategory
func (x *Guardrail_ModelSafety_SafetySetting) GetCategory() Guardrail_ModelSafety_HarmCategoryfunc (*Guardrail_ModelSafety_SafetySetting) GetThreshold
func (x *Guardrail_ModelSafety_SafetySetting) GetThreshold() Guardrail_ModelSafety_HarmBlockThresholdfunc (*Guardrail_ModelSafety_SafetySetting) ProtoMessage
func (*Guardrail_ModelSafety_SafetySetting) ProtoMessage()func (*Guardrail_ModelSafety_SafetySetting) ProtoReflect
func (x *Guardrail_ModelSafety_SafetySetting) ProtoReflect() protoreflect.Messagefunc (*Guardrail_ModelSafety_SafetySetting) Reset
func (x *Guardrail_ModelSafety_SafetySetting) Reset()func (*Guardrail_ModelSafety_SafetySetting) String
func (x *Guardrail_ModelSafety_SafetySetting) String() stringImage
type Image struct {
// Required. The IANA standard MIME type of the source data.
// Supported image types includes:
// - image/png
// - image/jpeg
// - image/webp
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Required. Raw bytes of the image.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}Represents an image input or output in the conversation.
func (*Image) Descriptor
Deprecated: Use Image.ProtoReflect.Descriptor instead.
func (*Image) GetData
func (*Image) GetMimeType
func (*Image) ProtoMessage
func (*Image) ProtoMessage()func (*Image) ProtoReflect
func (x *Image) ProtoReflect() protoreflect.Messagefunc (*Image) Reset
func (x *Image) Reset()func (*Image) String
ImportAppRequest
type ImportAppRequest struct {
// The app to import.
//
// Types that are valid to be assigned to App:
//
// *ImportAppRequest_GcsUri
// *ImportAppRequest_AppContent
App isImportAppRequest_App `protobuf_oneof:"app"`
// Required. The parent resource name with the location of the app to import.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The display name of the app to import.
// * If the app is created on import, and the display name is specified,
// the imported app will use this display name. If a conflict is detected
// with an existing app, a timestamp will be appended to the display name
// to make it unique.
// * If the app is a reimport, this field should not be set. Providing a
// display name during reimport will result in an INVALID_ARGUMENT error.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The ID to use for the imported app.
// * If not specified, a unique ID will be automatically assigned for
// the app.
// * Otherwise, the imported app will use this ID as the final component of
// its resource name. If an app with the same ID already exists at the
// specified location in the project, the content of the existing app will be
// replaced.
AppId string `protobuf:"bytes,3,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
// Optional. Options governing the import process for the app.
ImportOptions *ImportAppRequest_ImportOptions `protobuf:"bytes,6,opt,name=import_options,json=importOptions,proto3" json:"import_options,omitempty"`
// Optional. Flag for overriding the app lock during import.
// If set to true, the import process will ignore the app lock.
IgnoreAppLock bool `protobuf:"varint,7,opt,name=ignore_app_lock,json=ignoreAppLock,proto3" json:"ignore_app_lock,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ImportApp][google.cloud.ces.v1.AgentService.ImportApp].
func (*ImportAppRequest) Descriptor
func (*ImportAppRequest) Descriptor() ([]byte, []int)Deprecated: Use ImportAppRequest.ProtoReflect.Descriptor instead.
func (*ImportAppRequest) GetApp
func (x *ImportAppRequest) GetApp() isImportAppRequest_Appfunc (*ImportAppRequest) GetAppContent
func (x *ImportAppRequest) GetAppContent() []bytefunc (*ImportAppRequest) GetAppId
func (x *ImportAppRequest) GetAppId() stringfunc (*ImportAppRequest) GetDisplayName
func (x *ImportAppRequest) GetDisplayName() stringfunc (*ImportAppRequest) GetGcsUri
func (x *ImportAppRequest) GetGcsUri() stringfunc (*ImportAppRequest) GetIgnoreAppLock
func (x *ImportAppRequest) GetIgnoreAppLock() boolfunc (*ImportAppRequest) GetImportOptions
func (x *ImportAppRequest) GetImportOptions() *ImportAppRequest_ImportOptionsfunc (*ImportAppRequest) GetParent
func (x *ImportAppRequest) GetParent() stringfunc (*ImportAppRequest) ProtoMessage
func (*ImportAppRequest) ProtoMessage()func (*ImportAppRequest) ProtoReflect
func (x *ImportAppRequest) ProtoReflect() protoreflect.Messagefunc (*ImportAppRequest) Reset
func (x *ImportAppRequest) Reset()func (*ImportAppRequest) String
func (x *ImportAppRequest) String() stringImportAppRequest_AppContent
type ImportAppRequest_AppContent struct {
// Raw bytes representing the compressed zip file with the app folder
// structure.
AppContent []byte `protobuf:"bytes,5,opt,name=app_content,json=appContent,proto3,oneof"`
}ImportAppRequest_GcsUri
type ImportAppRequest_GcsUri struct {
// The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
// from which to import app. The format of this URI must be
// `gs://ImportAppRequest_ImportOptions
type ImportAppRequest_ImportOptions struct {
// Optional. The strategy to use when resolving conflicts during import.
ConflictResolutionStrategy ImportAppRequest_ImportOptions_ConflictResolutionStrategy `protobuf:"varint,1,opt,name=conflict_resolution_strategy,json=conflictResolutionStrategy,proto3,enum=google.cloud.ces.v1.ImportAppRequest_ImportOptions_ConflictResolutionStrategy" json:"conflict_resolution_strategy,omitempty"`
// contains filtered or unexported fields
}Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.
func (*ImportAppRequest_ImportOptions) Descriptor
func (*ImportAppRequest_ImportOptions) Descriptor() ([]byte, []int)Deprecated: Use ImportAppRequest_ImportOptions.ProtoReflect.Descriptor instead.
func (*ImportAppRequest_ImportOptions) GetConflictResolutionStrategy
func (x *ImportAppRequest_ImportOptions) GetConflictResolutionStrategy() ImportAppRequest_ImportOptions_ConflictResolutionStrategyfunc (*ImportAppRequest_ImportOptions) ProtoMessage
func (*ImportAppRequest_ImportOptions) ProtoMessage()func (*ImportAppRequest_ImportOptions) ProtoReflect
func (x *ImportAppRequest_ImportOptions) ProtoReflect() protoreflect.Messagefunc (*ImportAppRequest_ImportOptions) Reset
func (x *ImportAppRequest_ImportOptions) Reset()func (*ImportAppRequest_ImportOptions) String
func (x *ImportAppRequest_ImportOptions) String() stringImportAppRequest_ImportOptions_ConflictResolutionStrategy
type ImportAppRequest_ImportOptions_ConflictResolutionStrategy int32Defines the strategy for handling conflicts when an app with the same ID already exists, or when imported resources (like Agents, Tools, etc.) have the same display names as existing resources within that app.
ImportAppRequest_ImportOptions_CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED, ImportAppRequest_ImportOptions_REPLACE, ImportAppRequest_ImportOptions_OVERWRITE
const (
// The conflict resolution strategy is unspecified.
ImportAppRequest_ImportOptions_CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED ImportAppRequest_ImportOptions_ConflictResolutionStrategy = 0
// Replace existing data with imported data.
// If an app with the same `app_id` already exists, its content will be
// updated based on the imported app.
// - Resources (App, Agents, Tools, Examples, Guardrails, Toolsets) in the
// imported app that have the same display name as existing resources
// will overwrite the existing ones.
// - Imported resources with new display names will be created.
// - Existing resources that do not have a matching display name in the
// imported app will remain untouched.
ImportAppRequest_ImportOptions_REPLACE ImportAppRequest_ImportOptions_ConflictResolutionStrategy = 1
// Overwrite existing data with imported data.
// If an app with the same `app_id` already exists, its content will be
// overwritten with the imported app.
// - Existing resources (Agents, Tools, Examples, Guardrails, Toolsets) in
// the app will be deleted.
// - Imported resources will be created as new resources.
ImportAppRequest_ImportOptions_OVERWRITE ImportAppRequest_ImportOptions_ConflictResolutionStrategy = 2
)func (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Descriptor
func (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Descriptor() protoreflect.EnumDescriptorfunc (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Enum
func (x ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Enum() *ImportAppRequest_ImportOptions_ConflictResolutionStrategyfunc (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) EnumDescriptor
func (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) EnumDescriptor() ([]byte, []int)Deprecated: Use ImportAppRequest_ImportOptions_ConflictResolutionStrategy.Descriptor instead.
func (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Number
func (x ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Number() protoreflect.EnumNumberfunc (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) String
func (x ImportAppRequest_ImportOptions_ConflictResolutionStrategy) String() stringfunc (ImportAppRequest_ImportOptions_ConflictResolutionStrategy) Type
ImportAppResponse
type ImportAppResponse struct {
// The resource name of the app that was imported.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Warning messages generated during the import process.
// If errors occur for specific resources, they will not be included in the
// imported app and the error will be mentioned here.
Warnings []string `protobuf:"bytes,2,rep,name=warnings,proto3" json:"warnings,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ImportApp][google.cloud.ces.v1.AgentService.ImportApp].
func (*ImportAppResponse) Descriptor
func (*ImportAppResponse) Descriptor() ([]byte, []int)Deprecated: Use ImportAppResponse.ProtoReflect.Descriptor instead.
func (*ImportAppResponse) GetName
func (x *ImportAppResponse) GetName() stringfunc (*ImportAppResponse) GetWarnings
func (x *ImportAppResponse) GetWarnings() []stringfunc (*ImportAppResponse) ProtoMessage
func (*ImportAppResponse) ProtoMessage()func (*ImportAppResponse) ProtoReflect
func (x *ImportAppResponse) ProtoReflect() protoreflect.Messagefunc (*ImportAppResponse) Reset
func (x *ImportAppResponse) Reset()func (*ImportAppResponse) String
func (x *ImportAppResponse) String() stringInputAudioConfig
type InputAudioConfig struct {
// Required. The encoding of the input audio data.
AudioEncoding AudioEncoding `protobuf:"varint,1,opt,name=audio_encoding,json=audioEncoding,proto3,enum=google.cloud.ces.v1.AudioEncoding" json:"audio_encoding,omitempty"`
// Required. The sample rate (in Hertz) of the input audio data.
SampleRateHertz int32 `protobuf:"varint,2,opt,name=sample_rate_hertz,json=sampleRateHertz,proto3" json:"sample_rate_hertz,omitempty"`
// Optional. Whether to enable noise suppression on the input audio.
// Available values are "low", "moderate", "high", "very_high".
NoiseSuppressionLevel string `protobuf:"bytes,6,opt,name=noise_suppression_level,json=noiseSuppressionLevel,proto3" json:"noise_suppression_level,omitempty"`
// contains filtered or unexported fields
}InputAudioConfig configures how the CES agent should interpret the incoming audio data.
func (*InputAudioConfig) Descriptor
func (*InputAudioConfig) Descriptor() ([]byte, []int)Deprecated: Use InputAudioConfig.ProtoReflect.Descriptor instead.
func (*InputAudioConfig) GetAudioEncoding
func (x *InputAudioConfig) GetAudioEncoding() AudioEncodingfunc (*InputAudioConfig) GetNoiseSuppressionLevel
func (x *InputAudioConfig) GetNoiseSuppressionLevel() stringfunc (*InputAudioConfig) GetSampleRateHertz
func (x *InputAudioConfig) GetSampleRateHertz() int32func (*InputAudioConfig) ProtoMessage
func (*InputAudioConfig) ProtoMessage()func (*InputAudioConfig) ProtoReflect
func (x *InputAudioConfig) ProtoReflect() protoreflect.Messagefunc (*InputAudioConfig) Reset
func (x *InputAudioConfig) Reset()func (*InputAudioConfig) String
func (x *InputAudioConfig) String() stringInterruptionSignal
type InterruptionSignal struct {
// Whether the interruption is caused by a user barge-in event.
BargeIn bool `protobuf:"varint,1,opt,name=barge_in,json=bargeIn,proto3" json:"barge_in,omitempty"`
// contains filtered or unexported fields
}Indicates the agent's audio response has been interrupted. The client should immediately stop any current audio playback (e.g., due to user barge-in or a new agent response being generated).
func (*InterruptionSignal) Descriptor
func (*InterruptionSignal) Descriptor() ([]byte, []int)Deprecated: Use InterruptionSignal.ProtoReflect.Descriptor instead.
func (*InterruptionSignal) GetBargeIn
func (x *InterruptionSignal) GetBargeIn() boolfunc (*InterruptionSignal) ProtoMessage
func (*InterruptionSignal) ProtoMessage()func (*InterruptionSignal) ProtoReflect
func (x *InterruptionSignal) ProtoReflect() protoreflect.Messagefunc (*InterruptionSignal) Reset
func (x *InterruptionSignal) Reset()func (*InterruptionSignal) String
func (x *InterruptionSignal) String() stringLanguageSettings
type LanguageSettings struct {
// Optional. The default language code of the app.
DefaultLanguageCode string `protobuf:"bytes,1,opt,name=default_language_code,json=defaultLanguageCode,proto3" json:"default_language_code,omitempty"`
// Optional. List of languages codes supported by the app, in addition to the
// `default_language_code`.
SupportedLanguageCodes []string `protobuf:"bytes,2,rep,name=supported_language_codes,json=supportedLanguageCodes,proto3" json:"supported_language_codes,omitempty"`
// Optional. Enables multilingual support. If true, agents in the app will use
// pre-built instructions to improve handling of multilingual input.
EnableMultilingualSupport bool `protobuf:"varint,3,opt,name=enable_multilingual_support,json=enableMultilingualSupport,proto3" json:"enable_multilingual_support,omitempty"`
// Optional. Deprecated: This feature is no longer supported. Use
// `enable_multilingual_support` instead to improve handling of multilingual
// input.
// The action to perform when an agent receives input in an unsupported
// language.
//
// This can be a predefined action or a custom tool call.
// Valid values are:
// - A tool's full resource name, which triggers a specific tool execution.
// - A predefined system action, such as "escalate" or "exit", which triggers
// an [EndSession][google.cloud.ces.v1.EndSession] signal with corresponding
// [metadata][google.cloud.ces.v1.EndSession.metadata] to terminate the
// conversation.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
FallbackAction string `protobuf:"bytes,4,opt,name=fallback_action,json=fallbackAction,proto3" json:"fallback_action,omitempty"`
// contains filtered or unexported fields
}Language settings of the app.
func (*LanguageSettings) Descriptor
func (*LanguageSettings) Descriptor() ([]byte, []int)Deprecated: Use LanguageSettings.ProtoReflect.Descriptor instead.
func (*LanguageSettings) GetDefaultLanguageCode
func (x *LanguageSettings) GetDefaultLanguageCode() stringfunc (*LanguageSettings) GetEnableMultilingualSupport
func (x *LanguageSettings) GetEnableMultilingualSupport() boolfunc (*LanguageSettings) GetFallbackAction
func (x *LanguageSettings) GetFallbackAction() stringDeprecated: Marked as deprecated in google/cloud/ces/v1/app.proto.
func (*LanguageSettings) GetSupportedLanguageCodes
func (x *LanguageSettings) GetSupportedLanguageCodes() []stringfunc (*LanguageSettings) ProtoMessage
func (*LanguageSettings) ProtoMessage()func (*LanguageSettings) ProtoReflect
func (x *LanguageSettings) ProtoReflect() protoreflect.Messagefunc (*LanguageSettings) Reset
func (x *LanguageSettings) Reset()func (*LanguageSettings) String
func (x *LanguageSettings) String() stringListAgentsRequest
type ListAgentsRequest struct {
// Required. The resource name of the app to list agents from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListAgentsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListAgents][google.cloud.ces.v1.AgentService.ListAgents]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the agents.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListAgents][google.cloud.ces.v1.AgentService.ListAgents].
func (*ListAgentsRequest) Descriptor
func (*ListAgentsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListAgentsRequest.ProtoReflect.Descriptor instead.
func (*ListAgentsRequest) GetFilter
func (x *ListAgentsRequest) GetFilter() stringfunc (*ListAgentsRequest) GetOrderBy
func (x *ListAgentsRequest) GetOrderBy() stringfunc (*ListAgentsRequest) GetPageSize
func (x *ListAgentsRequest) GetPageSize() int32func (*ListAgentsRequest) GetPageToken
func (x *ListAgentsRequest) GetPageToken() stringfunc (*ListAgentsRequest) GetParent
func (x *ListAgentsRequest) GetParent() stringfunc (*ListAgentsRequest) ProtoMessage
func (*ListAgentsRequest) ProtoMessage()func (*ListAgentsRequest) ProtoReflect
func (x *ListAgentsRequest) ProtoReflect() protoreflect.Messagefunc (*ListAgentsRequest) Reset
func (x *ListAgentsRequest) Reset()func (*ListAgentsRequest) String
func (x *ListAgentsRequest) String() stringListAgentsResponse
type ListAgentsResponse struct {
// The list of agents.
Agents []*Agent `protobuf:"bytes,1,rep,name=agents,proto3" json:"agents,omitempty"`
// A token that can be sent as
// [ListAgentsRequest.page_token][google.cloud.ces.v1.ListAgentsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListAgents][google.cloud.ces.v1.AgentService.ListAgents].
func (*ListAgentsResponse) Descriptor
func (*ListAgentsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListAgentsResponse.ProtoReflect.Descriptor instead.
func (*ListAgentsResponse) GetAgents
func (x *ListAgentsResponse) GetAgents() []*Agentfunc (*ListAgentsResponse) GetNextPageToken
func (x *ListAgentsResponse) GetNextPageToken() stringfunc (*ListAgentsResponse) ProtoMessage
func (*ListAgentsResponse) ProtoMessage()func (*ListAgentsResponse) ProtoReflect
func (x *ListAgentsResponse) ProtoReflect() protoreflect.Messagefunc (*ListAgentsResponse) Reset
func (x *ListAgentsResponse) Reset()func (*ListAgentsResponse) String
func (x *ListAgentsResponse) String() stringListAppVersionsRequest
type ListAppVersionsRequest struct {
// Required. The resource name of the app to list app versions from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListAppVersionsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListAppVersions][google.cloud.ces.v1.AgentService.ListAppVersions]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the app versions.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListAppVersions][google.cloud.ces.v1.AgentService.ListAppVersions].
func (*ListAppVersionsRequest) Descriptor
func (*ListAppVersionsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListAppVersionsRequest.ProtoReflect.Descriptor instead.
func (*ListAppVersionsRequest) GetFilter
func (x *ListAppVersionsRequest) GetFilter() stringfunc (*ListAppVersionsRequest) GetOrderBy
func (x *ListAppVersionsRequest) GetOrderBy() stringfunc (*ListAppVersionsRequest) GetPageSize
func (x *ListAppVersionsRequest) GetPageSize() int32func (*ListAppVersionsRequest) GetPageToken
func (x *ListAppVersionsRequest) GetPageToken() stringfunc (*ListAppVersionsRequest) GetParent
func (x *ListAppVersionsRequest) GetParent() stringfunc (*ListAppVersionsRequest) ProtoMessage
func (*ListAppVersionsRequest) ProtoMessage()func (*ListAppVersionsRequest) ProtoReflect
func (x *ListAppVersionsRequest) ProtoReflect() protoreflect.Messagefunc (*ListAppVersionsRequest) Reset
func (x *ListAppVersionsRequest) Reset()func (*ListAppVersionsRequest) String
func (x *ListAppVersionsRequest) String() stringListAppVersionsResponse
type ListAppVersionsResponse struct {
// The list of app versions.
AppVersions []*AppVersion `protobuf:"bytes,1,rep,name=app_versions,json=appVersions,proto3" json:"app_versions,omitempty"`
// A token that can be sent as
// [ListAppVersionsRequest.page_token][google.cloud.ces.v1.ListAppVersionsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListAppVersions][google.cloud.ces.v1.AgentService.ListAppVersions].
func (*ListAppVersionsResponse) Descriptor
func (*ListAppVersionsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListAppVersionsResponse.ProtoReflect.Descriptor instead.
func (*ListAppVersionsResponse) GetAppVersions
func (x *ListAppVersionsResponse) GetAppVersions() []*AppVersionfunc (*ListAppVersionsResponse) GetNextPageToken
func (x *ListAppVersionsResponse) GetNextPageToken() stringfunc (*ListAppVersionsResponse) ProtoMessage
func (*ListAppVersionsResponse) ProtoMessage()func (*ListAppVersionsResponse) ProtoReflect
func (x *ListAppVersionsResponse) ProtoReflect() protoreflect.Messagefunc (*ListAppVersionsResponse) Reset
func (x *ListAppVersionsResponse) Reset()func (*ListAppVersionsResponse) String
func (x *ListAppVersionsResponse) String() stringListAppsRequest
type ListAppsRequest struct {
// Required. The resource name of the location to list apps from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListAppsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListApps][google.cloud.ces.v1.AgentService.ListApps] call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the apps.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListApps][google.cloud.ces.v1.AgentService.ListApps].
func (*ListAppsRequest) Descriptor
func (*ListAppsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListAppsRequest.ProtoReflect.Descriptor instead.
func (*ListAppsRequest) GetFilter
func (x *ListAppsRequest) GetFilter() stringfunc (*ListAppsRequest) GetOrderBy
func (x *ListAppsRequest) GetOrderBy() stringfunc (*ListAppsRequest) GetPageSize
func (x *ListAppsRequest) GetPageSize() int32func (*ListAppsRequest) GetPageToken
func (x *ListAppsRequest) GetPageToken() stringfunc (*ListAppsRequest) GetParent
func (x *ListAppsRequest) GetParent() stringfunc (*ListAppsRequest) ProtoMessage
func (*ListAppsRequest) ProtoMessage()func (*ListAppsRequest) ProtoReflect
func (x *ListAppsRequest) ProtoReflect() protoreflect.Messagefunc (*ListAppsRequest) Reset
func (x *ListAppsRequest) Reset()func (*ListAppsRequest) String
func (x *ListAppsRequest) String() stringListAppsResponse
type ListAppsResponse struct {
// The list of apps.
Apps []*App `protobuf:"bytes,1,rep,name=apps,proto3" json:"apps,omitempty"`
// A token that can be sent as
// [ListAppsRequest.page_token][google.cloud.ces.v1.ListAppsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Unordered list. Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListApps][google.cloud.ces.v1.AgentService.ListApps].
func (*ListAppsResponse) Descriptor
func (*ListAppsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListAppsResponse.ProtoReflect.Descriptor instead.
func (*ListAppsResponse) GetApps
func (x *ListAppsResponse) GetApps() []*Appfunc (*ListAppsResponse) GetNextPageToken
func (x *ListAppsResponse) GetNextPageToken() stringfunc (*ListAppsResponse) GetUnreachable
func (x *ListAppsResponse) GetUnreachable() []stringfunc (*ListAppsResponse) ProtoMessage
func (*ListAppsResponse) ProtoMessage()func (*ListAppsResponse) ProtoReflect
func (x *ListAppsResponse) ProtoReflect() protoreflect.Messagefunc (*ListAppsResponse) Reset
func (x *ListAppsResponse) Reset()func (*ListAppsResponse) String
func (x *ListAppsResponse) String() stringListChangelogsRequest
type ListChangelogsRequest struct {
// Required. The resource name of the app to list changelogs from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListChangelogsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListChangelogs][google.cloud.ces.v1.AgentService.ListChangelogs]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the changelogs.
// See https://google.aip.dev/160 for more details.
//
// The filter string can be used to filter by `action`, `resource_type`,
// `resource_name`, `author`, and `create_time`.
// The `:` comparator can be used for case-insensitive partial matching on
// string fields, while `=` performs an exact case-sensitive match.
//
// Examples:
// * `action:update` (case-insensitive partial match)
// * `action="Create"` (case-sensitive exact match)
// * `resource_type:agent`
// * `resource_name:my-agent`
// * `author:me@example.com`
// * `create_time > "2025-01-01T00:00:00Z"`
// * `create_time <= "2025-01-01t00:00:00z"="" and="" resource_type:tool`="" filter="">string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListChangelogs][google.cloud.ces.v1.AgentService.ListChangelogs].
func (*ListChangelogsRequest) Descriptor
func (*ListChangelogsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListChangelogsRequest.ProtoReflect.Descriptor instead.
func (*ListChangelogsRequest) GetFilter
func (x *ListChangelogsRequest) GetFilter() stringfunc (*ListChangelogsRequest) GetOrderBy
func (x *ListChangelogsRequest) GetOrderBy() stringfunc (*ListChangelogsRequest) GetPageSize
func (x *ListChangelogsRequest) GetPageSize() int32func (*ListChangelogsRequest) GetPageToken
func (x *ListChangelogsRequest) GetPageToken() stringfunc (*ListChangelogsRequest) GetParent
func (x *ListChangelogsRequest) GetParent() stringfunc (*ListChangelogsRequest) ProtoMessage
func (*ListChangelogsRequest) ProtoMessage()func (*ListChangelogsRequest) ProtoReflect
func (x *ListChangelogsRequest) ProtoReflect() protoreflect.Messagefunc (*ListChangelogsRequest) Reset
func (x *ListChangelogsRequest) Reset()func (*ListChangelogsRequest) String
func (x *ListChangelogsRequest) String() stringListChangelogsResponse
type ListChangelogsResponse struct {
// The list of changelogs.
Changelogs []*Changelog `protobuf:"bytes,1,rep,name=changelogs,proto3" json:"changelogs,omitempty"`
// A token that can be sent as
// [ListChangelogsRequest.page_token][google.cloud.ces.v1.ListChangelogsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListChangelogs][google.cloud.ces.v1.AgentService.ListChangelogs].
func (*ListChangelogsResponse) Descriptor
func (*ListChangelogsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListChangelogsResponse.ProtoReflect.Descriptor instead.
func (*ListChangelogsResponse) GetChangelogs
func (x *ListChangelogsResponse) GetChangelogs() []*Changelogfunc (*ListChangelogsResponse) GetNextPageToken
func (x *ListChangelogsResponse) GetNextPageToken() stringfunc (*ListChangelogsResponse) ProtoMessage
func (*ListChangelogsResponse) ProtoMessage()func (*ListChangelogsResponse) ProtoReflect
func (x *ListChangelogsResponse) ProtoReflect() protoreflect.Messagefunc (*ListChangelogsResponse) Reset
func (x *ListChangelogsResponse) Reset()func (*ListChangelogsResponse) String
func (x *ListChangelogsResponse) String() stringListConversationsRequest
type ListConversationsRequest struct {
// Required. The resource name of the app to list conversations from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListConversationsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListConversations][google.cloud.ces.v1.AgentService.ListConversations]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the conversations.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Indicate the source of the conversation. If not set, Source.Live
// will be applied by default. Will be deprecated in favor of `sources` field.
Source Conversation_Source `protobuf:"varint,5,opt,name=source,proto3,enum=google.cloud.ces.v1.Conversation_Source" json:"source,omitempty"`
// Optional. Indicate the sources of the conversations. If not set, all
// available sources will be applied by default.
Sources []Conversation_Source `protobuf:"varint,6,rep,packed,name=sources,proto3,enum=google.cloud.ces.v1.Conversation_Source" json:"sources,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListConversations][google.cloud.ces.v1.AgentService.ListConversations].
func (*ListConversationsRequest) Descriptor
func (*ListConversationsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListConversationsRequest.ProtoReflect.Descriptor instead.
func (*ListConversationsRequest) GetFilter
func (x *ListConversationsRequest) GetFilter() stringfunc (*ListConversationsRequest) GetPageSize
func (x *ListConversationsRequest) GetPageSize() int32func (*ListConversationsRequest) GetPageToken
func (x *ListConversationsRequest) GetPageToken() stringfunc (*ListConversationsRequest) GetParent
func (x *ListConversationsRequest) GetParent() stringfunc (*ListConversationsRequest) GetSource
func (x *ListConversationsRequest) GetSource() Conversation_Sourcefunc (*ListConversationsRequest) GetSources
func (x *ListConversationsRequest) GetSources() []Conversation_Sourcefunc (*ListConversationsRequest) ProtoMessage
func (*ListConversationsRequest) ProtoMessage()func (*ListConversationsRequest) ProtoReflect
func (x *ListConversationsRequest) ProtoReflect() protoreflect.Messagefunc (*ListConversationsRequest) Reset
func (x *ListConversationsRequest) Reset()func (*ListConversationsRequest) String
func (x *ListConversationsRequest) String() stringListConversationsResponse
type ListConversationsResponse struct {
// The list of conversations.
Conversations []*Conversation `protobuf:"bytes,1,rep,name=conversations,proto3" json:"conversations,omitempty"`
// A token that can be sent as
// [ListConversationsRequest.page_token][google.cloud.ces.v1.ListConversationsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListConversations][google.cloud.ces.v1.AgentService.ListConversations].
func (*ListConversationsResponse) Descriptor
func (*ListConversationsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListConversationsResponse.ProtoReflect.Descriptor instead.
func (*ListConversationsResponse) GetConversations
func (x *ListConversationsResponse) GetConversations() []*Conversationfunc (*ListConversationsResponse) GetNextPageToken
func (x *ListConversationsResponse) GetNextPageToken() stringfunc (*ListConversationsResponse) ProtoMessage
func (*ListConversationsResponse) ProtoMessage()func (*ListConversationsResponse) ProtoReflect
func (x *ListConversationsResponse) ProtoReflect() protoreflect.Messagefunc (*ListConversationsResponse) Reset
func (x *ListConversationsResponse) Reset()func (*ListConversationsResponse) String
func (x *ListConversationsResponse) String() stringListDeploymentsRequest
type ListDeploymentsRequest struct {
// Required. The parent app.
// Format:
// `projects/{project}/locations/{location}/apps/{app}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of deployments to return. The service may
// return fewer than this value. If unspecified, at most 50 deployments will
// be returned. The maximum value is 1000; values above 1000 will be coerced
// to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous `ListDeployments` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListDeployments` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListDeployments][google.cloud.ces.v1.AgentService.ListDeployments].
func (*ListDeploymentsRequest) Descriptor
func (*ListDeploymentsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDeploymentsRequest.ProtoReflect.Descriptor instead.
func (*ListDeploymentsRequest) GetOrderBy
func (x *ListDeploymentsRequest) GetOrderBy() stringfunc (*ListDeploymentsRequest) GetPageSize
func (x *ListDeploymentsRequest) GetPageSize() int32func (*ListDeploymentsRequest) GetPageToken
func (x *ListDeploymentsRequest) GetPageToken() stringfunc (*ListDeploymentsRequest) GetParent
func (x *ListDeploymentsRequest) GetParent() stringfunc (*ListDeploymentsRequest) ProtoMessage
func (*ListDeploymentsRequest) ProtoMessage()func (*ListDeploymentsRequest) ProtoReflect
func (x *ListDeploymentsRequest) ProtoReflect() protoreflect.Messagefunc (*ListDeploymentsRequest) Reset
func (x *ListDeploymentsRequest) Reset()func (*ListDeploymentsRequest) String
func (x *ListDeploymentsRequest) String() stringListDeploymentsResponse
type ListDeploymentsResponse struct {
// The list of deployments.
Deployments []*Deployment `protobuf:"bytes,1,rep,name=deployments,proto3" json:"deployments,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListDeployments][google.cloud.ces.v1.AgentService.ListDeployments].
func (*ListDeploymentsResponse) Descriptor
func (*ListDeploymentsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDeploymentsResponse.ProtoReflect.Descriptor instead.
func (*ListDeploymentsResponse) GetDeployments
func (x *ListDeploymentsResponse) GetDeployments() []*Deploymentfunc (*ListDeploymentsResponse) GetNextPageToken
func (x *ListDeploymentsResponse) GetNextPageToken() stringfunc (*ListDeploymentsResponse) ProtoMessage
func (*ListDeploymentsResponse) ProtoMessage()func (*ListDeploymentsResponse) ProtoReflect
func (x *ListDeploymentsResponse) ProtoReflect() protoreflect.Messagefunc (*ListDeploymentsResponse) Reset
func (x *ListDeploymentsResponse) Reset()func (*ListDeploymentsResponse) String
func (x *ListDeploymentsResponse) String() stringListExamplesRequest
type ListExamplesRequest struct {
// Required. The resource name of the app to list examples from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListExamplesResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListExamples][google.cloud.ces.v1.AgentService.ListExamples]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the examples.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListExamples][google.cloud.ces.v1.AgentService.ListExamples].
func (*ListExamplesRequest) Descriptor
func (*ListExamplesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListExamplesRequest.ProtoReflect.Descriptor instead.
func (*ListExamplesRequest) GetFilter
func (x *ListExamplesRequest) GetFilter() stringfunc (*ListExamplesRequest) GetOrderBy
func (x *ListExamplesRequest) GetOrderBy() stringfunc (*ListExamplesRequest) GetPageSize
func (x *ListExamplesRequest) GetPageSize() int32func (*ListExamplesRequest) GetPageToken
func (x *ListExamplesRequest) GetPageToken() stringfunc (*ListExamplesRequest) GetParent
func (x *ListExamplesRequest) GetParent() stringfunc (*ListExamplesRequest) ProtoMessage
func (*ListExamplesRequest) ProtoMessage()func (*ListExamplesRequest) ProtoReflect
func (x *ListExamplesRequest) ProtoReflect() protoreflect.Messagefunc (*ListExamplesRequest) Reset
func (x *ListExamplesRequest) Reset()func (*ListExamplesRequest) String
func (x *ListExamplesRequest) String() stringListExamplesResponse
type ListExamplesResponse struct {
// The list of examples.
Examples []*Example `protobuf:"bytes,1,rep,name=examples,proto3" json:"examples,omitempty"`
// A token that can be sent as
// [ListExamplesRequest.page_token][google.cloud.ces.v1.ListExamplesRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListExamples][google.cloud.ces.v1.AgentService.ListExamples].
func (*ListExamplesResponse) Descriptor
func (*ListExamplesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListExamplesResponse.ProtoReflect.Descriptor instead.
func (*ListExamplesResponse) GetExamples
func (x *ListExamplesResponse) GetExamples() []*Examplefunc (*ListExamplesResponse) GetNextPageToken
func (x *ListExamplesResponse) GetNextPageToken() stringfunc (*ListExamplesResponse) ProtoMessage
func (*ListExamplesResponse) ProtoMessage()func (*ListExamplesResponse) ProtoReflect
func (x *ListExamplesResponse) ProtoReflect() protoreflect.Messagefunc (*ListExamplesResponse) Reset
func (x *ListExamplesResponse) Reset()func (*ListExamplesResponse) String
func (x *ListExamplesResponse) String() stringListGuardrailsRequest
type ListGuardrailsRequest struct {
// Required. The resource name of the app to list guardrails from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListGuardrailsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListGuardrails][google.cloud.ces.v1.AgentService.ListGuardrails]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the guardrails.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListGuardrails][google.cloud.ces.v1.AgentService.ListGuardrails].
func (*ListGuardrailsRequest) Descriptor
func (*ListGuardrailsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListGuardrailsRequest.ProtoReflect.Descriptor instead.
func (*ListGuardrailsRequest) GetFilter
func (x *ListGuardrailsRequest) GetFilter() stringfunc (*ListGuardrailsRequest) GetOrderBy
func (x *ListGuardrailsRequest) GetOrderBy() stringfunc (*ListGuardrailsRequest) GetPageSize
func (x *ListGuardrailsRequest) GetPageSize() int32func (*ListGuardrailsRequest) GetPageToken
func (x *ListGuardrailsRequest) GetPageToken() stringfunc (*ListGuardrailsRequest) GetParent
func (x *ListGuardrailsRequest) GetParent() stringfunc (*ListGuardrailsRequest) ProtoMessage
func (*ListGuardrailsRequest) ProtoMessage()func (*ListGuardrailsRequest) ProtoReflect
func (x *ListGuardrailsRequest) ProtoReflect() protoreflect.Messagefunc (*ListGuardrailsRequest) Reset
func (x *ListGuardrailsRequest) Reset()func (*ListGuardrailsRequest) String
func (x *ListGuardrailsRequest) String() stringListGuardrailsResponse
type ListGuardrailsResponse struct {
// The list of guardrails.
Guardrails []*Guardrail `protobuf:"bytes,1,rep,name=guardrails,proto3" json:"guardrails,omitempty"`
// A token that can be sent as
// [ListGuardrailsRequest.page_token][google.cloud.ces.v1.ListGuardrailsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListGuardrails][google.cloud.ces.v1.AgentService.ListGuardrails].
func (*ListGuardrailsResponse) Descriptor
func (*ListGuardrailsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListGuardrailsResponse.ProtoReflect.Descriptor instead.
func (*ListGuardrailsResponse) GetGuardrails
func (x *ListGuardrailsResponse) GetGuardrails() []*Guardrailfunc (*ListGuardrailsResponse) GetNextPageToken
func (x *ListGuardrailsResponse) GetNextPageToken() stringfunc (*ListGuardrailsResponse) ProtoMessage
func (*ListGuardrailsResponse) ProtoMessage()func (*ListGuardrailsResponse) ProtoReflect
func (x *ListGuardrailsResponse) ProtoReflect() protoreflect.Messagefunc (*ListGuardrailsResponse) Reset
func (x *ListGuardrailsResponse) Reset()func (*ListGuardrailsResponse) String
func (x *ListGuardrailsResponse) String() stringListToolsRequest
type ListToolsRequest struct {
// Required. The resource name of the app to list tools from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListToolsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListTools][google.cloud.ces.v1.AgentService.ListTools] call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the tools. Use
// "include_system_tools=true" to include system tools in the response. See
// https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListTools][google.cloud.ces.v1.AgentService.ListTools].
func (*ListToolsRequest) Descriptor
func (*ListToolsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListToolsRequest.ProtoReflect.Descriptor instead.
func (*ListToolsRequest) GetFilter
func (x *ListToolsRequest) GetFilter() stringfunc (*ListToolsRequest) GetOrderBy
func (x *ListToolsRequest) GetOrderBy() stringfunc (*ListToolsRequest) GetPageSize
func (x *ListToolsRequest) GetPageSize() int32func (*ListToolsRequest) GetPageToken
func (x *ListToolsRequest) GetPageToken() stringfunc (*ListToolsRequest) GetParent
func (x *ListToolsRequest) GetParent() stringfunc (*ListToolsRequest) ProtoMessage
func (*ListToolsRequest) ProtoMessage()func (*ListToolsRequest) ProtoReflect
func (x *ListToolsRequest) ProtoReflect() protoreflect.Messagefunc (*ListToolsRequest) Reset
func (x *ListToolsRequest) Reset()func (*ListToolsRequest) String
func (x *ListToolsRequest) String() stringListToolsResponse
type ListToolsResponse struct {
// The list of tools.
Tools []*Tool `protobuf:"bytes,1,rep,name=tools,proto3" json:"tools,omitempty"`
// A token that can be sent as
// [ListToolsRequest.page_token][google.cloud.ces.v1.ListToolsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListTools][google.cloud.ces.v1.AgentService.ListTools].
func (*ListToolsResponse) Descriptor
func (*ListToolsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListToolsResponse.ProtoReflect.Descriptor instead.
func (*ListToolsResponse) GetNextPageToken
func (x *ListToolsResponse) GetNextPageToken() stringfunc (*ListToolsResponse) GetTools
func (x *ListToolsResponse) GetTools() []*Toolfunc (*ListToolsResponse) ProtoMessage
func (*ListToolsResponse) ProtoMessage()func (*ListToolsResponse) ProtoReflect
func (x *ListToolsResponse) ProtoReflect() protoreflect.Messagefunc (*ListToolsResponse) Reset
func (x *ListToolsResponse) Reset()func (*ListToolsResponse) String
func (x *ListToolsResponse) String() stringListToolsetsRequest
type ListToolsetsRequest struct {
// Required. The resource name of the app to list toolsets from.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. Server may return fewer items than
// requested. If unspecified, server will pick an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The
// [next_page_token][google.cloud.ces.v1.ListToolsetsResponse.next_page_token]
// value returned from a previous list
// [AgentService.ListToolsets][google.cloud.ces.v1.AgentService.ListToolsets]
// call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter to be applied when listing the toolsets.
// See https://google.aip.dev/160 for more details.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Field to sort by. Only "name" and "create_time" is supported.
// See https://google.aip.dev/132#ordering for more details.
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.ListToolsets][google.cloud.ces.v1.AgentService.ListToolsets].
func (*ListToolsetsRequest) Descriptor
func (*ListToolsetsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListToolsetsRequest.ProtoReflect.Descriptor instead.
func (*ListToolsetsRequest) GetFilter
func (x *ListToolsetsRequest) GetFilter() stringfunc (*ListToolsetsRequest) GetOrderBy
func (x *ListToolsetsRequest) GetOrderBy() stringfunc (*ListToolsetsRequest) GetPageSize
func (x *ListToolsetsRequest) GetPageSize() int32func (*ListToolsetsRequest) GetPageToken
func (x *ListToolsetsRequest) GetPageToken() stringfunc (*ListToolsetsRequest) GetParent
func (x *ListToolsetsRequest) GetParent() stringfunc (*ListToolsetsRequest) ProtoMessage
func (*ListToolsetsRequest) ProtoMessage()func (*ListToolsetsRequest) ProtoReflect
func (x *ListToolsetsRequest) ProtoReflect() protoreflect.Messagefunc (*ListToolsetsRequest) Reset
func (x *ListToolsetsRequest) Reset()func (*ListToolsetsRequest) String
func (x *ListToolsetsRequest) String() stringListToolsetsResponse
type ListToolsetsResponse struct {
// The list of toolsets.
Toolsets []*Toolset `protobuf:"bytes,1,rep,name=toolsets,proto3" json:"toolsets,omitempty"`
// A token that can be sent as
// [ListToolsetsRequest.page_token][google.cloud.ces.v1.ListToolsetsRequest.page_token]
// to retrieve the next page. Absence of this field indicates there are no
// subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response message for [AgentService.ListToolsets][google.cloud.ces.v1.AgentService.ListToolsets].
func (*ListToolsetsResponse) Descriptor
func (*ListToolsetsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListToolsetsResponse.ProtoReflect.Descriptor instead.
func (*ListToolsetsResponse) GetNextPageToken
func (x *ListToolsetsResponse) GetNextPageToken() stringfunc (*ListToolsetsResponse) GetToolsets
func (x *ListToolsetsResponse) GetToolsets() []*Toolsetfunc (*ListToolsetsResponse) ProtoMessage
func (*ListToolsetsResponse) ProtoMessage()func (*ListToolsetsResponse) ProtoReflect
func (x *ListToolsetsResponse) ProtoReflect() protoreflect.Messagefunc (*ListToolsetsResponse) Reset
func (x *ListToolsetsResponse) Reset()func (*ListToolsetsResponse) String
func (x *ListToolsetsResponse) String() stringLoggingSettings
type LoggingSettings struct {
// Optional. Configuration for how sensitive data should be redacted.
RedactionConfig *RedactionConfig `protobuf:"bytes,1,opt,name=redaction_config,json=redactionConfig,proto3" json:"redaction_config,omitempty"`
// Optional. Configuration for how audio interactions should be recorded.
AudioRecordingConfig *AudioRecordingConfig `protobuf:"bytes,2,opt,name=audio_recording_config,json=audioRecordingConfig,proto3" json:"audio_recording_config,omitempty"`
// Optional. Settings to describe the BigQuery export behaviors for the app.
// The conversation data will be exported to BigQuery tables if it is enabled.
BigqueryExportSettings *BigQueryExportSettings `protobuf:"bytes,3,opt,name=bigquery_export_settings,json=bigqueryExportSettings,proto3" json:"bigquery_export_settings,omitempty"`
// Optional. Settings to describe the Cloud Logging behaviors for the app.
CloudLoggingSettings *CloudLoggingSettings `protobuf:"bytes,4,opt,name=cloud_logging_settings,json=cloudLoggingSettings,proto3" json:"cloud_logging_settings,omitempty"`
// Optional. Settings to describe the conversation logging behaviors for the
// app.
ConversationLoggingSettings *ConversationLoggingSettings `protobuf:"bytes,5,opt,name=conversation_logging_settings,json=conversationLoggingSettings,proto3" json:"conversation_logging_settings,omitempty"`
// Optional. Configuration for how audio interactions should be recorded for
// the evaluation. By default, audio recording is not enabled for evaluation
// sessions.
EvaluationAudioRecordingConfig *AudioRecordingConfig `protobuf:"bytes,6,opt,name=evaluation_audio_recording_config,json=evaluationAudioRecordingConfig,proto3" json:"evaluation_audio_recording_config,omitempty"`
// Optional. Settings to describe the conversation data collection behaviors
// for the LLM analysis pipeline for the app.
MetricAnalysisSettings *MetricAnalysisSettings `protobuf:"bytes,7,opt,name=metric_analysis_settings,json=metricAnalysisSettings,proto3" json:"metric_analysis_settings,omitempty"`
// contains filtered or unexported fields
}Settings to describe the logging behaviors for the app.
func (*LoggingSettings) Descriptor
func (*LoggingSettings) Descriptor() ([]byte, []int)Deprecated: Use LoggingSettings.ProtoReflect.Descriptor instead.
func (*LoggingSettings) GetAudioRecordingConfig
func (x *LoggingSettings) GetAudioRecordingConfig() *AudioRecordingConfigfunc (*LoggingSettings) GetBigqueryExportSettings
func (x *LoggingSettings) GetBigqueryExportSettings() *BigQueryExportSettingsfunc (*LoggingSettings) GetCloudLoggingSettings
func (x *LoggingSettings) GetCloudLoggingSettings() *CloudLoggingSettingsfunc (*LoggingSettings) GetConversationLoggingSettings
func (x *LoggingSettings) GetConversationLoggingSettings() *ConversationLoggingSettingsfunc (*LoggingSettings) GetEvaluationAudioRecordingConfig
func (x *LoggingSettings) GetEvaluationAudioRecordingConfig() *AudioRecordingConfigfunc (*LoggingSettings) GetMetricAnalysisSettings
func (x *LoggingSettings) GetMetricAnalysisSettings() *MetricAnalysisSettingsfunc (*LoggingSettings) GetRedactionConfig
func (x *LoggingSettings) GetRedactionConfig() *RedactionConfigfunc (*LoggingSettings) ProtoMessage
func (*LoggingSettings) ProtoMessage()func (*LoggingSettings) ProtoReflect
func (x *LoggingSettings) ProtoReflect() protoreflect.Messagefunc (*LoggingSettings) Reset
func (x *LoggingSettings) Reset()func (*LoggingSettings) String
func (x *LoggingSettings) String() stringMcpTool
type McpTool struct {
// Required. The name of the MCP tool.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The description of the MCP tool.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The schema of the input arguments of the MCP tool.
InputSchema *Schema `protobuf:"bytes,3,opt,name=input_schema,json=inputSchema,proto3" json:"input_schema,omitempty"`
// Optional. The schema of the output arguments of the MCP tool.
OutputSchema *Schema `protobuf:"bytes,4,opt,name=output_schema,json=outputSchema,proto3" json:"output_schema,omitempty"`
// Required. The server address of the MCP server, e.g.,
// "https://example.com/mcp/". If the server is built with the MCP SDK, the
// url should be suffixed with
// "/mcp/". Only Streamable HTTP transport based servers are supported. This
// is the same as the server_address in the McpToolset. See
// https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http
// for more details.
ServerAddress string `protobuf:"bytes,5,opt,name=server_address,json=serverAddress,proto3" json:"server_address,omitempty"`
// Optional. Authentication information required to execute the tool against
// the MCP server. For bearer token authentication, the token applies only to
// tool execution, not to listing tools. This requires that tools can be
// listed without authentication.
ApiAuthentication *ApiAuthentication `protobuf:"bytes,6,opt,name=api_authentication,json=apiAuthentication,proto3" json:"api_authentication,omitempty"`
// Optional. The TLS configuration. Includes the custom server certificates
// that the client should trust.
TlsConfig *TlsConfig `protobuf:"bytes,7,opt,name=tls_config,json=tlsConfig,proto3" json:"tls_config,omitempty"`
// Optional. Service Directory configuration for VPC-SC, used to resolve
// service names within a perimeter.
ServiceDirectoryConfig *ServiceDirectoryConfig `protobuf:"bytes,8,opt,name=service_directory_config,json=serviceDirectoryConfig,proto3" json:"service_directory_config,omitempty"`
// Optional. The custom headers to send in the request to the MCP server. The
// values must be in the format `$context.variables.An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.
func (*McpTool) Descriptor
Deprecated: Use McpTool.ProtoReflect.Descriptor instead.
func (*McpTool) GetApiAuthentication
func (x *McpTool) GetApiAuthentication() *ApiAuthenticationfunc (*McpTool) GetCustomHeaders
func (*McpTool) GetDescription
func (*McpTool) GetInputSchema
func (*McpTool) GetName
func (*McpTool) GetOutputSchema
func (*McpTool) GetServerAddress
func (*McpTool) GetServiceDirectoryConfig
func (x *McpTool) GetServiceDirectoryConfig() *ServiceDirectoryConfigfunc (*McpTool) GetTlsConfig
func (*McpTool) ProtoMessage
func (*McpTool) ProtoMessage()func (*McpTool) ProtoReflect
func (x *McpTool) ProtoReflect() protoreflect.Messagefunc (*McpTool) Reset
func (x *McpTool) Reset()func (*McpTool) String
McpToolset
type McpToolset struct {
// Required. The address of the MCP server, for example,
// "https://example.com/mcp/". If the server is built with the MCP SDK, the
// url should be suffixed with
// "/mcp/". Only Streamable HTTP transport based servers are supported. See
// https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http
// for more details.
ServerAddress string `protobuf:"bytes,1,opt,name=server_address,json=serverAddress,proto3" json:"server_address,omitempty"`
// Optional. Authentication information required to access tools and execute a
// tool against the MCP server. For bearer token authentication, the token
// applies only to tool execution, not to listing tools. This requires that
// tools can be listed without authentication.
ApiAuthentication *ApiAuthentication `protobuf:"bytes,2,opt,name=api_authentication,json=apiAuthentication,proto3" json:"api_authentication,omitempty"`
// Optional. Service Directory configuration for VPC-SC, used to resolve
// service names within a perimeter.
ServiceDirectoryConfig *ServiceDirectoryConfig `protobuf:"bytes,3,opt,name=service_directory_config,json=serviceDirectoryConfig,proto3" json:"service_directory_config,omitempty"`
// Optional. The TLS configuration. Includes the custom server certificates
// that the client should trust.
TlsConfig *TlsConfig `protobuf:"bytes,4,opt,name=tls_config,json=tlsConfig,proto3" json:"tls_config,omitempty"`
// Optional. The custom headers to send in the request to the MCP server. The
// values must be in the format `$context.variables.A toolset that contains a list of tools that are offered by the MCP server.
func (*McpToolset) Descriptor
func (*McpToolset) Descriptor() ([]byte, []int)Deprecated: Use McpToolset.ProtoReflect.Descriptor instead.
func (*McpToolset) GetApiAuthentication
func (x *McpToolset) GetApiAuthentication() *ApiAuthenticationfunc (*McpToolset) GetCustomHeaders
func (x *McpToolset) GetCustomHeaders() map[string]stringfunc (*McpToolset) GetServerAddress
func (x *McpToolset) GetServerAddress() stringfunc (*McpToolset) GetServiceDirectoryConfig
func (x *McpToolset) GetServiceDirectoryConfig() *ServiceDirectoryConfigfunc (*McpToolset) GetTlsConfig
func (x *McpToolset) GetTlsConfig() *TlsConfigfunc (*McpToolset) ProtoMessage
func (*McpToolset) ProtoMessage()func (*McpToolset) ProtoReflect
func (x *McpToolset) ProtoReflect() protoreflect.Messagefunc (*McpToolset) Reset
func (x *McpToolset) Reset()func (*McpToolset) String
func (x *McpToolset) String() stringMessage
type Message struct {
// Optional. The role within the conversation, e.g., user, agent.
Role string `protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
// Optional. Content of the message as a series of chunks.
Chunks []*Chunk `protobuf:"bytes,2,rep,name=chunks,proto3" json:"chunks,omitempty"`
// Optional. Timestamp when the message was sent or received. Should not be
// used if the message is part of an [example][google.cloud.ces.v1.Example].
EventTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
// contains filtered or unexported fields
}A message within a conversation.
func (*Message) Descriptor
Deprecated: Use Message.ProtoReflect.Descriptor instead.
func (*Message) GetChunks
func (*Message) GetEventTime
func (x *Message) GetEventTime() *timestamppb.Timestampfunc (*Message) GetRole
func (*Message) ProtoMessage
func (*Message) ProtoMessage()func (*Message) ProtoReflect
func (x *Message) ProtoReflect() protoreflect.Messagefunc (*Message) Reset
func (x *Message) Reset()func (*Message) String
MetricAnalysisSettings
type MetricAnalysisSettings struct {
// Optional. Whether to collect conversation data for llm analysis metrics. If
// true, conversation data will not be collected for llm analysis metrics;
// otherwise, conversation data will be collected.
LlmMetricsOptedOut bool `protobuf:"varint,1,opt,name=llm_metrics_opted_out,json=llmMetricsOptedOut,proto3" json:"llm_metrics_opted_out,omitempty"`
// contains filtered or unexported fields
}Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.
func (*MetricAnalysisSettings) Descriptor
func (*MetricAnalysisSettings) Descriptor() ([]byte, []int)Deprecated: Use MetricAnalysisSettings.ProtoReflect.Descriptor instead.
func (*MetricAnalysisSettings) GetLlmMetricsOptedOut
func (x *MetricAnalysisSettings) GetLlmMetricsOptedOut() boolfunc (*MetricAnalysisSettings) ProtoMessage
func (*MetricAnalysisSettings) ProtoMessage()func (*MetricAnalysisSettings) ProtoReflect
func (x *MetricAnalysisSettings) ProtoReflect() protoreflect.Messagefunc (*MetricAnalysisSettings) Reset
func (x *MetricAnalysisSettings) Reset()func (*MetricAnalysisSettings) String
func (x *MetricAnalysisSettings) String() stringModelSettings
type ModelSettings struct {
// Optional. The LLM model that the agent should use.
// If not set, the agent will inherit the model from its parent agent.
Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
// Optional. If set, this temperature will be used for the LLM model.
// Temperature controls the randomness of the model's responses. Lower
// temperatures produce responses that are more predictable. Higher
// temperatures produce responses that are more creative.
Temperature *float64 `protobuf:"fixed64,2,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
// contains filtered or unexported fields
}Model settings contains various configurations for the LLM model.
func (*ModelSettings) Descriptor
func (*ModelSettings) Descriptor() ([]byte, []int)Deprecated: Use ModelSettings.ProtoReflect.Descriptor instead.
func (*ModelSettings) GetModel
func (x *ModelSettings) GetModel() stringfunc (*ModelSettings) GetTemperature
func (x *ModelSettings) GetTemperature() float64func (*ModelSettings) ProtoMessage
func (*ModelSettings) ProtoMessage()func (*ModelSettings) ProtoReflect
func (x *ModelSettings) ProtoReflect() protoreflect.Messagefunc (*ModelSettings) Reset
func (x *ModelSettings) Reset()func (*ModelSettings) String
func (x *ModelSettings) String() stringOAuthConfig
type OAuthConfig struct {
// Required. OAuth grant types.
OauthGrantType OAuthConfig_OauthGrantType `protobuf:"varint,1,opt,name=oauth_grant_type,json=oauthGrantType,proto3,enum=google.cloud.ces.v1.OAuthConfig_OauthGrantType" json:"oauth_grant_type,omitempty"`
// Required. The client ID from the OAuth provider.
ClientId string `protobuf:"bytes,2,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
// Required. The name of the SecretManager secret version resource storing the
// client secret.
// Format: `projects/{project}/secrets/{secret}/versions/{version}`
//
// Note: You should grant `roles/secretmanager.secretAccessor` role to the CES
// service agent
// `service-Configurations for authentication with OAuth.
func (*OAuthConfig) Descriptor
func (*OAuthConfig) Descriptor() ([]byte, []int)Deprecated: Use OAuthConfig.ProtoReflect.Descriptor instead.
func (*OAuthConfig) GetClientId
func (x *OAuthConfig) GetClientId() stringfunc (*OAuthConfig) GetClientSecretVersion
func (x *OAuthConfig) GetClientSecretVersion() stringfunc (*OAuthConfig) GetOauthGrantType
func (x *OAuthConfig) GetOauthGrantType() OAuthConfig_OauthGrantTypefunc (*OAuthConfig) GetScopes
func (x *OAuthConfig) GetScopes() []stringfunc (*OAuthConfig) GetTokenEndpoint
func (x *OAuthConfig) GetTokenEndpoint() stringfunc (*OAuthConfig) ProtoMessage
func (*OAuthConfig) ProtoMessage()func (*OAuthConfig) ProtoReflect
func (x *OAuthConfig) ProtoReflect() protoreflect.Messagefunc (*OAuthConfig) Reset
func (x *OAuthConfig) Reset()func (*OAuthConfig) String
func (x *OAuthConfig) String() stringOAuthConfig_OauthGrantType
type OAuthConfig_OauthGrantType int32OAuth grant types. Only client credential grant is supported.
OAuthConfig_OAUTH_GRANT_TYPE_UNSPECIFIED, OAuthConfig_CLIENT_CREDENTIAL
const (
// Unspecified. Defaults to CLIENT_CREDENTIAL.
OAuthConfig_OAUTH_GRANT_TYPE_UNSPECIFIED OAuthConfig_OauthGrantType = 0
// Represents the [client credential
// flow](https://oauth.net/2/grant-types/client-credentials).
OAuthConfig_CLIENT_CREDENTIAL OAuthConfig_OauthGrantType = 1
)func (OAuthConfig_OauthGrantType) Descriptor
func (OAuthConfig_OauthGrantType) Descriptor() protoreflect.EnumDescriptorfunc (OAuthConfig_OauthGrantType) Enum
func (x OAuthConfig_OauthGrantType) Enum() *OAuthConfig_OauthGrantTypefunc (OAuthConfig_OauthGrantType) EnumDescriptor
func (OAuthConfig_OauthGrantType) EnumDescriptor() ([]byte, []int)Deprecated: Use OAuthConfig_OauthGrantType.Descriptor instead.
func (OAuthConfig_OauthGrantType) Number
func (x OAuthConfig_OauthGrantType) Number() protoreflect.EnumNumberfunc (OAuthConfig_OauthGrantType) String
func (x OAuthConfig_OauthGrantType) String() stringfunc (OAuthConfig_OauthGrantType) Type
func (OAuthConfig_OauthGrantType) Type() protoreflect.EnumTypeOmnichannel
type Omnichannel struct {
// Identifier. The unique identifier of the omnichannel resource.
// Format:
// `projects/{project}/locations/{location}/omnichannels/{omnichannel}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Display name of the omnichannel resource.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Human-readable description of the omnichannel resource.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Timestamp when the omnichannel resource was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the omnichannel resource was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Etag used to ensure the object hasn't changed during a
// read-modify-write operation.
Etag string `protobuf:"bytes,6,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. The integration config for the omnichannel resource.
IntegrationConfig *OmnichannelIntegrationConfig `protobuf:"bytes,7,opt,name=integration_config,json=integrationConfig,proto3" json:"integration_config,omitempty"`
// contains filtered or unexported fields
}Represents an Omnichannel resource.
func (*Omnichannel) Descriptor
func (*Omnichannel) Descriptor() ([]byte, []int)Deprecated: Use Omnichannel.ProtoReflect.Descriptor instead.
func (*Omnichannel) GetCreateTime
func (x *Omnichannel) GetCreateTime() *timestamppb.Timestampfunc (*Omnichannel) GetDescription
func (x *Omnichannel) GetDescription() stringfunc (*Omnichannel) GetDisplayName
func (x *Omnichannel) GetDisplayName() stringfunc (*Omnichannel) GetEtag
func (x *Omnichannel) GetEtag() stringfunc (*Omnichannel) GetIntegrationConfig
func (x *Omnichannel) GetIntegrationConfig() *OmnichannelIntegrationConfigfunc (*Omnichannel) GetName
func (x *Omnichannel) GetName() stringfunc (*Omnichannel) GetUpdateTime
func (x *Omnichannel) GetUpdateTime() *timestamppb.Timestampfunc (*Omnichannel) ProtoMessage
func (*Omnichannel) ProtoMessage()func (*Omnichannel) ProtoReflect
func (x *Omnichannel) ProtoReflect() protoreflect.Messagefunc (*Omnichannel) Reset
func (x *Omnichannel) Reset()func (*Omnichannel) String
func (x *Omnichannel) String() stringOmnichannelIntegrationConfig
type OmnichannelIntegrationConfig struct {
// Optional. Various of configuration for handling App events.
ChannelConfigs map[string]*OmnichannelIntegrationConfig_ChannelConfig `protobuf:"bytes,1,rep,name=channel_configs,json=channelConfigs,proto3" json:"channel_configs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Various of subscribers configs.
SubscriberConfigs map[string]*OmnichannelIntegrationConfig_SubscriberConfig `protobuf:"bytes,2,rep,name=subscriber_configs,json=subscriberConfigs,proto3" json:"subscriber_configs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. The key of routing_configs is a key of `app_configs`, value is a
// `RoutingConfig`, which contains subscriber's key.
RoutingConfigs map[string]*OmnichannelIntegrationConfig_RoutingConfig `protobuf:"bytes,3,rep,name=routing_configs,json=routingConfigs,proto3" json:"routing_configs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// contains filtered or unexported fields
}OmnichannelIntegrationConfig contains all App integration configs.
func (*OmnichannelIntegrationConfig) Descriptor
func (*OmnichannelIntegrationConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig) GetChannelConfigs
func (x *OmnichannelIntegrationConfig) GetChannelConfigs() map[string]*OmnichannelIntegrationConfig_ChannelConfigfunc (*OmnichannelIntegrationConfig) GetRoutingConfigs
func (x *OmnichannelIntegrationConfig) GetRoutingConfigs() map[string]*OmnichannelIntegrationConfig_RoutingConfigfunc (*OmnichannelIntegrationConfig) GetSubscriberConfigs
func (x *OmnichannelIntegrationConfig) GetSubscriberConfigs() map[string]*OmnichannelIntegrationConfig_SubscriberConfigfunc (*OmnichannelIntegrationConfig) ProtoMessage
func (*OmnichannelIntegrationConfig) ProtoMessage()func (*OmnichannelIntegrationConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig) Reset
func (x *OmnichannelIntegrationConfig) Reset()func (*OmnichannelIntegrationConfig) String
func (x *OmnichannelIntegrationConfig) String() stringOmnichannelIntegrationConfig_CesAppConfig
type OmnichannelIntegrationConfig_CesAppConfig struct {
// The unique identifier of the CES app.
// Format: `projects/{project}/locations/{location}/apps/{app}`
App string `protobuf:"bytes,1,opt,name=app,proto3" json:"app,omitempty"`
// contains filtered or unexported fields
}Configs for CES app.
func (*OmnichannelIntegrationConfig_CesAppConfig) Descriptor
func (*OmnichannelIntegrationConfig_CesAppConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig_CesAppConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig_CesAppConfig) GetApp
func (x *OmnichannelIntegrationConfig_CesAppConfig) GetApp() stringfunc (*OmnichannelIntegrationConfig_CesAppConfig) ProtoMessage
func (*OmnichannelIntegrationConfig_CesAppConfig) ProtoMessage()func (*OmnichannelIntegrationConfig_CesAppConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig_CesAppConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig_CesAppConfig) Reset
func (x *OmnichannelIntegrationConfig_CesAppConfig) Reset()func (*OmnichannelIntegrationConfig_CesAppConfig) String
func (x *OmnichannelIntegrationConfig_CesAppConfig) String() stringOmnichannelIntegrationConfig_ChannelConfig
type OmnichannelIntegrationConfig_ChannelConfig struct {
// The config for the app.
//
// Types that are valid to be assigned to ChannelConfig:
//
// *OmnichannelIntegrationConfig_ChannelConfig_WhatsappConfig
ChannelConfig isOmnichannelIntegrationConfig_ChannelConfig_ChannelConfig `protobuf_oneof:"channel_config"`
// contains filtered or unexported fields
}ChannelConfig contains config for various of app integration.
func (*OmnichannelIntegrationConfig_ChannelConfig) Descriptor
func (*OmnichannelIntegrationConfig_ChannelConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig_ChannelConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig_ChannelConfig) GetChannelConfig
func (x *OmnichannelIntegrationConfig_ChannelConfig) GetChannelConfig() isOmnichannelIntegrationConfig_ChannelConfig_ChannelConfigfunc (*OmnichannelIntegrationConfig_ChannelConfig) GetWhatsappConfig
func (x *OmnichannelIntegrationConfig_ChannelConfig) GetWhatsappConfig() *OmnichannelIntegrationConfig_WhatsappConfigfunc (*OmnichannelIntegrationConfig_ChannelConfig) ProtoMessage
func (*OmnichannelIntegrationConfig_ChannelConfig) ProtoMessage()func (*OmnichannelIntegrationConfig_ChannelConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig_ChannelConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig_ChannelConfig) Reset
func (x *OmnichannelIntegrationConfig_ChannelConfig) Reset()func (*OmnichannelIntegrationConfig_ChannelConfig) String
func (x *OmnichannelIntegrationConfig_ChannelConfig) String() stringOmnichannelIntegrationConfig_ChannelConfig_WhatsappConfig
type OmnichannelIntegrationConfig_ChannelConfig_WhatsappConfig struct {
// WhatsApp config.
WhatsappConfig *OmnichannelIntegrationConfig_WhatsappConfig `protobuf:"bytes,1,opt,name=whatsapp_config,json=whatsappConfig,proto3,oneof"`
}OmnichannelIntegrationConfig_RoutingConfig
type OmnichannelIntegrationConfig_RoutingConfig struct {
// The key of the subscriber.
SubscriberKey string `protobuf:"bytes,1,opt,name=subscriber_key,json=subscriberKey,proto3" json:"subscriber_key,omitempty"`
// contains filtered or unexported fields
}Routing config specify how/who to route app events to a subscriber.
func (*OmnichannelIntegrationConfig_RoutingConfig) Descriptor
func (*OmnichannelIntegrationConfig_RoutingConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig_RoutingConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig_RoutingConfig) GetSubscriberKey
func (x *OmnichannelIntegrationConfig_RoutingConfig) GetSubscriberKey() stringfunc (*OmnichannelIntegrationConfig_RoutingConfig) ProtoMessage
func (*OmnichannelIntegrationConfig_RoutingConfig) ProtoMessage()func (*OmnichannelIntegrationConfig_RoutingConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig_RoutingConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig_RoutingConfig) Reset
func (x *OmnichannelIntegrationConfig_RoutingConfig) Reset()func (*OmnichannelIntegrationConfig_RoutingConfig) String
func (x *OmnichannelIntegrationConfig_RoutingConfig) String() stringOmnichannelIntegrationConfig_SubscriberConfig
type OmnichannelIntegrationConfig_SubscriberConfig struct {
// The config for the subscriber.
//
// Types that are valid to be assigned to SubscriberConfig:
//
// *OmnichannelIntegrationConfig_SubscriberConfig_CesAppConfig
SubscriberConfig isOmnichannelIntegrationConfig_SubscriberConfig_SubscriberConfig `protobuf_oneof:"subscriber_config"`
// contains filtered or unexported fields
}Configs of subscribers.
func (*OmnichannelIntegrationConfig_SubscriberConfig) Descriptor
func (*OmnichannelIntegrationConfig_SubscriberConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig_SubscriberConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig_SubscriberConfig) GetCesAppConfig
func (x *OmnichannelIntegrationConfig_SubscriberConfig) GetCesAppConfig() *OmnichannelIntegrationConfig_CesAppConfigfunc (*OmnichannelIntegrationConfig_SubscriberConfig) GetSubscriberConfig
func (x *OmnichannelIntegrationConfig_SubscriberConfig) GetSubscriberConfig() isOmnichannelIntegrationConfig_SubscriberConfig_SubscriberConfigfunc (*OmnichannelIntegrationConfig_SubscriberConfig) ProtoMessage
func (*OmnichannelIntegrationConfig_SubscriberConfig) ProtoMessage()func (*OmnichannelIntegrationConfig_SubscriberConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig_SubscriberConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig_SubscriberConfig) Reset
func (x *OmnichannelIntegrationConfig_SubscriberConfig) Reset()func (*OmnichannelIntegrationConfig_SubscriberConfig) String
func (x *OmnichannelIntegrationConfig_SubscriberConfig) String() stringOmnichannelIntegrationConfig_SubscriberConfig_CesAppConfig
type OmnichannelIntegrationConfig_SubscriberConfig_CesAppConfig struct {
// Ces app config.
CesAppConfig *OmnichannelIntegrationConfig_CesAppConfig `protobuf:"bytes,1,opt,name=ces_app_config,json=cesAppConfig,proto3,oneof"`
}OmnichannelIntegrationConfig_WhatsappConfig
type OmnichannelIntegrationConfig_WhatsappConfig struct {
// The Phone Number ID associated with the WhatsApp Business Account.
PhoneNumberId string `protobuf:"bytes,1,opt,name=phone_number_id,json=phoneNumberId,proto3" json:"phone_number_id,omitempty"`
// The phone number used for sending/receiving messages.
PhoneNumber string `protobuf:"bytes,2,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
// The customer's WhatsApp Business Account (WABA) ID.
WhatsappBusinessAccountId string `protobuf:"bytes,3,opt,name=whatsapp_business_account_id,json=whatsappBusinessAccountId,proto3" json:"whatsapp_business_account_id,omitempty"`
// The verify token configured in the Meta App Dashboard for webhook
// verification.
WebhookVerifyToken string `protobuf:"bytes,4,opt,name=webhook_verify_token,json=webhookVerifyToken,proto3" json:"webhook_verify_token,omitempty"`
// The access token for authenticating API calls to the WhatsApp Cloud API.
// https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens
WhatsappBusinessToken string `protobuf:"bytes,5,opt,name=whatsapp_business_token,json=whatsappBusinessToken,proto3" json:"whatsapp_business_token,omitempty"`
// The Meta Business Portfolio (MBP) ID.
// https://www.facebook.com/business/help/1710077379203657
MetaBusinessPortfolioId string `protobuf:"bytes,6,opt,name=meta_business_portfolio_id,json=metaBusinessPortfolioId,proto3" json:"meta_business_portfolio_id,omitempty"`
// contains filtered or unexported fields
}How Omnichannel should receive/reply events from WhatsApp.
func (*OmnichannelIntegrationConfig_WhatsappConfig) Descriptor
func (*OmnichannelIntegrationConfig_WhatsappConfig) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelIntegrationConfig_WhatsappConfig.ProtoReflect.Descriptor instead.
func (*OmnichannelIntegrationConfig_WhatsappConfig) GetMetaBusinessPortfolioId
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetMetaBusinessPortfolioId() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) GetPhoneNumber
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetPhoneNumber() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) GetPhoneNumberId
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetPhoneNumberId() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) GetWebhookVerifyToken
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetWebhookVerifyToken() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) GetWhatsappBusinessAccountId
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetWhatsappBusinessAccountId() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) GetWhatsappBusinessToken
func (x *OmnichannelIntegrationConfig_WhatsappConfig) GetWhatsappBusinessToken() stringfunc (*OmnichannelIntegrationConfig_WhatsappConfig) ProtoMessage
func (*OmnichannelIntegrationConfig_WhatsappConfig) ProtoMessage()func (*OmnichannelIntegrationConfig_WhatsappConfig) ProtoReflect
func (x *OmnichannelIntegrationConfig_WhatsappConfig) ProtoReflect() protoreflect.Messagefunc (*OmnichannelIntegrationConfig_WhatsappConfig) Reset
func (x *OmnichannelIntegrationConfig_WhatsappConfig) Reset()func (*OmnichannelIntegrationConfig_WhatsappConfig) String
func (x *OmnichannelIntegrationConfig_WhatsappConfig) String() stringOmnichannelOperationMetadata
type OmnichannelOperationMetadata struct {
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,3,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Output only. Identifies whether the user has requested cancellation of the
// operation.
RequestedCancellation bool `protobuf:"varint,4,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// contains filtered or unexported fields
}Represents the metadata of the long-running operation.
func (*OmnichannelOperationMetadata) Descriptor
func (*OmnichannelOperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OmnichannelOperationMetadata.ProtoReflect.Descriptor instead.
func (*OmnichannelOperationMetadata) GetCreateTime
func (x *OmnichannelOperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OmnichannelOperationMetadata) GetEndTime
func (x *OmnichannelOperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OmnichannelOperationMetadata) GetRequestedCancellation
func (x *OmnichannelOperationMetadata) GetRequestedCancellation() boolfunc (*OmnichannelOperationMetadata) GetStatusMessage
func (x *OmnichannelOperationMetadata) GetStatusMessage() stringfunc (*OmnichannelOperationMetadata) ProtoMessage
func (*OmnichannelOperationMetadata) ProtoMessage()func (*OmnichannelOperationMetadata) ProtoReflect
func (x *OmnichannelOperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OmnichannelOperationMetadata) Reset
func (x *OmnichannelOperationMetadata) Reset()func (*OmnichannelOperationMetadata) String
func (x *OmnichannelOperationMetadata) String() stringOpenApiTool
type OpenApiTool struct {
// Required. The OpenAPI schema in JSON or YAML format.
OpenApiSchema string `protobuf:"bytes,1,opt,name=open_api_schema,json=openApiSchema,proto3" json:"open_api_schema,omitempty"`
// Optional. The name of the tool. If not provided, the name of the tool will
// be derived from the OpenAPI schema, from `operation.operationId`.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The description of the tool. If not provided, the description of
// the tool will be derived from the OpenAPI schema, from
// `operation.description` or `operation.summary`.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Authentication information required by the API.
ApiAuthentication *ApiAuthentication `protobuf:"bytes,4,opt,name=api_authentication,json=apiAuthentication,proto3" json:"api_authentication,omitempty"`
// Optional. The TLS configuration. Includes the custom server certificates
// that the client will trust.
TlsConfig *TlsConfig `protobuf:"bytes,5,opt,name=tls_config,json=tlsConfig,proto3" json:"tls_config,omitempty"`
// Optional. Service Directory configuration.
ServiceDirectoryConfig *ServiceDirectoryConfig `protobuf:"bytes,6,opt,name=service_directory_config,json=serviceDirectoryConfig,proto3" json:"service_directory_config,omitempty"`
// Optional. If true, the agent will ignore unknown fields in the API
// response.
IgnoreUnknownFields bool `protobuf:"varint,7,opt,name=ignore_unknown_fields,json=ignoreUnknownFields,proto3" json:"ignore_unknown_fields,omitempty"`
// Optional. The server URL of the Open API schema.
// This field is only set in tools in the environment dependencies during the
// export process if the schema contains a server url. During the import
// process, if this url is present in the environment dependencies and the
// schema has the $env_var placeholder, it will replace the placeholder in the
// schema.
Url string `protobuf:"bytes,8,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}A remote API tool defined by an OpenAPI schema.
func (*OpenApiTool) Descriptor
func (*OpenApiTool) Descriptor() ([]byte, []int)Deprecated: Use OpenApiTool.ProtoReflect.Descriptor instead.
func (*OpenApiTool) GetApiAuthentication
func (x *OpenApiTool) GetApiAuthentication() *ApiAuthenticationfunc (*OpenApiTool) GetDescription
func (x *OpenApiTool) GetDescription() stringfunc (*OpenApiTool) GetIgnoreUnknownFields
func (x *OpenApiTool) GetIgnoreUnknownFields() boolfunc (*OpenApiTool) GetName
func (x *OpenApiTool) GetName() stringfunc (*OpenApiTool) GetOpenApiSchema
func (x *OpenApiTool) GetOpenApiSchema() stringfunc (*OpenApiTool) GetServiceDirectoryConfig
func (x *OpenApiTool) GetServiceDirectoryConfig() *ServiceDirectoryConfigfunc (*OpenApiTool) GetTlsConfig
func (x *OpenApiTool) GetTlsConfig() *TlsConfigfunc (*OpenApiTool) GetUrl
func (x *OpenApiTool) GetUrl() stringfunc (*OpenApiTool) ProtoMessage
func (*OpenApiTool) ProtoMessage()func (*OpenApiTool) ProtoReflect
func (x *OpenApiTool) ProtoReflect() protoreflect.Messagefunc (*OpenApiTool) Reset
func (x *OpenApiTool) Reset()func (*OpenApiTool) String
func (x *OpenApiTool) String() stringOpenApiToolset
type OpenApiToolset struct {
// Required. The OpenAPI schema of the toolset.
OpenApiSchema string `protobuf:"bytes,1,opt,name=open_api_schema,json=openApiSchema,proto3" json:"open_api_schema,omitempty"`
// Optional. Authentication information required by the API.
ApiAuthentication *ApiAuthentication `protobuf:"bytes,2,opt,name=api_authentication,json=apiAuthentication,proto3" json:"api_authentication,omitempty"`
// Optional. The TLS configuration. Includes the custom server certificates
TlsConfig *TlsConfig `protobuf:"bytes,3,opt,name=tls_config,json=tlsConfig,proto3" json:"tls_config,omitempty"`
// Optional. Service Directory configuration.
ServiceDirectoryConfig *ServiceDirectoryConfig `protobuf:"bytes,4,opt,name=service_directory_config,json=serviceDirectoryConfig,proto3" json:"service_directory_config,omitempty"`
// Optional. If true, the agent will ignore unknown fields in the API response
// for all operations defined in the OpenAPI schema.
IgnoreUnknownFields bool `protobuf:"varint,5,opt,name=ignore_unknown_fields,json=ignoreUnknownFields,proto3" json:"ignore_unknown_fields,omitempty"`
// Optional. The server URL of the Open API schema.
// This field is only set in toolsets in the environment dependencies during
// the export process if the schema contains a server url. During the import
// process, if this url is present in the environment dependencies and the
// schema has the $env_var placeholder, it will replace the placeholder in the
// schema.
Url string `protobuf:"bytes,6,opt,name=url,proto3" json:"url,omitempty"`
// contains filtered or unexported fields
}A toolset that contains a list of tools that are defined by an OpenAPI schema.
func (*OpenApiToolset) Descriptor
func (*OpenApiToolset) Descriptor() ([]byte, []int)Deprecated: Use OpenApiToolset.ProtoReflect.Descriptor instead.
func (*OpenApiToolset) GetApiAuthentication
func (x *OpenApiToolset) GetApiAuthentication() *ApiAuthenticationfunc (*OpenApiToolset) GetIgnoreUnknownFields
func (x *OpenApiToolset) GetIgnoreUnknownFields() boolfunc (*OpenApiToolset) GetOpenApiSchema
func (x *OpenApiToolset) GetOpenApiSchema() stringfunc (*OpenApiToolset) GetServiceDirectoryConfig
func (x *OpenApiToolset) GetServiceDirectoryConfig() *ServiceDirectoryConfigfunc (*OpenApiToolset) GetTlsConfig
func (x *OpenApiToolset) GetTlsConfig() *TlsConfigfunc (*OpenApiToolset) GetUrl
func (x *OpenApiToolset) GetUrl() stringfunc (*OpenApiToolset) ProtoMessage
func (*OpenApiToolset) ProtoMessage()func (*OpenApiToolset) ProtoReflect
func (x *OpenApiToolset) ProtoReflect() protoreflect.Messagefunc (*OpenApiToolset) Reset
func (x *OpenApiToolset) Reset()func (*OpenApiToolset) String
func (x *OpenApiToolset) String() stringOperationMetadata
type OperationMetadata struct {
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,3,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Output only. Identifies whether the user has requested cancellation of the
// operation. Operations that have been cancelled successfully have
// [google.longrunning.Operation.error][google.longrunning.Operation.error]
// value with a [google.rpc.Status.code][google.rpc.Status.code] of `1`,
// corresponding to `Code.CANCELLED`.
RequestedCancellation bool `protobuf:"varint,4,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// contains filtered or unexported fields
}Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() boolfunc (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringOutputAudioConfig
type OutputAudioConfig struct {
// Required. The encoding of the output audio data.
AudioEncoding AudioEncoding `protobuf:"varint,1,opt,name=audio_encoding,json=audioEncoding,proto3,enum=google.cloud.ces.v1.AudioEncoding" json:"audio_encoding,omitempty"`
// Required. The sample rate (in Hertz) of the output audio data.
SampleRateHertz int32 `protobuf:"varint,2,opt,name=sample_rate_hertz,json=sampleRateHertz,proto3" json:"sample_rate_hertz,omitempty"`
// contains filtered or unexported fields
}OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.
func (*OutputAudioConfig) Descriptor
func (*OutputAudioConfig) Descriptor() ([]byte, []int)Deprecated: Use OutputAudioConfig.ProtoReflect.Descriptor instead.
func (*OutputAudioConfig) GetAudioEncoding
func (x *OutputAudioConfig) GetAudioEncoding() AudioEncodingfunc (*OutputAudioConfig) GetSampleRateHertz
func (x *OutputAudioConfig) GetSampleRateHertz() int32func (*OutputAudioConfig) ProtoMessage
func (*OutputAudioConfig) ProtoMessage()func (*OutputAudioConfig) ProtoReflect
func (x *OutputAudioConfig) ProtoReflect() protoreflect.Messagefunc (*OutputAudioConfig) Reset
func (x *OutputAudioConfig) Reset()func (*OutputAudioConfig) String
func (x *OutputAudioConfig) String() stringPythonCodeCondition
type PythonCodeCondition struct {
// Required. The python code to execute.
PythonCode string `protobuf:"bytes,1,opt,name=python_code,json=pythonCode,proto3" json:"python_code,omitempty"`
// contains filtered or unexported fields
}Python code block to evaluate the condition.
func (*PythonCodeCondition) Descriptor
func (*PythonCodeCondition) Descriptor() ([]byte, []int)Deprecated: Use PythonCodeCondition.ProtoReflect.Descriptor instead.
func (*PythonCodeCondition) GetPythonCode
func (x *PythonCodeCondition) GetPythonCode() stringfunc (*PythonCodeCondition) ProtoMessage
func (*PythonCodeCondition) ProtoMessage()func (*PythonCodeCondition) ProtoReflect
func (x *PythonCodeCondition) ProtoReflect() protoreflect.Messagefunc (*PythonCodeCondition) Reset
func (x *PythonCodeCondition) Reset()func (*PythonCodeCondition) String
func (x *PythonCodeCondition) String() stringPythonFunction
type PythonFunction struct {
// Optional. The name of the Python function to execute. Must match a Python
// function name defined in the python code. Case sensitive. If the name is
// not provided, the first function defined in the python code will be used.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The Python code to execute for the tool.
PythonCode string `protobuf:"bytes,2,opt,name=python_code,json=pythonCode,proto3" json:"python_code,omitempty"`
// Output only. The description of the Python function, parsed from the python
// code's docstring.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}A Python function tool.
func (*PythonFunction) Descriptor
func (*PythonFunction) Descriptor() ([]byte, []int)Deprecated: Use PythonFunction.ProtoReflect.Descriptor instead.
func (*PythonFunction) GetDescription
func (x *PythonFunction) GetDescription() stringfunc (*PythonFunction) GetName
func (x *PythonFunction) GetName() stringfunc (*PythonFunction) GetPythonCode
func (x *PythonFunction) GetPythonCode() stringfunc (*PythonFunction) ProtoMessage
func (*PythonFunction) ProtoMessage()func (*PythonFunction) ProtoReflect
func (x *PythonFunction) ProtoReflect() protoreflect.Messagefunc (*PythonFunction) Reset
func (x *PythonFunction) Reset()func (*PythonFunction) String
func (x *PythonFunction) String() stringRecognitionResult
type RecognitionResult struct {
// Optional. Concatenated user speech segments captured during the current
// turn.
Transcript string `protobuf:"bytes,1,opt,name=transcript,proto3" json:"transcript,omitempty"`
// contains filtered or unexported fields
}Speech recognition result for the audio input.
func (*RecognitionResult) Descriptor
func (*RecognitionResult) Descriptor() ([]byte, []int)Deprecated: Use RecognitionResult.ProtoReflect.Descriptor instead.
func (*RecognitionResult) GetTranscript
func (x *RecognitionResult) GetTranscript() stringfunc (*RecognitionResult) ProtoMessage
func (*RecognitionResult) ProtoMessage()func (*RecognitionResult) ProtoReflect
func (x *RecognitionResult) ProtoReflect() protoreflect.Messagefunc (*RecognitionResult) Reset
func (x *RecognitionResult) Reset()func (*RecognitionResult) String
func (x *RecognitionResult) String() stringRedactionConfig
type RedactionConfig struct {
// Optional. If true, redaction will be applied in various logging scenarios,
// including conversation history, Cloud Logging and audio recording.
EnableRedaction bool `protobuf:"varint,1,opt,name=enable_redaction,json=enableRedaction,proto3" json:"enable_redaction,omitempty"`
// Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to
// configure detection of sensitive data types.
//
// Format:
// `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
InspectTemplate string `protobuf:"bytes,2,opt,name=inspect_template,json=inspectTemplate,proto3" json:"inspect_template,omitempty"`
// Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name
// to instruct on how to de-identify content.
//
// Format:
// `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
DeidentifyTemplate string `protobuf:"bytes,3,opt,name=deidentify_template,json=deidentifyTemplate,proto3" json:"deidentify_template,omitempty"`
// contains filtered or unexported fields
}Configuration to instruct how sensitive data should be handled.
func (*RedactionConfig) Descriptor
func (*RedactionConfig) Descriptor() ([]byte, []int)Deprecated: Use RedactionConfig.ProtoReflect.Descriptor instead.
func (*RedactionConfig) GetDeidentifyTemplate
func (x *RedactionConfig) GetDeidentifyTemplate() stringfunc (*RedactionConfig) GetEnableRedaction
func (x *RedactionConfig) GetEnableRedaction() boolfunc (*RedactionConfig) GetInspectTemplate
func (x *RedactionConfig) GetInspectTemplate() stringfunc (*RedactionConfig) ProtoMessage
func (*RedactionConfig) ProtoMessage()func (*RedactionConfig) ProtoReflect
func (x *RedactionConfig) ProtoReflect() protoreflect.Messagefunc (*RedactionConfig) Reset
func (x *RedactionConfig) Reset()func (*RedactionConfig) String
func (x *RedactionConfig) String() stringRestoreAppVersionRequest
type RestoreAppVersionRequest struct {
// Required. The resource name of the app version to restore.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.RestoreAppVersion][google.cloud.ces.v1.AgentService.RestoreAppVersion]
func (*RestoreAppVersionRequest) Descriptor
func (*RestoreAppVersionRequest) Descriptor() ([]byte, []int)Deprecated: Use RestoreAppVersionRequest.ProtoReflect.Descriptor instead.
func (*RestoreAppVersionRequest) GetName
func (x *RestoreAppVersionRequest) GetName() stringfunc (*RestoreAppVersionRequest) ProtoMessage
func (*RestoreAppVersionRequest) ProtoMessage()func (*RestoreAppVersionRequest) ProtoReflect
func (x *RestoreAppVersionRequest) ProtoReflect() protoreflect.Messagefunc (*RestoreAppVersionRequest) Reset
func (x *RestoreAppVersionRequest) Reset()func (*RestoreAppVersionRequest) String
func (x *RestoreAppVersionRequest) String() stringRestoreAppVersionResponse
type RestoreAppVersionResponse struct {
// contains filtered or unexported fields
}Response message for [AgentService.RestoreAppVersion][google.cloud.ces.v1.AgentService.RestoreAppVersion]
func (*RestoreAppVersionResponse) Descriptor
func (*RestoreAppVersionResponse) Descriptor() ([]byte, []int)Deprecated: Use RestoreAppVersionResponse.ProtoReflect.Descriptor instead.
func (*RestoreAppVersionResponse) ProtoMessage
func (*RestoreAppVersionResponse) ProtoMessage()func (*RestoreAppVersionResponse) ProtoReflect
func (x *RestoreAppVersionResponse) ProtoReflect() protoreflect.Messagefunc (*RestoreAppVersionResponse) Reset
func (x *RestoreAppVersionResponse) Reset()func (*RestoreAppVersionResponse) String
func (x *RestoreAppVersionResponse) String() stringRetrieveToolSchemaRequest
type RetrieveToolSchemaRequest struct {
// The identifier of the tool to retrieve the schema for. It could be either a
// persisted tool or a tool from a toolset.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *RetrieveToolSchemaRequest_Tool
// *RetrieveToolSchemaRequest_ToolsetTool
ToolIdentifier isRetrieveToolSchemaRequest_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// Required. The resource name of the app which the tool/toolset belongs to.
// Format: `projects/{project}/locations/{location}/apps/{app}`
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}Request message for [ToolService.RetrieveToolSchema][google.cloud.ces.v1.ToolService.RetrieveToolSchema].
func (*RetrieveToolSchemaRequest) Descriptor
func (*RetrieveToolSchemaRequest) Descriptor() ([]byte, []int)Deprecated: Use RetrieveToolSchemaRequest.ProtoReflect.Descriptor instead.
func (*RetrieveToolSchemaRequest) GetParent
func (x *RetrieveToolSchemaRequest) GetParent() stringfunc (*RetrieveToolSchemaRequest) GetTool
func (x *RetrieveToolSchemaRequest) GetTool() stringfunc (*RetrieveToolSchemaRequest) GetToolIdentifier
func (x *RetrieveToolSchemaRequest) GetToolIdentifier() isRetrieveToolSchemaRequest_ToolIdentifierfunc (*RetrieveToolSchemaRequest) GetToolsetTool
func (x *RetrieveToolSchemaRequest) GetToolsetTool() *ToolsetToolfunc (*RetrieveToolSchemaRequest) ProtoMessage
func (*RetrieveToolSchemaRequest) ProtoMessage()func (*RetrieveToolSchemaRequest) ProtoReflect
func (x *RetrieveToolSchemaRequest) ProtoReflect() protoreflect.Messagefunc (*RetrieveToolSchemaRequest) Reset
func (x *RetrieveToolSchemaRequest) Reset()func (*RetrieveToolSchemaRequest) String
func (x *RetrieveToolSchemaRequest) String() stringRetrieveToolSchemaRequest_Tool
type RetrieveToolSchemaRequest_Tool struct {
// Optional. The name of the tool to retrieve the schema for.
// Format:
// projects/{project}/locations/{location}/apps/{app}/tools/{tool}
Tool string `protobuf:"bytes,1,opt,name=tool,proto3,oneof"`
}RetrieveToolSchemaRequest_ToolsetTool
type RetrieveToolSchemaRequest_ToolsetTool struct {
// Optional. The toolset tool to retrieve the schema for. Only one tool
// should match the predicate from the toolset. Otherwise, an error will be
// returned.
ToolsetTool *ToolsetTool `protobuf:"bytes,2,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}RetrieveToolSchemaResponse
type RetrieveToolSchemaResponse struct {
// The identifier of the tool that the schema is for.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *RetrieveToolSchemaResponse_Tool
// *RetrieveToolSchemaResponse_ToolsetTool
ToolIdentifier isRetrieveToolSchemaResponse_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// The schema of the tool input parameters.
InputSchema *Schema `protobuf:"bytes,3,opt,name=input_schema,json=inputSchema,proto3" json:"input_schema,omitempty"`
// The schema of the tool output parameters.
OutputSchema *Schema `protobuf:"bytes,4,opt,name=output_schema,json=outputSchema,proto3" json:"output_schema,omitempty"`
// contains filtered or unexported fields
}Response message for [ToolService.RetrieveToolSchema][google.cloud.ces.v1.ToolService.RetrieveToolSchema].
func (*RetrieveToolSchemaResponse) Descriptor
func (*RetrieveToolSchemaResponse) Descriptor() ([]byte, []int)Deprecated: Use RetrieveToolSchemaResponse.ProtoReflect.Descriptor instead.
func (*RetrieveToolSchemaResponse) GetInputSchema
func (x *RetrieveToolSchemaResponse) GetInputSchema() *Schemafunc (*RetrieveToolSchemaResponse) GetOutputSchema
func (x *RetrieveToolSchemaResponse) GetOutputSchema() *Schemafunc (*RetrieveToolSchemaResponse) GetTool
func (x *RetrieveToolSchemaResponse) GetTool() stringfunc (*RetrieveToolSchemaResponse) GetToolIdentifier
func (x *RetrieveToolSchemaResponse) GetToolIdentifier() isRetrieveToolSchemaResponse_ToolIdentifierfunc (*RetrieveToolSchemaResponse) GetToolsetTool
func (x *RetrieveToolSchemaResponse) GetToolsetTool() *ToolsetToolfunc (*RetrieveToolSchemaResponse) ProtoMessage
func (*RetrieveToolSchemaResponse) ProtoMessage()func (*RetrieveToolSchemaResponse) ProtoReflect
func (x *RetrieveToolSchemaResponse) ProtoReflect() protoreflect.Messagefunc (*RetrieveToolSchemaResponse) Reset
func (x *RetrieveToolSchemaResponse) Reset()func (*RetrieveToolSchemaResponse) String
func (x *RetrieveToolSchemaResponse) String() stringRetrieveToolSchemaResponse_Tool
type RetrieveToolSchemaResponse_Tool struct {
// The name of the tool that the schema is for.
// Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
Tool string `protobuf:"bytes,1,opt,name=tool,proto3,oneof"`
}RetrieveToolSchemaResponse_ToolsetTool
type RetrieveToolSchemaResponse_ToolsetTool struct {
// The toolset tool that the schema is for.
ToolsetTool *ToolsetTool `protobuf:"bytes,2,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}RetrieveToolsRequest
type RetrieveToolsRequest struct {
// Required. The name of the toolset to retrieve the tools for.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Toolset string `protobuf:"bytes,1,opt,name=toolset,proto3" json:"toolset,omitempty"`
// Optional. The identifiers of the tools to retrieve from the toolset.
// If empty, all tools in the toolset will be returned.
ToolIds []string `protobuf:"bytes,3,rep,name=tool_ids,json=toolIds,proto3" json:"tool_ids,omitempty"`
// contains filtered or unexported fields
}Request message for [ToolService.RetrieveTools][google.cloud.ces.v1.ToolService.RetrieveTools].
func (*RetrieveToolsRequest) Descriptor
func (*RetrieveToolsRequest) Descriptor() ([]byte, []int)Deprecated: Use RetrieveToolsRequest.ProtoReflect.Descriptor instead.
func (*RetrieveToolsRequest) GetToolIds
func (x *RetrieveToolsRequest) GetToolIds() []stringfunc (*RetrieveToolsRequest) GetToolset
func (x *RetrieveToolsRequest) GetToolset() stringfunc (*RetrieveToolsRequest) ProtoMessage
func (*RetrieveToolsRequest) ProtoMessage()func (*RetrieveToolsRequest) ProtoReflect
func (x *RetrieveToolsRequest) ProtoReflect() protoreflect.Messagefunc (*RetrieveToolsRequest) Reset
func (x *RetrieveToolsRequest) Reset()func (*RetrieveToolsRequest) String
func (x *RetrieveToolsRequest) String() stringRetrieveToolsResponse
type RetrieveToolsResponse struct {
// The list of tools that are included in the specified toolset.
Tools []*Tool `protobuf:"bytes,1,rep,name=tools,proto3" json:"tools,omitempty"`
// contains filtered or unexported fields
}Response message for [ToolService.RetrieveTools][google.cloud.ces.v1.ToolService.RetrieveTools].
func (*RetrieveToolsResponse) Descriptor
func (*RetrieveToolsResponse) Descriptor() ([]byte, []int)Deprecated: Use RetrieveToolsResponse.ProtoReflect.Descriptor instead.
func (*RetrieveToolsResponse) GetTools
func (x *RetrieveToolsResponse) GetTools() []*Toolfunc (*RetrieveToolsResponse) ProtoMessage
func (*RetrieveToolsResponse) ProtoMessage()func (*RetrieveToolsResponse) ProtoReflect
func (x *RetrieveToolsResponse) ProtoReflect() protoreflect.Messagefunc (*RetrieveToolsResponse) Reset
func (x *RetrieveToolsResponse) Reset()func (*RetrieveToolsResponse) String
func (x *RetrieveToolsResponse) String() stringRunSessionRequest
type RunSessionRequest struct {
// Required. The configuration for the session.
Config *SessionConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
// Required. Inputs for the session.
Inputs []*SessionInput `protobuf:"bytes,3,rep,name=inputs,proto3" json:"inputs,omitempty"`
// contains filtered or unexported fields
}Request message for [SessionService.RunSession][google.cloud.ces.v1.SessionService.RunSession].
func (*RunSessionRequest) Descriptor
func (*RunSessionRequest) Descriptor() ([]byte, []int)Deprecated: Use RunSessionRequest.ProtoReflect.Descriptor instead.
func (*RunSessionRequest) GetConfig
func (x *RunSessionRequest) GetConfig() *SessionConfigfunc (*RunSessionRequest) GetInputs
func (x *RunSessionRequest) GetInputs() []*SessionInputfunc (*RunSessionRequest) ProtoMessage
func (*RunSessionRequest) ProtoMessage()func (*RunSessionRequest) ProtoReflect
func (x *RunSessionRequest) ProtoReflect() protoreflect.Messagefunc (*RunSessionRequest) Reset
func (x *RunSessionRequest) Reset()func (*RunSessionRequest) String
func (x *RunSessionRequest) String() stringRunSessionResponse
type RunSessionResponse struct {
// Outputs for the session.
Outputs []*SessionOutput `protobuf:"bytes,1,rep,name=outputs,proto3" json:"outputs,omitempty"`
// contains filtered or unexported fields
}Response message for [SessionService.RunSession][google.cloud.ces.v1.SessionService.RunSession].
func (*RunSessionResponse) Descriptor
func (*RunSessionResponse) Descriptor() ([]byte, []int)Deprecated: Use RunSessionResponse.ProtoReflect.Descriptor instead.
func (*RunSessionResponse) GetOutputs
func (x *RunSessionResponse) GetOutputs() []*SessionOutputfunc (*RunSessionResponse) ProtoMessage
func (*RunSessionResponse) ProtoMessage()func (*RunSessionResponse) ProtoReflect
func (x *RunSessionResponse) ProtoReflect() protoreflect.Messagefunc (*RunSessionResponse) Reset
func (x *RunSessionResponse) Reset()func (*RunSessionResponse) String
func (x *RunSessionResponse) String() stringSchema
type Schema struct {
// Required. The type of the data.
Type Schema_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.ces.v1.Schema_Type" json:"type,omitempty"`
// Optional. Properties of Type.OBJECT.
Properties map[string]*Schema `protobuf:"bytes,2,rep,name=properties,proto3" json:"properties,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Required properties of Type.OBJECT.
Required []string `protobuf:"bytes,3,rep,name=required,proto3" json:"required,omitempty"`
// Optional. The description of the data.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Optional. Schema of the elements of Type.ARRAY.
Items *Schema `protobuf:"bytes,5,opt,name=items,proto3" json:"items,omitempty"`
// Optional. Indicates if the value may be null.
Nullable bool `protobuf:"varint,6,opt,name=nullable,proto3" json:"nullable,omitempty"`
// Optional. Indicate the items in the array must be unique. Only applies to
// TYPE.ARRAY.
UniqueItems bool `protobuf:"varint,7,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
// Optional. Schemas of initial elements of Type.ARRAY.
PrefixItems []*Schema `protobuf:"bytes,8,rep,name=prefix_items,json=prefixItems,proto3" json:"prefix_items,omitempty"`
// Optional. Can either be a boolean or an object, controls the presence of
// additional properties.
AdditionalProperties *Schema `protobuf:"bytes,9,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
// Optional. The value should be validated against any (one or more) of the
// subschemas in the list.
AnyOf []*Schema `protobuf:"bytes,10,rep,name=any_of,json=anyOf,proto3" json:"any_of,omitempty"`
// Optional. Possible values of the element of primitive type with enum
// format. Examples:
// 1. We can define direction as :
// {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
// 2. We can define apartment number as :
// {type:INTEGER, format:enum, enum:["101", "201", "301"]}
Enum []string `protobuf:"bytes,11,rep,name=enum,proto3" json:"enum,omitempty"`
// Optional. Default value of the data.
Default *structpb.Value `protobuf:"bytes,12,opt,name=default,proto3" json:"default,omitempty"`
// Optional. Allows indirect references between schema nodes. The value should
// be a valid reference to a child of the root `defs`.
//
// For example, the following schema defines a reference to a schema node
// named "Pet":
//
// ```
// type: object
// properties:
//
// pet:
// ref: #/defs/Pet
//
// defs:
//
// Pet:
// type: object
// properties:
// name:
// type: string
//
// ```
//
// The value of the "pet" property is a reference to the schema node
// named "Pet".
// See details in
// https://json-schema.org/understanding-json-schema/structuring.
Ref string `protobuf:"bytes,13,opt,name=ref,proto3" json:"ref,omitempty"`
// Optional. A map of definitions for use by `ref`. Only allowed at the root
// of the schema.
Defs map[string]*Schema `protobuf:"bytes,14,rep,name=defs,proto3" json:"defs,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. The title of the schema.
Title string `protobuf:"bytes,15,opt,name=title,proto3" json:"title,omitempty"`
// Optional. Minimum number of the elements for Type.ARRAY.
MinItems int64 `protobuf:"varint,16,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
// Optional. Maximum number of the elements for Type.ARRAY.
MaxItems int64 `protobuf:"varint,17,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
// Optional. Minimum value for Type.INTEGER and Type.NUMBER.
Minimum *float64 `protobuf:"fixed64,18,opt,name=minimum,proto3,oneof" json:"minimum,omitempty"`
// Optional. Maximum value for Type.INTEGER and Type.NUMBER.
Maximum *float64 `protobuf:"fixed64,19,opt,name=maximum,proto3,oneof" json:"maximum,omitempty"`
// contains filtered or unexported fields
}Represents a select subset of an OpenAPI 3.0 schema object.
func (*Schema) Descriptor
Deprecated: Use Schema.ProtoReflect.Descriptor instead.
func (*Schema) GetAdditionalProperties
func (*Schema) GetAnyOf
func (*Schema) GetDefault
func (*Schema) GetDefs
func (*Schema) GetDescription
func (*Schema) GetEnum
func (*Schema) GetItems
func (*Schema) GetMaxItems
func (*Schema) GetMaximum
func (*Schema) GetMinItems
func (*Schema) GetMinimum
func (*Schema) GetNullable
func (*Schema) GetPrefixItems
func (*Schema) GetProperties
func (*Schema) GetRef
func (*Schema) GetRequired
func (*Schema) GetTitle
func (*Schema) GetType
func (x *Schema) GetType() Schema_Typefunc (*Schema) GetUniqueItems
func (*Schema) ProtoMessage
func (*Schema) ProtoMessage()func (*Schema) ProtoReflect
func (x *Schema) ProtoReflect() protoreflect.Messagefunc (*Schema) Reset
func (x *Schema) Reset()func (*Schema) String
Schema_Type
type Schema_Type int32OpenAPI data types.
Schema_TYPE_UNSPECIFIED, Schema_STRING, Schema_INTEGER, Schema_NUMBER, Schema_BOOLEAN, Schema_OBJECT, Schema_ARRAY
const (
// Type unspecified.
Schema_TYPE_UNSPECIFIED Schema_Type = 0
// String type.
Schema_STRING Schema_Type = 1
// Integer type.
Schema_INTEGER Schema_Type = 2
// Number type.
Schema_NUMBER Schema_Type = 3
// Boolean type.
Schema_BOOLEAN Schema_Type = 4
// Object type.
Schema_OBJECT Schema_Type = 5
// Array type.
Schema_ARRAY Schema_Type = 6
)func (Schema_Type) Descriptor
func (Schema_Type) Descriptor() protoreflect.EnumDescriptorfunc (Schema_Type) Enum
func (x Schema_Type) Enum() *Schema_Typefunc (Schema_Type) EnumDescriptor
func (Schema_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use Schema_Type.Descriptor instead.
func (Schema_Type) Number
func (x Schema_Type) Number() protoreflect.EnumNumberfunc (Schema_Type) String
func (x Schema_Type) String() stringfunc (Schema_Type) Type
func (Schema_Type) Type() protoreflect.EnumTypeSecuritySettings
type SecuritySettings struct {
// Identifier. The unique identifier of the security settings.
// Format: `projects/{project}/locations/{location}/securitySettings`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Endpoint control related settings.
EndpointControlPolicy *EndpointControlPolicy `protobuf:"bytes,2,opt,name=endpoint_control_policy,json=endpointControlPolicy,proto3" json:"endpoint_control_policy,omitempty"`
// Output only. Create time of the security settings.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Last update time of the security settings.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Etag of the security settings.
Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Project/Location level security settings for CES.
func (*SecuritySettings) Descriptor
func (*SecuritySettings) Descriptor() ([]byte, []int)Deprecated: Use SecuritySettings.ProtoReflect.Descriptor instead.
func (*SecuritySettings) GetCreateTime
func (x *SecuritySettings) GetCreateTime() *timestamppb.Timestampfunc (*SecuritySettings) GetEndpointControlPolicy
func (x *SecuritySettings) GetEndpointControlPolicy() *EndpointControlPolicyfunc (*SecuritySettings) GetEtag
func (x *SecuritySettings) GetEtag() stringfunc (*SecuritySettings) GetName
func (x *SecuritySettings) GetName() stringfunc (*SecuritySettings) GetUpdateTime
func (x *SecuritySettings) GetUpdateTime() *timestamppb.Timestampfunc (*SecuritySettings) ProtoMessage
func (*SecuritySettings) ProtoMessage()func (*SecuritySettings) ProtoReflect
func (x *SecuritySettings) ProtoReflect() protoreflect.Messagefunc (*SecuritySettings) Reset
func (x *SecuritySettings) Reset()func (*SecuritySettings) String
func (x *SecuritySettings) String() stringServiceAccountAuthConfig
type ServiceAccountAuthConfig struct {
// Required. The email address of the service account used for authentication.
// CES uses this service account to exchange an access token and the access
// token is then sent in the `Authorization` header of the request.
//
// The service account must have the
// `roles/iam.serviceAccountTokenCreator` role granted to the
// CES service agent
// `service-Configurations for authentication using a custom service account.
func (*ServiceAccountAuthConfig) Descriptor
func (*ServiceAccountAuthConfig) Descriptor() ([]byte, []int)Deprecated: Use ServiceAccountAuthConfig.ProtoReflect.Descriptor instead.
func (*ServiceAccountAuthConfig) GetScopes
func (x *ServiceAccountAuthConfig) GetScopes() []stringfunc (*ServiceAccountAuthConfig) GetServiceAccount
func (x *ServiceAccountAuthConfig) GetServiceAccount() stringfunc (*ServiceAccountAuthConfig) ProtoMessage
func (*ServiceAccountAuthConfig) ProtoMessage()func (*ServiceAccountAuthConfig) ProtoReflect
func (x *ServiceAccountAuthConfig) ProtoReflect() protoreflect.Messagefunc (*ServiceAccountAuthConfig) Reset
func (x *ServiceAccountAuthConfig) Reset()func (*ServiceAccountAuthConfig) String
func (x *ServiceAccountAuthConfig) String() stringServiceAgentIdTokenAuthConfig
type ServiceAgentIdTokenAuthConfig struct {
// contains filtered or unexported fields
}Configurations for authentication with ID token generated from service agent.
func (*ServiceAgentIdTokenAuthConfig) Descriptor
func (*ServiceAgentIdTokenAuthConfig) Descriptor() ([]byte, []int)Deprecated: Use ServiceAgentIdTokenAuthConfig.ProtoReflect.Descriptor instead.
func (*ServiceAgentIdTokenAuthConfig) ProtoMessage
func (*ServiceAgentIdTokenAuthConfig) ProtoMessage()func (*ServiceAgentIdTokenAuthConfig) ProtoReflect
func (x *ServiceAgentIdTokenAuthConfig) ProtoReflect() protoreflect.Messagefunc (*ServiceAgentIdTokenAuthConfig) Reset
func (x *ServiceAgentIdTokenAuthConfig) Reset()func (*ServiceAgentIdTokenAuthConfig) String
func (x *ServiceAgentIdTokenAuthConfig) String() stringServiceDirectoryConfig
type ServiceDirectoryConfig struct {
// Required. The name of [Service
// Directory](https://cloud.google.com/service-directory) service.
// Format:
// `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`.
// Location of the service directory must be the same as the location of the
// app.
Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}Configuration for tools using Service Directory.
func (*ServiceDirectoryConfig) Descriptor
func (*ServiceDirectoryConfig) Descriptor() ([]byte, []int)Deprecated: Use ServiceDirectoryConfig.ProtoReflect.Descriptor instead.
func (*ServiceDirectoryConfig) GetService
func (x *ServiceDirectoryConfig) GetService() stringfunc (*ServiceDirectoryConfig) ProtoMessage
func (*ServiceDirectoryConfig) ProtoMessage()func (*ServiceDirectoryConfig) ProtoReflect
func (x *ServiceDirectoryConfig) ProtoReflect() protoreflect.Messagefunc (*ServiceDirectoryConfig) Reset
func (x *ServiceDirectoryConfig) Reset()func (*ServiceDirectoryConfig) String
func (x *ServiceDirectoryConfig) String() stringSessionConfig
type SessionConfig struct {
// Required. The unique identifier of the session.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
Session string `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
// Optional. Configuration for processing the input audio.
InputAudioConfig *InputAudioConfig `protobuf:"bytes,2,opt,name=input_audio_config,json=inputAudioConfig,proto3" json:"input_audio_config,omitempty"`
// Optional. Configuration for generating the output audio.
OutputAudioConfig *OutputAudioConfig `protobuf:"bytes,3,opt,name=output_audio_config,json=outputAudioConfig,proto3" json:"output_audio_config,omitempty"`
// Optional. The historical context of the session, including user inputs,
// agent responses, and other messages. Typically, CES agent would manage
// session automatically so client doesn't need to explicitly populate this
// field. However, client can optionally override the historical contexts to
// force the session start from certain state.
HistoricalContexts []*Message `protobuf:"bytes,5,rep,name=historical_contexts,json=historicalContexts,proto3" json:"historical_contexts,omitempty"`
// Optional. The entry agent to handle the session. If not specified, the
// session will be handled by the [root
// agent][google.cloud.ces.v1.App.root_agent] of the app. Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
EntryAgent string `protobuf:"bytes,12,opt,name=entry_agent,json=entryAgent,proto3" json:"entry_agent,omitempty"`
// Optional. The deployment of the app to use for the session.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Deployment string `protobuf:"bytes,8,opt,name=deployment,proto3" json:"deployment,omitempty"`
// Optional. The time zone of the user. If provided, the agent will use the
// time zone for date and time related variables. Otherwise, the agent will
// use the time zone specified in the App.time_zone_settings.
//
// The format is the IANA Time Zone Database time zone, e.g.
// "America/Los_Angeles".
TimeZone string `protobuf:"bytes,11,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Optional. Whether to use tool fakes for the session.
// If this field is set, the agent will attempt use tool fakes instead of
// calling the real tools.
UseToolFakes bool `protobuf:"varint,14,opt,name=use_tool_fakes,json=useToolFakes,proto3" json:"use_tool_fakes,omitempty"`
// Optional.
// [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters)
// to send to the remote
// [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents)
// agent when the session control is transferred to the remote agent.
RemoteDialogflowQueryParameters *SessionConfig_RemoteDialogflowQueryParameters `protobuf:"bytes,15,opt,name=remote_dialogflow_query_parameters,json=remoteDialogflowQueryParameters,proto3" json:"remote_dialogflow_query_parameters,omitempty"`
// Optional. Whether to enable streaming text outputs from the model.
// By default, text outputs from the model are collected before sending to the
// client.
// NOTE: This is only supported for text (non-voice) sessions via
// [StreamRunSession][google.cloud.ces.v1.SessionService.StreamRunSession] or
// [BidiRunSession][google.cloud.ces.v1.SessionService.BidiRunSession].
EnableTextStreaming bool `protobuf:"varint,18,opt,name=enable_text_streaming,json=enableTextStreaming,proto3" json:"enable_text_streaming,omitempty"`
// contains filtered or unexported fields
}The configuration for the session.
func (*SessionConfig) Descriptor
func (*SessionConfig) Descriptor() ([]byte, []int)Deprecated: Use SessionConfig.ProtoReflect.Descriptor instead.
func (*SessionConfig) GetDeployment
func (x *SessionConfig) GetDeployment() stringfunc (*SessionConfig) GetEnableTextStreaming
func (x *SessionConfig) GetEnableTextStreaming() boolfunc (*SessionConfig) GetEntryAgent
func (x *SessionConfig) GetEntryAgent() stringfunc (*SessionConfig) GetHistoricalContexts
func (x *SessionConfig) GetHistoricalContexts() []*Messagefunc (*SessionConfig) GetInputAudioConfig
func (x *SessionConfig) GetInputAudioConfig() *InputAudioConfigfunc (*SessionConfig) GetOutputAudioConfig
func (x *SessionConfig) GetOutputAudioConfig() *OutputAudioConfigfunc (*SessionConfig) GetRemoteDialogflowQueryParameters
func (x *SessionConfig) GetRemoteDialogflowQueryParameters() *SessionConfig_RemoteDialogflowQueryParametersfunc (*SessionConfig) GetSession
func (x *SessionConfig) GetSession() stringfunc (*SessionConfig) GetTimeZone
func (x *SessionConfig) GetTimeZone() stringfunc (*SessionConfig) GetUseToolFakes
func (x *SessionConfig) GetUseToolFakes() boolfunc (*SessionConfig) ProtoMessage
func (*SessionConfig) ProtoMessage()func (*SessionConfig) ProtoReflect
func (x *SessionConfig) ProtoReflect() protoreflect.Messagefunc (*SessionConfig) Reset
func (x *SessionConfig) Reset()func (*SessionConfig) String
func (x *SessionConfig) String() stringSessionConfig_RemoteDialogflowQueryParameters
type SessionConfig_RemoteDialogflowQueryParameters struct {
// Optional. The HTTP headers to be sent as webhook_headers in
// [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
WebhookHeaders map[string]string `protobuf:"bytes,1,rep,name=webhook_headers,json=webhookHeaders,proto3" json:"webhook_headers,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. The payload to be sent in
// [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
Payload *structpb.Struct `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
// Optional. The end user metadata to be sent in
// [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters).
EndUserMetadata *structpb.Struct `protobuf:"bytes,3,opt,name=end_user_metadata,json=endUserMetadata,proto3" json:"end_user_metadata,omitempty"`
// contains filtered or unexported fields
}QueryParameters to send to the remote Dialogflow agent when the session control is transferred to the remote agent.
func (*SessionConfig_RemoteDialogflowQueryParameters) Descriptor
func (*SessionConfig_RemoteDialogflowQueryParameters) Descriptor() ([]byte, []int)Deprecated: Use SessionConfig_RemoteDialogflowQueryParameters.ProtoReflect.Descriptor instead.
func (*SessionConfig_RemoteDialogflowQueryParameters) GetEndUserMetadata
func (x *SessionConfig_RemoteDialogflowQueryParameters) GetEndUserMetadata() *structpb.Structfunc (*SessionConfig_RemoteDialogflowQueryParameters) GetPayload
func (x *SessionConfig_RemoteDialogflowQueryParameters) GetPayload() *structpb.Structfunc (*SessionConfig_RemoteDialogflowQueryParameters) GetWebhookHeaders
func (x *SessionConfig_RemoteDialogflowQueryParameters) GetWebhookHeaders() map[string]stringfunc (*SessionConfig_RemoteDialogflowQueryParameters) ProtoMessage
func (*SessionConfig_RemoteDialogflowQueryParameters) ProtoMessage()func (*SessionConfig_RemoteDialogflowQueryParameters) ProtoReflect
func (x *SessionConfig_RemoteDialogflowQueryParameters) ProtoReflect() protoreflect.Messagefunc (*SessionConfig_RemoteDialogflowQueryParameters) Reset
func (x *SessionConfig_RemoteDialogflowQueryParameters) Reset()func (*SessionConfig_RemoteDialogflowQueryParameters) String
func (x *SessionConfig_RemoteDialogflowQueryParameters) String() stringSessionInput
type SessionInput struct {
// The type of the input.
//
// Types that are valid to be assigned to InputType:
//
// *SessionInput_Text
// *SessionInput_Dtmf
// *SessionInput_Audio
// *SessionInput_ToolResponses
// *SessionInput_Image
// *SessionInput_Blob
// *SessionInput_Variables
// *SessionInput_Event
InputType isSessionInput_InputType `protobuf_oneof:"input_type"`
// Optional. A flag to indicate if the current message is a fragment of a
// larger input in the bidi streaming session.
//
// When set to `true`, the agent defers processing until it receives a
// subsequent message where `will_continue` is `false`, or until the system
// detects an endpoint in the audio input.
//
// NOTE: This field does not apply to audio and DTMF inputs, as they are
// always processed automatically based on the endpointing signal.
WillContinue bool `protobuf:"varint,8,opt,name=will_continue,json=willContinue,proto3" json:"will_continue,omitempty"`
// contains filtered or unexported fields
}Input for the session.
func (*SessionInput) Descriptor
func (*SessionInput) Descriptor() ([]byte, []int)Deprecated: Use SessionInput.ProtoReflect.Descriptor instead.
func (*SessionInput) GetAudio
func (x *SessionInput) GetAudio() []bytefunc (*SessionInput) GetBlob
func (x *SessionInput) GetBlob() *Blobfunc (*SessionInput) GetDtmf
func (x *SessionInput) GetDtmf() stringfunc (*SessionInput) GetEvent
func (x *SessionInput) GetEvent() *Eventfunc (*SessionInput) GetImage
func (x *SessionInput) GetImage() *Imagefunc (*SessionInput) GetInputType
func (x *SessionInput) GetInputType() isSessionInput_InputTypefunc (*SessionInput) GetText
func (x *SessionInput) GetText() stringfunc (*SessionInput) GetToolResponses
func (x *SessionInput) GetToolResponses() *ToolResponsesfunc (*SessionInput) GetVariables
func (x *SessionInput) GetVariables() *structpb.Structfunc (*SessionInput) GetWillContinue
func (x *SessionInput) GetWillContinue() boolfunc (*SessionInput) ProtoMessage
func (*SessionInput) ProtoMessage()func (*SessionInput) ProtoReflect
func (x *SessionInput) ProtoReflect() protoreflect.Messagefunc (*SessionInput) Reset
func (x *SessionInput) Reset()func (*SessionInput) String
func (x *SessionInput) String() stringSessionInput_Audio
type SessionInput_Audio struct {
// Optional. Audio data from the end user.
Audio []byte `protobuf:"bytes,2,opt,name=audio,proto3,oneof"`
}SessionInput_Blob
type SessionInput_Blob struct {
// Optional. Blob data from the end user.
Blob *Blob `protobuf:"bytes,7,opt,name=blob,proto3,oneof"`
}SessionInput_Dtmf
type SessionInput_Dtmf struct {
// Optional. DTMF digits from the end user.
Dtmf string `protobuf:"bytes,6,opt,name=dtmf,proto3,oneof"`
}SessionInput_Event
type SessionInput_Event struct {
// Optional. Event input.
Event *Event `protobuf:"bytes,9,opt,name=event,proto3,oneof"`
}SessionInput_Image
type SessionInput_Image struct {
// Optional. Image data from the end user.
Image *Image `protobuf:"bytes,4,opt,name=image,proto3,oneof"`
}SessionInput_Text
type SessionInput_Text struct {
// Optional. Text data from the end user.
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}SessionInput_ToolResponses
type SessionInput_ToolResponses struct {
// Optional. Execution results for the tool calls from the client.
ToolResponses *ToolResponses `protobuf:"bytes,3,opt,name=tool_responses,json=toolResponses,proto3,oneof"`
}SessionInput_Variables
type SessionInput_Variables struct {
// Optional. Contextual variables for the session, keyed by name. Only
// variables declared in the app will be used by the CES agent.
//
// Unrecognized variables will still be sent to the [Dialogflow
// agent][Agent.RemoteDialogflowAgent] as additional session parameters.
Variables *structpb.Struct `protobuf:"bytes,5,opt,name=variables,proto3,oneof"`
}SessionOutput
type SessionOutput struct {
// The type of the output.
//
// Types that are valid to be assigned to OutputType:
//
// *SessionOutput_Text
// *SessionOutput_Audio
// *SessionOutput_ToolCalls
// *SessionOutput_Citations
// *SessionOutput_GoogleSearchSuggestions
// *SessionOutput_EndSession
// *SessionOutput_Payload
OutputType isSessionOutput_OutputType `protobuf_oneof:"output_type"`
// Indicates the sequential order of conversation turn to which this output
// belongs to, starting from 1.
TurnIndex int32 `protobuf:"varint,6,opt,name=turn_index,json=turnIndex,proto3" json:"turn_index,omitempty"`
// If true, the CES agent has detected the end of the current conversation
// turn and will provide no further output for this turn.
TurnCompleted bool `protobuf:"varint,4,opt,name=turn_completed,json=turnCompleted,proto3" json:"turn_completed,omitempty"`
// Optional. Diagnostic information contains execution details during the
// processing of the input. Only populated in the last SessionOutput (with
// `turn_completed=true`) for each turn.
DiagnosticInfo *SessionOutput_DiagnosticInfo `protobuf:"bytes,7,opt,name=diagnostic_info,json=diagnosticInfo,proto3" json:"diagnostic_info,omitempty"`
// contains filtered or unexported fields
}Output for the session.
func (*SessionOutput) Descriptor
func (*SessionOutput) Descriptor() ([]byte, []int)Deprecated: Use SessionOutput.ProtoReflect.Descriptor instead.
func (*SessionOutput) GetAudio
func (x *SessionOutput) GetAudio() []bytefunc (*SessionOutput) GetCitations
func (x *SessionOutput) GetCitations() *Citationsfunc (*SessionOutput) GetDiagnosticInfo
func (x *SessionOutput) GetDiagnosticInfo() *SessionOutput_DiagnosticInfofunc (*SessionOutput) GetEndSession
func (x *SessionOutput) GetEndSession() *EndSessionfunc (*SessionOutput) GetGoogleSearchSuggestions
func (x *SessionOutput) GetGoogleSearchSuggestions() *GoogleSearchSuggestionsfunc (*SessionOutput) GetOutputType
func (x *SessionOutput) GetOutputType() isSessionOutput_OutputTypefunc (*SessionOutput) GetPayload
func (x *SessionOutput) GetPayload() *structpb.Structfunc (*SessionOutput) GetText
func (x *SessionOutput) GetText() stringfunc (*SessionOutput) GetToolCalls
func (x *SessionOutput) GetToolCalls() *ToolCallsfunc (*SessionOutput) GetTurnCompleted
func (x *SessionOutput) GetTurnCompleted() boolfunc (*SessionOutput) GetTurnIndex
func (x *SessionOutput) GetTurnIndex() int32func (*SessionOutput) ProtoMessage
func (*SessionOutput) ProtoMessage()func (*SessionOutput) ProtoReflect
func (x *SessionOutput) ProtoReflect() protoreflect.Messagefunc (*SessionOutput) Reset
func (x *SessionOutput) Reset()func (*SessionOutput) String
func (x *SessionOutput) String() stringSessionOutput_Audio
type SessionOutput_Audio struct {
// Output audio from the CES agent.
Audio []byte `protobuf:"bytes,2,opt,name=audio,proto3,oneof"`
}SessionOutput_Citations
type SessionOutput_Citations struct {
// Citations that provide the source information for the agent's generated
// text.
Citations *Citations `protobuf:"bytes,8,opt,name=citations,proto3,oneof"`
}SessionOutput_DiagnosticInfo
type SessionOutput_DiagnosticInfo struct {
// List of the messages that happened during the processing.
Messages []*Message `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
// A trace of the entire request processing, represented as a root span.
// This span can contain nested child spans for specific operations.
RootSpan *Span `protobuf:"bytes,3,opt,name=root_span,json=rootSpan,proto3" json:"root_span,omitempty"`
// contains filtered or unexported fields
}Contains execution details during the processing.
func (*SessionOutput_DiagnosticInfo) Descriptor
func (*SessionOutput_DiagnosticInfo) Descriptor() ([]byte, []int)Deprecated: Use SessionOutput_DiagnosticInfo.ProtoReflect.Descriptor instead.
func (*SessionOutput_DiagnosticInfo) GetMessages
func (x *SessionOutput_DiagnosticInfo) GetMessages() []*Messagefunc (*SessionOutput_DiagnosticInfo) GetRootSpan
func (x *SessionOutput_DiagnosticInfo) GetRootSpan() *Spanfunc (*SessionOutput_DiagnosticInfo) ProtoMessage
func (*SessionOutput_DiagnosticInfo) ProtoMessage()func (*SessionOutput_DiagnosticInfo) ProtoReflect
func (x *SessionOutput_DiagnosticInfo) ProtoReflect() protoreflect.Messagefunc (*SessionOutput_DiagnosticInfo) Reset
func (x *SessionOutput_DiagnosticInfo) Reset()func (*SessionOutput_DiagnosticInfo) String
func (x *SessionOutput_DiagnosticInfo) String() stringSessionOutput_EndSession
type SessionOutput_EndSession struct {
// Indicates the session has ended.
EndSession *EndSession `protobuf:"bytes,9,opt,name=end_session,json=endSession,proto3,oneof"`
}SessionOutput_GoogleSearchSuggestions
type SessionOutput_GoogleSearchSuggestions struct {
// The suggestions returned from Google Search as a result of invoking the
// [GoogleSearchTool][google.cloud.ces.v1.GoogleSearchTool].
GoogleSearchSuggestions *GoogleSearchSuggestions `protobuf:"bytes,10,opt,name=google_search_suggestions,json=googleSearchSuggestions,proto3,oneof"`
}SessionOutput_Payload
type SessionOutput_Payload struct {
// Custom payload with structured output from the CES agent.
Payload *structpb.Struct `protobuf:"bytes,11,opt,name=payload,proto3,oneof"`
}SessionOutput_Text
type SessionOutput_Text struct {
// Output text from the CES agent.
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}SessionOutput_ToolCalls
type SessionOutput_ToolCalls struct {
// Request for the client to execute the tools.
ToolCalls *ToolCalls `protobuf:"bytes,3,opt,name=tool_calls,json=toolCalls,proto3,oneof"`
}SessionServiceClient
type SessionServiceClient interface {
// Initiates a single-turn interaction with the CES agent within a session.
RunSession(ctx context.Context, in *RunSessionRequest, opts ...grpc.CallOption) (*RunSessionResponse, error)
// Initiates a single-turn interaction with the CES agent. Uses server-side
// streaming to deliver incremental results and partial responses as they are
// generated.
//
// By default, complete responses (e.g., messages from callbacks or full LLM
// responses) are sent to the client as soon as they are available. To enable
// streaming individual text chunks directly from the model, set
// [enable_text_streaming][google.cloud.ces.v1.SessionConfig.enable_text_streaming]
// to true.
StreamRunSession(ctx context.Context, in *RunSessionRequest, opts ...grpc.CallOption) (SessionService_StreamRunSessionClient, error)
// Establishes a bidirectional streaming connection with the CES agent.
// The agent processes continuous multimodal inputs (e.g., text, audio) and
// generates real-time multimodal output streams.
//
// --- Client Request Stream ---
// The client streams requests in the following order:
//
// 1. Initialization:
// The first message must contain
// [SessionConfig][google.cloud.ces.v1.BidiSessionClientMessage.config].
// For audio sessions, this should also include
// [InputAudioConfig][google.cloud.ces.v1.SessionConfig.input_audio_config]
// and
// [OutputAudioConfig][google.cloud.ces.v1.SessionConfig.output_audio_config]
// to define audio processing and synthesis parameters.
//
// 2. Interaction:
// Subsequent messages stream
// [SessionInput][google.cloud.ces.v1.BidiSessionClientMessage.realtime_input]
// containing real-time user input data.
//
// 3. Termination:
// The client should half-close the stream when there is no more user
// input. It should also half-close upon receiving
// [EndSession][google.cloud.ces.v1.BidiSessionServerMessage.end_session]
// or [GoAway][google.cloud.ces.v1.BidiSessionServerMessage.go_away] from
// the agent.
//
// --- Server Response Stream ---
// For each interaction turn, the agent streams messages in the following
// sequence:
//
// 1. Speech Recognition (First N messages):
// Contains
// [RecognitionResult][google.cloud.ces.v1.BidiSessionServerMessage.recognition_result]
// representing the concatenated user speech segments captured so far.
// This is only populated for audio sessions.
//
// 2. Response (Next M messages):
// Contains
// [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
// delivering the agent's response in various modalities (e.g., text,
// audio).
//
// 3. Turn Completion (Final message of the turn):
// Contains
// [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
// with [turn_completed][google.cloud.ces.v1.SessionOutput.turn_completed]
// set to true. This signals the end of the current turn and includes
// [DiagnosticInfo][google.cloud.ces.v1.SessionOutput.diagnostic_info]
// with execution details.
//
// --- Audio Best Practices ---
// 1. Streaming:
// Stream [audio data][google.cloud.ces.v1.SessionInput.audio]
// **CONTINUOUSLY**, even during silence. Recommended chunk size: 40-120ms
// (balances latency vs. efficiency).
//
// 2. Playback & Interruption:
// Play [audio responses][google.cloud.ces.v1.SessionOutput.audio] upon
// receipt. Stop playback immediately if an
// [InterruptionSignal][google.cloud.ces.v1.BidiSessionServerMessage.interruption_signal]
// is received (e.g., user barge-in or new agent response).
BidiRunSession(ctx context.Context, opts ...grpc.CallOption) (SessionService_BidiRunSessionClient, error)
}SessionServiceClient is the client API for SessionService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSessionServiceClient
func NewSessionServiceClient(cc grpc.ClientConnInterface) SessionServiceClientSessionServiceServer
type SessionServiceServer interface {
// Initiates a single-turn interaction with the CES agent within a session.
RunSession(context.Context, *RunSessionRequest) (*RunSessionResponse, error)
// Initiates a single-turn interaction with the CES agent. Uses server-side
// streaming to deliver incremental results and partial responses as they are
// generated.
//
// By default, complete responses (e.g., messages from callbacks or full LLM
// responses) are sent to the client as soon as they are available. To enable
// streaming individual text chunks directly from the model, set
// [enable_text_streaming][google.cloud.ces.v1.SessionConfig.enable_text_streaming]
// to true.
StreamRunSession(*RunSessionRequest, SessionService_StreamRunSessionServer) error
// Establishes a bidirectional streaming connection with the CES agent.
// The agent processes continuous multimodal inputs (e.g., text, audio) and
// generates real-time multimodal output streams.
//
// --- Client Request Stream ---
// The client streams requests in the following order:
//
// 1. Initialization:
// The first message must contain
// [SessionConfig][google.cloud.ces.v1.BidiSessionClientMessage.config].
// For audio sessions, this should also include
// [InputAudioConfig][google.cloud.ces.v1.SessionConfig.input_audio_config]
// and
// [OutputAudioConfig][google.cloud.ces.v1.SessionConfig.output_audio_config]
// to define audio processing and synthesis parameters.
//
// 2. Interaction:
// Subsequent messages stream
// [SessionInput][google.cloud.ces.v1.BidiSessionClientMessage.realtime_input]
// containing real-time user input data.
//
// 3. Termination:
// The client should half-close the stream when there is no more user
// input. It should also half-close upon receiving
// [EndSession][google.cloud.ces.v1.BidiSessionServerMessage.end_session]
// or [GoAway][google.cloud.ces.v1.BidiSessionServerMessage.go_away] from
// the agent.
//
// --- Server Response Stream ---
// For each interaction turn, the agent streams messages in the following
// sequence:
//
// 1. Speech Recognition (First N messages):
// Contains
// [RecognitionResult][google.cloud.ces.v1.BidiSessionServerMessage.recognition_result]
// representing the concatenated user speech segments captured so far.
// This is only populated for audio sessions.
//
// 2. Response (Next M messages):
// Contains
// [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
// delivering the agent's response in various modalities (e.g., text,
// audio).
//
// 3. Turn Completion (Final message of the turn):
// Contains
// [SessionOutput][google.cloud.ces.v1.BidiSessionServerMessage.session_output]
// with [turn_completed][google.cloud.ces.v1.SessionOutput.turn_completed]
// set to true. This signals the end of the current turn and includes
// [DiagnosticInfo][google.cloud.ces.v1.SessionOutput.diagnostic_info]
// with execution details.
//
// --- Audio Best Practices ---
// 1. Streaming:
// Stream [audio data][google.cloud.ces.v1.SessionInput.audio]
// **CONTINUOUSLY**, even during silence. Recommended chunk size: 40-120ms
// (balances latency vs. efficiency).
//
// 2. Playback & Interruption:
// Play [audio responses][google.cloud.ces.v1.SessionOutput.audio] upon
// receipt. Stop playback immediately if an
// [InterruptionSignal][google.cloud.ces.v1.BidiSessionServerMessage.interruption_signal]
// is received (e.g., user barge-in or new agent response).
BidiRunSession(SessionService_BidiRunSessionServer) error
}SessionServiceServer is the server API for SessionService service. All implementations should embed UnimplementedSessionServiceServer for forward compatibility
SessionService_BidiRunSessionClient
type SessionService_BidiRunSessionClient interface {
Send(*BidiSessionClientMessage) error
Recv() (*BidiSessionServerMessage, error)
grpc.ClientStream
}SessionService_BidiRunSessionServer
type SessionService_BidiRunSessionServer interface {
Send(*BidiSessionServerMessage) error
Recv() (*BidiSessionClientMessage, error)
grpc.ServerStream
}SessionService_StreamRunSessionClient
type SessionService_StreamRunSessionClient interface {
Recv() (*RunSessionResponse, error)
grpc.ClientStream
}SessionService_StreamRunSessionServer
type SessionService_StreamRunSessionServer interface {
Send(*RunSessionResponse) error
grpc.ServerStream
}Span
type Span struct {
// Output only. The name of the span.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The start time of the span.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The end time of the span.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. The duration of the span.
Duration *durationpb.Duration `protobuf:"bytes,6,opt,name=duration,proto3" json:"duration,omitempty"`
// Output only. Key-value attributes associated with the span.
Attributes *structpb.Struct `protobuf:"bytes,4,opt,name=attributes,proto3" json:"attributes,omitempty"`
// Output only. The child spans that are nested under this span.
ChildSpans []*Span `protobuf:"bytes,5,rep,name=child_spans,json=childSpans,proto3" json:"child_spans,omitempty"`
// contains filtered or unexported fields
}A span is a unit of work or a single operation during the request processing.
func (*Span) Descriptor
Deprecated: Use Span.ProtoReflect.Descriptor instead.
func (*Span) GetAttributes
func (*Span) GetChildSpans
func (*Span) GetDuration
func (x *Span) GetDuration() *durationpb.Durationfunc (*Span) GetEndTime
func (x *Span) GetEndTime() *timestamppb.Timestampfunc (*Span) GetName
func (*Span) GetStartTime
func (x *Span) GetStartTime() *timestamppb.Timestampfunc (*Span) ProtoMessage
func (*Span) ProtoMessage()func (*Span) ProtoReflect
func (x *Span) ProtoReflect() protoreflect.Messagefunc (*Span) Reset
func (x *Span) Reset()func (*Span) String
SynthesizeSpeechConfig
type SynthesizeSpeechConfig struct {
// Optional. The name of the voice. If not set, the service will choose a
// voice based on the other parameters such as language_code.
//
// For the list of available voices, please refer to [Supported voices and
// languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud
// Text-to-Speech.
Voice string `protobuf:"bytes,1,opt,name=voice,proto3" json:"voice,omitempty"`
// Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the
// normal native speed supported by the specific voice. 2.0 is twice as fast,
// and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will
// return an error.
SpeakingRate float64 `protobuf:"fixed64,2,opt,name=speaking_rate,json=speakingRate,proto3" json:"speaking_rate,omitempty"`
// contains filtered or unexported fields
}Configuration for how the agent response should be synthesized.
func (*SynthesizeSpeechConfig) Descriptor
func (*SynthesizeSpeechConfig) Descriptor() ([]byte, []int)Deprecated: Use SynthesizeSpeechConfig.ProtoReflect.Descriptor instead.
func (*SynthesizeSpeechConfig) GetSpeakingRate
func (x *SynthesizeSpeechConfig) GetSpeakingRate() float64func (*SynthesizeSpeechConfig) GetVoice
func (x *SynthesizeSpeechConfig) GetVoice() stringfunc (*SynthesizeSpeechConfig) ProtoMessage
func (*SynthesizeSpeechConfig) ProtoMessage()func (*SynthesizeSpeechConfig) ProtoReflect
func (x *SynthesizeSpeechConfig) ProtoReflect() protoreflect.Messagefunc (*SynthesizeSpeechConfig) Reset
func (x *SynthesizeSpeechConfig) Reset()func (*SynthesizeSpeechConfig) String
func (x *SynthesizeSpeechConfig) String() stringSystemTool
type SystemTool struct {
// Required. The name of the system tool.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The description of the system tool.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}Pre-defined system tool.
func (*SystemTool) Descriptor
func (*SystemTool) Descriptor() ([]byte, []int)Deprecated: Use SystemTool.ProtoReflect.Descriptor instead.
func (*SystemTool) GetDescription
func (x *SystemTool) GetDescription() stringfunc (*SystemTool) GetName
func (x *SystemTool) GetName() stringfunc (*SystemTool) ProtoMessage
func (*SystemTool) ProtoMessage()func (*SystemTool) ProtoReflect
func (x *SystemTool) ProtoReflect() protoreflect.Messagefunc (*SystemTool) Reset
func (x *SystemTool) Reset()func (*SystemTool) String
func (x *SystemTool) String() stringTimeZoneSettings
type TimeZoneSettings struct {
// Optional. The time zone of the app from the [time zone
// database](https://www.iana.org/time-zones), e.g., America/Los_Angeles,
// Europe/Paris.
TimeZone string `protobuf:"bytes,1,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// contains filtered or unexported fields
}TimeZone settings of the app.
func (*TimeZoneSettings) Descriptor
func (*TimeZoneSettings) Descriptor() ([]byte, []int)Deprecated: Use TimeZoneSettings.ProtoReflect.Descriptor instead.
func (*TimeZoneSettings) GetTimeZone
func (x *TimeZoneSettings) GetTimeZone() stringfunc (*TimeZoneSettings) ProtoMessage
func (*TimeZoneSettings) ProtoMessage()func (*TimeZoneSettings) ProtoReflect
func (x *TimeZoneSettings) ProtoReflect() protoreflect.Messagefunc (*TimeZoneSettings) Reset
func (x *TimeZoneSettings) Reset()func (*TimeZoneSettings) String
func (x *TimeZoneSettings) String() stringTlsConfig
type TlsConfig struct {
// Required. Specifies a list of allowed custom CA certificates for HTTPS
// verification.
CaCerts []*TlsConfig_CaCert `protobuf:"bytes,1,rep,name=ca_certs,json=caCerts,proto3" json:"ca_certs,omitempty"`
// contains filtered or unexported fields
}The TLS configuration.
func (*TlsConfig) Descriptor
Deprecated: Use TlsConfig.ProtoReflect.Descriptor instead.
func (*TlsConfig) GetCaCerts
func (x *TlsConfig) GetCaCerts() []*TlsConfig_CaCertfunc (*TlsConfig) ProtoMessage
func (*TlsConfig) ProtoMessage()func (*TlsConfig) ProtoReflect
func (x *TlsConfig) ProtoReflect() protoreflect.Messagefunc (*TlsConfig) Reset
func (x *TlsConfig) Reset()func (*TlsConfig) String
TlsConfig_CaCert
type TlsConfig_CaCert struct {
// Required. The name of the allowed custom CA certificates. This
// can be used to disambiguate the custom CA certificates.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The allowed custom CA certificates (in DER format) for
// HTTPS verification. This overrides the default SSL trust store. If this
// is empty or unspecified, CES will use Google's default trust
// store to verify certificates. N.B. Make sure the HTTPS server
// certificates are signed with "subject alt name". For instance a
// certificate can be self-signed using the following command:
//
// ```
//
// openssl x509 -req -days 200 -in example.com.csr \
// -signkey example.com.key \
// -out example.com.crt \
// -extfile <(printf "\nsubjectaltname='DNS:www.example.com' ")="" ```="" cert="">byte `protobuf:"bytes,2,opt,name=cert,proto3" json:"cert,omitempty"`
// contains filtered or unexported fields
}The CA certificate.
func (*TlsConfig_CaCert) Descriptor
func (*TlsConfig_CaCert) Descriptor() ([]byte, []int)Deprecated: Use TlsConfig_CaCert.ProtoReflect.Descriptor instead.
func (*TlsConfig_CaCert) GetCert
func (x *TlsConfig_CaCert) GetCert() []bytefunc (*TlsConfig_CaCert) GetDisplayName
func (x *TlsConfig_CaCert) GetDisplayName() stringfunc (*TlsConfig_CaCert) ProtoMessage
func (*TlsConfig_CaCert) ProtoMessage()func (*TlsConfig_CaCert) ProtoReflect
func (x *TlsConfig_CaCert) ProtoReflect() protoreflect.Messagefunc (*TlsConfig_CaCert) Reset
func (x *TlsConfig_CaCert) Reset()func (*TlsConfig_CaCert) String
func (x *TlsConfig_CaCert) String() stringTool
type Tool struct {
// The type of the tool.
//
// Types that are valid to be assigned to ToolType:
//
// *Tool_ClientFunction
// *Tool_OpenApiTool
// *Tool_GoogleSearchTool
// *Tool_ConnectorTool
// *Tool_DataStoreTool
// *Tool_PythonFunction
// *Tool_McpTool
// *Tool_FileSearchTool
// *Tool_SystemTool
// *Tool_AgentTool
// *Tool_WidgetTool
ToolType isTool_ToolType `protobuf_oneof:"tool_type"`
// Identifier. The resource name of the tool. Format:
//
// - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
// for standalone tools.
// - `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}`
// for tools retrieved from a toolset.
//
// These tools are dynamic and output-only; they cannot be referenced directly
// where a tool is expected.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The display name of the tool, derived based on the tool's
// type. For example, display name of a [ClientFunction][Tool.ClientFunction]
// is derived from its `name` property.
DisplayName string `protobuf:"bytes,13,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The execution type of the tool.
ExecutionType ExecutionType `protobuf:"varint,12,opt,name=execution_type,json=executionType,proto3,enum=google.cloud.ces.v1.ExecutionType" json:"execution_type,omitempty"`
// Output only. Timestamp when the tool was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the tool was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Etag used to ensure the object hasn't changed during a read-modify-write
// operation. If the etag is empty, the update will overwrite any concurrent
// changes.
Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
// Output only. If the tool is generated by the LLM assistant, this field
// contains a descriptive summary of the generation.
GeneratedSummary string `protobuf:"bytes,15,opt,name=generated_summary,json=generatedSummary,proto3" json:"generated_summary,omitempty"`
// Optional. Configuration for tool behavior in fake mode.
ToolFakeConfig *ToolFakeConfig `protobuf:"bytes,20,opt,name=tool_fake_config,json=toolFakeConfig,proto3" json:"tool_fake_config,omitempty"`
// contains filtered or unexported fields
}A tool represents an action that the CES agent can take to achieve certain goals.
func (*Tool) Descriptor
Deprecated: Use Tool.ProtoReflect.Descriptor instead.
func (*Tool) GetAgentTool
func (*Tool) GetClientFunction
func (x *Tool) GetClientFunction() *ClientFunctionfunc (*Tool) GetConnectorTool
func (x *Tool) GetConnectorTool() *ConnectorToolfunc (*Tool) GetCreateTime
func (x *Tool) GetCreateTime() *timestamppb.Timestampfunc (*Tool) GetDataStoreTool
func (x *Tool) GetDataStoreTool() *DataStoreToolfunc (*Tool) GetDisplayName
func (*Tool) GetEtag
func (*Tool) GetExecutionType
func (x *Tool) GetExecutionType() ExecutionTypefunc (*Tool) GetFileSearchTool
func (x *Tool) GetFileSearchTool() *FileSearchToolfunc (*Tool) GetGeneratedSummary
func (*Tool) GetGoogleSearchTool
func (x *Tool) GetGoogleSearchTool() *GoogleSearchToolfunc (*Tool) GetMcpTool
func (*Tool) GetName
func (*Tool) GetOpenApiTool
func (x *Tool) GetOpenApiTool() *OpenApiToolfunc (*Tool) GetPythonFunction
func (x *Tool) GetPythonFunction() *PythonFunctionfunc (*Tool) GetSystemTool
func (x *Tool) GetSystemTool() *SystemToolfunc (*Tool) GetToolFakeConfig
func (x *Tool) GetToolFakeConfig() *ToolFakeConfigfunc (*Tool) GetToolType
func (x *Tool) GetToolType() isTool_ToolTypefunc (*Tool) GetUpdateTime
func (x *Tool) GetUpdateTime() *timestamppb.Timestampfunc (*Tool) GetWidgetTool
func (x *Tool) GetWidgetTool() *WidgetToolfunc (*Tool) ProtoMessage
func (*Tool) ProtoMessage()func (*Tool) ProtoReflect
func (x *Tool) ProtoReflect() protoreflect.Messagefunc (*Tool) Reset
func (x *Tool) Reset()func (*Tool) String
ToolCall
type ToolCall struct {
// The identifier of the tool to execute. It could be either a persisted tool
// or a tool from a toolset.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *ToolCall_Tool
// *ToolCall_ToolsetTool
ToolIdentifier isToolCall_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// Optional. The unique identifier of the tool call. If populated, the client
// should return the execution result with the matching ID in
// [ToolResponse][google.cloud.ces.v1.ToolResponse.id].
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Output only. Display name of the tool.
DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The input parameters and values for the tool in JSON object
// format.
Args *structpb.Struct `protobuf:"bytes,3,opt,name=args,proto3" json:"args,omitempty"`
// contains filtered or unexported fields
}Request for the client or the agent to execute the specified tool.
func (*ToolCall) Descriptor
Deprecated: Use ToolCall.ProtoReflect.Descriptor instead.
func (*ToolCall) GetArgs
func (*ToolCall) GetDisplayName
func (*ToolCall) GetId
func (*ToolCall) GetTool
func (*ToolCall) GetToolIdentifier
func (x *ToolCall) GetToolIdentifier() isToolCall_ToolIdentifierfunc (*ToolCall) GetToolsetTool
func (x *ToolCall) GetToolsetTool() *ToolsetToolfunc (*ToolCall) ProtoMessage
func (*ToolCall) ProtoMessage()func (*ToolCall) ProtoReflect
func (x *ToolCall) ProtoReflect() protoreflect.Messagefunc (*ToolCall) Reset
func (x *ToolCall) Reset()func (*ToolCall) String
ToolCall_Tool
type ToolCall_Tool struct {
// Optional. The name of the tool to execute.
// Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
Tool string `protobuf:"bytes,2,opt,name=tool,proto3,oneof"`
}ToolCall_ToolsetTool
type ToolCall_ToolsetTool struct {
// Optional. The toolset tool to execute.
ToolsetTool *ToolsetTool `protobuf:"bytes,5,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}ToolCalls
type ToolCalls struct {
// Optional. The list of tool calls to execute.
ToolCalls []*ToolCall `protobuf:"bytes,1,rep,name=tool_calls,json=toolCalls,proto3" json:"tool_calls,omitempty"`
// contains filtered or unexported fields
}Request for the client to execute the tools and return the execution results before continuing the session.
func (*ToolCalls) Descriptor
Deprecated: Use ToolCalls.ProtoReflect.Descriptor instead.
func (*ToolCalls) GetToolCalls
func (*ToolCalls) ProtoMessage
func (*ToolCalls) ProtoMessage()func (*ToolCalls) ProtoReflect
func (x *ToolCalls) ProtoReflect() protoreflect.Messagefunc (*ToolCalls) Reset
func (x *ToolCalls) Reset()func (*ToolCalls) String
ToolFakeConfig
type ToolFakeConfig struct {
// The response is either static or it is provided by a python function.
//
// Types that are valid to be assigned to ToolResponse:
//
// *ToolFakeConfig_CodeBlock
ToolResponse isToolFakeConfig_ToolResponse `protobuf_oneof:"tool_response"`
// Optional. Whether the tool is using fake mode.
EnableFakeMode bool `protobuf:"varint,2,opt,name=enable_fake_mode,json=enableFakeMode,proto3" json:"enable_fake_mode,omitempty"`
// contains filtered or unexported fields
}Configuration for tool behavior in fake mode.
func (*ToolFakeConfig) Descriptor
func (*ToolFakeConfig) Descriptor() ([]byte, []int)Deprecated: Use ToolFakeConfig.ProtoReflect.Descriptor instead.
func (*ToolFakeConfig) GetCodeBlock
func (x *ToolFakeConfig) GetCodeBlock() *CodeBlockfunc (*ToolFakeConfig) GetEnableFakeMode
func (x *ToolFakeConfig) GetEnableFakeMode() boolfunc (*ToolFakeConfig) GetToolResponse
func (x *ToolFakeConfig) GetToolResponse() isToolFakeConfig_ToolResponsefunc (*ToolFakeConfig) ProtoMessage
func (*ToolFakeConfig) ProtoMessage()func (*ToolFakeConfig) ProtoReflect
func (x *ToolFakeConfig) ProtoReflect() protoreflect.Messagefunc (*ToolFakeConfig) Reset
func (x *ToolFakeConfig) Reset()func (*ToolFakeConfig) String
func (x *ToolFakeConfig) String() stringToolFakeConfig_CodeBlock
type ToolFakeConfig_CodeBlock struct {
// Optional. Code block which will be executed instead of a real tool call.
CodeBlock *CodeBlock `protobuf:"bytes,1,opt,name=code_block,json=codeBlock,proto3,oneof"`
}ToolResponse
type ToolResponse struct {
// The identifier of the tool that got executed. It could be either a
// persisted tool or a tool from a toolset.
//
// Types that are valid to be assigned to ToolIdentifier:
//
// *ToolResponse_Tool
// *ToolResponse_ToolsetTool
ToolIdentifier isToolResponse_ToolIdentifier `protobuf_oneof:"tool_identifier"`
// Optional. The matching ID of the [tool call][google.cloud.ces.v1.ToolCall]
// the response is for.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Output only. Display name of the tool.
DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. The tool execution result in JSON object format.
// Use "output" key to specify tool response and "error" key to specify
// error details (if any). If "output" and "error" keys are not specified,
// then whole "response" is treated as tool execution result.
Response *structpb.Struct `protobuf:"bytes,3,opt,name=response,proto3" json:"response,omitempty"`
// contains filtered or unexported fields
}The execution result of a specific tool from the client or the agent.
func (*ToolResponse) Descriptor
func (*ToolResponse) Descriptor() ([]byte, []int)Deprecated: Use ToolResponse.ProtoReflect.Descriptor instead.
func (*ToolResponse) GetDisplayName
func (x *ToolResponse) GetDisplayName() stringfunc (*ToolResponse) GetId
func (x *ToolResponse) GetId() stringfunc (*ToolResponse) GetResponse
func (x *ToolResponse) GetResponse() *structpb.Structfunc (*ToolResponse) GetTool
func (x *ToolResponse) GetTool() stringfunc (*ToolResponse) GetToolIdentifier
func (x *ToolResponse) GetToolIdentifier() isToolResponse_ToolIdentifierfunc (*ToolResponse) GetToolsetTool
func (x *ToolResponse) GetToolsetTool() *ToolsetToolfunc (*ToolResponse) ProtoMessage
func (*ToolResponse) ProtoMessage()func (*ToolResponse) ProtoReflect
func (x *ToolResponse) ProtoReflect() protoreflect.Messagefunc (*ToolResponse) Reset
func (x *ToolResponse) Reset()func (*ToolResponse) String
func (x *ToolResponse) String() stringToolResponse_Tool
type ToolResponse_Tool struct {
// Optional. The name of the tool to execute.
// Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
Tool string `protobuf:"bytes,2,opt,name=tool,proto3,oneof"`
}ToolResponse_ToolsetTool
type ToolResponse_ToolsetTool struct {
// Optional. The toolset tool that got executed.
ToolsetTool *ToolsetTool `protobuf:"bytes,5,opt,name=toolset_tool,json=toolsetTool,proto3,oneof"`
}ToolResponses
type ToolResponses struct {
// Optional. The list of tool execution results.
ToolResponses []*ToolResponse `protobuf:"bytes,1,rep,name=tool_responses,json=toolResponses,proto3" json:"tool_responses,omitempty"`
// contains filtered or unexported fields
}Execution results for the requested tool calls from the client.
func (*ToolResponses) Descriptor
func (*ToolResponses) Descriptor() ([]byte, []int)Deprecated: Use ToolResponses.ProtoReflect.Descriptor instead.
func (*ToolResponses) GetToolResponses
func (x *ToolResponses) GetToolResponses() []*ToolResponsefunc (*ToolResponses) ProtoMessage
func (*ToolResponses) ProtoMessage()func (*ToolResponses) ProtoReflect
func (x *ToolResponses) ProtoReflect() protoreflect.Messagefunc (*ToolResponses) Reset
func (x *ToolResponses) Reset()func (*ToolResponses) String
func (x *ToolResponses) String() stringToolServiceClient
type ToolServiceClient interface {
// Executes the given tool with the given arguments.
ExecuteTool(ctx context.Context, in *ExecuteToolRequest, opts ...grpc.CallOption) (*ExecuteToolResponse, error)
// Retrieve the schema of the given tool. The schema is computed on the fly
// for the given instance of the tool.
RetrieveToolSchema(ctx context.Context, in *RetrieveToolSchemaRequest, opts ...grpc.CallOption) (*RetrieveToolSchemaResponse, error)
// Retrieve the list of tools included in the specified toolset.
RetrieveTools(ctx context.Context, in *RetrieveToolsRequest, opts ...grpc.CallOption) (*RetrieveToolsResponse, error)
}ToolServiceClient is the client API for ToolService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewToolServiceClient
func NewToolServiceClient(cc grpc.ClientConnInterface) ToolServiceClientToolServiceServer
type ToolServiceServer interface {
// Executes the given tool with the given arguments.
ExecuteTool(context.Context, *ExecuteToolRequest) (*ExecuteToolResponse, error)
// Retrieve the schema of the given tool. The schema is computed on the fly
// for the given instance of the tool.
RetrieveToolSchema(context.Context, *RetrieveToolSchemaRequest) (*RetrieveToolSchemaResponse, error)
// Retrieve the list of tools included in the specified toolset.
RetrieveTools(context.Context, *RetrieveToolsRequest) (*RetrieveToolsResponse, error)
}ToolServiceServer is the server API for ToolService service. All implementations should embed UnimplementedToolServiceServer for forward compatibility
Tool_AgentTool
type Tool_AgentTool struct {
// Optional. The agent tool.
AgentTool *AgentTool `protobuf:"bytes,23,opt,name=agent_tool,json=agentTool,proto3,oneof"`
}Tool_ClientFunction
type Tool_ClientFunction struct {
// Optional. The client function.
ClientFunction *ClientFunction `protobuf:"bytes,2,opt,name=client_function,json=clientFunction,proto3,oneof"`
}Tool_ConnectorTool
type Tool_ConnectorTool struct {
// Optional. The Integration Connector tool.
ConnectorTool *ConnectorTool `protobuf:"bytes,8,opt,name=connector_tool,json=connectorTool,proto3,oneof"`
}Tool_DataStoreTool
type Tool_DataStoreTool struct {
// Optional. The data store tool.
DataStoreTool *DataStoreTool `protobuf:"bytes,10,opt,name=data_store_tool,json=dataStoreTool,proto3,oneof"`
}Tool_FileSearchTool
type Tool_FileSearchTool struct {
// Optional. The file search tool.
FileSearchTool *FileSearchTool `protobuf:"bytes,17,opt,name=file_search_tool,json=fileSearchTool,proto3,oneof"`
}Tool_GoogleSearchTool
type Tool_GoogleSearchTool struct {
// Optional. The google search tool.
GoogleSearchTool *GoogleSearchTool `protobuf:"bytes,5,opt,name=google_search_tool,json=googleSearchTool,proto3,oneof"`
}Tool_McpTool
type Tool_McpTool struct {
// Optional. The MCP tool. An MCP tool cannot be created or updated directly
// and is managed by the MCP toolset.
McpTool *McpTool `protobuf:"bytes,16,opt,name=mcp_tool,json=mcpTool,proto3,oneof"`
}Tool_OpenApiTool
type Tool_OpenApiTool struct {
// Optional. The open API tool.
OpenApiTool *OpenApiTool `protobuf:"bytes,3,opt,name=open_api_tool,json=openApiTool,proto3,oneof"`
}Tool_PythonFunction
type Tool_PythonFunction struct {
// Optional. The python function tool.
PythonFunction *PythonFunction `protobuf:"bytes,11,opt,name=python_function,json=pythonFunction,proto3,oneof"`
}Tool_SystemTool
type Tool_SystemTool struct {
// Optional. The system tool.
SystemTool *SystemTool `protobuf:"bytes,18,opt,name=system_tool,json=systemTool,proto3,oneof"`
}Tool_WidgetTool
type Tool_WidgetTool struct {
// Optional. The widget tool.
WidgetTool *WidgetTool `protobuf:"bytes,24,opt,name=widget_tool,json=widgetTool,proto3,oneof"`
}Toolset
type Toolset struct {
// The type of the toolset.
//
// Types that are valid to be assigned to ToolsetType:
//
// *Toolset_McpToolset
// *Toolset_OpenApiToolset
// *Toolset_ConnectorToolset
ToolsetType isToolset_ToolsetType `protobuf_oneof:"toolset_type"`
// Identifier. The unique identifier of the toolset.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The display name of the toolset. Must be unique within the same
// app.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. The description of the toolset.
Description string `protobuf:"bytes,10,opt,name=description,proto3" json:"description,omitempty"`
// Output only. Timestamp when the toolset was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Timestamp when the toolset was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// ETag used to ensure the object hasn't changed during a read-modify-write
// operation. If the etag is empty, the update will overwrite any concurrent
// changes.
Etag string `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. The execution type of the tools in the toolset.
ExecutionType ExecutionType `protobuf:"varint,9,opt,name=execution_type,json=executionType,proto3,enum=google.cloud.ces.v1.ExecutionType" json:"execution_type,omitempty"`
// Optional. Configuration for tools behavior in fake mode.
ToolFakeConfig *ToolFakeConfig `protobuf:"bytes,11,opt,name=tool_fake_config,json=toolFakeConfig,proto3" json:"tool_fake_config,omitempty"`
// contains filtered or unexported fields
}A toolset represents a group of dynamically managed tools that can be used by the agent.
func (*Toolset) Descriptor
Deprecated: Use Toolset.ProtoReflect.Descriptor instead.
func (*Toolset) GetConnectorToolset
func (x *Toolset) GetConnectorToolset() *ConnectorToolsetfunc (*Toolset) GetCreateTime
func (x *Toolset) GetCreateTime() *timestamppb.Timestampfunc (*Toolset) GetDescription
func (*Toolset) GetDisplayName
func (*Toolset) GetEtag
func (*Toolset) GetExecutionType
func (x *Toolset) GetExecutionType() ExecutionTypefunc (*Toolset) GetMcpToolset
func (x *Toolset) GetMcpToolset() *McpToolsetfunc (*Toolset) GetName
func (*Toolset) GetOpenApiToolset
func (x *Toolset) GetOpenApiToolset() *OpenApiToolsetfunc (*Toolset) GetToolFakeConfig
func (x *Toolset) GetToolFakeConfig() *ToolFakeConfigfunc (*Toolset) GetToolsetType
func (x *Toolset) GetToolsetType() isToolset_ToolsetTypefunc (*Toolset) GetUpdateTime
func (x *Toolset) GetUpdateTime() *timestamppb.Timestampfunc (*Toolset) ProtoMessage
func (*Toolset) ProtoMessage()func (*Toolset) ProtoReflect
func (x *Toolset) ProtoReflect() protoreflect.Messagefunc (*Toolset) Reset
func (x *Toolset) Reset()func (*Toolset) String
ToolsetTool
type ToolsetTool struct {
// Required. The resource name of the Toolset from which this tool is derived.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Toolset string `protobuf:"bytes,1,opt,name=toolset,proto3" json:"toolset,omitempty"`
// Optional. The tool ID to filter the tools to retrieve the schema for.
ToolId string `protobuf:"bytes,3,opt,name=tool_id,json=toolId,proto3" json:"tool_id,omitempty"`
// contains filtered or unexported fields
}A tool that is created from a toolset.
func (*ToolsetTool) Descriptor
func (*ToolsetTool) Descriptor() ([]byte, []int)Deprecated: Use ToolsetTool.ProtoReflect.Descriptor instead.
func (*ToolsetTool) GetToolId
func (x *ToolsetTool) GetToolId() stringfunc (*ToolsetTool) GetToolset
func (x *ToolsetTool) GetToolset() stringfunc (*ToolsetTool) ProtoMessage
func (*ToolsetTool) ProtoMessage()func (*ToolsetTool) ProtoReflect
func (x *ToolsetTool) ProtoReflect() protoreflect.Messagefunc (*ToolsetTool) Reset
func (x *ToolsetTool) Reset()func (*ToolsetTool) String
func (x *ToolsetTool) String() stringToolset_ConnectorToolset
type Toolset_ConnectorToolset struct {
// Optional. A toolset that generates tools from an Integration Connectors
// Connection.
ConnectorToolset *ConnectorToolset `protobuf:"bytes,8,opt,name=connector_toolset,json=connectorToolset,proto3,oneof"`
}Toolset_McpToolset
type Toolset_McpToolset struct {
// Optional. A toolset that contains a list of tools that are offered by the
// MCP server.
McpToolset *McpToolset `protobuf:"bytes,6,opt,name=mcp_toolset,json=mcpToolset,proto3,oneof"`
}Toolset_OpenApiToolset
type Toolset_OpenApiToolset struct {
// Optional. A toolset that contains a list of tools that are defined by an
// OpenAPI schema.
OpenApiToolset *OpenApiToolset `protobuf:"bytes,7,opt,name=open_api_toolset,json=openApiToolset,proto3,oneof"`
}TransferRule
type TransferRule struct {
// The rule type.
//
// Types that are valid to be assigned to RuleType:
//
// *TransferRule_DeterministicTransfer_
// *TransferRule_DisablePlannerTransfer_
RuleType isTransferRule_RuleType `protobuf_oneof:"rule_type"`
// Required. The resource name of the child agent the rule applies to.
// Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
ChildAgent string `protobuf:"bytes,1,opt,name=child_agent,json=childAgent,proto3" json:"child_agent,omitempty"`
// Required. The direction of the transfer.
Direction TransferRule_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=google.cloud.ces.v1.TransferRule_Direction" json:"direction,omitempty"`
// contains filtered or unexported fields
}Rule for transferring to a specific agent.
func (*TransferRule) Descriptor
func (*TransferRule) Descriptor() ([]byte, []int)Deprecated: Use TransferRule.ProtoReflect.Descriptor instead.
func (*TransferRule) GetChildAgent
func (x *TransferRule) GetChildAgent() stringfunc (*TransferRule) GetDeterministicTransfer
func (x *TransferRule) GetDeterministicTransfer() *TransferRule_DeterministicTransferfunc (*TransferRule) GetDirection
func (x *TransferRule) GetDirection() TransferRule_Directionfunc (*TransferRule) GetDisablePlannerTransfer
func (x *TransferRule) GetDisablePlannerTransfer() *TransferRule_DisablePlannerTransferfunc (*TransferRule) GetRuleType
func (x *TransferRule) GetRuleType() isTransferRule_RuleTypefunc (*TransferRule) ProtoMessage
func (*TransferRule) ProtoMessage()func (*TransferRule) ProtoReflect
func (x *TransferRule) ProtoReflect() protoreflect.Messagefunc (*TransferRule) Reset
func (x *TransferRule) Reset()func (*TransferRule) String
func (x *TransferRule) String() stringTransferRule_DeterministicTransfer
type TransferRule_DeterministicTransfer struct {
// The condition to evaluate.
//
// Types that are valid to be assigned to ConditionType:
//
// *TransferRule_DeterministicTransfer_ExpressionCondition
// *TransferRule_DeterministicTransfer_PythonCodeCondition
ConditionType isTransferRule_DeterministicTransfer_ConditionType `protobuf_oneof:"condition_type"`
// contains filtered or unexported fields
}Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.
func (*TransferRule_DeterministicTransfer) Descriptor
func (*TransferRule_DeterministicTransfer) Descriptor() ([]byte, []int)Deprecated: Use TransferRule_DeterministicTransfer.ProtoReflect.Descriptor instead.
func (*TransferRule_DeterministicTransfer) GetConditionType
func (x *TransferRule_DeterministicTransfer) GetConditionType() isTransferRule_DeterministicTransfer_ConditionTypefunc (*TransferRule_DeterministicTransfer) GetExpressionCondition
func (x *TransferRule_DeterministicTransfer) GetExpressionCondition() *ExpressionConditionfunc (*TransferRule_DeterministicTransfer) GetPythonCodeCondition
func (x *TransferRule_DeterministicTransfer) GetPythonCodeCondition() *PythonCodeConditionfunc (*TransferRule_DeterministicTransfer) ProtoMessage
func (*TransferRule_DeterministicTransfer) ProtoMessage()func (*TransferRule_DeterministicTransfer) ProtoReflect
func (x *TransferRule_DeterministicTransfer) ProtoReflect() protoreflect.Messagefunc (*TransferRule_DeterministicTransfer) Reset
func (x *TransferRule_DeterministicTransfer) Reset()func (*TransferRule_DeterministicTransfer) String
func (x *TransferRule_DeterministicTransfer) String() stringTransferRule_DeterministicTransfer_
type TransferRule_DeterministicTransfer_ struct {
// Optional. A rule that immediately transfers to the target agent when the
// condition is met.
DeterministicTransfer *TransferRule_DeterministicTransfer `protobuf:"bytes,3,opt,name=deterministic_transfer,json=deterministicTransfer,proto3,oneof"`
}TransferRule_DeterministicTransfer_ExpressionCondition
type TransferRule_DeterministicTransfer_ExpressionCondition struct {
// Optional. A rule that evaluates a session state condition.
// If the condition evaluates to true, the transfer occurs.
ExpressionCondition *ExpressionCondition `protobuf:"bytes,1,opt,name=expression_condition,json=expressionCondition,proto3,oneof"`
}TransferRule_DeterministicTransfer_PythonCodeCondition
type TransferRule_DeterministicTransfer_PythonCodeCondition struct {
// Optional. A rule that uses Python code block to evaluate the
// conditions. If the condition evaluates to true, the transfer occurs.
PythonCodeCondition *PythonCodeCondition `protobuf:"bytes,2,opt,name=python_code_condition,json=pythonCodeCondition,proto3,oneof"`
}TransferRule_Direction
type TransferRule_Direction int32The direction of the transfer.
TransferRule_DIRECTION_UNSPECIFIED, TransferRule_PARENT_TO_CHILD, TransferRule_CHILD_TO_PARENT
const (
// Unspecified direction.
TransferRule_DIRECTION_UNSPECIFIED TransferRule_Direction = 0
// Transfer from the parent agent to the child agent.
TransferRule_PARENT_TO_CHILD TransferRule_Direction = 1
// Transfer from the child agent to the parent agent.
TransferRule_CHILD_TO_PARENT TransferRule_Direction = 2
)func (TransferRule_Direction) Descriptor
func (TransferRule_Direction) Descriptor() protoreflect.EnumDescriptorfunc (TransferRule_Direction) Enum
func (x TransferRule_Direction) Enum() *TransferRule_Directionfunc (TransferRule_Direction) EnumDescriptor
func (TransferRule_Direction) EnumDescriptor() ([]byte, []int)Deprecated: Use TransferRule_Direction.Descriptor instead.
func (TransferRule_Direction) Number
func (x TransferRule_Direction) Number() protoreflect.EnumNumberfunc (TransferRule_Direction) String
func (x TransferRule_Direction) String() stringfunc (TransferRule_Direction) Type
func (TransferRule_Direction) Type() protoreflect.EnumTypeTransferRule_DisablePlannerTransfer
type TransferRule_DisablePlannerTransfer struct {
// Required. If the condition evaluates to true, planner will not be allowed
// to transfer to the target agent.
ExpressionCondition *ExpressionCondition `protobuf:"bytes,1,opt,name=expression_condition,json=expressionCondition,proto3" json:"expression_condition,omitempty"`
// contains filtered or unexported fields
}A rule that prevents the planner from transferring to the target agent.
func (*TransferRule_DisablePlannerTransfer) Descriptor
func (*TransferRule_DisablePlannerTransfer) Descriptor() ([]byte, []int)Deprecated: Use TransferRule_DisablePlannerTransfer.ProtoReflect.Descriptor instead.
func (*TransferRule_DisablePlannerTransfer) GetExpressionCondition
func (x *TransferRule_DisablePlannerTransfer) GetExpressionCondition() *ExpressionConditionfunc (*TransferRule_DisablePlannerTransfer) ProtoMessage
func (*TransferRule_DisablePlannerTransfer) ProtoMessage()func (*TransferRule_DisablePlannerTransfer) ProtoReflect
func (x *TransferRule_DisablePlannerTransfer) ProtoReflect() protoreflect.Messagefunc (*TransferRule_DisablePlannerTransfer) Reset
func (x *TransferRule_DisablePlannerTransfer) Reset()func (*TransferRule_DisablePlannerTransfer) String
func (x *TransferRule_DisablePlannerTransfer) String() stringTransferRule_DisablePlannerTransfer_
type TransferRule_DisablePlannerTransfer_ struct {
// Optional. Rule that prevents the planner from transferring to the target
// agent.
DisablePlannerTransfer *TransferRule_DisablePlannerTransfer `protobuf:"bytes,4,opt,name=disable_planner_transfer,json=disablePlannerTransfer,proto3,oneof"`
}TriggerAction
type TriggerAction struct {
// The action to take.
//
// Types that are valid to be assigned to Action:
//
// *TriggerAction_RespondImmediately_
// *TriggerAction_TransferAgent_
// *TriggerAction_GenerativeAnswer_
Action isTriggerAction_Action `protobuf_oneof:"action"`
// contains filtered or unexported fields
}Action that is taken when a certain precondition is met.
func (*TriggerAction) Descriptor
func (*TriggerAction) Descriptor() ([]byte, []int)Deprecated: Use TriggerAction.ProtoReflect.Descriptor instead.
func (*TriggerAction) GetAction
func (x *TriggerAction) GetAction() isTriggerAction_Actionfunc (*TriggerAction) GetGenerativeAnswer
func (x *TriggerAction) GetGenerativeAnswer() *TriggerAction_GenerativeAnswerfunc (*TriggerAction) GetRespondImmediately
func (x *TriggerAction) GetRespondImmediately() *TriggerAction_RespondImmediatelyfunc (*TriggerAction) GetTransferAgent
func (x *TriggerAction) GetTransferAgent() *TriggerAction_TransferAgentfunc (*TriggerAction) ProtoMessage
func (*TriggerAction) ProtoMessage()func (*TriggerAction) ProtoReflect
func (x *TriggerAction) ProtoReflect() protoreflect.Messagefunc (*TriggerAction) Reset
func (x *TriggerAction) Reset()func (*TriggerAction) String
func (x *TriggerAction) String() stringTriggerAction_GenerativeAnswer
type TriggerAction_GenerativeAnswer struct {
// Required. The prompt to use for the generative answer.
Prompt string `protobuf:"bytes,1,opt,name=prompt,proto3" json:"prompt,omitempty"`
// contains filtered or unexported fields
}The agent will immediately respond with a generative answer.
func (*TriggerAction_GenerativeAnswer) Descriptor
func (*TriggerAction_GenerativeAnswer) Descriptor() ([]byte, []int)Deprecated: Use TriggerAction_GenerativeAnswer.ProtoReflect.Descriptor instead.
func (*TriggerAction_GenerativeAnswer) GetPrompt
func (x *TriggerAction_GenerativeAnswer) GetPrompt() stringfunc (*TriggerAction_GenerativeAnswer) ProtoMessage
func (*TriggerAction_GenerativeAnswer) ProtoMessage()func (*TriggerAction_GenerativeAnswer) ProtoReflect
func (x *TriggerAction_GenerativeAnswer) ProtoReflect() protoreflect.Messagefunc (*TriggerAction_GenerativeAnswer) Reset
func (x *TriggerAction_GenerativeAnswer) Reset()func (*TriggerAction_GenerativeAnswer) String
func (x *TriggerAction_GenerativeAnswer) String() stringTriggerAction_GenerativeAnswer_
type TriggerAction_GenerativeAnswer_ struct {
// Optional. Respond with a generative answer.
GenerativeAnswer *TriggerAction_GenerativeAnswer `protobuf:"bytes,3,opt,name=generative_answer,json=generativeAnswer,proto3,oneof"`
}TriggerAction_RespondImmediately
type TriggerAction_RespondImmediately struct {
// Required. The canned responses for the agent to choose from. The response
// is chosen randomly.
Responses []*TriggerAction_Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
// contains filtered or unexported fields
}The agent will immediately respond with a preconfigured response.
func (*TriggerAction_RespondImmediately) Descriptor
func (*TriggerAction_RespondImmediately) Descriptor() ([]byte, []int)Deprecated: Use TriggerAction_RespondImmediately.ProtoReflect.Descriptor instead.
func (*TriggerAction_RespondImmediately) GetResponses
func (x *TriggerAction_RespondImmediately) GetResponses() []*TriggerAction_Responsefunc (*TriggerAction_RespondImmediately) ProtoMessage
func (*TriggerAction_RespondImmediately) ProtoMessage()func (*TriggerAction_RespondImmediately) ProtoReflect
func (x *TriggerAction_RespondImmediately) ProtoReflect() protoreflect.Messagefunc (*TriggerAction_RespondImmediately) Reset
func (x *TriggerAction_RespondImmediately) Reset()func (*TriggerAction_RespondImmediately) String
func (x *TriggerAction_RespondImmediately) String() stringTriggerAction_RespondImmediately_
type TriggerAction_RespondImmediately_ struct {
// Optional. Immediately respond with a preconfigured response.
RespondImmediately *TriggerAction_RespondImmediately `protobuf:"bytes,1,opt,name=respond_immediately,json=respondImmediately,proto3,oneof"`
}TriggerAction_Response
type TriggerAction_Response struct {
// Required. Text for the agent to respond with.
Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
// Optional. Whether the response is disabled. Disabled responses are not
// used by the agent.
Disabled bool `protobuf:"varint,2,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}Represents a response from the agent.
func (*TriggerAction_Response) Descriptor
func (*TriggerAction_Response) Descriptor() ([]byte, []int)Deprecated: Use TriggerAction_Response.ProtoReflect.Descriptor instead.
func (*TriggerAction_Response) GetDisabled
func (x *TriggerAction_Response) GetDisabled() boolfunc (*TriggerAction_Response) GetText
func (x *TriggerAction_Response) GetText() stringfunc (*TriggerAction_Response) ProtoMessage
func (*TriggerAction_Response) ProtoMessage()func (*TriggerAction_Response) ProtoReflect
func (x *TriggerAction_Response) ProtoReflect() protoreflect.Messagefunc (*TriggerAction_Response) Reset
func (x *TriggerAction_Response) Reset()func (*TriggerAction_Response) String
func (x *TriggerAction_Response) String() stringTriggerAction_TransferAgent
type TriggerAction_TransferAgent struct {
// Required. The name of the agent to transfer the conversation to. The
// agent must be in the same app as the current agent. Format:
// `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
Agent string `protobuf:"bytes,1,opt,name=agent,proto3" json:"agent,omitempty"`
// contains filtered or unexported fields
}The agent will transfer the conversation to a different agent.
func (*TriggerAction_TransferAgent) Descriptor
func (*TriggerAction_TransferAgent) Descriptor() ([]byte, []int)Deprecated: Use TriggerAction_TransferAgent.ProtoReflect.Descriptor instead.
func (*TriggerAction_TransferAgent) GetAgent
func (x *TriggerAction_TransferAgent) GetAgent() stringfunc (*TriggerAction_TransferAgent) ProtoMessage
func (*TriggerAction_TransferAgent) ProtoMessage()func (*TriggerAction_TransferAgent) ProtoReflect
func (x *TriggerAction_TransferAgent) ProtoReflect() protoreflect.Messagefunc (*TriggerAction_TransferAgent) Reset
func (x *TriggerAction_TransferAgent) Reset()func (*TriggerAction_TransferAgent) String
func (x *TriggerAction_TransferAgent) String() stringTriggerAction_TransferAgent_
type TriggerAction_TransferAgent_ struct {
// Optional. Transfer the conversation to a different agent.
TransferAgent *TriggerAction_TransferAgent `protobuf:"bytes,2,opt,name=transfer_agent,json=transferAgent,proto3,oneof"`
}UnimplementedAgentServiceServer
type UnimplementedAgentServiceServer struct {
}UnimplementedAgentServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedAgentServiceServer) BatchDeleteConversations
func (UnimplementedAgentServiceServer) BatchDeleteConversations(context.Context, *BatchDeleteConversationsRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) CreateAgent
func (UnimplementedAgentServiceServer) CreateAgent(context.Context, *CreateAgentRequest) (*Agent, error)func (UnimplementedAgentServiceServer) CreateApp
func (UnimplementedAgentServiceServer) CreateApp(context.Context, *CreateAppRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) CreateAppVersion
func (UnimplementedAgentServiceServer) CreateAppVersion(context.Context, *CreateAppVersionRequest) (*AppVersion, error)func (UnimplementedAgentServiceServer) CreateDeployment
func (UnimplementedAgentServiceServer) CreateDeployment(context.Context, *CreateDeploymentRequest) (*Deployment, error)func (UnimplementedAgentServiceServer) CreateExample
func (UnimplementedAgentServiceServer) CreateExample(context.Context, *CreateExampleRequest) (*Example, error)func (UnimplementedAgentServiceServer) CreateGuardrail
func (UnimplementedAgentServiceServer) CreateGuardrail(context.Context, *CreateGuardrailRequest) (*Guardrail, error)func (UnimplementedAgentServiceServer) CreateTool
func (UnimplementedAgentServiceServer) CreateTool(context.Context, *CreateToolRequest) (*Tool, error)func (UnimplementedAgentServiceServer) CreateToolset
func (UnimplementedAgentServiceServer) CreateToolset(context.Context, *CreateToolsetRequest) (*Toolset, error)func (UnimplementedAgentServiceServer) DeleteAgent
func (UnimplementedAgentServiceServer) DeleteAgent(context.Context, *DeleteAgentRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteApp
func (UnimplementedAgentServiceServer) DeleteApp(context.Context, *DeleteAppRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) DeleteAppVersion
func (UnimplementedAgentServiceServer) DeleteAppVersion(context.Context, *DeleteAppVersionRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteConversation
func (UnimplementedAgentServiceServer) DeleteConversation(context.Context, *DeleteConversationRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteDeployment
func (UnimplementedAgentServiceServer) DeleteDeployment(context.Context, *DeleteDeploymentRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteExample
func (UnimplementedAgentServiceServer) DeleteExample(context.Context, *DeleteExampleRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteGuardrail
func (UnimplementedAgentServiceServer) DeleteGuardrail(context.Context, *DeleteGuardrailRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteTool
func (UnimplementedAgentServiceServer) DeleteTool(context.Context, *DeleteToolRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) DeleteToolset
func (UnimplementedAgentServiceServer) DeleteToolset(context.Context, *DeleteToolsetRequest) (*emptypb.Empty, error)func (UnimplementedAgentServiceServer) ExportApp
func (UnimplementedAgentServiceServer) ExportApp(context.Context, *ExportAppRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) GetAgent
func (UnimplementedAgentServiceServer) GetAgent(context.Context, *GetAgentRequest) (*Agent, error)func (UnimplementedAgentServiceServer) GetApp
func (UnimplementedAgentServiceServer) GetApp(context.Context, *GetAppRequest) (*App, error)func (UnimplementedAgentServiceServer) GetAppVersion
func (UnimplementedAgentServiceServer) GetAppVersion(context.Context, *GetAppVersionRequest) (*AppVersion, error)func (UnimplementedAgentServiceServer) GetChangelog
func (UnimplementedAgentServiceServer) GetChangelog(context.Context, *GetChangelogRequest) (*Changelog, error)func (UnimplementedAgentServiceServer) GetConversation
func (UnimplementedAgentServiceServer) GetConversation(context.Context, *GetConversationRequest) (*Conversation, error)func (UnimplementedAgentServiceServer) GetDeployment
func (UnimplementedAgentServiceServer) GetDeployment(context.Context, *GetDeploymentRequest) (*Deployment, error)func (UnimplementedAgentServiceServer) GetExample
func (UnimplementedAgentServiceServer) GetExample(context.Context, *GetExampleRequest) (*Example, error)func (UnimplementedAgentServiceServer) GetGuardrail
func (UnimplementedAgentServiceServer) GetGuardrail(context.Context, *GetGuardrailRequest) (*Guardrail, error)func (UnimplementedAgentServiceServer) GetTool
func (UnimplementedAgentServiceServer) GetTool(context.Context, *GetToolRequest) (*Tool, error)func (UnimplementedAgentServiceServer) GetToolset
func (UnimplementedAgentServiceServer) GetToolset(context.Context, *GetToolsetRequest) (*Toolset, error)func (UnimplementedAgentServiceServer) ImportApp
func (UnimplementedAgentServiceServer) ImportApp(context.Context, *ImportAppRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) ListAgents
func (UnimplementedAgentServiceServer) ListAgents(context.Context, *ListAgentsRequest) (*ListAgentsResponse, error)func (UnimplementedAgentServiceServer) ListAppVersions
func (UnimplementedAgentServiceServer) ListAppVersions(context.Context, *ListAppVersionsRequest) (*ListAppVersionsResponse, error)func (UnimplementedAgentServiceServer) ListApps
func (UnimplementedAgentServiceServer) ListApps(context.Context, *ListAppsRequest) (*ListAppsResponse, error)func (UnimplementedAgentServiceServer) ListChangelogs
func (UnimplementedAgentServiceServer) ListChangelogs(context.Context, *ListChangelogsRequest) (*ListChangelogsResponse, error)func (UnimplementedAgentServiceServer) ListConversations
func (UnimplementedAgentServiceServer) ListConversations(context.Context, *ListConversationsRequest) (*ListConversationsResponse, error)func (UnimplementedAgentServiceServer) ListDeployments
func (UnimplementedAgentServiceServer) ListDeployments(context.Context, *ListDeploymentsRequest) (*ListDeploymentsResponse, error)func (UnimplementedAgentServiceServer) ListExamples
func (UnimplementedAgentServiceServer) ListExamples(context.Context, *ListExamplesRequest) (*ListExamplesResponse, error)func (UnimplementedAgentServiceServer) ListGuardrails
func (UnimplementedAgentServiceServer) ListGuardrails(context.Context, *ListGuardrailsRequest) (*ListGuardrailsResponse, error)func (UnimplementedAgentServiceServer) ListTools
func (UnimplementedAgentServiceServer) ListTools(context.Context, *ListToolsRequest) (*ListToolsResponse, error)func (UnimplementedAgentServiceServer) ListToolsets
func (UnimplementedAgentServiceServer) ListToolsets(context.Context, *ListToolsetsRequest) (*ListToolsetsResponse, error)func (UnimplementedAgentServiceServer) RestoreAppVersion
func (UnimplementedAgentServiceServer) RestoreAppVersion(context.Context, *RestoreAppVersionRequest) (*longrunningpb.Operation, error)func (UnimplementedAgentServiceServer) UpdateAgent
func (UnimplementedAgentServiceServer) UpdateAgent(context.Context, *UpdateAgentRequest) (*Agent, error)func (UnimplementedAgentServiceServer) UpdateApp
func (UnimplementedAgentServiceServer) UpdateApp(context.Context, *UpdateAppRequest) (*App, error)func (UnimplementedAgentServiceServer) UpdateDeployment
func (UnimplementedAgentServiceServer) UpdateDeployment(context.Context, *UpdateDeploymentRequest) (*Deployment, error)func (UnimplementedAgentServiceServer) UpdateExample
func (UnimplementedAgentServiceServer) UpdateExample(context.Context, *UpdateExampleRequest) (*Example, error)func (UnimplementedAgentServiceServer) UpdateGuardrail
func (UnimplementedAgentServiceServer) UpdateGuardrail(context.Context, *UpdateGuardrailRequest) (*Guardrail, error)func (UnimplementedAgentServiceServer) UpdateTool
func (UnimplementedAgentServiceServer) UpdateTool(context.Context, *UpdateToolRequest) (*Tool, error)func (UnimplementedAgentServiceServer) UpdateToolset
func (UnimplementedAgentServiceServer) UpdateToolset(context.Context, *UpdateToolsetRequest) (*Toolset, error)UnimplementedSessionServiceServer
type UnimplementedSessionServiceServer struct {
}UnimplementedSessionServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedSessionServiceServer) BidiRunSession
func (UnimplementedSessionServiceServer) BidiRunSession(SessionService_BidiRunSessionServer) errorfunc (UnimplementedSessionServiceServer) RunSession
func (UnimplementedSessionServiceServer) RunSession(context.Context, *RunSessionRequest) (*RunSessionResponse, error)func (UnimplementedSessionServiceServer) StreamRunSession
func (UnimplementedSessionServiceServer) StreamRunSession(*RunSessionRequest, SessionService_StreamRunSessionServer) errorUnimplementedToolServiceServer
type UnimplementedToolServiceServer struct {
}UnimplementedToolServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedToolServiceServer) ExecuteTool
func (UnimplementedToolServiceServer) ExecuteTool(context.Context, *ExecuteToolRequest) (*ExecuteToolResponse, error)func (UnimplementedToolServiceServer) RetrieveToolSchema
func (UnimplementedToolServiceServer) RetrieveToolSchema(context.Context, *RetrieveToolSchemaRequest) (*RetrieveToolSchemaResponse, error)func (UnimplementedToolServiceServer) RetrieveTools
func (UnimplementedToolServiceServer) RetrieveTools(context.Context, *RetrieveToolsRequest) (*RetrieveToolsResponse, error)UnimplementedWidgetServiceServer
type UnimplementedWidgetServiceServer struct {
}UnimplementedWidgetServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedWidgetServiceServer) GenerateChatToken
func (UnimplementedWidgetServiceServer) GenerateChatToken(context.Context, *GenerateChatTokenRequest) (*GenerateChatTokenResponse, error)UnsafeAgentServiceServer
type UnsafeAgentServiceServer interface {
// contains filtered or unexported methods
}UnsafeAgentServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AgentServiceServer will result in compilation errors.
UnsafeSessionServiceServer
type UnsafeSessionServiceServer interface {
// contains filtered or unexported methods
}UnsafeSessionServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SessionServiceServer will result in compilation errors.
UnsafeToolServiceServer
type UnsafeToolServiceServer interface {
// contains filtered or unexported methods
}UnsafeToolServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ToolServiceServer will result in compilation errors.
UnsafeWidgetServiceServer
type UnsafeWidgetServiceServer interface {
// contains filtered or unexported methods
}UnsafeWidgetServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WidgetServiceServer will result in compilation errors.
UpdateAgentRequest
type UpdateAgentRequest struct {
// Required. The agent to update.
Agent *Agent `protobuf:"bytes,1,opt,name=agent,proto3" json:"agent,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateAgent][google.cloud.ces.v1.AgentService.UpdateAgent].
func (*UpdateAgentRequest) Descriptor
func (*UpdateAgentRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateAgentRequest.ProtoReflect.Descriptor instead.
func (*UpdateAgentRequest) GetAgent
func (x *UpdateAgentRequest) GetAgent() *Agentfunc (*UpdateAgentRequest) GetUpdateMask
func (x *UpdateAgentRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateAgentRequest) ProtoMessage
func (*UpdateAgentRequest) ProtoMessage()func (*UpdateAgentRequest) ProtoReflect
func (x *UpdateAgentRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateAgentRequest) Reset
func (x *UpdateAgentRequest) Reset()func (*UpdateAgentRequest) String
func (x *UpdateAgentRequest) String() stringUpdateAppRequest
type UpdateAppRequest struct {
// Required. The app to update.
App *App `protobuf:"bytes,1,opt,name=app,proto3" json:"app,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateApp][google.cloud.ces.v1.AgentService.UpdateApp].
func (*UpdateAppRequest) Descriptor
func (*UpdateAppRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateAppRequest.ProtoReflect.Descriptor instead.
func (*UpdateAppRequest) GetApp
func (x *UpdateAppRequest) GetApp() *Appfunc (*UpdateAppRequest) GetUpdateMask
func (x *UpdateAppRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateAppRequest) ProtoMessage
func (*UpdateAppRequest) ProtoMessage()func (*UpdateAppRequest) ProtoReflect
func (x *UpdateAppRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateAppRequest) Reset
func (x *UpdateAppRequest) Reset()func (*UpdateAppRequest) String
func (x *UpdateAppRequest) String() stringUpdateDeploymentRequest
type UpdateDeploymentRequest struct {
// Required. The deployment to update.
Deployment *Deployment `protobuf:"bytes,1,opt,name=deployment,proto3" json:"deployment,omitempty"`
// Optional. The list of fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateDeployment][google.cloud.ces.v1.AgentService.UpdateDeployment].
func (*UpdateDeploymentRequest) Descriptor
func (*UpdateDeploymentRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateDeploymentRequest.ProtoReflect.Descriptor instead.
func (*UpdateDeploymentRequest) GetDeployment
func (x *UpdateDeploymentRequest) GetDeployment() *Deploymentfunc (*UpdateDeploymentRequest) GetUpdateMask
func (x *UpdateDeploymentRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateDeploymentRequest) ProtoMessage
func (*UpdateDeploymentRequest) ProtoMessage()func (*UpdateDeploymentRequest) ProtoReflect
func (x *UpdateDeploymentRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateDeploymentRequest) Reset
func (x *UpdateDeploymentRequest) Reset()func (*UpdateDeploymentRequest) String
func (x *UpdateDeploymentRequest) String() stringUpdateExampleRequest
type UpdateExampleRequest struct {
// Required. The example to update.
Example *Example `protobuf:"bytes,1,opt,name=example,proto3" json:"example,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateExample][google.cloud.ces.v1.AgentService.UpdateExample].
func (*UpdateExampleRequest) Descriptor
func (*UpdateExampleRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateExampleRequest.ProtoReflect.Descriptor instead.
func (*UpdateExampleRequest) GetExample
func (x *UpdateExampleRequest) GetExample() *Examplefunc (*UpdateExampleRequest) GetUpdateMask
func (x *UpdateExampleRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateExampleRequest) ProtoMessage
func (*UpdateExampleRequest) ProtoMessage()func (*UpdateExampleRequest) ProtoReflect
func (x *UpdateExampleRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateExampleRequest) Reset
func (x *UpdateExampleRequest) Reset()func (*UpdateExampleRequest) String
func (x *UpdateExampleRequest) String() stringUpdateGuardrailRequest
type UpdateGuardrailRequest struct {
// Required. The guardrail to update.
Guardrail *Guardrail `protobuf:"bytes,1,opt,name=guardrail,proto3" json:"guardrail,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateGuardrail][google.cloud.ces.v1.AgentService.UpdateGuardrail].
func (*UpdateGuardrailRequest) Descriptor
func (*UpdateGuardrailRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateGuardrailRequest.ProtoReflect.Descriptor instead.
func (*UpdateGuardrailRequest) GetGuardrail
func (x *UpdateGuardrailRequest) GetGuardrail() *Guardrailfunc (*UpdateGuardrailRequest) GetUpdateMask
func (x *UpdateGuardrailRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateGuardrailRequest) ProtoMessage
func (*UpdateGuardrailRequest) ProtoMessage()func (*UpdateGuardrailRequest) ProtoReflect
func (x *UpdateGuardrailRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateGuardrailRequest) Reset
func (x *UpdateGuardrailRequest) Reset()func (*UpdateGuardrailRequest) String
func (x *UpdateGuardrailRequest) String() stringUpdateToolRequest
type UpdateToolRequest struct {
// Required. The tool to update.
Tool *Tool `protobuf:"bytes,1,opt,name=tool,proto3" json:"tool,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateTool][google.cloud.ces.v1.AgentService.UpdateTool].
func (*UpdateToolRequest) Descriptor
func (*UpdateToolRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateToolRequest.ProtoReflect.Descriptor instead.
func (*UpdateToolRequest) GetTool
func (x *UpdateToolRequest) GetTool() *Toolfunc (*UpdateToolRequest) GetUpdateMask
func (x *UpdateToolRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateToolRequest) ProtoMessage
func (*UpdateToolRequest) ProtoMessage()func (*UpdateToolRequest) ProtoReflect
func (x *UpdateToolRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateToolRequest) Reset
func (x *UpdateToolRequest) Reset()func (*UpdateToolRequest) String
func (x *UpdateToolRequest) String() stringUpdateToolsetRequest
type UpdateToolsetRequest struct {
// Required. The toolset to update.
Toolset *Toolset `protobuf:"bytes,1,opt,name=toolset,proto3" json:"toolset,omitempty"`
// Optional. Field mask is used to control which fields get updated. If the
// mask is not present, all fields will be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request message for [AgentService.UpdateToolset][google.cloud.ces.v1.AgentService.UpdateToolset].
func (*UpdateToolsetRequest) Descriptor
func (*UpdateToolsetRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateToolsetRequest.ProtoReflect.Descriptor instead.
func (*UpdateToolsetRequest) GetToolset
func (x *UpdateToolsetRequest) GetToolset() *Toolsetfunc (*UpdateToolsetRequest) GetUpdateMask
func (x *UpdateToolsetRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateToolsetRequest) ProtoMessage
func (*UpdateToolsetRequest) ProtoMessage()func (*UpdateToolsetRequest) ProtoReflect
func (x *UpdateToolsetRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateToolsetRequest) Reset
func (x *UpdateToolsetRequest) Reset()func (*UpdateToolsetRequest) String
func (x *UpdateToolsetRequest) String() stringWebSearchQuery
type WebSearchQuery struct {
// The search query text.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// The URI to the Google Search results page for the query.
Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}Represents a single web search query and its associated search uri.
func (*WebSearchQuery) Descriptor
func (*WebSearchQuery) Descriptor() ([]byte, []int)Deprecated: Use WebSearchQuery.ProtoReflect.Descriptor instead.
func (*WebSearchQuery) GetQuery
func (x *WebSearchQuery) GetQuery() stringfunc (*WebSearchQuery) GetUri
func (x *WebSearchQuery) GetUri() stringfunc (*WebSearchQuery) ProtoMessage
func (*WebSearchQuery) ProtoMessage()func (*WebSearchQuery) ProtoReflect
func (x *WebSearchQuery) ProtoReflect() protoreflect.Messagefunc (*WebSearchQuery) Reset
func (x *WebSearchQuery) Reset()func (*WebSearchQuery) String
func (x *WebSearchQuery) String() stringWidgetServiceClient
type WidgetServiceClient interface {
// Generates a session scoped token for chat widget to authenticate with
// Session APIs.
GenerateChatToken(ctx context.Context, in *GenerateChatTokenRequest, opts ...grpc.CallOption) (*GenerateChatTokenResponse, error)
}WidgetServiceClient is the client API for WidgetService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewWidgetServiceClient
func NewWidgetServiceClient(cc grpc.ClientConnInterface) WidgetServiceClientWidgetServiceServer
type WidgetServiceServer interface {
// Generates a session scoped token for chat widget to authenticate with
// Session APIs.
GenerateChatToken(context.Context, *GenerateChatTokenRequest) (*GenerateChatTokenResponse, error)
}WidgetServiceServer is the server API for WidgetService service. All implementations should embed UnimplementedWidgetServiceServer for forward compatibility
WidgetTool
type WidgetTool struct {
// The input of the widget tool.
//
// Types that are valid to be assigned to Input:
//
// *WidgetTool_Parameters
Input isWidgetTool_Input `protobuf_oneof:"input"`
// Required. The display name of the widget tool.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The description of the widget tool.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Optional. The type of the widget tool. If not specified, the default type
// will be CUSTOMIZED.
WidgetType WidgetTool_WidgetType `protobuf:"varint,3,opt,name=widget_type,json=widgetType,proto3,enum=google.cloud.ces.v1.WidgetTool_WidgetType" json:"widget_type,omitempty"`
// Optional. Configuration for rendering the widget.
UiConfig *structpb.Struct `protobuf:"bytes,5,opt,name=ui_config,json=uiConfig,proto3" json:"ui_config,omitempty"`
// Optional. The mapping that defines how data from a source tool is mapped to
// the widget's input parameters.
DataMapping *WidgetTool_DataMapping `protobuf:"bytes,6,opt,name=data_mapping,json=dataMapping,proto3" json:"data_mapping,omitempty"`
// contains filtered or unexported fields
}Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.
func (*WidgetTool) Descriptor
func (*WidgetTool) Descriptor() ([]byte, []int)Deprecated: Use WidgetTool.ProtoReflect.Descriptor instead.
func (*WidgetTool) GetDataMapping
func (x *WidgetTool) GetDataMapping() *WidgetTool_DataMappingfunc (*WidgetTool) GetDescription
func (x *WidgetTool) GetDescription() stringfunc (*WidgetTool) GetInput
func (x *WidgetTool) GetInput() isWidgetTool_Inputfunc (*WidgetTool) GetName
func (x *WidgetTool) GetName() stringfunc (*WidgetTool) GetParameters
func (x *WidgetTool) GetParameters() *Schemafunc (*WidgetTool) GetUiConfig
func (x *WidgetTool) GetUiConfig() *structpb.Structfunc (*WidgetTool) GetWidgetType
func (x *WidgetTool) GetWidgetType() WidgetTool_WidgetTypefunc (*WidgetTool) ProtoMessage
func (*WidgetTool) ProtoMessage()func (*WidgetTool) ProtoReflect
func (x *WidgetTool) ProtoReflect() protoreflect.Messagefunc (*WidgetTool) Reset
func (x *WidgetTool) Reset()func (*WidgetTool) String
func (x *WidgetTool) String() stringWidgetTool_DataMapping
type WidgetTool_DataMapping struct {
// Optional. The resource name of the tool that provides the data for the
// widget (e.g., a search tool or a custom function). Format:
// `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
SourceToolName string `protobuf:"bytes,1,opt,name=source_tool_name,json=sourceToolName,proto3" json:"source_tool_name,omitempty"`
// Optional. A map of widget input parameter fields to the corresponding
// output fields of the source tool.
FieldMappings map[string]string `protobuf:"bytes,2,rep,name=field_mappings,json=fieldMappings,proto3" json:"field_mappings,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
// Optional. Configuration for a Python function used to transform the
// source tool's output into the widget's input format.
PythonFunction *PythonFunction `protobuf:"bytes,5,opt,name=python_function,json=pythonFunction,proto3" json:"python_function,omitempty"`
// Optional. The mode of the data mapping.
Mode WidgetTool_DataMapping_Mode `protobuf:"varint,4,opt,name=mode,proto3,enum=google.cloud.ces.v1.WidgetTool_DataMapping_Mode" json:"mode,omitempty"`
// Deprecated: Use `python_function` instead.
//
// Deprecated: Marked as deprecated in google/cloud/ces/v1/widget_tool.proto.
PythonScript string `protobuf:"bytes,3,opt,name=python_script,json=pythonScript,proto3" json:"python_script,omitempty"`
// contains filtered or unexported fields
}Configuration for mapping data from a source tool to the widget's input parameters.
func (*WidgetTool_DataMapping) Descriptor
func (*WidgetTool_DataMapping) Descriptor() ([]byte, []int)Deprecated: Use WidgetTool_DataMapping.ProtoReflect.Descriptor instead.
func (*WidgetTool_DataMapping) GetFieldMappings
func (x *WidgetTool_DataMapping) GetFieldMappings() map[string]stringfunc (*WidgetTool_DataMapping) GetMode
func (x *WidgetTool_DataMapping) GetMode() WidgetTool_DataMapping_Modefunc (*WidgetTool_DataMapping) GetPythonFunction
func (x *WidgetTool_DataMapping) GetPythonFunction() *PythonFunctionfunc (*WidgetTool_DataMapping) GetPythonScript
func (x *WidgetTool_DataMapping) GetPythonScript() stringDeprecated: Marked as deprecated in google/cloud/ces/v1/widget_tool.proto.
func (*WidgetTool_DataMapping) GetSourceToolName
func (x *WidgetTool_DataMapping) GetSourceToolName() stringfunc (*WidgetTool_DataMapping) ProtoMessage
func (*WidgetTool_DataMapping) ProtoMessage()func (*WidgetTool_DataMapping) ProtoReflect
func (x *WidgetTool_DataMapping) ProtoReflect() protoreflect.Messagefunc (*WidgetTool_DataMapping) Reset
func (x *WidgetTool_DataMapping) Reset()func (*WidgetTool_DataMapping) String
func (x *WidgetTool_DataMapping) String() stringWidgetTool_DataMapping_Mode
type WidgetTool_DataMapping_Mode int32The strategy used to map data from the source tool to the widget.
WidgetTool_DataMapping_MODE_UNSPECIFIED, WidgetTool_DataMapping_FIELD_MAPPING, WidgetTool_DataMapping_PYTHON_SCRIPT
const (
// Unspecified mode.
WidgetTool_DataMapping_MODE_UNSPECIFIED WidgetTool_DataMapping_Mode = 0
// Use the `field_mappings` map for data transformation.
WidgetTool_DataMapping_FIELD_MAPPING WidgetTool_DataMapping_Mode = 1
// Use the `python_script` for data transformation.
WidgetTool_DataMapping_PYTHON_SCRIPT WidgetTool_DataMapping_Mode = 2
)func (WidgetTool_DataMapping_Mode) Descriptor
func (WidgetTool_DataMapping_Mode) Descriptor() protoreflect.EnumDescriptorfunc (WidgetTool_DataMapping_Mode) Enum
func (x WidgetTool_DataMapping_Mode) Enum() *WidgetTool_DataMapping_Modefunc (WidgetTool_DataMapping_Mode) EnumDescriptor
func (WidgetTool_DataMapping_Mode) EnumDescriptor() ([]byte, []int)Deprecated: Use WidgetTool_DataMapping_Mode.Descriptor instead.
func (WidgetTool_DataMapping_Mode) Number
func (x WidgetTool_DataMapping_Mode) Number() protoreflect.EnumNumberfunc (WidgetTool_DataMapping_Mode) String
func (x WidgetTool_DataMapping_Mode) String() stringfunc (WidgetTool_DataMapping_Mode) Type
func (WidgetTool_DataMapping_Mode) Type() protoreflect.EnumTypeWidgetTool_Parameters
type WidgetTool_Parameters struct {
// Optional. The input parameters of the widget tool.
Parameters *Schema `protobuf:"bytes,4,opt,name=parameters,proto3,oneof"`
}WidgetTool_WidgetType
type WidgetTool_WidgetType int32All available widget types. New values may be added to this enum in the future.
WidgetTool_WIDGET_TYPE_UNSPECIFIED, WidgetTool_CUSTOM, WidgetTool_PRODUCT_CAROUSEL, WidgetTool_PRODUCT_DETAILS, WidgetTool_QUICK_ACTIONS, WidgetTool_PRODUCT_COMPARISON, WidgetTool_ADVANCED_PRODUCT_DETAILS, WidgetTool_SHORT_FORM, WidgetTool_OVERALL_SATISFACTION, WidgetTool_ORDER_SUMMARY, WidgetTool_APPOINTMENT_DETAILS, WidgetTool_APPOINTMENT_SCHEDULER, WidgetTool_CONTACT_FORM
const (
// Unspecified widget type.
WidgetTool_WIDGET_TYPE_UNSPECIFIED WidgetTool_WidgetType = 0
// Custom widget type.
WidgetTool_CUSTOM WidgetTool_WidgetType = 1
// Product carousel widget.
WidgetTool_PRODUCT_CAROUSEL WidgetTool_WidgetType = 2
// Product details widget.
WidgetTool_PRODUCT_DETAILS WidgetTool_WidgetType = 3
// Quick actions widget.
WidgetTool_QUICK_ACTIONS WidgetTool_WidgetType = 4
// Product comparison widget.
WidgetTool_PRODUCT_COMPARISON WidgetTool_WidgetType = 5
// Advanced product details widget.
WidgetTool_ADVANCED_PRODUCT_DETAILS WidgetTool_WidgetType = 6
// Short form widget.
WidgetTool_SHORT_FORM WidgetTool_WidgetType = 7
// Overall satisfaction widget.
WidgetTool_OVERALL_SATISFACTION WidgetTool_WidgetType = 8
// Order summary widget.
WidgetTool_ORDER_SUMMARY WidgetTool_WidgetType = 9
// Appointment details widget.
WidgetTool_APPOINTMENT_DETAILS WidgetTool_WidgetType = 10
// Appointment scheduler widget.
WidgetTool_APPOINTMENT_SCHEDULER WidgetTool_WidgetType = 11
// Contact form widget.
WidgetTool_CONTACT_FORM WidgetTool_WidgetType = 12
)func (WidgetTool_WidgetType) Descriptor
func (WidgetTool_WidgetType) Descriptor() protoreflect.EnumDescriptorfunc (WidgetTool_WidgetType) Enum
func (x WidgetTool_WidgetType) Enum() *WidgetTool_WidgetTypefunc (WidgetTool_WidgetType) EnumDescriptor
func (WidgetTool_WidgetType) EnumDescriptor() ([]byte, []int)Deprecated: Use WidgetTool_WidgetType.Descriptor instead.
func (WidgetTool_WidgetType) Number
func (x WidgetTool_WidgetType) Number() protoreflect.EnumNumberfunc (WidgetTool_WidgetType) String
func (x WidgetTool_WidgetType) String() stringfunc (WidgetTool_WidgetType) Type
func (WidgetTool_WidgetType) Type() protoreflect.EnumType