Package google.cloud.ces.v1

אינדקס

• ‫AgentService (ממשק)
• ‫SessionService (ממשק)
• ‫ToolService (ממשק)
• ‫WidgetService (ממשק)
• ‫Action (הודעה)
• ‫Action.EntityOperation (הודעה)
• ‫Action.EntityOperation.OperationType (enum)
• ‫Agent (הודעה)
• ‫Agent.AgentToolset (הודעה)
• ‫Agent.LlmAgent (הודעה)
• ‫Agent.RemoteA2aAgent (הודעה)
• ‫Agent.RemoteDialogflowAgent (הודעה)
• ‫AgentCard (הודעה)
• ‫AgentInterface (הודעה)
• ‫AgentRegistryDeployment (הודעה)
• ‫AgentSkill (הודעה)
• ‫AgentTool (הודעה)
• ‫AgentTransfer (הודעה)
• ‫AmbientSoundConfig (הודעה)
• ‫AmbientSoundConfig.PrebuiltAmbientNoise (enum)
• ‫ApiAuthentication (הודעה)
• ‫ApiKeyConfig (הודעה)
• ‫ApiKeyConfig.RequestLocation (enum)
• ‫App (הודעה)
• ‫App.ToolExecutionMode (enum)
• ‫App.VariableDeclaration (הודעה)
• ‫AppSnapshot (הודעה)
• ‫AppVersion (הודעה)
• ‫AudioEncoding (enum)
• ‫AudioProcessingConfig (הודעה)
• ‫AudioRecordingConfig (הודעה)
• ‫BargeInConfig (הודעה)
• ‫BatchDeleteConversationsRequest (הודעה)
• ‫BatchDeleteConversationsResponse (הודעה)
• ‫BearerTokenConfig (הודעה)
• ‫BidiSessionClientMessage (הודעה)
• ‫BidiSessionServerMessage (הודעה)
• ‫BigQueryExportSettings (הודעה)
• ‫Blob (הודעה)
• ‫Callback (הודעה)
• ‫Changelog (הודעה)
• ‫ChannelProfile (הודעה)
• ‫ChannelProfile.ChannelType (enum)
• ‫ChannelProfile.InstagramConfig (הודעה)
• ‫ChannelProfile.PersonaProperty (הודעה)
• ‫ChannelProfile.PersonaProperty.Persona (enum)
• ‫ChannelProfile.WebWidgetConfig (הודעה)
• ‫ChannelProfile.WebWidgetConfig.Modality (enum)
• ‫ChannelProfile.WebWidgetConfig.SecuritySettings (הודעה)
• ‫ChannelProfile.WebWidgetConfig.Theme (enum)
• ‫ChannelProfile.WhatsAppConfig (הודעה)
• ‫Chunk (הודעה)
• ‫Citations (הודעה)
• ‫Citations.CitedChunk (הודעה)
• ‫Citations.InlineCitation (הודעה)
• ‫ClientCertificateSettings (הודעה)
• ‫ClientFunction (הודעה)
• ‫CloudLoggingSettings (הודעה)
• ‫CodeBlock (הודעה)
• ‫ConnectorTool (הודעה)
• ‫ConnectorToolset (הודעה)
• ‫Conversation (הודעה)
• ‫Conversation.ChannelType (enum)
• ‫Conversation.InputType (enum)
• ‫Conversation.Source (enum)
• ‫Conversation.Turn (הודעה)
• ‫ConversationLoggingSettings (הודעה)
• ‫CreateAgentRequest (הודעה)
• ‫CreateAppRequest (הודעה)
• ‫CreateAppVersionRequest (הודעה)
• ‫CreateDeploymentRequest (הודעה)
• ‫CreateExampleRequest (הודעה)
• ‫CreateGuardrailRequest (הודעה)
• ‫CreateToolRequest (הודעה)
• ‫CreateToolsetRequest (הודעה)
• ‫CustomVoiceSample (הודעה)
• ‫CustomVoiceSample.VoiceInstructionMode (enum)
• ‫CustomVoiceSample.Warning (הודעה)
• ‫CustomVoiceSample.Warning.WarningType (enum)
• ‫DashboardSettings (הודעה)
• ‫DataStore (הודעה)
• ‫DataStore.ConnectorConfig (הודעה)
• ‫DataStore.DataStoreType (enum)
• ‫DataStore.DocumentProcessingMode (enum)
• ‫DataStoreSettings (הודעה)
• ‫DataStoreSettings.Engine (הודעה)
• ‫DataStoreSettings.Engine.Type (enum)
• ‫DataStoreTool (הודעה)
• ‫DataStoreTool.BoostSpec (הודעה)
• ‫DataStoreTool.BoostSpec.ConditionBoostSpec (הודעה)
• ‫DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec (הודעה)
• ‫DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType (enum)
• ‫DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint (הודעה)
• ‫DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType (enum)
• ‫DataStoreTool.BoostSpecs (הודעה)
• ‫DataStoreTool.DataStoreSource (הודעה)
• ‫DataStoreTool.EngineSource (הודעה)
• ‫DataStoreTool.FilterParameterBehavior (enum)
• ‫DataStoreTool.GroundingConfig (הודעה)
• ‫DataStoreTool.ModalityConfig (הודעה)
• ‫DataStoreTool.ModalityConfig.ModalityType (enum)
• ‫DataStoreTool.RewriterConfig (הודעה)
• ‫DataStoreTool.SnippetsConfig (הודעה)
• ‫DataStoreTool.SummarizationConfig (הודעה)
• ‫DeleteAgentRequest (הודעה)
• ‫DeleteAppRequest (הודעה)
• ‫DeleteAppVersionRequest (הודעה)
• ‫DeleteConversationRequest (הודעה)
• ‫DeleteDeploymentRequest (הודעה)
• ‫DeleteExampleRequest (הודעה)
• ‫DeleteGuardrailRequest (הודעה)
• ‫DeleteToolRequest (הודעה)
• ‫DeleteToolsetRequest (הודעה)
• ‫DeployChannelResponse (הודעה)
• ‫Deployment (הודעה)
• ‫Deployment.Modality (enum)
• ‫EndSession (הודעה)
• ‫EndUserAuthConfig (הודעה)
• ‫EndUserAuthConfig.Oauth2AuthCodeConfig (הודעה)
• ‫EndUserAuthConfig.Oauth2JwtBearerConfig (הודעה)
• ‫EndpointControlPolicy (הודעה)
• ‫EndpointControlPolicy.EnforcementScope (enum)
• ‫ErrorHandlingSettings (הודעה)
• ‫ErrorHandlingSettings.EndSessionConfig (הודעה)
• ‫ErrorHandlingSettings.ErrorHandlingStrategy (enum)
• ‫ErrorHandlingSettings.FallbackResponseConfig (הודעה)
• ‫EvaluationMetricsThresholds (הודעה)
• ‫EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds (הודעה)
• ‫EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds (הודעה)
• ‫EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds (הודעה)
• ‫EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel (enum)
• ‫EvaluationMetricsThresholds.HallucinationMetricBehavior (enum)
• ‫EvaluationMetricsThresholds.ToolMatchingSettings (הודעה)
• ‫EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior (enum)
• ‫Event (הודעה)
• ‫Example (הודעה)
• ‫ExecuteToolRequest (הודעה)
• ‫ExecuteToolResponse (הודעה)
• ‫ExecutionType (enum)
• ‫ExperimentConfig (הודעה)
• ‫ExperimentConfig.State (enum)
• ‫ExperimentConfig.VersionRelease (הודעה)
• ‫ExperimentConfig.VersionRelease.TrafficAllocation (הודעה)
• ‫ExportAppRequest (הודעה)
• ‫ExportAppRequest.ExportFormat (enum)
• ‫ExportAppResponse (הודעה)
• ‫ExpressionCondition (הודעה)
• ‫FileSearchTool (הודעה)
• ‫FileSearchTool.CorpusType (enum)
• ‫GenerateChatTokenRequest (הודעה)
• ‫GenerateChatTokenResponse (הודעה)
• ‫GetAgentRequest (הודעה)
• ‫GetAppRequest (הודעה)
• ‫GetAppVersionRequest (הודעה)
• ‫GetChangelogRequest (הודעה)
• ‫GetConversationRequest (הודעה)
• ‫GetDeploymentRequest (הודעה)
• ‫GetExampleRequest (הודעה)
• ‫GetGuardrailRequest (הודעה)
• ‫GetToolRequest (הודעה)
• ‫GetToolsetRequest (הודעה)
• ‫GoAway (הודעה)
• ‫GoogleSearchSuggestions (הודעה)
• ‫GoogleSearchTool (הודעה)
• ‫GoogleSearchTool.PromptConfig (הודעה)
• ‫Guardrail (הודעה)
• ‫Guardrail.CodeCallback (הודעה)
• ‫Guardrail.ContentFilter (הודעה)
• ‫Guardrail.ContentFilter.MatchType (enum)
• ‫Guardrail.LlmPolicy (הודעה)
• ‫Guardrail.LlmPolicy.PolicyScope (enum)
• ‫Guardrail.LlmPromptSecurity (הודעה)
• ‫Guardrail.LlmPromptSecurity.DefaultSecuritySettings (הודעה)
• ‫Guardrail.ModelSafety (הודעה)
• ‫Guardrail.ModelSafety.HarmBlockThreshold (enum)
• ‫Guardrail.ModelSafety.HarmCategory (enum)
• ‫Guardrail.ModelSafety.SafetySetting (הודעה)
• ‫Guardrail.Supervisor (הודעה)
• ‫Guardrail.Supervisor.DetectionMode (enum)
• ‫Guardrail.Supervisor.Type (enum)
• ‫Image (הודעה)
• ‫ImportAppRequest (הודעה)
• ‫ImportAppRequest.ImportOptions (הודעה)
• ‫ImportAppRequest.ImportOptions.ConflictResolutionStrategy (enum)
• ‫ImportAppResponse (הודעה)
• ‫InputAudioConfig (הודעה)
• ‫InstagramCredentials (הודעה)
• ‫InterruptionSignal (הודעה)
• ‫LanguageSettings (הודעה)
• ‫ListAgentsRequest (הודעה)
• ‫ListAgentsResponse (הודעה)
• ‫ListAppVersionsRequest (הודעה)
• ‫ListAppVersionsResponse (הודעה)
• ‫ListAppsRequest (הודעה)
• ‫ListAppsResponse (הודעה)
• ‫ListChangelogsRequest (הודעה)
• ‫ListChangelogsResponse (הודעה)
• ‫ListConversationsRequest (הודעה)
• ‫ListConversationsResponse (הודעה)
• ‫ListDeploymentsRequest (הודעה)
• ‫ListDeploymentsResponse (הודעה)
• ‫ListExamplesRequest (הודעה)
• ‫ListExamplesResponse (הודעה)
• ‫ListGuardrailsRequest (הודעה)
• ‫ListGuardrailsResponse (הודעה)
• ‫ListToolsRequest (הודעה)
• ‫ListToolsResponse (הודעה)
• ‫ListToolsetsRequest (הודעה)
• ‫ListToolsetsResponse (הודעה)
• ‫LoggingSettings (הודעה)
• ‫McpTool (הודעה)
• ‫McpTool.State (enum)
• ‫McpToolDefinition (הודעה)
• ‫McpToolOverride (הודעה)
• ‫McpToolset (הודעה)
• ‫Message (הודעה)
• ‫MetricAnalysisSettings (הודעה)
• ‫MockConfig (הודעה)
• ‫MockConfig.UnmatchedToolCallBehavior (enum)
• ‫MockedToolCall (הודעה)
• ‫ModelSettings (הודעה)
• ‫ModelSettings.ThinkingLevel (enum)
• ‫OAuthConfig (הודעה)
• ‫OAuthConfig.OauthGrantType (enum)
• ‫OpenApiTool (הודעה)
• ‫OpenApiToolset (הודעה)
• ‫OperationMetadata (הודעה)
• ‫OutputAudioConfig (הודעה)
• ‫PythonCodeCondition (הודעה)
• ‫PythonFunction (הודעה)
• ‫RecognitionResult (הודעה)
• ‫RedactionConfig (הודעה)
• ‫RemoteA2aConfig (הודעה)
• ‫RemoteAgentTool (הודעה)
• ‫RestoreAppVersionRequest (הודעה)
• ‫RestoreAppVersionResponse (הודעה)
• ‫RetrieveToolSchemaRequest (הודעה)
• ‫RetrieveToolSchemaResponse (הודעה)
• ‫RetrieveToolsRequest (הודעה)
• ‫RetrieveToolsResponse (הודעה)
• ‫RunSessionRequest (הודעה)
• ‫RunSessionResponse (הודעה)
• ‫Schema (הודעה)
• ‫Schema.Type (enum)
• ‫SecuritySettings (הודעה)
• ‫ServiceAccountAuthConfig (הודעה)
• ‫ServiceAgentIdTokenAuthConfig (הודעה)
• ‫ServiceDirectoryConfig (הודעה)
• ‫SessionConfig (הודעה)
• ‫SessionConfig.RemoteDialogflowQueryParameters (הודעה)
• ‫SessionInput (הודעה)
• ‫SessionOutput (הודעה)
• ‫SessionOutput.DiagnosticInfo (הודעה)
• ‫Span (הודעה)
• ‫SynthesizeSpeechConfig (הודעה)
• ‫SystemTool (הודעה)
• ‫TimeZoneSettings (הודעה)
• ‫TlsConfig (הודעה)
• ‫TlsConfig.CaCert (הודעה)
• ‫Tool (הודעה)
• ‫ToolCall (הודעה)
• ‫ToolCalls (הודעה)
• ‫ToolFakeConfig (הודעה)
• ‫ToolResponse (הודעה)
• ‫ToolResponses (הודעה)
• ‫Toolset (הודעה)
• ‫ToolsetTool (הודעה)
• ‫TransferRule (הודעה)
• ‫TransferRule.DeterministicTransfer (הודעה)
• ‫TransferRule.Direction (enum)
• ‫TransferRule.DisablePlannerTransfer (הודעה)
• ‫TriggerAction (הודעה)
• ‫TriggerAction.GenerativeAnswer (הודעה)
• ‫TriggerAction.RespondImmediately (הודעה)
• ‫TriggerAction.Response (הודעה)
• ‫TriggerAction.TransferAgent (הודעה)
• ‫UpdateAgentRequest (הודעה)
• ‫UpdateAppRequest (הודעה)
• ‫UpdateAppVersionRequest (הודעה)
• ‫UpdateDeploymentRequest (הודעה)
• ‫UpdateExampleRequest (הודעה)
• ‫UpdateGuardrailRequest (הודעה)
• ‫UpdateToolRequest (הודעה)
• ‫UpdateToolsetRequest (הודעה)
• ‫VpcScSettings (הודעה)
• ‫WebSearchQuery (הודעה)
• ‫WhatsAppCredentials (הודעה)
• ‫WidgetTool (הודעה)
• ‫WidgetTool.DataMapping (הודעה)
• ‫WidgetTool.DataMapping.Mode (enum)
• ‫WidgetTool.TextResponseConfig (הודעה)
• ‫WidgetTool.TextResponseConfig.Type (enum)
• ‫WidgetTool.WidgetType (enum)

AgentService

השירות שמנהל משאבים שקשורים לסוכנים ב-Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) מחיקה של קבוצת שיחות שצוינו. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.conversations.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateAgent
rpc CreateAgent(CreateAgentRequest) returns (Agent) יוצרת סוכן חדש באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.agents.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateApp
rpc CreateApp(CreateAppRequest) returns (Operation) יוצרת אפליקציה חדשה בפרויקט ובמיקום שצוינו. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.apps.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) יצירת גרסה חדשה של האפליקציה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.appVersions.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateDeployment
rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) יצירת פריסה חדשה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.deployments.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateExample
rpc CreateExample(CreateExampleRequest) returns (Example) יוצרת דוגמה חדשה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.examples.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateGuardrail
rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) יוצרת אמצעי הגנה חדש באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.guardrails.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateTool
rpc CreateTool(CreateToolRequest) returns (Tool) הפונקציה יוצרת כלי חדש באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.tools.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

CreateToolset
rpc CreateToolset(CreateToolsetRequest) returns (Toolset) יוצרת ערכת כלים חדשה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.toolsets.create מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty) מחיקת הסוכן שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.agents.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteApp
rpc DeleteApp(DeleteAppRequest) returns (Operation) מחיקת האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.apps.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteAppVersion
rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) מוחק את גרסת האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.appVersions.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteConversation
rpc DeleteConversation(DeleteConversationRequest) returns (Empty) מחיקת השיחה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.conversations.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteDeployment
rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) מחיקת הפריסה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.deployments.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteExample
rpc DeleteExample(DeleteExampleRequest) returns (Empty) מחיקת הדוגמה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.examples.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteGuardrail
rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) מחיקת אמצעי הבקרה שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.guardrails.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteTool
rpc DeleteTool(DeleteToolRequest) returns (Empty) מחיקת הכלי שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.tools.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

DeleteToolset
rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) מוחק את ערכת הכלים שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.toolsets.delete מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ExportApp
rpc ExportApp(ExportAppRequest) returns (Operation) מייצא את האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.apps.export מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent) הפעולה הזו מחזירה את הפרטים של הסוכן שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.agents.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetApp
rpc GetApp(GetAppRequest) returns (App) קבלת פרטים על האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.apps.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetAppVersion
rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) קבלת פרטים על גרסה ספציפית של אפליקציה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.appVersions.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetChangelog
rpc GetChangelog(GetChangelogRequest) returns (Changelog) מחזירה את יומן השינויים שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.changelogs.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) מקבל פרטים של השיחה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.conversations.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetDeployment
rpc GetDeployment(GetDeploymentRequest) returns (Deployment) קבלת פרטים על הפריסה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.deployments.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetExample
rpc GetExample(GetExampleRequest) returns (Example) הפעולה הזו מחזירה את הפרטים של הדוגמה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.examples.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetGuardrail
rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) הפעולה מחזירה את הפרטים של אמצעי הבקרה שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.guardrails.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetTool
rpc GetTool(GetToolRequest) returns (Tool) מקבל את הפרטים של הכלי שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.tools.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

GetToolset
rpc GetToolset(GetToolsetRequest) returns (Toolset) הפעולה מחזירה את הפרטים של ערכת הכלים שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.toolsets.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ImportApp
rpc ImportApp(ImportAppRequest) returns (Operation) מייבא את האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.apps.import מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListAgents
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) מציג רשימה של סוכנים באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.agents.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) רשימה של כל גרסאות האפליקציה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.appVersions.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListApps
rpc ListApps(ListAppsRequest) returns (ListAppsResponse) מציג רשימה של אפליקציות בפרויקט ובמיקום שצוינו. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.apps.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) מציגה את יומני השינויים של האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.changelogs.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) מציג את רשימת השיחות באפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.conversations.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) מציג את הפריסות באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.deployments.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListExamples
rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) מציג דוגמאות לרשימות באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.examples.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) רשימת אמצעי הבקרה באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.guardrails.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListTools
rpc ListTools(ListToolsRequest) returns (ListToolsResponse) רשימת הכלים באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.tools.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ListToolsets
rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) רשימת ערכות הכלים באפליקציה הנתונה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.toolsets.list מידע נוסף מופיע במאמרי העזרה בנושא IAM.

RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) משחזר את הגרסה שצוינה של האפליקציה. הפעולה הזו תיצור גרסה חדשה של האפליקציה מהטיוטה הנוכחית של האפליקציה, ותחליף את הטיוטה הנוכחית בגרסה שצוינה של האפליקציה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.appVersions.restore מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) מעדכן את הסוכן שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.agents.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateApp
rpc UpdateApp(UpdateAppRequest) returns (App) מעדכנת את האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.apps.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateAppVersion
rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion) מעדכן את גרסת האפליקציה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview.

UpdateDeployment
rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) מעדכנים את הפריסה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.deployments.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateExample
rpc UpdateExample(UpdateExampleRequest) returns (Example) מעדכן את הדוגמה שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.examples.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateGuardrail
rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) מעדכנים את אמצעי הבקרה שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.guardrails.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateTool
rpc UpdateTool(UpdateToolRequest) returns (Tool) מעדכן את הכלי שצוין. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.tools.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

UpdateToolset
rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) עדכון של ערכת הכלים שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב name: ces.toolsets.update מידע נוסף מופיע במאמרי העזרה בנושא IAM.

SessionService

שירות הסשנים מספק ממשקי API לאינטראקציה עם סוכני CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) יוצר חיבור סטרימינג דו-כיווני עם סוכן CES. הסוכן מעבד קלט רציף מכמה מודלים (למשל, טקסט, אודיו) ומפיק פלט רציף בזמן אמת מכמה מודלים. ‫--- Client Request Stream --- הלקוח מעביר בקשות בסטרימינג בסדר הבא: הפעלה: ההודעה הראשונה חייבת להכיל את התו SessionConfig. בסשנים של אודיו, צריך לכלול גם את InputAudioConfig ו-OutputAudioConfig כדי להגדיר פרמטרים של עיבוד וסינתזה של אודיו. אינטראקציה: הודעות עוקבות מועברות בסטרימינג SessionInput עם נתוני קלט של משתמשים בזמן אמת. סיום: הלקוח צריך לסגור חצי מהשידור כשאין יותר קלט של משתמשים. החלון צריך להיסגר חלקית כשמתקבלת הודעה EndSession או GoAway מהסוכן. ‫--- Server Response Stream --- לכל תור באינטראקציה, הסוכן מעביר הודעות בסטרימינג ברצף הבא: זיהוי דיבור (הודעות ראשונות): מכיל את הערך RecognitionResult שמייצג את פלחי הדיבור של המשתמשים שצולמו עד עכשיו. השדה הזה מאוכלס רק בסשנים של אודיו. תשובה (הודעות M הבאות): מכילה SessionOutput את התשובה של הסוכן במגוון פורמטים (למשל, טקסט, אודיו). השלמת תור (ההודעה האחרונה בתור): מכילה את SessionOutput עם הערך true ב-turn_completed. הסימן הזה מציין את סוף התור הנוכחי וכולל את DiagnosticInfo עם פרטי הביצוע. --- Audio Best Practices --- 1. סטרימינג: הפעלת סטרימינג של audio data באופן רציף, גם במהלך שתיקה. גודל מומלץ של חלקי נתונים: 40-120ms (איזון בין זמן האחזור ליעילות). הפעלה והפרעה: הפעלת audio responses עם קבלת ההודעה. ההפעלה תיפסק באופן מיידי אם מתקבלת הודעה מסוג InterruptionSignal (למשל, אם המשתמש מתפרץ לשיחה או אם מתקבלת תגובה מסוכן חדש). היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב session: ces.sessions.bidiRunSession מידע נוסף מופיע במאמרי העזרה בנושא IAM.

RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse) הפעולה יוזמת אינטראקציה חד-שלבית עם סוכן CES במהלך סשן. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב session: ces.sessions.runSession מידע נוסף מופיע במאמרי העזרה בנושא IAM.

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) מפעיל אינטראקציה חד-פעמית עם נציג CES. משתמש בהזרמה בצד השרת כדי לספק תוצאות מצטברות ותשובות חלקיות בזמן שהן נוצרות. כברירת מחדל, תשובות מלאות (למשל, הודעות משיחות חוזרות או תשובות מלאות של LLM) נשלחות ללקוח ברגע שהן זמינות. כדי להפעיל סטרימינג של נתחי טקסט בודדים ישירות מהמודל, מגדירים את enable_text_streaming לערך true. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב session: ces.sessions.runSession מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ToolService

שירות הכלים מספק ממשקי API לאינטראקציה עם כלי CES.

ExecuteTool
rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) מפעיל את הכלי שצוין עם הארגומנטים שצוינו. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.tools.execute מידע נוסף מופיע במאמרי העזרה בנושא IAM.

RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) אחזור הסכימה של הכלי הנתון. הסכימה מחושבת תוך כדי תנועה עבור המופע הנתון של הכלי. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב parent: ces.tools.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) אחזור רשימת הכלים שנכללים בערכת הכלים שצוינה. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview. הרשאות IAM נדרשת הרשאת IAM הבאה במשאב toolset: ces.toolsets.get מידע נוסף מופיע במאמרי העזרה בנושא IAM.

WidgetService

מספקת ממשקי API לווידג'טים כדי ליצור אינטראקציה עם ממשקי API של CES.

GenerateChatToken
rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) יוצר אסימון בהיקף סשן לווידג'ט של הצ'אט לצורך אימות באמצעות ממשקי Session API. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces ניתן למצוא מידע נוסף כאן: Authentication Overview.

פעולה

הגדרה של פעולה לשימוש בכלי. הערה: יכול להיות שמדובר בפעולה או בתפעול. פרטים נוספים זמינים בכתובת https://cloud.google.com/integration-connectors/docs/entities-operation-action.

שדות
input_fields[]	string זה שינוי אופציונלי. שדות של ישויות שמשמשים כקלט לפעולה. אם לא מציינים שדות, המערכת משתמשת בכל השדות של הישות.
output_fields[]	string זה שינוי אופציונלי. שדות הישות שיוחזרו מהפעולה. אם לא מציינים שדות, כל השדות של הישות יוחזרו.
שדה איחוד action_spec. מפרט של פעולה להגדרה לשימוש בכלי. הערך action_spec יכול להיות רק אחד מהבאים:
connection_action_id	string מזהה של פעולת חיבור שהכלי ישתמש בה.
entity_operation	Action.EntityOperation הגדרת פעולת ישות לשימוש בכלי.

EntityOperation

מפרט של פעולות CRUD בישות.

שדות
entity_id	string חובה. המזהה של הישות.
operation	Action.EntityOperation.OperationType חובה. הפעולה שרוצים לבצע בישות.

OperationType

הפעולה שצריך לבצע ביישות.

טיפוסים בני מנייה (enum)
OPERATION_TYPE_UNSPECIFIED	לא צוין סוג הפעולה. לא תקין, יצירה או עדכון של ConnectorTool ייכשלו.
LIST	פעולה ברשימה.
GET	פעולת קבלת נתונים.
CREATE	פעולת יצירה.
UPDATE	פעולת עדכון.
DELETE	פעולת מחיקה.

סוכן

סוכן פועל כאבן הבניין הבסיסית שמספקת הוראות למודל שפה גדול (LLM) לביצוע משימות ספציפיות.

שדות
name	string מזהה. המזהה הייחודי של הסוכן. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string חובה. השם המוצג של הנציג.
description	string זה שינוי אופציונלי. תיאור של הסוכן שכתוב בצורה שקריאה לאנשים.
model_settings	ModelSettings זה שינוי אופציונלי. הגדרות למודל ה-LLM.
instruction	string זה שינוי אופציונלי. הוראות למודל שפה גדול (LLM) שמנחות את התנהגות הסוכן.
tools[]	string זה שינוי אופציונלי. רשימת הכלים הזמינים לסוכן. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string זה שינוי אופציונלי. רשימה של סוכני ילדים בעץ הסוכנים. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback זה שינוי אופציונלי. פונקציות ה-callback שיופעלו לפני שהסוכן יקבל שיחה. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
after_agent_callbacks[]	Callback זה שינוי אופציונלי. הפונקציות להפעלה חוזרת שיופעלו אחרי שהסוכן יקרא. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
before_model_callbacks[]	Callback זה שינוי אופציונלי. הקריאות החוזרות (callback) לביצוע לפני הקריאה למודל. אם יש כמה קריאות למודל, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
after_model_callbacks[]	Callback זה שינוי אופציונלי. פונקציות ה-callback שיבוצעו אחרי הפעלת המודל. אם יש כמה קריאות למודל, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
before_tool_callbacks[]	Callback זה שינוי אופציונלי. הפונקציות לקריאה חוזרת שיופעלו לפני הפעלת הכלי. אם יש כמה הפעלות של כלים, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
after_tool_callbacks[]	Callback זה שינוי אופציונלי. הקריאות החוזרות (callbacks) לביצוע אחרי הפעלת הכלי. אם יש כמה הפעלות של כלים, הקריאה החוזרת תופעל כמה פעמים. הקריאות החוזרות שצוינו מופעלות ברצף, בדיוק לפי הסדר שבו הן מופיעות ברשימה. אם פונקציית קריאה חוזרת מחזירה תגובה שהוחלפה, הביצוע נפסק וכל פונקציות הקריאה החוזרת שנותרו מדלגות.
create_time	Timestamp פלט בלבד. חותמת זמן של מועד יצירת הסוכן.
update_time	Timestamp פלט בלבד. חותמת זמן של מועד העדכון האחרון של הסוכן.
guardrails[]	string זה שינוי אופציונלי. רשימת אמצעי הבקרה של הסוכן. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
toolsets[]	Agent.AgentToolset זה שינוי אופציונלי. רשימה של ערכות כלים לסוכן.
generated_summary	string פלט בלבד. אם הסוכן נוצר על ידי עוזר ה-LLM, השדה הזה מכיל סיכום תיאורי של הדור.
transfer_rules[]	TransferRule זה שינוי אופציונלי. כללי העברה של סוכנים. אם כמה כללים תואמים, המערכת תשתמש בכלל הראשון ברשימה.
validation_errors[]	string פלט בלבד. שגיאות או הגדרות שגויות בסוכן שעלולות להשפיע על איכות הסוכן.
שדה איחוד agent_type. סוג הסוכן. הערך agent_type יכול להיות רק אחד מהבאים:
llm_agent	Agent.LlmAgent זה שינוי אופציונלי. סוג הסוכן שמוגדר כברירת מחדל.
remote_dialogflow_agent	Agent.RemoteDialogflowAgent זה שינוי אופציונלי. סוכן Dialogflow מרוחק שישמש להפעלת הסוכן. אם השדה הזה מוגדר, המערכת תתעלם מכל שאר המאפיינים ברמת הסוכן. הערה: אם סוכן Dialogflow נמצא בפרויקט אחר מהאפליקציה, צריך להעניק את ההרשאה roles/dialogflow.client לסוכן שירות ה-CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
remote_a2a_agent	Agent.RemoteA2aAgent זה שינוי אופציונלי. סוכן A2A מרוחק שישמש להרצת הסוכן.

AgentToolset

ערכת כלים עם מבחר מהכלים שלה.

שדות
toolset	string חובה. שם המשאב של ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string זה שינוי אופציונלי. מזהי הכלים שמשמשים לסינון ערכת הכלים.

LlmAgent

בסוג הזה אין שדות.

סוג ברירת המחדל של הסוכן. הסוכן משתמש בהוראות ובפונקציות קריאה חוזרת שצוינו בסוכן כדי לבצע את המשימה באמצעות מודל שפה גדול.

RemoteA2aAgent

הסוכן שיעביר את ההרצה לסוכן מרוחק של A2A.

שדות
a2a_config	RemoteA2aConfig חובה. הגדרת החיבור של A2A.

RemoteDialogflowAgent

הסוכן שיעביר את הביצוע לסוכן מרוחק של Dialogflow CX. סוכן Dialogflow יעבד את השאילתות הבאות של המשתמש עד שהסשן או התהליך יסתיימו, והשליטה תועבר חזרה לסוכן ה-CES הראשי.

שדות
agent	string חובה. שם משאב הסוכן ב-Dialogflow. פורמט: projects/{project}/locations/{location}/agents/{agent}
flow_id	string זה שינוי אופציונלי. מזהה ה-Flow של ה-Flow בסוכן Dialogflow.
environment_id	string זה שינוי אופציונלי. מזהה הסביבה של נציג Dialogflow שישמש להרצת הנציג. אם לא מציינים סביבה, המערכת משתמשת בסביבת הטיוטה.
input_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות משתני האפליקציה לשמות פרמטרים של סשן Dialogflow שיישלחו לסוכן Dialogflow כקלט.
output_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות הפרמטרים של סשן Dialogflow לשמות המשתנים של האפליקציה שיוחזרו לסוכן CES אחרי שהביצוע של סוכן Dialogflow יסתיים.
respect_response_interruption_settings	bool זה שינוי אופציונלי. הגדרה שקובעת אם להתחשב בהגדרות ההפרעה ברמת ההודעה שהוגדרו בסוכן Dialogflow. אם הערך הוא false: כל הודעות התגובה מהנציג ב-Dialogflow פועלות לפי הגדרות ההתפרצות ברמת האפליקציה. אם הערך הוא true: אפשר יהיה לקטוע רק הודעות תגובה עם allow_playback_interruption שמוגדר כ-true. כל ההודעות האחרות יפעלו לפי הגדרות ההשתלטות ברמת האפליקציה.
language_code_variable	string זה שינוי אופציונלי. השם של המשתנה שמכיל את קוד השפה שבו יש להשתמש בסשן Dialogflow. אם לא תציינו קוד שפה, המערכת תשתמש בקוד השפה שמוגדר כברירת מחדל לסוכן Dialogflow.

AgentCard

בכרטיס הסוכן מוצג מידע חשוב על סוכן מרוחק. זוהי גרסה מצומצמת של AgentCard שמוגדרת בפרוטוקול A2A‏ https://a2a-protocol.org/dev/specification/#441-agentcard

שדות
name	string חובה. שם הסוכן בפורמט שקריא לבני אדם.
description	string חובה. תיאור של תחום הפעולה או מרחב הפתרונות של הסוכן.
supported_interfaces[]	AgentInterface חובה. רשימה מסודרת של ממשקים נתמכים. עדיף להשתמש ברשומה הראשונה.
version	string חובה. גרסת הסוכן.
skills[]	AgentSkill חובה. סקילים מייצגים יחידת יכולת שהסוכן יכול לבצע. יכול להיות שההגדרה הזו תהיה קצת מופשטת, אבל היא מייצגת קבוצה ממוקדת יותר של פעולות שהסוכן צפוי להצליח בהן.

AgentInterface

ההגדרה הזו מציינת שילוב של כתובת יעד, אמצעי תחבורה וגרסת פרוטוקול לאינטראקציה עם הסוכן. כך סוכנים יכולים לחשוף את אותה פונקציונליות באמצעות מנגנונים שונים של קישור פרוטוקולים.

שדות
url	string חובה. כתובת ה-URL שבה הממשק הזה זמין. זו צריכה להיות כתובת URL תקינה מסוג HTTPS בייצור. דוגמה: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocol_binding	string חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זהו מחרוזת של טופס פתוח, שאפשר להרחיב אותה בקלות לקישורי פרוטוקול אחרים. הסכימות המרכזיות שנתמכות באופן רשמי הן JSONRPC, ‏ GRPC ו-HTTP+JSON.
tenant	string מזהה הדייר שישמש בבקשה כשמתקשרים לסוכן.
protocol_version	string חובה. הגרסה של פרוטוקול A2A שהממשק הזה חושף. מומלץ להשתמש בגרסה המשנית הנתמכת האחרונה לכל גרסה ראשית. דוגמאות: ‎0.3,‏ ‎1.0

AgentRegistryDeployment

ההגדרה והסטטוס של הפריסה של Agent Registry.

שדות
agent_registry_service_name	string זה שינוי אופציונלי. פלט בלבד. שם המשאב של שירות Agent Registry שנפרס. פורמט: projects/{project}/locations/{location}/services/{service}

AgentSkill

מייצג יכולת או פונקציה ייחודית שהנציג יכול לבצע.

שדות
id	string חובה. מזהה ייחודי של מיומנות הסוכן.
name	string חובה. שם המיומנות שקריא לבני אדם.
description	string חובה. תיאור מפורט של המיומנות.
tags[]	string חובה. קבוצה של מילות מפתח שמתארות את היכולות של המיומנות.
examples[]	string דוגמאות לפרומפטים או לתרחישים שהמיומנות הזו יכולה לטפל בהם.
input_modes[]	string קבוצת סוגי המדיה הנתמכים לקלט במיומנות הזו, שמשמשת במקום ברירות המחדל של הסוכן.
output_modes[]	string קבוצת סוגי המדיה הנתמכים של הפלט במיומנות הזו, שדוחפת את ברירות המחדל של הסוכן.

AgentTool

מייצג כלי שמאפשר לסוכן להתקשר לסוכן אחר.

שדות
name	string חובה. השם של כלי הסוכן.
description	string זה שינוי אופציונלי. תיאור של מטרת הכלי.
agent	string זה שינוי אופציונלי. שם המשאב של הסוכן שמשמש כנקודת הכניסה לכלי. פורמט: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

מייצג אירוע שמציין העברה של שיחה לסוכן אחר.

שדות
target_agent	string חובה. הסוכן שאליו מועברת השיחה. הנציג יטפל בשיחה מכאן ואילך. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string פלט בלבד. השם המוצג של הנציג.

AmbientSoundConfig

הגדרות של מוזיקת אמביינט שתופעל עם התשובה המסונתזת של הסוכן, כדי לשפר את הטבעיות של השיחה.

שדות
volume_gain_db	double זה שינוי אופציונלי. הגברת עוצמת הקול (בדציבלים) של עוצמת הקול המקורית הרגילה שנתמכת על ידי רעשי רקע, בטווח [‎-96.0, 16.0]. אם לא מוגדר ערך או אם הערך הוא 0.0 (dB), ההפעלה תהיה בעוצמת האות המקורי הרגילה. ערך של ‎-6.0 (dB)‎ יושמע בעוצמה של בערך חצי מהעוצמה של האות המקורי הרגיל. ערך של ‎+6.0 (dB)‎ יושמע בעוצמה שהיא בערך כפולה מעוצמת האות המקורי הרגילה. מומלץ מאוד לא לחרוג מ-+10 (dB), כי בדרך כלל אין עלייה משמעותית בעוצמת הקול בכל ערך שגדול יותר מזה.
שדה איחוד source. רעשי הסביבה שיושמעו עם התשובה המסונתזת של הסוכן, כדי לשפר את הטבעיות של השיחה. הערך source יכול להיות רק אחד מהבאים:
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise הפריט הזה הוצא משימוש. זה שינוי אופציונלי. הוצא משימוש: השימוש ב-prebuilt_ambient_noise הוצא משימוש, ועכשיו צריך להשתמש ב-prebuilt_ambient_sound.
gcs_uri	string זה שינוי אופציונלי. רעשי הסביבה כקובץ WAV עם ערוץ מונו, ‎16 kHz, שמאוחסן ב-Cloud Storage. הערה: חשוב לוודא שלסוכן השירות של CES‏, service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com, יש הרשאה מסוג storage.objects.get לאובייקט ב-Cloud Storage.
prebuilt_ambient_sound	string זה שינוי אופציונלי. השם של צליל הסביבה המובנה. הערכים האפשריים הם: - coffee_shop - keyboard - keypad - hum - office_1 - office_2 - office_3 - room_1 - room_2 - room_3 - room_4 - room_5 - air_conditioner

PrebuiltAmbientNoise

רעשי סביבה מוכנים מראש.

טיפוסים בני מנייה (enum)
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	לא צוין.
RETAIL_STORE	רעשי הסביבה בחנות קמעונאית.
CONVENTION_HALL	רעשי הסביבה באולם כנסים.
OUTDOOR	רעשי הסביבה של רחוב.

ApiAuthentication

פרטי אימות שנדרשים לקריאות ל-API.

שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
api_key_config	ApiKeyConfig זה שינוי אופציונלי. הגדרות לאימות מפתח API.
oauth_config	OAuthConfig זה שינוי אופציונלי. הגדרות ל-OAuth.
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig זה שינוי אופציונלי. ההגדרה לאימות באמצעות טוקן של מזהה שנוצר מסוכן השירות של CES.
service_account_auth_config	ServiceAccountAuthConfig זה שינוי אופציונלי. הגדרות לאימות של חשבון שירות.
bearer_token_config	BearerTokenConfig זה שינוי אופציונלי. הגדרת אימות באמצעות טוקן bearer.

ApiKeyConfig

הגדרות לאימות באמצעות מפתח API.

שדות
key_name	string חובה. שם הפרמטר או שם הכותרת של מפתח ה-API. למשל, אם בקשת ה-API היא "https://example.com/act?X-Api-Key=", שם הפרמטר יהיה "X-Api-Key".
api_key_secret_version	string חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן מפתח ה-API. פורמט: projects/{project}/secrets/{secret}/versions/{version} הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location	ApiKeyConfig.RequestLocation חובה. מיקום המפתח בבקשה.

RequestLocation

המיקום של מפתח ה-API בבקשה.

טיפוסים בני מנייה (enum)
REQUEST_LOCATION_UNSPECIFIED	לא צוין. אין להשתמש בערך הזה.
HEADER	מייצג את המפתח בכותרת ה-HTTP.
QUERY_STRING	מייצג את המפתח במחרוזת של שאילתה.

אפליקציה

אפליקציה משמשת כמאגר ברמה העליונה לקבוצה של סוכנים, כולל סוכן הבסיס וסוכני המשנה שלו, וגם ההגדרות שמשויכות אליהם. הסוכנים האלה פועלים יחד כדי להשיג יעדים ספציפיים בהקשר של האפליקציה.

שדות
name	string מזהה. המזהה הייחודי של האפליקציה. הפורמט: projects/{project}/locations/{location}/apps/{app}
display_name	string חובה. השם המוצג של האפליקציה.
description	string זה שינוי אופציונלי. תיאור של האפליקציה שכתוב בצורה שקריאה לאנשים.
pinned	bool זה שינוי אופציונלי. האם האפליקציה מוצמדת לרשימת האפליקציות.
root_agent	string זה שינוי אופציונלי. הסוכן הראשי הוא נקודת הכניסה לאפליקציה. הפורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings זה שינוי אופציונלי. הגדרות השפה של האפליקציה.
time_zone_settings	TimeZoneSettings זה שינוי אופציונלי. הגדרות אזור הזמן של האפליקציה.
audio_processing_config	AudioProcessingConfig זה שינוי אופציונלי. הגדרת עיבוד האודיו של האפליקציה.
logging_settings	LoggingSettings זה שינוי אופציונלי. הגדרות הרישום של האפליקציה.
error_handling_settings	ErrorHandlingSettings זה שינוי אופציונלי. הגדרות לטיפול בשגיאות באפליקציה.
model_settings	ModelSettings זה שינוי אופציונלי. הגדרות ברירת המחדל של מודל LLM לאפליקציה. משאבים ספציפיים (למשל סוכנים, אמצעי הגנה) יכולים לשנות את ההגדרות האלה לפי הצורך.
tool_execution_mode	App.ToolExecutionMode זה שינוי אופציונלי. מצב ההפעלה של הכלי באפליקציה. אם לא מציינים מצב, ברירת המחדל היא PARALLEL.
evaluation_metrics_thresholds	EvaluationMetricsThresholds זה שינוי אופציונלי. סף ההערכה של האפליקציה.
variable_declarations[]	App.VariableDeclaration זה שינוי אופציונלי. ההצהרות של המשתנים.
predefined_variable_declarations[]	App.VariableDeclaration פלט בלבד. ההצהרות של משתנים מוגדרים מראש באפליקציה.
global_instruction	string זה שינוי אופציונלי. הוראות לכל הסוכנים באפליקציה. אפשר להשתמש בהוראה הזו כדי להגדיר זהות או אישיות יציבה לכל הסוכנים.
guardrails[]	string זה שינוי אופציונלי. רשימת אמצעי הבקרה לאפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings זה שינוי אופציונלי. הגדרות מאגר הנתונים של האפליקציה.
default_channel_profile	ChannelProfile זה שינוי אופציונלי. פרופיל הערוץ שמוגדר כברירת מחדל ומשמש את האפליקציה.
metadata	map<string, string> זה שינוי אופציונלי. מטא-נתונים על האפליקציה. אפשר להשתמש בשדה הזה כדי לאחסן מידע נוסף שרלוונטי לפרטי האפליקציה או לשימושים המיועדים שלה.
create_time	Timestamp פלט בלבד. חותמת הזמן שבה האפליקציה נוצרה.
update_time	Timestamp פלט בלבד. חותמת זמן של מועד העדכון האחרון של האפליקציה.
etag	string פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
deployment_count	int32 פלט בלבד. מספר הפריסות באפליקציה.
client_certificate_settings	ClientCertificateSettings זה שינוי אופציונלי. הגדרות ברירת המחדל של אישורי הלקוח לאפליקציה.
vpc_sc_settings	VpcScSettings זה שינוי אופציונלי. ההגדרות של VPC-SC לאפליקציה.
locked	bool זה שינוי אופציונלי. התנאי מציין אם האפליקציה נעולה ואי אפשר לבצע בה שינויים. אם האפליקציה נעולה, שינויים במשאבי האפליקציה יידחו.
validation_errors[]	string פלט בלבד. הגדרות שגויות או אזהרות באפליקציה.
dashboard_settings	DashboardSettings זה שינוי אופציונלי. הגדרות ספציפיות לאפליקציה לקישור ולהגדרה של מרכזי בקרה של Contact Center Insights.

ToolExecutionMode

ההגדרה הזו קובעת את אופן הפעולה של הכלי אם הסוכן בוחר כמה כלים באותו הזמן.

טיפוסים בני מנייה (enum)
TOOL_EXECUTION_MODE_UNSPECIFIED	מצב ההרצה של הכלי לא צוין. ברירת המחדל היא PARALLEL.
PARALLEL	אם בוחרים כמה כלים, הם יופעלו במקביל עם אותו ToolContext.
SEQUENTIAL	אם בוחרים כמה כלים, הם יופעלו ברצף. הכלי הבא יופעל רק אחרי שהכלי הקודם יסיים את הפעולה, והוא יוכל לראות את ToolContext המעודכן מהכלי הקודם.

VariableDeclaration

הגדרת המבנה והמטא-נתונים של משתנה.

שדות
name	string חובה. שם המשתנה. השם צריך להתחיל באות או בקו תחתון, והוא יכול להכיל רק אותיות, מספרים או קווים תחתונים.
description	string חובה. תיאור המשתנה.
schema	Schema חובה. הסכימה של המשתנה.

AppSnapshot

תמונה של האפליקציה.

שדות
app	App זה שינוי אופציונלי. ההגדרות הבסיסיות של האפליקציה.
agents[]	Agent זה שינוי אופציונלי. רשימת הנציגים באפליקציה.
tools[]	Tool זה שינוי אופציונלי. רשימת הכלים באפליקציה.
examples[]	Example זה שינוי אופציונלי. רשימת דוגמאות באפליקציה.
guardrails[]	Guardrail זה שינוי אופציונלי. רשימת אמצעי הבטיחות באפליקציה.
toolsets[]	Toolset זה שינוי אופציונלי. רשימה של ערכות כלים באפליקציה.

AppVersion

ב-Customer Engagement Suite (CES), גרסת אפליקציה היא תמונת מצב של האפליקציה בנקודת זמן מסוימת. הוא קבוע ואי אפשר לשנות אותו אחרי שיוצרים אותו.

שדות
name	string מזהה. המזהה הייחודי של גרסת האפליקציה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string זה שינוי אופציונלי. השם המוצג של גרסת האפליקציה.
description	string זה שינוי אופציונלי. תיאור גרסת האפליקציה.
creator	string פלט בלבד. כתובת האימייל של המשתמש שיצר את גרסת האפליקציה.
create_time	Timestamp פלט בלבד. חותמת הזמן שבה נוצרה גרסת האפליקציה.
update_time	Timestamp פלט בלבד. חותמת הזמן של העדכון האחרון של גרסת האפליקציה.
snapshot	AppSnapshot פלט בלבד. קובץ ה-snapshot של האפליקציה כשיוצרים את הגרסה.
etag	string פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.

AudioEncoding

התג AudioEncoding מציין את פורמט הקידוד של נתוני האודיו.

טיפוסים בני מנייה (enum)
AUDIO_ENCODING_UNSPECIFIED	קידוד אודיו שלא צוין.
LINEAR16	קידוד אודיו PCM ליניארי של 16 ביט.
MULAW	דגימות של 8 ביט שמרחיבות דגימות של אודיו של 14 ביט באמצעות G.711 PCMU/mu-law.
ALAW	דגימות של 8 ביט שמרחיבות דגימות אודיו של 14 ביט באמצעות G.711 PCMU/A-law.

AudioProcessingConfig

הגדרות לעיבוד ולשידור של האודיו מהקלט והפלט.

שדות
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> זה שינוי אופציונלי. הגדרה של אופן סינתוז התשובה של הסוכן, מיפוי מקוד השפה ל-SynthesizeSpeechConfig. אם לא נמצאה הגדרה לקוד השפה שצוין, המערכת תשתמש בהגדרה של קוד שפת הבסיס. לדוגמה, אם המפה מכילה את הערכים en-us ו-en, וקוד השפה שצוין הוא en-gb, נעשה שימוש בהגדרה en. הערה: קוד השפה לא תלוי באותיות רישיות.
barge_in_config	BargeInConfig זה שינוי אופציונלי. המדיניות הזו מגדירה את התנהגות הסוכן בפעילויות של כניסה לשיחה של משתמש.
inactivity_timeout	Duration זה שינוי אופציונלי. משך הזמן של חוסר פעילות של המשתמש (ללא דיבור או אינטראקציה) לפני שהסוכן מציג למשתמש בקשה לחידוש האינטראקציה. אם לא מגדירים את ההגדרה הזו, הסוכן לא יציע למשתמש להמשיך את השיחה.
ambient_sound_config	AmbientSoundConfig זה שינוי אופציונלי. הגדרות של מוזיקת אמביינט שתופעל עם התשובה המסונתזת של הסוכן, כדי לשפר את הטבעיות של השיחה.
custom_voice_samples[]	CustomVoiceSample זה שינוי אופציונלי. הגדרות של דגימות קול בהתאמה אישית לשכפול קול.

AudioRecordingConfig

הגדרות לגבי אופן ההקלטה של אינטראקציות עם אודיו.

שדות
gcs_bucket	string זה שינוי אופציונלי. קטגוריית Cloud Storage שבה יאוחסנו הקלטות האודיו של הסשן. כתובת ה-URI חייבת להתחיל ב-gs://‎. צריך לבחור מיקום של מאגר שעומד בדרישות שלכם לגבי מיקום אחסון הנתונים. הערה: אם קטגוריית Cloud Storage נמצאת בפרויקט אחר מהאפליקציה, צריך להעניק storage.objects.create הרשאה לסוכן השירות של CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix	string זה שינוי אופציונלי. קידומת הנתיב של Cloud Storage להקלטות אודיו. הקידומת יכולה לכלול את הפלייס הולדרים הבאים, שיוחלפו באופן דינמי בזמן הצגת המודעה: ‫- $project: מזהה הפרויקט ‫- $location: מיקום האפליקציה ‫- $app: מזהה האפליקציה ‫- $date: תאריך הסשן בפורמט YYYY-MM-DD ‫- $session: מזהה הסשן אם לא מציינים קידומת נתיב, המערכת תשתמש בקידומת ברירת המחדל $project/$location/$app/$date/$session/.

BargeInConfig

הגדרה של אופן הטיפול בפעילויות של משתמשים שנכנסים לשיחה.

שדות
disable_barge_in (deprecated)	bool הפריט הזה הוצא משימוש. זה שינוי אופציונלי. הוצא משימוש: המאפיין disable_barge_in הוצא משימוש לטובת disable_barge_in_control ב-ChannelProfile. המשתמשים לא יוכלו להתפרץ לשיחה בזמן שהנציג מדבר. אם הערך הוא true, המערכת תתעלם מקלט של משתמשים במהלך השמעת התגובה של הסוכן.
barge_in_awareness	bool זה שינוי אופציונלי. אם ההגדרה הזו מופעלת, הנציג יתאים את התגובה הבאה שלו על סמך ההנחה שהמשתמש לא שמע את ההודעה המלאה הקודמת של הנציג. אין להשתמש בערך הזה בתרחישים שבהם התשובות של הנציג מוצגות באופן חזותי.

BatchDeleteConversationsRequest

בקשת הודעה עבור AgentService.BatchDeleteConversations.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים למחוק שיחות. פורמט: projects/{project}/locations/{location}/apps/{app}
conversations[]	string חובה. שמות המשאבים של השיחות שרוצים למחוק.

BatchDeleteConversationsResponse

הודעת תגובה ל-AgentService.BatchDeleteConversations.

שדות
deleted_conversations[]	string רשימת השיחות שנמחקו בהצלחה.
failed_conversations[]	string רשימת השיחות שלא נמחקו.
error_messages[]	string זה שינוי אופציונלי. רשימה של הודעות שגיאה שקשורות לשיחות שלא נמחקו.

BearerTokenConfig

הגדרות לאימות באמצעות טוקן Bearer.

שדות
token	string חובה. טוקן למוכ"ז. חייב להיות בפורמט $context.variables.<name_of_variable>.

BidiSessionClientMessage

ההודעה ברמה העליונה שנשלחת על ידי הלקוח עבור השיטה SessionService.BidiRunSession.

שדות
שדה איחוד message_type. סוג ההודעה. הערך message_type יכול להיות רק אחד מהבאים:
config	SessionConfig זה שינוי אופציונלי. הודעת ההגדרה הראשונית של הסשן.
realtime_input	SessionInput זה שינוי אופציונלי. הנתונים שמתקבלים בזמן אמת במהלך הסשן.

BidiSessionServerMessage

ההודעה ברמה העליונה שהוחזרה מהשיטה SessionService.BidiRunSession.

שדות
שדה איחוד message_type. סוג ההודעה. הערך message_type יכול להיות רק אחד מהבאים:
session_output	SessionOutput זה שינוי אופציונלי. תוצאת העיבוד מהסוכן של CES.
recognition_result	RecognitionResult זה שינוי אופציונלי. תוצאה של זיהוי דיבור בזמן אמת לקלט האודיו.
interruption_signal	InterruptionSignal זה שינוי אופציונלי. מציין שהתגובה הקולית של הסוכן הופרעה.
end_session	EndSession זה שינוי אופציונלי. מציין שהסשן הסתיים.
go_away	GoAway זה שינוי אופציונלי. הודעה שהשרת יתנתק בקרוב והלקוח צריך לסגור את החיבור באופן חלקי ולהפעיל אותו מחדש.

BigQueryExportSettings

הגדרות שמתארות את אופן הפעולה של הייצוא מ-BigQuery עבור האפליקציה.

שדות
enabled	bool זה שינוי אופציונלי. מציין אם הייצוא ל-BigQuery מופעל.
project	string זה שינוי אופציונלי. מזהה הפרויקט של מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים. הערה: אם מערך הנתונים של BigQuery נמצא בפרויקט אחר מהאפליקציה, צריך להעניק את התפקיד roles/bigquery.admin לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string זה שינוי אופציונלי. מזהה מערך הנתונים ב-BigQuery שאליו רוצים לייצא את הנתונים.

Blob

מייצג קלט או פלט של blob בשיחה.

שדות
mime_type	string חובה. סוג ה-MIME התקני של IANA של נתוני המקור.
data	bytes חובה. בייטים גולמיים של ה-blob.

התקשרות חזרה

ההגדרה של שיחת חזרה מגדירה את הלוגיקה המותאמת אישית שתופעל בשלבים שונים של האינטראקציה עם הנציג.

שדות
description	string זה שינוי אופציונלי. תיאור קריא של הקריאה החוזרת.
disabled	bool זה שינוי אופציונלי. האם ההתקשרות חזרה מושבתת. הסוכן מתעלם מהגדרות של בקשות להחזרת שיחה שהושבתו.
proactive_execution_enabled	bool זה שינוי אופציונלי. אם האפשרות הזו מופעלת, הקריאה החוזרת מופעלת גם בפלט של מודלים ביניים. ההגדרה הזו משפיעה רק על קריאה חוזרת (callback) של מודל. הפעלה בזהירות. בדרך כלל, צריך להפעיל את הקריאה החוזרת של המודל רק אחרי שמקבלים את כל התשובות של המודל. הפעלת ביצוע פרואקטיבי עלולה להשפיע לרעה על עלות הביצוע ועל זמן האחזור, ולכן מומלץ להפעיל אותה רק במקרים נדירים.
שדה איחוד callback. הפונקציה לקריאה חוזרת שתופעל. הערך callback יכול להיות רק אחד מהבאים:
python_code	string חובה. קוד ה-Python להרצה עבור הקריאה החוזרת.

יומן שינויים

יומני שינויים מייצגים שינוי שבוצע באפליקציה או במשאב בתוך האפליקציה.

שדות
name	string מזהה. המזהה הייחודי של יומן השינויים. פורמט: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string פלט בלבד. כתובת האימייל של כותב השינוי.
display_name	string פלט בלבד. השם המוצג של השינוי. בדרך כלל זה צריך להיות השם המוצג של המשאב ששונה.
description	string פלט בלבד. תיאור השינוי, שבדרך כלל כולל את השדות ששונו במשאב.
resource	string פלט בלבד. המשאב שהשתנה.
resource_type	string פלט בלבד. סוג המשאב שהשתנה.
action	string פלט בלבד. הפעולה שבוצעה במשאב.
original_resource	Struct פלט בלבד. מקור המידע המקורי לפני השינוי.
new_resource	Struct פלט בלבד. מקור המידע החדש אחרי השינוי.
dependent_resources[]	Struct פלט בלבד. מקורות המידע התלויים שהשתנו.
create_time	Timestamp פלט בלבד. השעה שבה בוצע השינוי.
sequence_number	int64 פלט בלבד. מספר הרצף של יומן השינויים, שגדל באופן מונוטוני.

ChannelProfile

ההגדרה ChannelProfile קובעת את התנהגות הסוכן בערוץ תקשורת ספציפי, כמו ממשק משתמש באינטרנט או טלפוניה.

שדות
profile_id	string זה שינוי אופציונלי. המזהה הייחודי של פרופיל הערוץ.
channel_type	ChannelProfile.ChannelType זה שינוי אופציונלי. סוג פרופיל הערוץ.
persona_property	ChannelProfile.PersonaProperty זה שינוי אופציונלי. מאפיין הפרסונה של פרופיל הערוץ.
web_widget_config	ChannelProfile.WebWidgetConfig זה שינוי אופציונלי. ההגדרה של הווידג'ט לאתר.
whatsapp_config	ChannelProfile.WhatsAppConfig זה שינוי אופציונלי. הגדרה ספציפית לפריסות בוואטסאפ.
instagram_config	ChannelProfile.InstagramConfig זה שינוי אופציונלי. הגדרה ספציפית לפריסות באינסטגרם.
disable_dtmf	bool זה שינוי אופציונלי. האם להשבית את DTMF (חיוג רב-תדרים).
disable_barge_in_control	bool זה שינוי אופציונלי. האם להשבית את השליטה של המשתמשים בהצטרפות לשיחה. ‫- true: המשתמש לא יכול להפריע בזמן שהסוכן מדבר. ‫- false: הסוכן שומר על שליטה אוטומטית לגבי מתי המשתמש יכול להפריע.
noise_suppression_level	string זה שינוי אופציונלי. רמת ביטול הרעשים בפרופיל הערוץ. הערכים האפשריים הם low,‏ moderate,‏ high,‏ very_high.

ChannelType

סוג פרופיל הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN	סוג הערוץ לא ידוע.
WEB_UI	ערוץ בממשק המשתמש האינטרנטי.
API	ערוץ API.
TWILIO	ערוץ Twilio.
GOOGLE_TELEPHONY_PLATFORM	ערוץ פלטפורמת הטלפוניה של Google.
CONTACT_CENTER_AS_A_SERVICE	ערוץ Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	ערוץ Contact Center as a Service (CCaaS Chat).
FIVE9	ערוץ Five9.
CONTACT_CENTER_INTEGRATION	ערוץ שילוב של מרכז תמיכה של צד שלישי.
WHATSAPP	ערוץ וואטסאפ.
INSTAGRAM	ערוץ באינסטגרם.

InstagramConfig

הגדרה ספציפית לפריסות באינסטגרם.

שדות
instagram_account_id	string חובה. מזהה החשבון באינסטגרם.
display_name	string פלט בלבד. השם של הדף העסקי ב-מטא שאוחזר.
thumbnail_url	string פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאותרה.
description	string פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא.

PersonaProperty

מייצג את מאפיין האישיות של הערוץ.

שדות
persona	ChannelProfile.PersonaProperty.Persona זה שינוי אופציונלי. הפרסונה של הערוץ.

פרסונה

הפרסונה של הערוץ.

טיפוסים בני מנייה (enum)
UNKNOWN	פרסונה לא ידועה.
CONCISE	הסוכן שומר על תשובות תמציתיות וענייניות
CHATTY	הסוכן מספק הקשר, הסברים ופרטים נוספים

WebWidgetConfig

הודעה לגבי ההגדרה של הווידג'ט לאתר.

שדות
modality	ChannelProfile.WebWidgetConfig.Modality זה שינוי אופציונלי. האופן שבו הווידג'ט מוצג באתר.
theme	ChannelProfile.WebWidgetConfig.Theme זה שינוי אופציונלי. העיצוב של הווידג'ט לאתר.
web_widget_title	string זה שינוי אופציונלי. השם של הווידג'ט לאתר.
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings זה שינוי אופציונלי. הגדרות האבטחה של הווידג'ט לאינטרנט.

מודליות

האופן שבו הווידג'ט מוצג באתר.

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED	אמצעי לא ידוע.
CHAT_AND_VOICE	הווידג'ט תומך גם בצ'אט וגם בקלט קולי.
VOICE_ONLY	בווידג'ט יש תמיכה רק בקלט קולי.
CHAT_ONLY	הווידג'ט תומך רק בהזנת צ'אט.
CHAT_VOICE_AND_VIDEO	הווידג'ט תומך בקלט של צ'אט, קול ווידאו.

SecuritySettings

הגדרות האבטחה של הווידג'ט לאינטרנט.

שדות
enable_public_access	bool זה שינוי אופציונלי. מציין אם הגישה הציבורית לווידג'ט האינטרנט מופעלת. אם הערך הוא true, הווידג'ט לאתר יהיה נגיש לכולם. אם false, צריך לשלב את הווידג'ט לאינטרנט עם מערכת האימות וההרשאה שלכם כדי לקבל פרטי כניסה תקפים לגישה לסוכן CES.
enable_origin_check	bool זה שינוי אופציונלי. המדיניות הזו מציינת אם בדיקת המקור של הווידג'ט לאתר מופעלת. אם הערך הוא true, הווידג'ט לאתר יבדוק את המקור של האתר שטוען את הווידג'ט לאתר, ויאפשר את הטעינה שלו רק באותו מקור או בכל אחד מהמקורות המותרים.
allowed_origins[]	string זה שינוי אופציונלי. המקורות שיכולים לארח את הווידג'ט לאינטרנט. מקור מוגדר על ידי RFC 6454. אם לא תציינו ערך בשדה הזה, כל המקורות יהיו מותרים. אפשר להוסיף עד 100 מקורות. דוגמה: "https://example.com"
enable_recaptcha	bool זה שינוי אופציונלי. התנאי מציין אם אימות מסוג reCAPTCHA של הווידג'ט לאתר מופעל.

עיצוב

העיצוב של הווידג'ט לאתר.

טיפוסים בני מנייה (enum)
THEME_UNSPECIFIED	עיצוב לא ידוע.
LIGHT	עיצוב בהיר.
DARK	עיצוב כהה.

WhatsAppConfig

הגדרה ספציפית לפריסות בוואטסאפ.

שדות
waba_id	string חובה. מספר החשבון ב-WhatsApp Business.
phone_number_id	string חובה. מזהה מספר הטלפון של Meta.
phone_number	string זה שינוי אופציונלי. מספר הטלפון בפורמט E.164.
display_name	string פלט בלבד. שם דף העסק במטא שאוחזר.
thumbnail_url	string פלט בלבד. כתובת ה-URL של התמונה הממוזערת של פרופיל העסק ב-Meta שאותרה.
description	string פלט בלבד. התיאור של הדף או הפרופיל העסקי במטא.

מקטע

חלק מהתוכן בהודעה.

שדות
שדה איחוד data. מקטעים של נתונים. הערך data יכול להיות רק אחד מהבאים:
text	string זה שינוי אופציונלי. נתוני טקסט.
transcript	string זה שינוי אופציונלי. תמליל שמשויך לאודיו.
blob	Blob זה שינוי אופציונלי. נתוני Blob.
payload	Struct זה שינוי אופציונלי. נתונים של מטען ייעודי בהתאמה אישית.
image	Image זה שינוי אופציונלי. נתוני תמונה.
tool_call	ToolCall זה שינוי אופציונלי. בקשה להרצת כלי.
tool_response	ToolResponse זה שינוי אופציונלי. תשובה להרצת הכלי.
agent_transfer	AgentTransfer זה שינוי אופציונלי. אירוע של העברה לסוכן.
updated_variables	Struct מבנה הנתונים מייצג משתנים שעודכנו בשיחה, עם שמות המשתנים כמפתחות.
default_variables	Struct מבנה נתונים מייצג משתני ברירת מחדל בתחילת השיחה, עם מפתחות לפי שמות המשתנים.

ציטוטים

ציטוטים שמשויכים לתשובה של הסוכן.

שדות
cited_chunks[]	Citations.CitedChunk רשימה של פריטי מידע שצוטטו.
inline_citations[]	Citations.InlineCitation זה שינוי אופציונלי. רשימה של ציטוטים מוטמעים בתשובת הסוכן.

CitedChunk

חלק מהמידע שמצוטט.

שדות
uri	string ה-URI שמשמש לציטוט.
title	string שם המסמך שמצוטט.
text	string הטקסט שמשמש לציטוט.
requires_attribution	bool האם צריך להציג למשתמשי הקצה את הקרדיט על הציטוט הזה.

InlineCitation

ציטוט ביבליוגרפי בתוך הטקסט בתשובה.

שדות
start_index	int32 אינדקס ההתחלה (בבייטים) של פלח הטקסט בתשובת הסוכן.
end_index	int32 אינדקס הסיום (בבייטים) של קטע הטקסט בתשובת הסוכן.
cited_chunk_indices[]	int32 האינדקסים של נתחי המידע שמופיעים בציטוטים ומגבים את קטע הטקסט הזה. האינדקסים מתייחסים לאלמנטים ב-cited_chunks.

ClientCertificateSettings

הגדרות לאישורי לקוח מותאמים אישית.

שדות
tls_certificate	string חובה. אישור ה-TLS מקודד בפורמט PEM. המחרוזת הזו חייבת לכלול את השורות של תחילת הכותרת העליונה וסוף הכותרת התחתונה.
private_key	string חובה. השם של משאב הגרסה של הסוד ב-SecretManager שבו מאוחסן המפתח הפרטי בקידוד בפורמט PEM. פורמט: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string זה שינוי אופציונלי. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן ביטוי הגישה לפענוח המפתח הפרטי. אם המפתח הפרטי לא מוצפן, צריך להשאיר את השדה הזה ללא הגדרה. פורמט: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

מייצג פונקציה בצד הלקוח שהסוכן יכול להפעיל. כשהסוכן בוחר את הכלי, השליטה מועברת ללקוח. הלקוח אחראי להפעלת הפונקציה ולהחזרת התוצאה כ-ToolResponse כדי להמשיך את האינטראקציה עם הנציג.

שדות
name	string חובה. שם הפונקציה.
description	string זה שינוי אופציונלי. תיאור הפונקציה.
parameters	Schema זה שינוי אופציונלי. הסכימה של פרמטרים של הפונקציה.
response	Schema זה שינוי אופציונלי. הסכימה של תשובת הפונקציה.

CloudLoggingSettings

הגדרות שמתארות את ההתנהגויות של Cloud Logging באפליקציה.

שדות
enable_cloud_logging	bool זה שינוי אופציונלי. האם להפעיל את Cloud Logging עבור הסשנים.

CodeBlock

בלוק קוד שיופעל במקום קריאה אמיתית לכלי.

שדות

python_code

string חובה. קוד Python שיופעל במצב מזויף של הכלי. חתימת פונקציית Python הצפויה – כדי לתפוס את כל קריאות הכלים: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: כדי לתפוס קריאה ספציפית לכלי: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: אם הפונקציה מחזירה None, הכלי האמיתי יופעל במקום זאת.

ConnectorTool

כלי ConnectorTool מאפשר חיבורים לשילובים שונים. מידע נוסף זמין בכתובת: https://cloud.google.com/integration-connectors/docs/overview.

שדות
connection	string חובה. השם המלא של המשאב של חיבור Integration Connectors שאליו מתייחסים. פורמט: projects/{project}/locations/{location}/connections/{connection}
action	Action חובה. הפעולה שבה הכלי ישתמש.
auth_config	EndUserAuthConfig זה שינוי אופציונלי. ההגדרה הזו קובעת איך מתבצע אימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל את האפשרות 'ביטול ברירת המחדל של האימות' בחיבור – אחרת, יצירת הכלי ConnectorTool תיכשל. פרטים נוספים זמינים במאמר https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name	string זה שינוי אופציונלי. שם הכלי שהסוכן יכול להשתמש בו כדי להחליט אם להפעיל את ConnectorTool.
description	string זה שינוי אופציונלי. תיאור של הכלי שהסוכן יכול להשתמש בו כדי להחליט אם להפעיל את ConnectorTool.

ConnectorToolset

ערכת כלים שיוצרת כלים מחיבור Integration Connectors.

שדות
connection	string חובה. השם המלא של המשאב של חיבור Integration Connectors שאליו מתייחסים. פורמט: projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig זה שינוי אופציונלי. ההגדרה הזו קובעת איך מתבצע אימות ב-Integration Connectors. כברירת מחדל, אימות אדמין מועבר בבקשות Integration Connectors API. אפשר לשנות את ההגדרה הזו באמצעות הגדרת אימות אחרת של משתמשי קצה. הערה: כדי לציין כאן הגדרת EUC, צריך להפעיל את האפשרות 'ביטול הגדרות אימות' בחיבור – אחרת, יצירת ערכת הכלים תיכשל. מידע נוסף זמין בכתובת: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]	Action חובה. רשימה של פעולות מחבר או פעולות ישות ליצירת כלים עבורן.

שיחה

שיחה מייצגת אינטראקציה בין משתמש קצה לבין אפליקציית CES.

שדות
name	string מזהה. המזהה הייחודי של השיחה. פורמט: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp פלט בלבד. חותמת הזמן שבה השיחה נוצרה.
end_time	Timestamp פלט בלבד. חותמת זמן של סיום השיחה.
turns[]	Conversation.Turn חובה. התורות בשיחה.
turn_count	int32 פלט בלבד. מספר התורות בשיחה.
channel_type (deprecated)	Conversation.ChannelType הפריט הזה הוצא משימוש. הוצא משימוש. במקומה צריך להשתמש ב-input_types.
source	Conversation.Source פלט בלבד. מציינים את מקור השיחה.
input_types[]	Conversation.InputType פלט בלבד. סוגי הקלט של השיחה.
entry_agent	string פלט בלבד. הסוכן שמטפל בשיחה בהתחלה. אם לא מציינים סוכן, השיחה מטופלת על ידי סוכן הבסיס. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string פלט בלבד. הפריסה של האפליקציה שמשמשת לעיבוד השיחה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string פלט בלבד. גרסת האפליקציה שמשמשת לעיבוד השיחה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string פלט בלבד. קוד השפה של השיחה.
messages[] (deprecated)	Message הפריט הזה הוצא משימוש. הוצאה משימוש, במקום זאת, אפשר להשתמש בתורות.

ChannelType

סוג הערוץ של השיחה.

טיפוסים בני מנייה (enum)
CHANNEL_TYPE_UNSPECIFIED	סוג הערוץ לא צוין.
TEXT	השיחה מכילה רק הודעות טקסט בין משתמש הקצה לבין הסוכן.
AUDIO	השיחה מכילה הודעות אודיו בין משתמש הקצה לבין הסוכן.
MULTIMODAL	השיחה כוללת הודעות מולטי-מודאליות (למשל, תמונה) בין משתמש הקצה לבין הסוכן.

InputType

סוג הודעת הקלט.

טיפוסים בני מנייה (enum)
INPUT_TYPE_UNSPECIFIED	סוג הקלט לא צוין.
INPUT_TYPE_TEXT	קלט טקסט.
INPUT_TYPE_EVENT	קלט האירוע.
INPUT_TYPE_AUDIO	קלט אודיו.
INPUT_TYPE_IMAGE	תמונת הקלט.
INPUT_TYPE_BLOB	קלט Blob.
INPUT_TYPE_TOOL_RESPONSE	קלט של תגובה לכלי פונקציית לקוח.
INPUT_TYPE_VARIABLES	קלט של משתנים.

מקור

המקור של השיחה.

טיפוסים בני מנייה (enum)
SOURCE_UNSPECIFIED	מקור לא מוגדר.
LIVE	השיחה היא ממשתמש הקצה הפעיל.
SIMULATOR	השיחה היא מהסימולטור.
EVAL	השיחה היא מההערכה.
AGENT_TOOL	השיחה היא מכלי של סוכן. כלי הסוכן מריץ את הסוכן בסשן נפרד, שנשמר למטרות בדיקה וניפוי באגים.

סיבוב

כל המידע על תור יחיד בשיחה.

שדות
messages[]	Message זה שינוי אופציונלי. רשימת ההודעות בשלב השיחה, כולל הקלט של המשתמשים, התשובות של הסוכנים ואירועים ביניים במהלך העיבוד.
root_span	Span זה שינוי אופציונלי. טווח הבסיס של עיבוד הפעולה.
user_intended_text	string זה שינוי אופציונלי. הטקסט המיועד של האמת הבסיסית מהמתקשר המדומה (Polysynth). הנתונים יאוכלסו רק אם תפעילו את מדדי שיעור השגיאות במילים.

ConversationLoggingSettings

הגדרות שמתארות את התנהגויות הרישום ביומן של השיחות באפליקציה.

שדות
disable_conversation_logging	bool זה שינוי אופציונלי. האם להשבית את הרישום ביומן של השיחות בסשנים.
retention_window	Duration זה שינוי אופציונלי. המדיניות קובעת את חלון השמירה של השיחה. אם לא תגדירו את משך הזמן, השיחה תישמר למשך 365 ימים.

CreateAgentRequest

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור סוכן.
agent_id	string זה שינוי אופציונלי. המזהה שבו יש להשתמש עבור הסוכן, שיהפוך לרכיב הסופי של שם המשאב של הסוכן. אם לא מציינים מזהה, המערכת מקצה מזהה ייחודי לסוכן באופן אוטומטי.
agent	Agent חובה. הסוכן שרוצים ליצור.

CreateAppRequest

בקשת הודעה עבור AgentService.CreateApp.

שדות
parent	string חובה. שם המשאב של המיקום שבו רוצים ליצור את האפליקציה.
app_id	string זה שינוי אופציונלי. המזהה לשימוש באפליקציה, שיהפוך לרכיב הסופי של שם המשאב של האפליקציה. אם לא מציינים מזהה, המערכת מקצה לאפליקציה מזהה ייחודי באופן אוטומטי.
app	App חובה. האפליקציה שרוצים ליצור.

CreateAppVersionRequest

הודעת בקשה בשביל AgentService.CreateAppVersion

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור גרסת אפליקציה.
app_version_id	string זה שינוי אופציונלי. המזהה לשימוש בגרסת האפליקציה, שיהפוך לרכיב הסופי של שם המשאב של גרסת האפליקציה. אם לא מספקים מזהה, המערכת מקצה מזהה ייחודי לגרסת האפליקציה באופן אוטומטי.
app_version	AppVersion חובה. גרסת האפליקציה שרוצים ליצור.

CreateDeploymentRequest

בקשת הודעה עבור AgentService.CreateDeployment.

שדות
parent	string חובה. האפליקציה הראשית. הפורמט: projects/{project}/locations/{location}/apps/{app}
deployment_id	string זה שינוי אופציונלי. המזהה לשימוש בפריסה, שיהפוך לרכיב הסופי של שם המשאב של הפריסה. אם לא מציינים מזהה, המערכת מקצה מזהה ייחודי לפריסה באופן אוטומטי.
deployment	Deployment חובה. הפריסה שרוצים ליצור.

CreateExampleRequest

בקשת הודעה עבור AgentService.CreateExample.

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור דוגמה.
example_id	string זה שינוי אופציונלי. המזהה שבו צריך להשתמש בדוגמה, שיהפוך לרכיב הסופי של שם המשאב של הדוגמה. אם לא מציינים מזהה, המערכת מקצה מזהה ייחודי לדוגמה באופן אוטומטי.
example	Example חובה. הדוגמה ליצירה.

CreateGuardrailRequest

בקשת הודעה עבור AgentService.CreateGuardrail.

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור אמצעי בקרה.
guardrail_id	string זה שינוי אופציונלי. המזהה שבו יש להשתמש בשביל אמצעי הבקרה, שיהפוך לרכיב הסופי של שם המשאב של אמצעי הבקרה. אם לא מספקים מזהה, המערכת מקצה באופן אוטומטי מזהה ייחודי לגדר הבטיחות.
guardrail	Guardrail חובה. הגדרת האבטחה שרוצים ליצור.

CreateToolRequest

בקשת הודעה עבור AgentService.CreateTool.

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור כלי.
tool_id	string זה שינוי אופציונלי. המזהה לשימוש בכלי, שיהפוך לרכיב הסופי של שם המשאב של הכלי. אם לא מספקים מזהה, המערכת מקצה מזהה ייחודי לכלי באופן אוטומטי.
tool	Tool חובה. הכלי ליצירה.

CreateToolsetRequest

בקשת הודעה עבור AgentService.CreateToolset.

שדות
parent	string חובה. שם המשאב של האפליקציה שבה רוצים ליצור את ערכת הכלים.
toolset_id	string זה שינוי אופציונלי. המזהה לשימוש בערכת הכלים, שיהפוך לרכיב הסופי של שם המשאב של ערכת הכלים. אם לא מספקים מזהה, המערכת מקצה מזהה ייחודי לערכת הכלים באופן אוטומטי.
toolset	Toolset חובה. ערכת הכלים ליצירה.

CustomVoiceSample

הגדרה של דגימת קול מותאמת אישית שמשמשת לשכפול קול.

שדות
name	string זה שינוי אופציונלי. השם שהמשתמש הגדיר לדגימת הקול המותאמת אישית.
voice_sample_gcs_uri	string זה שינוי אופציונלי. ה-URI של Cloud Storage לדגימת האודיו לשכפול הקול. דגימת האודיו צריכה להיות קובץ WAV עם ערוץ מונו, בתדירות של ‎24 kHz.
consent_audio_gcs_uri	string זה שינוי אופציונלי. הסכמה לשימוש באודיו לצורך שכפול קול.
voice_instruction	string זה שינוי אופציונלי. הוראות בשפה טבעית לגבי סגנון הקול, הטון, הקצב או ההגייה.
preview_audio_content	bytes פלט בלבד. אודיו לדוגמה של קול בהתאמה אישית, בפורמט WAV קנוני (LINEAR16, ‏ 24kHz, ‏ 16-bit, ‏ מונו).
preview_text	string זה שינוי אופציונלי. טקסט לסינתוז של אודיו לתצוגה מקדימה של קול בהתאמה אישית.
warnings[]	CustomVoiceSample.Warning פלט בלבד. הודעות אזהרה שמופיעות במהלך העיבוד של שיבוט הקול (למשל, רמת שמע נמוכה).
voice_instruction_mode	CustomVoiceSample.VoiceInstructionMode זה שינוי אופציונלי. מצב ההוראות לדוגמת הקול. אם לא מציינים ערך, ברירת המחדל היא NO_INSTRUCTION.

VoiceInstructionMode

מצב ההוראות לדוגמת הקול.

טיפוסים בני מנייה (enum)
VOICE_INSTRUCTION_MODE_UNSPECIFIED	מצב ההוראה לא צוין. ברירת המחדל היא NO_INSTRUCTION.
NO_INSTRUCTION	לא ייעשה שימוש בהוראות קוליות.
GENERATE_INSTRUCTION	ההוראה הקולית תיווצר באופן אוטומטי על ידי AI מדגימת האודיו.
CUSTOM_INSTRUCTION	הוראה קולית בהתאמה אישית שסופקה על ידי המשתמש.

אזהרה

הודעת אזהרה שנתקלתם בה במהלך עיבוד דגימת הקול.

שדות
message	string פלט בלבד. תיאור של האזהרה שכתוב בצורה שקריאה לאנשים.
type	CustomVoiceSample.Warning.WarningType פלט בלבד. סוג האזהרה.

WarningType

סוג האזהרה שנתקלה בה במהלך עיבוד דגימת הקול.

טיפוסים בני מנייה (enum)
WARNING_TYPE_UNSPECIFIED	סוג האזהרה לא צוין.
LOW_AUDIO_LEVEL	רמת האודיו של דגימת הקול נמוכה מדי (למשל, אמפליטודת RMS נמוכה).

DashboardSettings

הגדרות של לוחות בקרה שמשויכים לאפליקציה, שמופיעים בתצוגת המעקב.

שדות
default_dashboard	string זה שינוי אופציונלי. שם המשאב של לוח הבקרה שמוגדר כברירת מחדל ב-Contact Center Insights שמשויך לאפליקציה. זה לוח הבקרה שיוצג כשמשתמשים יעברו לתצוגת המעקב של האפליקציה. פורמט: projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

משאב DataStore בחיפוש מבוסס-Vertex AI.

שדות
name	string חובה. השם המלא של המשאב DataStore. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType פלט בלבד. סוג מאגר הנתונים. השדה הזה הוא לקריאה בלבד והוא מאוכלס על ידי השרת.
document_processing_mode	DataStore.DocumentProcessingMode פלט בלבד. מצב עיבוד המסמכים לחיבור מאגר הנתונים. ההגדרה הזו רלוונטית רק למאגרי נתונים מסוג PUBLIC_WEB ו-UNSTRUCTURED.
display_name	string פלט בלבד. השם המוצג של מאגר הנתונים.
create_time	Timestamp פלט בלבד. חותמת הזמן שבה נוצר מאגר הנתונים.
connector_config	DataStore.ConnectorConfig פלט בלבד. הגדרת המחבר לחיבור למאגר הנתונים.

ConnectorConfig

הגדרת המחבר לחיבור למאגר הנתונים.

שדות
collection	string שם המשאב של האוסף שאליו שייך מאגר הנתונים.
collection_display_name	string השם המוצג של האוסף שאליו שייך מאגר הנתונים.
data_source	string השם של מקור הנתונים. דוגמה: salesforce, jira, confluence, bigquery.

DataStoreType

סוג מאגר הנתונים.

טיפוסים בני מנייה (enum)
DATA_STORE_TYPE_UNSPECIFIED	לא צוין. הערך הזה מציין שסוג מאגר הנתונים לא צוין, ולכן המערכת לא תשתמש בו במהלך החיפוש.
PUBLIC_WEB	מאגר נתונים שמכיל תוכן אינטרנטי שזמין לכולם.
UNSTRUCTURED	מאגר נתונים שמכיל נתונים פרטיים לא מובנים.
FAQ	מאגר נתונים שמכיל נתונים מובְנים שמשמשים כשאלות נפוצות.
CONNECTOR	מאגר נתונים שהוא מחבר לשירות צד ראשון או צד שלישי.

DocumentProcessingMode

מצב עיבוד המסמכים של מאגר הנתונים.

טיפוסים בני מנייה (enum)
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	לא צוין.
DOCUMENTS	המסמכים מעובדים כמסמכים.
CHUNKS	המסמכים מומרים לחלקים.

DataStoreSettings

הגדרות שקשורות למאגר הנתונים של האפליקציה.

שדות
engines[]	DataStoreSettings.Engine פלט בלבד. המנועים של האפליקציה.

מנוע

מנוע שמאגרי הנתונים מחוברים אליו. מידע נוסף על חיפוש מבוסס-Vertex AI: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

שדות
name	string פלט בלבד. שם המשאב של המנוע. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type פלט בלבד. סוג המנוע.

סוג

סוג המנוע. מידע נוסף זמין במסמכים בכתובות https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType ו-https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED	סוג המנוע לא צוין.
ENGINE_TYPE_SEARCH	מנוע SOLUTION_TYPE_SEARCH לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה.
ENGINE_TYPE_CHAT	סוג מנוע הצ'אט. מנוע SOLUTION_TYPE_CHAT לאפליקציה. כל מאגרי הנתונים של המחברים שנוספו לאפליקציה יתווספו למנוע הזה.

DataStoreTool

כלי לאחזור נתונים ממאגר נתונים או ממנוע של חיפוש מבוסס-Vertex AI לצורך ביסוס. אפשר להזין מאגר נתונים או מנוע, אבל לא את שניהם. מידע נוסף על חיפוש מבוסס-Vertex AI: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

שדות
name	string חובה. השם של כלי מאגר הנתונים.
description	string זה שינוי אופציונלי. תיאור הכלי.
boost_specs[]	DataStoreTool.BoostSpecs זה שינוי אופציונלי. הגדרת חיזוק כדי לחזק מסמכים מסוימים.
modality_configs[]	DataStoreTool.ModalityConfig זה שינוי אופציונלי. הגדרות המודאליות של מאגר הנתונים.
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior זה שינוי אופציונלי. התנהגות פרמטר המסנן.
שדה איחוד search_source. הגדרה של מקור החיפוש, יכול להיות מאגר נתונים יחיד או מנוע. הערך search_source יכול להיות רק אחד מהבאים:
data_store_source	DataStoreTool.DataStoreSource זה שינוי אופציונלי. חיפוש ב-DataStore ספציפי.
engine_source	DataStoreTool.EngineSource זה שינוי אופציונלי. חיפוש בתוך מנוע (יכול להיות בכמה מאגרי נתונים).

BoostSpec

הגדרת חיזוק כדי לחזק מסמכים מסוימים.

שדות
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec חובה. רשימה של מפרטי הגברה.

ConditionBoostSpec

הגדרת חיזוק לתנאי.

שדות
condition	string חובה. ביטוי שמציין תנאי להגברת החשיפה. התחביר זהה לתחביר של ביטויי סינון. בשלב הזה, התנאי היחיד שנתמך הוא רשימה של קודי שפה לפי BCP-47. דוגמה: כדי לשפר את ההצעות בשפות en או fr: ‏(lang_code: ANY("en", "fr"))
boost	float זה שינוי אופציונלי. עוצמת ההגברה, שצריכה להיות בטווח [‎-1, 1]. הגברה שלילית פירושה הורדה בדרגה. ברירת המחדל היא 0.0. הגדרה של 1.0 מעניקה להצעות קידום משמעותי. עם זאת, זה לא אומר בהכרח שהתוצאה הראשונה תהיה הצעה משופרת. הגדרה של ‎-1.0 גורמת להורדה משמעותית של ההצעות. עם זאת, יכול להיות שעדיין יוצגו הצעות רלוונטיות אחרות. הגדרה של 0.0 פירושה שלא מוחל שיפור. המערכת מתעלמת מתנאי ההדגשה.
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec זה שינוי אופציונלי. מפרט מורכב לדירוג מותאם אישית על סמך ערך מאפיין שהוגדר על ידי הלקוח.

BoostControlSpec

מפרט לדירוג מותאם אישית על סמך ערך מאפיין שצוין על ידי הלקוח. הוא מספק יותר אמצעי בקרה לדירוג מותאם אישית מאשר השילוב הפשוט (תנאי, הגדלה) שלמעלה.

שדות
field_name	string זה שינוי אופציונלי. השם של השדה שהערך שלו ישמש לקביעת סכום ההגדלה.
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType זה שינוי אופציונלי. סוג המאפיין שמשמש לקביעת סכום ההגדלה. אפשר לגזור את ערך המאפיין מערך השדה של field_name שצוין. במקרה של ערך מספרי, זה פשוט: attribute_value = numerical_field_value. במקרה של טריות, attribute_value = (time.now() - datetime_field_value).
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType זה שינוי אופציונלי. סוג האינטרפולציה שיש להחיל כדי לחבר את נקודות הבקרה שמפורטות בהמשך.
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint זה שינוי אופציונלי. נקודות הבקרה שמשמשות להגדרת העקומה. הפונקציה המונוטונית (מוגדרת באמצעות interpolation_type שלמעלה) עוברת דרך נקודות הבקרה שמפורטות כאן.

AttributeType

המאפיין(או הפונקציה) שעליו יחול הדירוג המותאם אישית.

טיפוסים בני מנייה (enum)
ATTRIBUTE_TYPE_UNSPECIFIED	סוג מאפיין לא צוין.
NUMERICAL	הערך של השדה המספרי ישמש לעדכון דינמי של סכום ההגדלה. במקרה כזה, ערך המאפיין (ערך x) של נקודת הבקרה יהיה הערך בפועל של השדה המספרי שצוין עבורו boost_amount.
FRESHNESS	במקרה השימוש של רעננות, ערך המאפיין יהיה משך הזמן שעבר בין השעה הנוכחית לבין התאריך בשדה התאריך והשעה שצוין. הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן לפי ISO 8601). הדפוס של זה הוא: [nD][T[nH][nM][nS]]. לדוגמה: 5D, ‏ 3DT12H30M, ‏ T24H.

ControlPoint

נקודות הבקרה שמשמשות להגדרת העקומה. העקומה שמוגדרת באמצעות נקודות הבקרה האלה יכולה להיות רק עולה או יורדת(ערכים קבועים הם אפשריים).

שדות
attribute_value	string זה שינוי אופציונלי. יכול להיות אחד מהערכים הבאים: 1. הערך המספרי של השדה. 2. מפרט משך הזמן של הטריות: הערך צריך להיות בפורמט של ערך XSD dayTimeDuration (קבוצת משנה מוגבלת של ערך משך זמן בפורמט ISO 8601). הדפוס של זה הוא: [nD][T[nH][nM][nS]].
boost_amount	float זה שינוי אופציונלי. הערך בין ‎-1 ל-1 שבו יש להגדיל את הניקוד אם הערך של attribute_value שווה לערך שצוין למעלה.

InterpolationType

סוג האינטרפולציה שרוצים להחיל. ברירת המחדל תהיה לינארית (Piecewise Linear).

טיפוסים בני מנייה (enum)
INTERPOLATION_TYPE_UNSPECIFIED	לא צוין סוג האינטרפולציה. במקרה כזה, ברירת המחדל היא לינארית.
LINEAR	תופעל אינטרפולציה ליניארית מקטע לקטע.

BoostSpecs

מגדירים מפרטים לחיזוק כדי לחזק מסמכים מסוימים. מידע נוסף זמין בכתובת https://cloud.google.com/generative-ai-app-builder/docs/boosting.

שדות
data_stores[]	string חובה. מאגר הנתונים שבו מוחלת הגדרת ההגברה. השם המלא של משאב DataStore, למשל projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]	DataStoreTool.BoostSpec חובה. רשימה של מפרטי הגברה.

DataStoreSource

הגדרה של חיפוש ב-DataStore ספציפי.

שדות
filter	string זה שינוי אופציונלי. מפרט הסינון של מאגר הנתונים. מידע נוסף מופיע כאן: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore זה שינוי אופציונלי. מאגר הנתונים.

EngineSource

הגדרה של חיפוש בתוך מנוע, עם אפשרות לטרגוט מאגרי נתונים ספציפיים.

שדות
engine	string חובה. השם המלא של המשאב של המנוע. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource זה שינוי אופציונלי. השימוש הוא לטירגוט מאגרי נתונים ספציפיים במנוע. אם לא תציינו ערך בשדה הזה, החיפוש יחול על כל מאגרי הנתונים שמשויכים למנוע.
filter	string זה שינוי אופציונלי. מסנן שמוחל על החיפוש במנוע. לא רלוונטי ולא בשימוש אם מצוין הערך 'data_store_sources'. מידע נוסף מופיע כאן: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

התנהגות של פרמטר סינון.

טיפוסים בני מנייה (enum)
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	התנהגות ברירת המחדל של המסנן. כוללים פרמטר של מסנן במאגרי נתונים של מחברים. בשאר סוגי מאגרי הנתונים, פרמטר הקלט של המסנן מושמט.
ALWAYS_INCLUDE	תמיד צריך לכלול פרמטר של מסנן לכל סוגי מאגרי הנתונים.
NEVER_INCLUDE	פרמטר הסינון אף פעם לא נכלל ברשימת הפרמטרים של הכלי, ללא קשר לסוג מאגר הנתונים.

GroundingConfig

הגדרת ההארקה.

שדות
grounding_level	float זה שינוי אופציונלי. סף ההצמדה של התשובה למקורות שאוחזרו. הערך יכול להיות בין 1 ל-5. הרמה משמשת להגדרת סף למידת העיגון של התשובה, כלומר כל התשובות עם ציון עיגון מתחת לסף יחזרו להחזרת קטעי מידע רלוונטיים בלבד. לדוגמה, רמה 3 אומרת שציון ההתבססות על מקורות צריך להיות 3 ומעלה כדי שהתשובה תוחזר.
disabled	bool זה שינוי אופציונלי. האם ההארקה מושבתת.

ModalityConfig

אם מציינים ערך, המערכת תחיל את ההגדרה שצוינה על האופן שצוין.

שדות
modality_type	DataStoreTool.ModalityConfig.ModalityType חובה. סוג האמצעי.
rewriter_config	DataStoreTool.RewriterConfig זה שינוי אופציונלי. הגדרות הכתיבה מחדש.
summarization_config	DataStoreTool.SummarizationConfig זה שינוי אופציונלי. הגדרת הסיכום.
grounding_config	DataStoreTool.GroundingConfig זה שינוי אופציונלי. הגדרת ההארקה.
snippets_config	DataStoreTool.SnippetsConfig זה שינוי אופציונלי. הגדרות של קטעי קוד.

ModalityType

סוג האופן.

טיפוסים בני מנייה (enum)
MODALITY_TYPE_UNSPECIFIED	סוג המודאליות לא צוין.
TEXT	אופן הצגת הטקסט.
AUDIO	שיטת אודיו.

RewriterConfig

הגדרות של כלי השכתוב.

שדות
model_settings	ModelSettings חובה. הגדרות למודל ה-LLM.
prompt	string זה שינוי אופציונלי. הגדרת ההנחיה. אם לא מגדירים את ההנחיה, המערכת תשתמש בהנחיית ברירת המחדל.
disabled	bool זה שינוי אופציונלי. האם הכתיבה מחדש מושבתת.

SnippetsConfig

הגדרת קטעי קוד.

שדות
enable_snippets	bool זה שינוי אופציונלי. האם הפעלתם נכסי מידע מובנה מהאתר.
max_snippets	int32 זה שינוי אופציונלי. מספר התקצירים שיוחזרו לכל שאילתה. אם לא מוגדר, מחזיר כברירת מחדל את כל הקטעים מהשירות.

SummarizationConfig

הגדרת סיכומים.

שדות
model_settings	ModelSettings זה שינוי אופציונלי. הגדרות למודל ה-LLM.
prompt	string זה שינוי אופציונלי. הגדרת ההנחיה. אם לא מגדירים את ההנחיה, המערכת תשתמש בהנחיית ברירת המחדל.
disabled	bool זה שינוי אופציונלי. האם הסיכום מושבת.

DeleteAgentRequest

בקשת הודעה עבור AgentService.DeleteAgent.

שדות
name	string חובה. שם המשאב של הסוכן שרוצים למחוק.
force	bool זה שינוי אופציונלי. מציין אם למחוק את הסוכן בכוח, גם אם עדיין יש הפניות אליו באפליקציות, בסוכנים או בדוגמאות אחרות. אם force = false, המחיקה נכשלת אם סוכנים או דוגמאות אחרים מפנים אליו. אם force = true, מוחקים את הסוכן ומסירים אותו מכל האפליקציות, הסוכנים או הדוגמאות שמפנים אליו.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של הסוכן. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים תג etag והוא לא תואם לתג etag הנוכחי של הסוכן, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteAppRequest

בקשת הודעה עבור AgentService.DeleteApp.

שדות
name	string חובה. שם המשאב של האפליקציה שרוצים למחוק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של האפליקציה. אם לא מציינים etag, המחיקה תדרוס שינויים מקבילים. אם מציינים תג etag שלא תואם לתג etag הנוכחי של האפליקציה, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteAppVersionRequest

בקשת הודעה עבור AgentService.DeleteAppVersion.

שדות
name	string חובה. שם המשאב של גרסת האפליקציה שרוצים למחוק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של גרסת האפליקציה. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים etag שלא תואם ל-etag הנוכחי של גרסת האפליקציה, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteConversationRequest

בקשת הודעה עבור AgentService.DeleteConversation.

שדות
name	string חובה. שם המשאב של השיחה שרוצים למחוק.
source (deprecated)	Conversation.Source הפריט הזה הוצא משימוש. זה שינוי אופציונלי. מציינים את מקור השיחה. אם לא מגדירים את המדיניות, המערכת תשתמש ב-Source.Live כברירת מחדל.

DeleteDeploymentRequest

בקשת הודעה עבור AgentService.DeleteDeployment.

שדות
name	string חובה. שם הפריסה שרוצים למחוק. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string זה שינוי אופציונלי. תג ה-etag של הפריסה. אם מציינים etag שלא תואם ל-etag הנוכחי של הפריסה, המחיקה תיחסם ותוחזר שגיאה מסוג ABORTED.

DeleteExampleRequest

בקשת הודעה עבור AgentService.DeleteExample.

שדות
name	string חובה. שם המשאב של הדוגמה שרוצים למחוק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של הדוגמה. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים תג etag והוא לא תואם לתג etag הנוכחי של הדוגמה, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteGuardrailRequest

בקשת הודעה עבור AgentService.DeleteGuardrail.

שדות
name	string חובה. שם המשאב של אמצעי הבקרה שרוצים למחוק.
force	bool זה שינוי אופציונלי. מציין אם למחוק בכוח את אמצעי הבקרה, גם אם עדיין יש הפניה אליו באפליקציה או בסוכנים. אם force = false, המחיקה תיכשל אם יש עדיין אפליקציות או סוכנים שמפנים למגבלת השימוש. אם force = true, כל ההפניות הקיימות מאפליקציות/סוכנים יוסרו והגדרת אמצעי הבקרה תימחק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של אמצעי הבקרה. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים etag שלא תואם ל-etag הנוכחי של אמצעי הבקרה, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteToolRequest

בקשת הודעה עבור AgentService.DeleteTool.

שדות
name	string חובה. שם המשאב של הכלי שרוצים למחוק.
force	bool זה שינוי אופציונלי. מציין אם למחוק את הכלי בכוח, גם אם עדיין יש הפניות אליו על ידי סוכנים או דוגמאות. אם force = false, המחיקה תיכשל אם יש עדיין סוכנים שמפנים לכלי. אם force = true, כל ההפניות הקיימות של הסוכנים יוסרו והכלי יימחק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של הכלי. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים תג etag שלא תואם לתג הנוכחי של הכלי, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeleteToolsetRequest

בקשת הודעה עבור AgentService.DeleteToolset.

שדות
name	string חובה. שם המשאב של ערכת הכלים שרוצים למחוק.
force	bool זה שינוי אופציונלי. מציין אם למחוק את ערכת הכלים בכוח, גם אם עדיין יש הפניות אליה באפליקציה או בסוכנים. אם force = false, המחיקה נכשלת אם יש סוכנים שעדיין מפנים לערכת הכלים. אם force = true, כל ההפניות הקיימות מסוכנים יוסרו וערכת הכלים תימחק.
etag	string זה שינוי אופציונלי. ה-etag הנוכחי של ערכת הכלים. אם לא מציינים etag, המחיקה תחליף את כל השינויים שמתבצעים בו-זמנית. אם מציינים תג etag שלא תואם לתג etag הנוכחי של ערכת הכלים, המחיקה תיחסם ותוחזר שגיאת ABORTED.

DeployChannelResponse

הודעת תגובה ל-AgentService.DeployChannel.

שדות
deployment	Deployment הפריסה שנוצרה.

פריסה

פריסה מייצגת גרסה של האפליקציה שלא ניתן לשנות, שאפשר להריץ עליה שאילתות. היא משמשת לפריסת גרסה של האפליקציה עם פרופיל ערוץ ספציפי.

שדות
name	string מזהה. שם המשאב של הפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string חובה. השם המוצג של הפריסה.
app_version	string זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה שרוצים לפרוס. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version} משתמשים ב-projects/{project}/locations/{location}/apps/{app}/versions/- כדי להשתמש באפליקציה בטיוטה.
channel_profile	ChannelProfile חובה. פרופיל הערוץ שבו נעשה שימוש בהטמעה.
create_time	Timestamp פלט בלבד. חותמת זמן של מועד היצירה של הפריסה הזו.
update_time	Timestamp פלט בלבד. חותמת הזמן של העדכון האחרון של הפריסה הזו.
etag	string פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
experiment_config	ExperimentConfig זה שינוי אופציונלי. הגדרת הניסוי לפריסה.
whatsapp_credentials	WhatsAppCredentials זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ וואטסאפ, צריך להזין פרטי כניסה זמניים לוואטסאפ.
instagram_credentials	InstagramCredentials זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל ערוץ באינסטגרם, צריך להזין פרטי כניסה זמניים לאינסטגרם.
model_settings	ModelSettings זה שינוי אופציונלי. הגדרות המודל לפריסה. ההגדרה הזו מחליפה את הגדרות המודל שהוגדרו ברמת האפליקציה או הסוכן. הערה: כדי לבטל את הגדרות המודל ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS.
modality	Deployment.Modality זה שינוי אופציונלי. אופן הפריסה. הערה: כדי להשתמש בהחלפת מודאליות ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS.
agent_registry_deployment	AgentRegistryDeployment זה שינוי אופציונלי. הגדרה לפריסת הפריסה הזו ב-Agent Registry. אם יש פריסה כזו, היא תפורסם ב-Agent Registry.

מודליות

אופן הפריסה.

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED	אמצעי לא ידוע.
MODALITY_TEXT	אופן הצגת הטקסט.
MODALITY_VOICE	אמצעי תקשורת קולי.
MODALITY_VIDEO	שיטת הצגת הסרטון.

EndSession

מציין שהסשן הסתיים, בגלל השלמה מוצלחת (לדוגמה, המשתמש אומר "להתראות!" ) או להעביר את השיחה לטיפול ברמה גבוהה יותר.

הסוכן לא יעבד יותר קלט אחרי שהסשן יסתיים, והלקוח צריך לסגור את החיבור ולנתק אותו אחרי שהוא יקבל את כל התשובות שנותרו מהסוכן.

שדות
metadata	Struct זה שינוי אופציונלי. מספק מידע נוסף על אות סיום הסשן, כמו הסיבה לסיום הסשן.

EndUserAuthConfig

הגדרת אימות משתמש הקצה שמשמשת לשיחות חיבור. הערכים בשדה צריכים להיות השמות של משתני ההקשר בפורמט $context.variables.<name_of_variable>.

שדות
שדה איחוד auth_config. הגדרת האימות. הערך auth_config יכול להיות רק אחד מהבאים:
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig אימות באמצעות קוד הרשאה של Oauth 2.0.
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig אימות JWT Profile Oauth 2.0 Authorization Grant.

Oauth2AuthCodeConfig

הגדרת אימות של קוד הרשאה ב-OAuth 2.0.

שדות
oauth_token	string חובה. שם הפרמטר של טוקן OAuth להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

הגדרת אימות של הרשאת גישה ל-OAuth 2.0 בפרופיל JWT.

שדות
issuer	string חובה. שם הפרמטר של המנפיק שרוצים להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.
subject	string חובה. שם הפרמטר של הנושא להעברה. חייב להיות בפורמט $context.variables.<name_of_variable>.
client_key	string חובה. שם הפרמטר של הלקוח שרוצים להעביר. חייב להיות בפורמט $context.variables.<name_of_variable>.

EndpointControlPolicy

מגדירה מדיניות לבקרת נקודות קצה ברמת הפרויקט או המיקום.

שדות
enforcement_scope	EndpointControlPolicy.EnforcementScope זה שינוי אופציונלי. ההיקף שבו רשימת המקורות המותרים של המדיניות הזו נאכפת.
allowed_origins[]	string זה שינוי אופציונלי. מקורות HTTP(s) מותרים שהכלים באפליקציה יכולים להפעיל ישירות. האכיפה תלויה בערך של enforcement_scope ובסטטוס של VPC-SC בפרויקט. אם לא מציינים מספר יציאה, כל היציאות מורשות. אחרת, מספר הניוד חייב להיות זהה בדיוק. לדוגמה, המחרוזת 'https://example.com' תתאים למחרוזת 'https://example.com:443' ולכל יציאה אחרת. הכתובת https://example.com:443 תתאים רק לכתובת https://example.com:443.

EnforcementScope

ההגדרה הזו מגדירה את ההיקף שבו רשימת המקורות המותרים של המדיניות הזו נאכפת.

טיפוסים בני מנייה (enum)
ENFORCEMENT_SCOPE_UNSPECIFIED	לא צוין. המדיניות הזו תטופל כ-VPCSC_ONLY.
VPCSC_ONLY	המדיניות הזו חלה רק כשהתכונה VPC-SC פעילה.
ALWAYS	המדיניות הזו חלה תמיד, ללא קשר לסטטוס של VPC-SC.

ErrorHandlingSettings

הגדרות שמתארות איך לטפל בשגיאות באפליקציה.

שדות
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy זה שינוי אופציונלי. האסטרטגיה שבה רוצים להשתמש לטיפול בשגיאות.
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig זה שינוי אופציונלי. הגדרות לטיפול בתשובות חלופיות.
end_session_config	ErrorHandlingSettings.EndSessionConfig זה שינוי אופציונלי. הגדרה לסיום הסשן במקרה של שגיאות מערכת (למשל שגיאות LLM).

EndSessionConfig

הגדרה לסיום הסשן במקרה של שגיאות מערכת (למשל שגיאות LLM).

שדות
escalate_session	bool זה שינוי אופציונלי. האם להעביר את הסשן לטיפול ברמה גבוהה יותר ב-EndSession. אם הסשן מועבר לטיפול ברמה גבוהה יותר, metadata in EndSession יכיל את הערך session_escalated = true. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ErrorHandlingStrategy

הגדרת האסטרטגיה לטיפול בשגיאות.

טיפוסים בני מנייה (enum)
ERROR_HANDLING_STRATEGY_UNSPECIFIED	שיטת טיפול בשגיאות לא מזוהה.
NONE	לא מופעל טיפול ספציפי.
FALLBACK_RESPONSE	אם יש שגיאות במערכת (למשל שגיאות ב-LLM), המשתמש יקבל הודעת גיבוי.
END_SESSION	במקרה של שגיאות מערכת (למשל שגיאות LLM), ייפלט אות EndSession.

FallbackResponseConfig

הגדרות לטיפול בתשובות חלופיות.

שדות
custom_fallback_messages	map<string, string> זה שינוי אופציונלי. הודעות הגיבוי במקרה של שגיאות מערכת (למשל שגיאות LLM), ממופות לפי קוד שפה נתמך.
max_fallback_attempts	int32 זה שינוי אופציונלי. מספר הניסיונות המקסימלי לגיבוי לפני שהסוכן ישדר את האות EndSession.

EvaluationMetricsThresholds

הגדרות סף למדדים בהערכה.

שדות
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים.
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior הפריט הזה הוצא משימוש. זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב-golden_hallucination_metric_behavior. ההתנהגות של מדד ההזיות משמשת כרגע להערכות מוזהבות.
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות מוזהבות.
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות של תרחישים.

GoldenEvaluationMetricsThresholds

הגדרות להערכות מוזהבות.

שדות
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור.
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds זה שינוי אופציונלי. ערכי הסף של מדדי רמת הציפייה.
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת.

ExpectationLevelMetricsThresholds

ערכי הסף של מדדים ברמת הציפייה.

שדות
tool_invocation_parameter_correctness_threshold	float זה שינוי אופציונלי. סף ההצלחה לפרמטרים של הפעלת כלי ספציפיים. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0.

TurnLevelMetricsThresholds

הפעלת ערכי סף של מדדים ברמת הקמפיין.

שדות
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel זה שינוי אופציונלי. הערוץ של הדמיון הסמנטי שבו רוצים להשתמש לצורך הערכה.
semantic_similarity_success_threshold	int32 זה שינוי אופציונלי. סף ההצלחה לדמיון סמנטי. הערך צריך להיות מספר שלם בין 0 ל-4. ברירת המחדל היא >= 3.
overall_tool_invocation_correctness_threshold	float זה שינוי אופציונלי. סף ההצלחה לדיוק הכולל של הפעלת הכלי. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0.

SemanticSimilarityChannel

הערוץ שבו רוצים להשתמש כדי למצוא דמיון סמנטי.

טיפוסים בני מנייה (enum)
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	לא צוין מדד. ברירת המחדל היא TEXT.
TEXT	שימוש בדמיון סמנטי בין טקסטים.
AUDIO	שימוש בדמיון סמנטי של אודיו.

HallucinationMetricBehavior

ההתנהגות של מדד ההזיות. ללא קשר להתנהגות, המדד תמיד יחושב. ההבדל הוא שכשהמדד מושבת, הוא לא משמש לחישוב ציון ההערכה הכולל.

טיפוסים בני מנייה (enum)
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	התנהגות לא מוגדרת של מדד הזיות.
DISABLED	השבתת מדד ההזיות.
ENABLED	הפעלת מדד ההזיות.

ToolMatchingSettings

הגדרות להתאמת שיחות עם כלי.

שדות
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior זה שינוי אופציונלי. התנהגות של קריאות נוספות לכלים. ברירת המחדל היא FAIL.

ExtraToolCallBehavior

הגדרת ההתנהגות כשנתקלים בקריאה נוספת לכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת.

טיפוסים בני מנייה (enum)
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	התנהגות לא מוגדרת. ברירת המחדל היא FAIL.
FAIL	הבדיקה תיכשל אם תזוהה קריאה נוספת לכלי.
ALLOW	מאשרים את השימוש בכלי הנוסף.

אירוע

קלט האירוע.

שדות
event	string חובה. שם האירוע.
variables	Struct זה שינוי אופציונלי. משתנים נוספים שמשויכים לאירוע.

דוגמה

דוגמה מייצגת שיחה לדוגמה בין המשתמש לבין הסוכן או הסוכנים.

שדות
name	string מזהה. המזהה הייחודי של הדוגמה. פורמט: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string חובה. השם המוצג של הדוגמה.
description	string זה שינוי אופציונלי. תיאור קריא של הדוגמה.
entry_agent	string זה שינוי אופציונלי. הסוכן שמטפל בשיחה בהתחלה. אם לא מציינים סוכן, הדוגמה מייצגת שיחה שמטופלת על ידי סוכן הבסיס. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message זה שינוי אופציונלי. אוסף ההודעות שמרכיבות את השיחה.
create_time	Timestamp פלט בלבד. חותמת הזמן שבה הדוגמה נוצרה.
update_time	Timestamp פלט בלבד. חותמת הזמן של העדכון האחרון של הדוגמה.
invalid	bool פלט בלבד. יכול להיות שהדוגמה תהפוך ללא תקפה אם משאבים שמפנים אליה יימחקו. דוגמאות לא תקינות לא ישמשו כדוגמאות לפרומפט עם כמה דוגמאות (few-shot).
etag	string תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.

ExecuteToolRequest

בקשת הודעה עבור ToolService.ExecuteTool.

שדות
parent	string חובה. שם המשאב של האפליקציה שאליה שייך הכלי או ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}
args	Struct זה שינוי אופציונלי. פרמטרי הקלט והערכים של הכלי בפורמט אובייקט JSON.
mock_config	MockConfig זה שינוי אופציונלי. הגדרת מוקאפ להפעלת הכלי. אם השדה הזה מוגדר, כלים שמפעילים כלים אחרים יקבלו תשובות מדומה על סמך הדפוסים והתשובות שסופקו.
שדה איחוד tool_identifier. המזהה של הכלי להפעלה. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string זה שינוי אופציונלי. שם הכלי להפעלה. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool זה שינוי אופציונלי. הכלי להרצה מתוך ערכת הכלים. רק כלי אחד צריך להתאים לפרדיקט מתוך ערכת הכלים. אחרת, תוחזר שגיאה.
שדה איחוד tool_execution_context. ההקשר הנוסף שצריך לספק להפעלת הכלי tool_execution_context יכול להיות רק אחד מהבאים:
variables	Struct זה שינוי אופציונלי. המשתנים שזמינים להרצת הכלי.
context	Struct זה שינוי אופציונלי. [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment לפרטים) שיועבר לכלי Python.

ExecuteToolResponse

הודעת תגובה ל-ToolService.ExecuteTool.

שדות
response	Struct תוצאת ההפעלה של הכלי בפורמט אובייקט JSON. משתמשים במפתח 'output' כדי לציין את התגובה של הכלי ובמפתח 'error' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות output ו-error, כל התגובה נחשבת לתוצאת ההפעלה של הכלי.
variables	Struct ערכי המשתנים בסיום ההרצה של הכלי.
citations	Citations ציטוטים שמספקים את פרטי המקור של הפעלת הכלי.
google_search_suggestions	GoogleSearchSuggestions ההצעות שמוחזרות מחיפוש Google כתוצאה מהפעלת הכלי 'חיפוש Google' במהלך ההרצה של הכלי.
שדה איחוד tool_identifier. המזהה של הכלי שהופעל. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string שם הכלי שהופעל. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool הכלי בערכת הכלים שהופעל.

ExecutionType

סוג הביצוע של הכלי או של ערכת הכלים.

טיפוסים בני מנייה (enum)
EXECUTION_TYPE_UNSPECIFIED	לא צוין סוג ההפעלה. אם לא מציינים ערך, ברירת המחדל היא SYNCHRONOUS.
SYNCHRONOUS	הכלי מופעל באופן סינכרוני. הסשן נחסם עד שהכלי חוזר.
ASYNCHRONOUS	הכלי מופעל באופן אסינכרוני. הסשן ימשיך בזמן שהכלי יפעל.

ExperimentConfig

ניסוי לפריסה.

שדות
version_release	ExperimentConfig.VersionRelease זה שינוי אופציונלי. גרסת הפרסום של הניסוי.

מדינה

מצב הניסוי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED	מצב לא מוגדר.
PENDING	הוצא משימוש: המצב הזה כבר לא בשימוש.
RUNNING	מצב הפעלה. הניסוי פועל ותקף.
DONE	הוצא משימוש: המצב הזה כבר לא בשימוש.
EXPIRED	הוצא משימוש: המצב הזה כבר לא בשימוש.

VersionRelease

גרסת הפרסום של הניסוי.

שדות
state	ExperimentConfig.State זה שינוי אופציונלי. המצב של פרסום הגרסה.
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation זה שינוי אופציונלי. הקצאות תנועה לגרסת ההפצה.

TrafficAllocation

הקצאת תנועה לגרסת ההפצה.

שדות
id	string זה שינוי אופציונלי. המזהה של הקצאת התנועה. מחרוזת בפורמט חופשי, עד 128 תווים.
traffic_percentage	int32 זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. הערך צריך להיות בין 0 ל-100.
app_version	string זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

בקשת הודעה עבור AgentService.ExportApp.

שדות
name	string חובה. שם המשאב של האפליקציה לייצוא.
export_format	ExportAppRequest.ExportFormat חובה. הפורמט לייצוא האפליקציה.
gcs_uri	string זה שינוי אופציונלי. מזהה ה-URI של Google Cloud Storage שאליו רוצים לייצא את האפליקציה. הפורמט של מזהה ה-URI הזה צריך להיות gs://<bucket-name>/<object-name>. ארכיון האפליקציה המיוצא ייכתב ישירות לאובייקט GCS שצוין.
app_version	string זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה לייצוא. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportFormat

פורמט הייצוא של האפליקציה.

טיפוסים בני מנייה (enum)
EXPORT_FORMAT_UNSPECIFIED	לא צוין פורמט ייצוא.
JSON	פורמט הייצוא הוא JSON.
YAML	פורמט הייצוא הוא YAML.

ExportAppResponse

הודעת תגובה ל-AgentService.ExportApp.

שדות
שדה איחוד app. האפליקציה המיוצאת. הערך app יכול להיות רק אחד מהבאים:
app_content	bytes תיקיית האפליקציה דחוסה כקובץ ZIP.
app_uri	string ה-URI של Google Cloud Storage שאליו יוצאה האפליקציה.

ExpressionCondition

תנאי ביטוי שמבוסס על מצב הסשן.

שדות
expression	string חובה. ייצוג המחרוזת של התנאי cloud.api.Expression.

FileSearchTool

כלי החיפוש בקבצים מאפשר לסוכן לחפש בקבצים שהועלו על ידי מפתח האפליקציה או הסוכן. יש לו הגדרות קבועות מראש שמאפשרות חיפוש באיכות טובה יחסית בקבצים שהועלו וסיכום של התוצאות שאותרו.

שדות
corpus_type	FileSearchTool.CorpusType זה שינוי אופציונלי. סוג המאגר. ברירת המחדל היא FULLY_MANAGED.
name	string חובה. שם הכלי.
description	string זה שינוי אופציונלי. תיאור הכלי.
file_corpus	string זה שינוי אופציונלי. מאגר המידע שבו הקבצים מאוחסנים. פורמט: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

סוג המאגר של Vertex RAG.

טיפוסים בני מנייה (enum)
CORPUS_TYPE_UNSPECIFIED	סוג הקורפוס לא צוין.
USER_OWNED	המאגר נוצר על ידי המשתמש והוא הבעלים שלו.
FULLY_MANAGED	המאגר נוצר על ידי הסוכן.

GenerateChatTokenRequest

בקשת הודעה עבור WidgetService.GenerateChatToken.

שדות
name	string חובה. שם הסשן ליצירת טוקן הצ'אט. פורמט: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string חובה. הפריסה של האפליקציה שבה נעשה שימוש בסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string זה שינוי אופציונלי. טוקן reCAPTCHA שנוצר על ידי ווידג'ט הצ'אט בצד הלקוח.
live_handoff_enabled	bool זה שינוי אופציונלי. השדה הזה מציין אם העברה חיה מופעלת בסשן.

GenerateChatTokenResponse

הודעת תגובה ל-WidgetService.GenerateChatToken.

שדות
chat_token	string הטוקן בהיקף הסשן לווידג'ט הצ'אט לצורך אימות באמצעות ממשקי API של סשנים.
expire_time	Timestamp השעה שבה פג תוקף אסימון הצ'אט.

GetAgentRequest

בקשת הודעה עבור AgentService.GetAgent.

שדות
name	string חובה. שם המשאב של הסוכן לאחזור.

GetAppRequest

בקשת הודעה עבור AgentService.GetApp.

שדות
name	string חובה. שם המשאב של האפליקציה שרוצים לאחזר.

GetAppVersionRequest

בקשת הודעה עבור AgentService.GetAppVersion.

שדות
name	string חובה. שם המשאב של גרסת האפליקציה שרוצים לאחזר.

GetChangelogRequest

בקשת הודעה עבור AgentService.GetChangelog.

שדות
name	string חובה. שם המשאב של יומן השינויים שיש לאחזר.

GetConversationRequest

בקשת הודעה עבור AgentService.GetConversation.

שדות
name	string חובה. שם המשאב של השיחה שרוצים לאחזר.
source (deprecated)	Conversation.Source הפריט הזה הוצא משימוש. זה שינוי אופציונלי. מציינים את מקור השיחה. אם לא מוגדרים מקורות, החיפוש יתבצע בכל המקורות.

GetDeploymentRequest

בקשת הודעה עבור AgentService.GetDeployment.

שדות
name	string חובה. שם הפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

בקשת הודעה עבור AgentService.GetExample.

שדות
name	string חובה. שם המשאב של הדוגמה לאחזור.

GetGuardrailRequest

בקשת הודעה עבור AgentService.GetGuardrail.

שדות
name	string חובה. שם המשאב של אמצעי הבקרה שרוצים לאחזר.

GetToolRequest

בקשת הודעה עבור AgentService.GetTool.

שדות
name	string חובה. שם המשאב של הכלי לאחזור.

GetToolsetRequest

בקשת הודעה עבור AgentService.GetToolset.

שדות
name	string חובה. שם המשאב של ערכת הכלים לאחזור.

GoAway

בסוג הזה אין שדות.

הודעה שהשרת יתנתק בקרוב והלקוח צריך לסגור את החיבור באופן חלקי ולהפעיל אותו מחדש.

GoogleSearchSuggestions

הצעות לחיפוש מ-Google Search Tool.

שדות
htmls[]	string סגנון תואם של HTML ו-CSS להצעות לחיפוש. קוד ה-HTML וה-CSS שסופק מותאם אוטומטית להגדרות המכשיר, ומוצג במצב בהיר או כהה בהתאם לסימן @media(prefers-color-scheme).
web_search_queries[]	WebSearchQuery רשימה של שאילתות ששימשו לביצוע החיפוש ב-Google, יחד עם מזהי ה-URI של תוצאות החיפוש שמהן נוצרות הצעות החיפוש.

GoogleSearchTool

מייצג כלי לביצוע חיפושים באינטרנט של Google לצורך עיגון. מידע נוסף מופיע כאן: https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

שדות
name	string חובה. שם הכלי.
description	string זה שינוי אופציונלי. תיאור של מטרת הכלי.
context_urls[]	string זה שינוי אופציונלי. התוכן יאוחזר ישירות מכתובות ה-URL האלה כדי לספק הקשר וביסוס. דוגמה: "https://example.com/path.html". אפשר להוסיף עד 20 כתובות URL.
preferred_domains[]	string זה שינוי אופציונלי. מציינים דומיינים להגבלת תוצאות החיפוש. לדוגמה: example.com,‏ another.site. אפשר לציין עד 20 דומיינים.
exclude_domains[]	string זה שינוי אופציונלי. רשימת דומיינים שיוחרגו מתוצאות החיפוש. לדוגמה: example.com. אפשר להחריג עד 2,000 דומיינים.
prompt_config	GoogleSearchTool.PromptConfig זה שינוי אופציונלי. הוראות לפרומפט שמועברות לכלי לתכנון לגבי אופן העיבוד של תוצאות החיפוש לטקסט ולקול.

PromptConfig

הגדרות ההנחיה שבהן נעשה שימוש על ידי המודל כשמעבדים או מסכמים את תוצאות החיפוש ב-Google.

שדות
text_prompt	string זה שינוי אופציונלי. ההגדרה הזו מגדירה את הפרומפט שמשמש להוראות המערכת כשמנהלים שיחות בצ'אט עם הסוכן. אם לא מגדירים את ההנחיה, המערכת תשתמש בהנחיית ברירת המחדל.
voice_prompt	string זה שינוי אופציונלי. ההגדרה הזו מגדירה את הפרומפט שמשמש להוראות המערכת כשמנהלים שיחות קוליות עם הסוכן. אם לא מגדירים את ההנחיה, המערכת תשתמש בהנחיית ברירת המחדל.

שכבת הגנה

הגדרת אמצעי בקרה כוללת רשימה של בדיקות ואיזונים כדי לשמור על בטיחות ועל אבטחה של הסוכנים.

שדות
name	string מזהה. המזהה הייחודי של אמצעי הבקרה. פורמט: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string חובה. השם המוצג של אמצעי הבקרה.
description	string זה שינוי אופציונלי. תיאור של אמצעי הבטיחות.
enabled	bool זה שינוי אופציונלי. האם אמצעי הבקרה מופעל.
action	TriggerAction זה שינוי אופציונלי. הפעולה שתתבצע כשהגדרת הבטיחות תופעל.
create_time	Timestamp פלט בלבד. חותמת הזמן שבה נוצר אמצעי הבקרה.
update_time	Timestamp פלט בלבד. חותמת זמן של מועד העדכון האחרון של אמצעי הבקרה.
etag	string תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
שדה איחוד guardrail_type. סוג מעקה הבטיחות. הערך guardrail_type יכול להיות רק אחד מהבאים:
content_filter	Guardrail.ContentFilter זה שינוי אופציונלי. אמצעי הגנה שאוסר על שימוש בתוכן מסוים בשיחה.
llm_prompt_security	Guardrail.LlmPromptSecurity זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם ההנחיה נחשבת ללא בטוחה על סמך הסיווג של ה-LLM.
llm_policy	Guardrail.LlmPolicy זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם התשובה של ה-LLM נחשבת להפרה של המדיניות על סמך הסיווג של ה-LLM.
model_safety	Guardrail.ModelSafety זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה אם התשובה של ה-LLM נחשבת לא בטוחה על סמך הגדרות הבטיחות של המודל.
code_callback	Guardrail.CodeCallback זה שינוי אופציונלי. אמצעי הגנה שחוסם את השיחה על סמך התוצאה של הפעלת ה-callback.
supervisor	Guardrail.Supervisor זה שינוי אופציונלי. אמצעי הגנה שמופעלים בהתערבות של מפקח/ת.

CodeCallback

אמצעי הגנה שחוסם את השיחה על סמך קריאות החזרה (callback) של הקוד שסופקו.

שדות
before_agent_callback	Callback זה שינוי אופציונלי. הקריאה החוזרת לביצוע לפני הקריאה לסוכן. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: ‫- 'decision': הערך 'OK' או 'TRIGGER'. ‫- reason: מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER (הפעלה) עשויה להפסיק את העיבוד הנוסף.
after_agent_callback	Callback זה שינוי אופציונלי. התקשרות חוזרת שתופעל אחרי שהסוכן יתקשר. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: ‫- 'decision': הערך 'OK' או 'TRIGGER'. ‫- reason: מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER (הפעלה) עשויה להפסיק את העיבוד הנוסף.
before_model_callback	Callback זה שינוי אופציונלי. הקריאה החוזרת לביצוע לפני הקריאה למודל. אם יש כמה קריאות למודל, הקריאה החוזרת תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: ‫- 'decision': הערך 'OK' או 'TRIGGER'. ‫- reason: מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER (הפעלה) עשויה להפסיק את העיבוד הנוסף.
after_model_callback	Callback זה שינוי אופציונלי. הקריאה החוזרת שתופעל אחרי הפעלת המודל. אם יש כמה קריאות למודל, הקריאה החוזרת תופעל כמה פעמים. כל פונקציית קריאה חוזרת צריכה להחזיר מבנה (למשל, dict או אובייקט) שמכיל לפחות: ‫- 'decision': הערך 'OK' או 'TRIGGER'. ‫- reason: מחרוזת שמסבירה את ההחלטה. החלטה מסוג TRIGGER (הפעלה) עשויה להפסיק את העיבוד הנוסף.

ContentFilter

אמצעי הגנה שאוסר על שימוש בתוכן מסוים בשיחה.

שדות
banned_contents[]	string זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה גם על קלט מהמשתמשים וגם על תשובות של סוכנים.
banned_contents_in_user_input[]	string זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה רק על קלט משתמש.
banned_contents_in_agent_response[]	string זה שינוי אופציונלי. רשימה של ביטויים אסורים. ההגדרה חלה רק על תשובות של סוכנים.
match_type	Guardrail.ContentFilter.MatchType חובה. סוג ההתאמה של מסנן התוכן.
disregard_diacritics	bool זה שינוי אופציונלי. אם הערך הוא true, סימני הניקוד לא נלקחים בחשבון במהלך ההתאמה.

MatchType

סוג ההתאמה של מסנן התוכן.

טיפוסים בני מנייה (enum)
MATCH_TYPE_UNSPECIFIED	לא צוין סוג התאמה.
SIMPLE_STRING_MATCH	התוכן מותאם למחרוזות משנה תו אחר תו.
WORD_BOUNDARY_STRING_MATCH	התוכן יתאים רק אם התבנית שנמצאה בטקסט מוקפת בתווים שמפרידים בין מילים. ביטויים אסורים יכולים להכיל גם תווי הפרדה בין מילים.
REGEXP_MATCH	התוכן מותאם באמצעות תחביר של ביטויים רגולריים.

LlmPolicy

אמצעי הגנה שחוסם את השיחה אם התשובה של ה-LLM נחשבת להפרה של המדיניות על סמך הסיווג של ה-LLM.

שדות
max_conversation_messages	int32 זה שינוי אופציונלי. כשבודקים את המדיניות הזו, צריך להתייחס ל-n ההודעות האחרונות בשיחה. אם לא מגדירים ערך ברירת מחדל, המערכת תשתמש בערך ברירת המחדל 10.
model_settings	ModelSettings זה שינוי אופציונלי. הגדרות המודל.
prompt	string חובה. פרומפט מדיניות.
policy_scope	Guardrail.LlmPolicy.PolicyScope חובה. הגדרת התנאים שבהם יתבצע אימות המדיניות במהלך השיחה. אם המדיניות מוגדרת לערך POLICY_SCOPE_UNSPECIFIED, היא תחול על קלט של משתמשים. כשמחילים את המדיניות על התגובה של הסוכן, נוסף זמן אחזור לפני שהסוכן יכול להגיב.
fail_open	bool זה שינוי אופציונלי. אם מתרחשת שגיאה במהלך בדיקת המדיניות, המערכת נכשלת בפתיחה ולא מפעילה את אמצעי ההגנה.
allow_short_utterance	bool זה שינוי אופציונלי. כברירת מחדל, בדיקת המדיניות של LLM לא מתבצעת לגבי ביטויים קצרים. אם מפעילים את ההגדרה הזו, בדיקת המדיניות חלה על כל האמירות, כולל אלה שבדרך כלל היו נדלגות.

PolicyScope

הגדרת התנאים שבהם יתבצע אימות המדיניות במהלך השיחה.

טיפוסים בני מנייה (enum)
POLICY_SCOPE_UNSPECIFIED	לא צוין היקף המדיניות.
USER_QUERY	בדיקת המדיניות מופעלת כשמשתמש מזין קלט.
AGENT_RESPONSE	בדיקת המדיניות מופעלת בתגובת הנציג. החלת היקף המדיניות הזה תוביל לזמן אחזור נוסף לפני שהסוכן יוכל להגיב.
USER_QUERY_AND_AGENT_RESPONSE	בדיקת המדיניות מופעלת גם כשמשתמש מזין קלט של משתמשים וגם כשסוכן מגיב. החלת היקף המדיניות הזה תוביל לזמן אחזור נוסף לפני שהסוכן יוכל להגיב.

LlmPromptSecurity

אמצעי הגנה שחוסם את השיחה אם הקלט נחשב לא בטוח על סמך הסיווג של ה-LLM.

שדות
fail_open	bool זה שינוי אופציונלי. ההגדרה קובעת את ההתנהגות של אמצעי הבקרה כשהוא נתקל בשגיאה ב-LLM. ‫- אם הערך הוא True: המגבלה עוקפת את המגבלה. ‫- אם הערך הוא false (ברירת מחדל): אמצעי הבקרה מופעל או נחסם. הערה: אם מסופקת מדיניות בהתאמה אישית, המערכת מתעלמת מהשדה הזה ומשתמשת בהגדרה fail_open של המדיניות.
שדה איחוד security_config. הגדרה של מצב הגדרות האבטחה. המשתמש צריך לבחור אחת מההגדרות הבאות. הערך security_config יכול להיות רק אחד מהבאים:
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings זה שינוי אופציונלי. שימוש בהגדרות האבטחה שמוגדרות כברירת מחדל במערכת. כדי לבחור במצב הזה, צריך לכלול בבקשה הודעה ריקה של default_settings. השרת ימלא את השדה default_prompt_template בתגובה.
custom_policy	Guardrail.LlmPolicy זה שינוי אופציונלי. כדי להגדיר את אמצעי הבטיחות, משתמשים ב-LlmPolicy שהוגדר על ידי המשתמש.

DefaultSecuritySettings

הגדרות ברירת המחדל של אבטחת המערכת.

שדות
default_prompt_template	string פלט בלבד. תבנית ברירת המחדל של ההנחיה שבה המערכת משתמשת. השדה הזה מיועד לתצוגה בלבד, כדי להראות למשתמש איזו הנחיה המערכת משתמשת כברירת מחדל. הוא OUTPUT_ONLY.

ModelSafety

הגדרות בטיחות של מודלים שמוגדרות כברירת מחדל. אם ההגדרה הזו מוגדרת, היא תבטל את הגדרות ברירת המחדל ותפעיל את אמצעי ההגנה אם התשובה תיחשב לא בטוחה.

שדות
safety_settings[]	Guardrail.ModelSafety.SafetySetting חובה. רשימה של הגדרות הבטיחות.

HarmBlockThreshold

רמות סף לחסימה שמבוססות על הסתברות.

טיפוסים בני מנייה (enum)
HARM_BLOCK_THRESHOLD_UNSPECIFIED	סף חסימה לא מוגדר של תוכן מזיק.
BLOCK_LOW_AND_ABOVE	חסימה של סף נמוך ומעלה (כלומר, חסימה של יותר תוכן).
BLOCK_MEDIUM_AND_ABOVE	חסימה של סף בינוני ומעלה.
BLOCK_ONLY_HIGH	חסימה רק של סף גבוה (כלומר, חסימה פחותה).
BLOCK_NONE	לא לחסום אף אחד.
OFF	משביתים את מסנן הבטיחות.

HarmCategory

קטגוריית הנזק.

טיפוסים בני מנייה (enum)
HARM_CATEGORY_UNSPECIFIED	לא צוינה קטגוריית הנזק.
HARM_CATEGORY_HATE_SPEECH	קטגוריית הנזק היא דברי שטנה.
HARM_CATEGORY_DANGEROUS_CONTENT	הקטגוריה של הנזק היא תוכן מסוכן.
HARM_CATEGORY_HARASSMENT	קטגוריית הנזק היא הטרדה.
HARM_CATEGORY_SEXUALLY_EXPLICIT	קטגוריית הנזק היא תוכן מיני בוטה.
HARM_CATEGORY_PROFANITY	קטגוריית הנזק היא שפה גסה.
HARM_CATEGORY_TOXIC	קטגוריית הנזק היא רעילה.

SafetySetting

הגדרת בטיחות.

שדות
category	Guardrail.ModelSafety.HarmCategory חובה. קטגוריית הנזק.
threshold	Guardrail.ModelSafety.HarmBlockThreshold חובה. סף החסימה של תוכן מזיק.

מפקח/ת

אמצעי הגנה שמופעל כשנדרשת התערבות של מפקח.

שדות
type	Guardrail.Supervisor.Type זה שינוי אופציונלי. סוג המפקח.
detection_mode	Guardrail.Supervisor.DetectionMode זה שינוי אופציונלי. מצב הזיהוי של המפקח.

DetectionMode

מצב הזיהוי של המפקח.

טיפוסים בני מנייה (enum)
DETECTION_MODE_UNSPECIFIED	מצב הזיהוי לא מוגדר. ברירת המחדל היא NON_BLOCKING.
NON_BLOCKING	מצב זיהוי לא חוסם. התגובה לא נחסמת בזמן שהזיהוי של המפקח מתבצע.
BLOCKING	מצב זיהוי חסימות. התשובה נחסמת בזמן שהזיהוי של המפקח מתבצע.

סוג

סוג המפקח.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED	לא צוין סוג.
INVALID_TEXT	סוג הבעיה של הטקסט לא תקין.
LANGUAGE_SHIFT	סוג הבעיה של שינוי השפה.
SPEAKER_SHIFT	סוג הבעיה של שינוי הדובר.
AUDIO_MISMATCH	סוג הבעיה: חוסר התאמה באודיו.
MISSING_TOOL_CALL	לא צוין סוג הבעיה של הפעלת הכלי.
CUSTOM	סוג בעיה מותאם אישית.
CHOPPY_AUDIO	סוג הבעיה: אודיו קטוע.
PROFANITY	סוג הבעיה: שפה גסה של סוכן.

תמונה

מייצג קלט או פלט של תמונה בשיחה.

שדות
mime_type	string חובה. סוג ה-MIME התקני של IANA של נתוני המקור. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp
data	bytes חובה. בייטים גולמיים של התמונה.
alt_text	string זה שינוי אופציונלי. הטקסט החלופי של התמונה.

ImportAppRequest

בקשת הודעה עבור AgentService.ImportApp.

שדות
parent	string חובה. שם המשאב הראשי עם המיקום של האפליקציה לייבוא.
display_name	string זה שינוי אופציונלי. השם המוצג של האפליקציה לייבוא. * אם האפליקציה נוצרת במהלך הייבוא, והשם המוצג מצוין, האפליקציה המיובאת תשתמש בשם המוצג הזה. אם המערכת מזהה סתירה עם אפליקציה קיימת, היא מוסיפה חותמת זמן לשם התצוגה כדי להפוך אותו לייחודי. * אם האפליקציה היא ייבוא מחדש, השדה הזה לא צריך להיות מוגדר. אם תציינו שם לתצוגה במהלך הייבוא מחדש, תקבלו שגיאת INVALID_ARGUMENT.
app_id	string זה שינוי אופציונלי. המזהה שישמש לאפליקציה המיובאת. * אם לא מציינים מזהה, יוקצה לאפליקציה מזהה ייחודי באופן אוטומטי. * אחרת, האפליקציה המיובאת תשתמש במזהה הזה כרכיב הסופי של שם המשאב שלה. אם כבר קיימת אפליקציה עם אותו מזהה במיקום שצוין בפרויקט, התוכן של האפליקציה הקיימת יוחלף.
import_options	ImportAppRequest.ImportOptions זה שינוי אופציונלי. אפשרויות שקובעות את תהליך הייבוא של האפליקציה.
ignore_app_lock	bool זה שינוי אופציונלי. דגל לביטול נעילת האפליקציה במהלך הייבוא. אם המדיניות מוגדרת כ-True, תהליך הייבוא יתעלם מנעילת האפליקציה.
שדה איחוד app. האפליקציה לייבוא. הערך app יכול להיות רק אחד מהבאים:
gcs_uri	string מזהה ה-URI של Google Cloud Storage שממנו מייבאים את האפליקציה. הפורמט של ה-URI הזה צריך להיות gs://<bucket-name>/<object-name>.
app_content	bytes בייטים גולמיים שמייצגים את קובץ ה-ZIP הדחוס עם מבנה התיקיות של האפליקציה.
שדה איחוד json_patch. תיקוני ה-JSON שרוצים להחיל על האפליקציה המיובאת. הערך json_patch יכול להיות רק אחד מהבאים:
json_patch_content	string זה שינוי אופציונלי. תוכן התיקון כמחרוזת JSON.
json_patch_gcs_uri	string זה שינוי אופציונלי. ‫URI של Cloud Storage שמפנה לקובץ JSON שמכיל את התיקונים.

ImportOptions

אפשרויות ההגדרה לתהליך ייבוא האפליקציה. האפשרויות האלה קובעות את אופן הייבוא, במיוחד כשמתעוררות בעיות שקשורות לנתוני האפליקציה הקיימים.

שדות
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy זה שינוי אופציונלי. האסטרטגיה שבה יש להשתמש כשמייבאים נתונים ומתגלים קונפליקטים.
validate_only	bool זה שינוי אופציונלי. דגל להרצת תהליך הייבוא ללא ביצוע בפועל. אם המדיניות מוגדרת כ-True, תהליך הייבוא יבצע רק אימותים ולא יבצע שינויים באפליקציה הקיימת או ייצור אפליקציה חדשה.

ConflictResolutionStrategy

ההגדרה מגדירה את האסטרטגיה לטיפול בקונפליקטים כשכבר קיימת אפליקציה עם אותו מזהה, או כשמשאבים מיובאים (כמו סוכנים, כלים וכו') כוללים שמות מוצגים זהים למשאבים קיימים באותה אפליקציה.

טיפוסים בני מנייה (enum)
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	לא צוינה אסטרטגיה לפתרון קונפליקטים.
REPLACE	החלפת הנתונים הקיימים בנתונים המיובאים. אם כבר קיימת אפליקציה עם אותו app_id, התוכן שלה יעודכן על סמך האפליקציה המיובאת. – משאבים (אפליקציה, סוכנים, כלים, דוגמאות, אמצעי הגנה, ערכות כלים) באפליקציה המיובאת שיש להם אותו שם תצוגה כמו למשאבים קיימים ידחוסו את המשאבים הקיימים. – ייווצרו משאבים מיובאים עם שמות חדשים לתצוגה. – משאבים קיימים שלא מופיע להם שם מוצג תואם באפליקציה המיובאת יישארו ללא שינוי.
OVERWRITE	החלפת הנתונים הקיימים בנתונים מיובאים. אם כבר קיימת אפליקציה עם אותו app_id, התוכן שלה יוחלף באפליקציה המיובאת. – משאבים קיימים (סוכנים, כלים, דוגמאות, אמצעי הגנה, ערכות כלים) באפליקציה יימחקו. – משאבים מיובאים ייצרו משאבים חדשים.

ImportAppResponse

הודעת תגובה ל-AgentService.ImportApp.

שדות
name	string שם המשאב של האפליקציה שיובאה.
warnings[]	string הודעות אזהרה שנוצרות במהלך תהליך הייבוא. אם מתרחשות שגיאות במשאבים ספציפיים, הם לא ייכללו באפליקציה המיובאת והשגיאה תצוין כאן.

InputAudioConfig

ההגדרה InputAudioConfig קובעת איך סוכן ה-CES יפרש את נתוני האודיו הנכנסים.

שדות
audio_encoding	AudioEncoding חובה. הקידוד של נתוני האודיו של הקלט.
sample_rate_hertz	int32 חובה. תדירות הדגימה (בהרץ) של נתוני האודיו של הקלט.
noise_suppression_level	string זה שינוי אופציונלי. האם להפעיל סינון רעשים באודיו של הקלט. הערכים האפשריים הם low,‏ moderate,‏ high,‏ very_high.

InstagramCredentials

פרטי כניסה זמניים ל-Meta לצורך שילוב מובנה של אינסטגרם.

שדות
auth_code	string חובה. קוד האימות של Meta שמופיע בתהליך ההרשמה המוטמע.
conversation_profile_id	string זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה.

InterruptionSignal

מציין שהתגובה הקולית של הסוכן הופרעה. הלקוח צריך להפסיק מיידית את השמע הנוכחי (לדוגמה, בגלל התפרצות של משתמש לשיחה או בגלל יצירה של תשובה חדשה של נציג).

שדות
barge_in	bool האם ההפרעה נגרמת על ידי אירוע של משתמש שמתפרץ לשיחה.

LanguageSettings

הגדרות השפה של האפליקציה.

שדות
default_language_code	string זה שינוי אופציונלי. קוד השפה שמוגדר כברירת מחדל באפליקציה.
supported_language_codes[]	string זה שינוי אופציונלי. רשימת קודי השפות שהאפליקציה תומכת בהן, בנוסף לdefault_language_code.
enable_multilingual_support	bool זה שינוי אופציונלי. הגדרה שמאפשרת תמיכה בשפות רבות. אם הערך הוא True, סוכנים באפליקציה ישתמשו בהוראות מוכנות מראש כדי לשפר את הטיפול בקלט רב-לשוני.
fallback_action (deprecated)	string הפריט הזה הוצא משימוש. זה שינוי אופציונלי. הוצאה משימוש: התכונה הזו לא נתמכת יותר. במקום זאת, אפשר להשתמש ב-enable_multilingual_support כדי לשפר את הטיפול בקלט רב-לשוני. הפעולה שצריך לבצע כשהסוכן מקבל קלט בשפה שלא נתמכת. יכול להיות שמדובר בפעולה מוגדרת מראש או בקריאה מותאמת אישית לכלי. הערכים התקינים הם: – השם המלא של משאב הכלי, שמפעיל ביצוע ספציפי של הכלי. – פעולת מערכת מוגדרת מראש, כמו 'העברה לטיפול בדרג גבוה יותר' או 'יציאה', שמפעילה אות EndSession עם metadata תואם כדי לסיים את השיחה.

ListAgentsRequest

בקשת הודעה עבור AgentService.ListAgents.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את רשימת הסוכנים.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListAgents.
filter	string זה שינוי אופציונלי. מסנן שיש להחיל כשמציגים את רשימת הסוכנים. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListAgentsResponse

הודעת תגובה ל-AgentService.ListAgents.

שדות
agents[]	Agent רשימת הנציגים.
next_page_token	string טוקן שאפשר לשלוח כ-ListAgentsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListAppVersionsRequest

בקשת הודעה עבור AgentService.ListAppVersions.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את גרסאות האפליקציה.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListAppVersions.
filter	string זה שינוי אופציונלי. המסנן שיוחל כשמוצגות גרסאות האפליקציה. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListAppVersionsResponse

הודעת תגובה ל-AgentService.ListAppVersions.

שדות
app_versions[]	AppVersion רשימת גרסאות האפליקציה.
next_page_token	string טוקן שאפשר לשלוח כ-ListAppVersionsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListAppsRequest

בקשת הודעה עבור AgentService.ListApps.

שדות
parent	string חובה. שם המשאב של המיקום שממנו רוצים להציג את רשימת האפליקציות.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListApps.
filter	string זה שינוי אופציונלי. המסנן שיוחל כשמציגים את רשימת האפליקציות. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListAppsResponse

הודעת תגובה ל-AgentService.ListApps.

שדות
apps[]	App רשימת האפליקציות.
next_page_token	string טוקן שאפשר לשלוח כ-ListAppsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.
unreachable[]	string רשימה לא ממוינת. מיקומים שלא ניתן להגיע אליהם.

ListChangelogsRequest

בקשת הודעה עבור AgentService.ListChangelogs.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את יומני השינויים.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListChangelogs.
filter	string זה שינוי אופציונלי. המסנן שיוחל כשמציגים את יומני השינויים. פרטים נוספים זמינים בכתובת https://google.aip.dev/160. אפשר להשתמש במחרוזת הסינון כדי לסנן לפי action, resource_type, resource_name, author וגם create_time. אפשר להשתמש באופרטור ההשוואה : להתאמה חלקית לא תלוית-רישיות בשדות מחרוזת, ואילו האופרטור = מבצע התאמה מדויקת תלוית-רישיות. דוגמאות: * action:update (התאמה חלקית לא תלוית-רישיות) * action="Create" (התאמה מדויקת תלוית-רישיות) * resource_type:agent * resource_name:my-agent * author:[e-mail] * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListChangelogsResponse

הודעת תגובה ל-AgentService.ListChangelogs.

שדות
changelogs[]	Changelog רשימת יומני השינויים.
next_page_token	string טוקן שאפשר לשלוח כ-ListChangelogsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListConversationsRequest

בקשת הודעה עבור AgentService.ListConversations.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את רשימת השיחות.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListConversations.
filter	string זה שינוי אופציונלי. המסנן שיופעל כשמציגים את רשימת השיחות. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
source	Conversation.Source זה שינוי אופציונלי. מציינים את מקור השיחה. אם לא מגדירים את המדיניות, המערכת תשתמש ב-Source.Live כברירת מחדל. יצא משימוש לטובת השדה sources.
sources[]	Conversation.Source זה שינוי אופציונלי. לציין את המקורות של השיחות. אם לא מגדירים את המקורות, המערכת מתבססת על כל המקורות הזמינים כברירת מחדל.

ListConversationsResponse

הודעת תגובה ל-AgentService.ListConversations.

שדות
conversations[]	Conversation רשימת השיחות.
next_page_token	string טוקן שאפשר לשלוח כ-ListConversationsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListDeploymentsRequest

בקשת הודעה עבור AgentService.ListDeployments.

שדות
parent	string חובה. האפליקציה הראשית. הפורמט: projects/{project}/locations/{location}/apps/{app}
page_size	int32 זה שינוי אופציונלי. מספר הפריסות המקסימלי שיוחזר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 פריסות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.
page_token	string זה שינוי אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של ListDeployments. צריך להזין את הטוקן כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-ListDeployments חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListDeploymentsResponse

הודעת תגובה ל-AgentService.ListDeployments.

שדות
deployments[]	Deployment רשימת הפריסות.
next_page_token	string טוקן שאפשר לשלוח כ-page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ListExamplesRequest

בקשת הודעה עבור AgentService.ListExamples.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג דוגמאות.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListExamples.
filter	string זה שינוי אופציונלי. מסנן שיוחל כשמציגים את הדוגמאות. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListExamplesResponse

הודעת תגובה ל-AgentService.ListExamples.

שדות
examples[]	Example רשימת הדוגמאות.
next_page_token	string טוקן שאפשר לשלוח כ-ListExamplesRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListGuardrailsRequest

בקשת הודעה עבור AgentService.ListGuardrails.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את אמצעי הבקרה.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListGuardrails.
filter	string זה שינוי אופציונלי. המסנן שיוחל כשמציגים את כללי ההגנה. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListGuardrailsResponse

הודעת תגובה ל-AgentService.ListGuardrails.

שדות
guardrails[]	Guardrail רשימת אמצעי הבקרה.
next_page_token	string טוקן שאפשר לשלוח כ-ListGuardrailsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListToolsRequest

בקשת הודעה עבור AgentService.ListTools.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את רשימת הכלים.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListTools.
filter	string זה שינוי אופציונלי. המסנן שיחול כשמציגים את רשימת הכלים. כדי לכלול את כלי המערכת בתשובה, צריך להשתמש בפרמטר include_system_tools=true. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListToolsResponse

הודעת תגובה ל-AgentService.ListTools.

שדות
tools[]	Tool רשימת הכלים.
next_page_token	string טוקן שאפשר לשלוח כ-ListToolsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

ListToolsetsRequest

בקשת הודעה עבור AgentService.ListToolsets.

שדות
parent	string חובה. שם המשאב של האפליקציה שממנה רוצים להציג את ערכות הכלים.
page_size	int32 זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מציינים ערך, השרת יבחר ברירת מחדל מתאימה.
page_token	string זה שינוי אופציונלי. הערך next_page_token שמוחזר מקריאה קודמת של AgentService.ListToolsets.
filter	string זה שינוי אופציונלי. המסנן שיחול כשמציגים את ערכות הכלים. פרטים נוספים זמינים בכתובת https://google.aip.dev/160.
order_by	string זה שינוי אופציונלי. השדה שלפיו יתבצע המיון. יש תמיכה רק בערכים name ו-create_time. פרטים נוספים זמינים בכתובת https://google.aip.dev/132#ordering.

ListToolsetsResponse

הודעת תגובה ל-AgentService.ListToolsets.

שדות
toolsets[]	Toolset רשימת ערכות הכלים.
next_page_token	string טוקן שאפשר לשלוח כ-ListToolsetsRequest.page_token כדי לאחזר את הדף הבא. אם לא מציינים את השדה הזה, לא יופיעו דפים נוספים.

LoggingSettings

הגדרות שמתארות את התנהגויות הרישום ביומן של האפליקציה.

שדות
redaction_config	RedactionConfig זה שינוי אופציונלי. הגדרות לצנזור מידע אישי רגיש.
audio_recording_config	AudioRecordingConfig זה שינוי אופציונלי. הגדרות לגבי אופן ההקלטה של אינטראקציות עם אודיו. האודיו כפוף לצנזורה כפי שהוגדר ב-RedactionConfig.
unredacted_audio_recording_config	AudioRecordingConfig זה שינוי אופציונלי. ההגדרה קובעת הקלטה נוספת של אודיו שלא צונזר. אפשר להשתמש בזה כדי לשמור עותק של האודיו הגולמי כשמבצעים צנזורה של אודיו enabled, בדרך כלל למטרות ביקורת או מעקב.
bigquery_export_settings	BigQueryExportSettings זה שינוי אופציונלי. הגדרת אופן הייצוא של נתוני BigQuery עבור האפליקציה. נתוני השיחות כפופים לצנזורה בהתאם להגדרות ב-RedactionConfig.
unredacted_bigquery_export_settings	BigQueryExportSettings זה שינוי אופציונלי. הגדרה של אופן הייצוא ל-BigQuery עבור האפליקציה. אם הייצוא מופעל, נתוני השיחות שלא עברו צנזורה ייצאו לטבלאות ב-BigQuery.
cloud_logging_settings	CloudLoggingSettings זה שינוי אופציונלי. הגדרות שמתארות את ההתנהגויות של Cloud Logging באפליקציה.
conversation_logging_settings	ConversationLoggingSettings זה שינוי אופציונלי. הגדרות שמתארות את התנהגויות הרישום ביומן של השיחות באפליקציה.
evaluation_audio_recording_config	AudioRecordingConfig זה שינוי אופציונלי. הגדרות לגבי אופן התיעוד של אינטראקציות עם אודיו לצורך ההערכה. כברירת מחדל, הקלטת אודיו לא מופעלת בסשנים של הערכה.
metric_analysis_settings	MetricAnalysisSettings זה שינוי אופציונלי. הגדרות שמתארות את התנהגויות איסוף נתוני השיחות בצינור הניתוח של מודל שפה גדול (LLM) עבור האפליקציה.

McpTool

כלי MCP. פרטים נוספים זמינים בכתובת https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

שדות
name	string חובה. השם של כלי ה-MCP.
name_override	string זה שינוי אופציונלי. השם שמוגדר לכלי MCP במקום השם המקורי. השדה הזה מאוכלס אם השם שונה באמצעות שינוי ברירת המחדל של ערכת הכלים.
description	string זה שינוי אופציונלי. תיאור הכלי MCP.
input_schema	Schema זה שינוי אופציונלי. הסכימה של ארגומנטי הקלט של כלי ה-MCP.
output_schema	Schema זה שינוי אופציונלי. הסכימה של ארגומנטי הפלט של כלי ה-MCP.
server_address	string חובה. כתובת השרת של שרת ה-MCP, למשל, https://example.com/mcp/. אם השרת נבנה באמצעות ה-SDK של MCP, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. זהה ל-server_address ב-McpToolset. מידע נוסף זמין בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication זה שינוי אופציונלי. פרטי האימות שנדרשים להרצת הכלי מול שרת ה-MCP. באימות באמצעות טוקן bearer, הטוקן חל רק על הפעלת הכלי, ולא על כלי הרישום. לכן, צריך לוודא שאפשר לראות את רשימת הכלים בלי אימות.
tls_config	TlsConfig זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח צריך לסמוך עליהם.
service_directory_config	ServiceDirectoryConfig זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
custom_headers	map<string, string> זה שינוי אופציונלי. הכותרות המותאמות אישית שיישלחו בבקשה לשרת ה-MCP. הערכים צריכים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
state	McpTool.State פלט בלבד. מצב הזמינות הדינמי של הכלי בשרת החיצוני.

מדינה

מייצג את מצב הזמינות הדינמי של הכלי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED	מצב ברירת מחדל.
ACTIVE	הכלי זמין והשרת מציע אותו באופן פעיל.
INACTIVE	הכלי מוגדר או מוצמד, אבל השרת לא מציע אותו כרגע.
STALE	הכלי קיים בשרת, אבל הוא לא תואם לגרסה בשרת.

McpToolDefinition

קונטיינר של רכיבי ההגדרה הבסיסיים של כלי מסוים, שמוצגים בתמונת מצב. סכימות בצילום המצב משמשות כמו שהן, ואי אפשר לשנות אותן.

שדות
description	string פלט בלבד. תיאור הכלי MCP. אפשר לשנות את ההגדרה הזו ב-description_override דרך McpToolOverride.
input_schema	Schema פלט בלבד. הסכימה של ארגומנטי הקלט של כלי ה-MCP.
output_schema	Schema פלט בלבד. הסכימה של ארגומנטי הפלט של כלי ה-MCP.

McpToolOverride

שינויים שמשויכים לכלי מסוים בערכת כלים. כך אפשר להצמיד או לבטל הגדרות של כלים מהשרת הדינמי החיצוני.

שדות
tool	string חובה. השם המקורי של הכלי כפי שהוא מועבר על ידי שרת ה-MCP.
name_override	string זה שינוי אופציונלי. אם השם הזה קיים, הכלי משתמש בו בסוכן במקום בשם המקורי. השימוש העיקרי בהגדרה הזו הוא ככינוי אם שרת ה-MCP מציע כלים עם שמות לא מוצלחים.
description_override	string זה שינוי אופציונלי. אם התיאור הזה קיים, הכלי משתמש בו במקום בתיאור המקורי מהשרת.
snapshot	McpToolDefinition פלט בלבד. אם הכלי הזה קיים, הוא מוצמד ומשתמש בערכי התמונה כגיבוי אם השרת לא זמין באופן זמני או אם לא קיים ביטול.

McpToolset

ערכת כלים שמכילה רשימה של כלים שמוצעים על ידי שרת ה-MCP.

שדות
server_address	string חובה. הכתובת של שרת ה-MCP, לדוגמה, https://example.com/mcp/. אם השרת נבנה באמצעות ה-SDK של MCP, צריך להוסיף את הסיומת ‎/mcp/‎ לכתובת ה-URL. יש תמיכה רק בשרתים מבוססי-תעבורה של HTTP שניתן להזרים מהם. מידע נוסף זמין בכתובת https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication זה שינוי אופציונלי. פרטי אימות שנדרשים כדי לגשת לכלים ולהריץ כלי מול שרת ה-MCP. באימות באמצעות טוקן bearer, הטוקן חל רק על הפעלת הכלי, ולא על כלי הרישום. לכן, צריך לוודא שאפשר לראות את רשימת הכלים בלי אימות.
service_directory_config	ServiceDirectoryConfig זה שינוי אופציונלי. הגדרת Service Directory ל-VPC-SC, שמשמשת לפתרון שמות שירותים בתוך perimeter.
tls_config	TlsConfig זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח צריך לסמוך עליהם.
custom_headers	map<string, string> זה שינוי אופציונלי. הכותרות המותאמות אישית שיישלחו בבקשה לשרת ה-MCP. הערכים צריכים להיות בפורמט $context.variables.<name_of_variable> ואפשר להגדיר אותם במשתני הסשן. פרטים נוספים זמינים בכתובת https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
tool_overrides[]	McpToolOverride זה שינוי אופציונלי. שינויים שחלים על כלים ספציפיים בערכת הכלים הזו. כך אפשר לשנות פרטים ספציפיים כמו תיאורים ושמות, או להצמיד את מצבי הכלים כדי שלא יהיו דינמיים לחלוטין.

הודעה

הודעה בשיחה.

שדות
role	string זה שינוי אופציונלי. התפקיד בשיחה, למשל: משתמש, נציג.
chunks[]	Chunk זה שינוי אופציונלי. תוכן ההודעה כסדרה של נתחים.
event_time	Timestamp זה שינוי אופציונלי. חותמת הזמן שבה ההודעה נשלחה או התקבלה. אסור להשתמש בתג הזה אם ההודעה היא חלק מexample.

MetricAnalysisSettings

הגדרות שמתארות את התנהגויות איסוף נתוני השיחות עבור צינור עיבוד הנתונים של מדדי ניתוח LLM.

שדות
llm_metrics_opted_out	bool זה שינוי אופציונלי. האם לאסוף נתוני שיחות למדדים של ניתוח LLM. אם הערך הוא true, לא ייאספו נתוני שיחות למדדי ניתוח של מודלים גדולים של שפה (LLM). אחרת, ייאספו נתוני שיחות.

MockConfig

הגדרת קריאות מוקדמות לכלים בסשן.

שדות
mocked_tool_calls[]	MockedToolCall זה שינוי אופציונלי. כל קריאות הכלים שצריך ליצור להן מוקאפ למשך הפעלת הסשן.
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior חובה. התנהגות של קריאות לכלים שלא תואמות לאף תבנית של ארגומנטים ב-mocked_tool_calls.

UnmatchedToolCallBehavior

מה עושים כשקריאה לכלי לא תואמת לקריאות לכלי שנוצרו כדוגמה.

טיפוסים בני מנייה (enum)
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	ערך ברירת המחדל. הערך הזה לא בשימוש.
FAIL	הפונקציה תזרוק שגיאה לכל קריאה לכלים שלא תואמת לתבנית קלט צפויה מדומה.
PASS_THROUGH	אם קריאות הכלים לא תואמות, מעבירים את קריאת הכלים לכלי האמיתי.

MockedToolCall

קריאה לכלי בהדמיה.

מציין את כלי היעד + תבנית להתאמה לארגומנטים או לקלט של הכלי הזה. אם התבנית תואמת, תוחזר התגובה המדומה.

שדות
tool (deprecated)	string הפריט הזה הוצא משימוש. זה שינוי אופציונלי. הוצאה משימוש, במקום זאת, צריך להשתמש ב-tool_identifier.
expected_args_pattern	Struct חובה. תבנית להתאמה לכל הארגומנטים או הקלט של כל קריאות הכלים שנשלחו. אם הקלט של קריאת הפונקציה תואם לתבנית הזו, יוחזר פלט מדומה.
mock_response	Struct זה שינוי אופציונלי. התגובה או הפלט המדומים שיוחזרו אם הארגומנטים או הקלט של קריאת הכלי תואמים לתבנית.
שדה איחוד tool_identifier. המזהה של הכלי שרוצים ליצור לו מוקאפ. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool_id	string זה שינוי אופציונלי. השם של הכלי שרוצים ליצור לו מוק. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool זה שינוי אופציונלי. ערכת הכלים לזיוף.

ModelSettings

ההגדרות של המודל מכילות הגדרות שונות של מודל ה-LLM.

שדות
model	string זה שינוי אופציונלי. מודל ה-LLM שהסוכן צריך להשתמש בו. אם לא מגדירים מודל, הסוכן יקבל בירושה את המודל מהסוכן הראשי שלו.
thinking_level	ModelSettings.ThinkingLevel זה שינוי אופציונלי. רמת ההעמקה של המודל.
temperature	double זה שינוי אופציונלי. אם המדיניות מוגדרת, רמת האקראיות הזו תשמש את מודל ה-LLM. רמת האקראיות קובעת את רמת הרנדומיזציה של התשובות של המודל. טמפרטורות נמוכות יותר מפיקות תשובות צפויות יותר. טמפרטורות גבוהות יותר יוצרות תשובות יצירתיות יותר.

ThinkingLevel

הגדרת רמת החשיבה של המודל.

טיפוסים בני מנייה (enum)
THINKING_LEVEL_UNSPECIFIED	לא צוינה רמת ההעמקה.
DEFAULT	רמת ההעמקה שמוגדרת כברירת מחדל.
LOW	רמת העמקה נמוכה.
MEDIUM	רמת חשיבה בינונית.
HIGH	רמת העמקה גבוהה.

OAuthConfig

הגדרות לאימות באמצעות OAuth.

שדות
oauth_grant_type	OAuthConfig.OauthGrantType חובה. סוגי הרשאות OAuth.
client_id	string חובה. מזהה הלקוח מספק OAuth.
client_secret_version	string חובה. השם של משאב גרסת הסוד ב-SecretManager שבו מאוחסן סוד הלקוח. פורמט: projects/{project}/secrets/{secret}/versions/{version} הערה: צריך להקצות את התפקיד roles/secretmanager.secretAccessor לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint	string חובה. נקודת הקצה של האסימון בספק OAuth להחלפה באסימון גישה.
scopes[]	string זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק.

OauthGrantType

סוגי הרשאות OAuth. יש תמיכה רק ב-client credential grant.

טיפוסים בני מנייה (enum)
OAUTH_GRANT_TYPE_UNSPECIFIED	לא צוין. ברירת המחדל היא CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	מייצג את תהליך פרטי הכניסה של הלקוח.

OpenApiTool

כלי API מרחוק שמוגדר על ידי סכימת OpenAPI.

שדות
open_api_schema	string חובה. סכימת OpenAPI בפורמט JSON או YAML.
name	string זה שינוי אופציונלי. שם הכלי. אם לא תציינו שם, השם של הכלי ייגזר מסכימת OpenAPI, מ-operation.operationId.
description	string זה שינוי אופציונלי. תיאור הכלי. אם לא תספקו תיאור, הוא יחולץ מסכמת OpenAPI, מ-operation.description או מ-operation.summary.
api_authentication	ApiAuthentication זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API.
tls_config	TlsConfig זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת המותאמים אישית שהלקוח ייתן בהם אמון.
service_directory_config	ServiceDirectoryConfig זה שינוי אופציונלי. הגדרת ספריית השירותים.
ignore_unknown_fields	bool זה שינוי אופציונלי. אם הערך הוא true, הסוכן יתעלם משדות לא מוכרים בתגובת ה-API.
url	string זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת Open API. השדה הזה מוגדר רק בכלים בתלות הסביבתית במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו מופיעה בתלות בסביבה ולסכימה יש פלייסהולדר מסוג ‎ $env_var, הפלייסהולדר יוחלף בסכימה.

OpenApiToolset

ערכת כלים שמכילה רשימה של כלים שמוגדרים על ידי סכימת OpenAPI.

שדות
open_api_schema	string חובה. סכימת OpenAPI של ערכת הכלים.
api_authentication	ApiAuthentication זה שינוי אופציונלי. פרטי האימות שנדרשים על ידי ה-API.
tls_config	TlsConfig זה שינוי אופציונלי. הגדרת TLS. כולל את אישורי השרת בהתאמה אישית
service_directory_config	ServiceDirectoryConfig זה שינוי אופציונלי. הגדרת ספריית השירותים.
ignore_unknown_fields	bool זה שינוי אופציונלי. אם הערך הוא true, הסוכן יתעלם משדות לא מוכרים בתגובת ה-API לכל הפעולות שמוגדרות בסכימת OpenAPI.
url	string זה שינוי אופציונלי. כתובת ה-URL של השרת של סכימת Open API. השדה הזה מוגדר רק בערכות כלים בתלות הסביבתית במהלך תהליך הייצוא, אם הסכימה מכילה כתובת URL של שרת. במהלך תהליך הייבוא, אם כתובת ה-URL הזו מופיעה בתלות בסביבה ולסכימה יש פלייסולדר של $env_var, הפלייסולדר יוחלף בסכימה.

OperationMetadata

מייצג את המטא-נתונים של הפעולה הממושכת.

שדות
create_time	Timestamp פלט בלבד. השעה שבה נוצרה הפעולה.
end_time	Timestamp פלט בלבד. השעה שבה הפעולה הסתיימה.
status_message	string פלט בלבד. סטטוס הפעולה שקריא לבני אדם, אם יש כזה.
requested_cancellation	bool פלט בלבד. הערך מציין אם המשתמש ביקש לבטל את הפעולה. לפעולות שבוטלו בהצלחה יש ערך google.longrunning.Operation.error עם google.rpc.Status.code של 1, שמתאים ל-Code.CANCELLED.

OutputAudioConfig

ההגדרה OutputAudioConfig קובעת איך סוכן CES צריך לסנתז תשובות אודיו יוצאות.

שדות
audio_encoding	AudioEncoding חובה. הקידוד של נתוני האודיו של הפלט.
sample_rate_hertz	int32 חובה. תדירות הדגימה (בהרץ) של נתוני האודיו של הפלט.

PythonCodeCondition

בלוק קוד של Python להערכת התנאי.

שדות
python_code	string חובה. קוד Python להרצה.

PythonFunction

כלי פונקציית Python.

שדות
name	string זה שינוי אופציונלי. השם של פונקציית Python להפעלה. השם חייב להיות זהה לשם של פונקציית Python שמוגדרת בקוד Python. תלוי אותיות רישיות. אם לא מציינים שם, המערכת תשתמש בפונקציה הראשונה שמוגדרת בקוד Python.
python_code	string זה שינוי אופציונלי. קוד Python להרצה עבור הכלי.
description	string פלט בלבד. התיאור של פונקציית Python, שנותח ממחרוזת התיעוד של קוד Python.
service_directory_config	ServiceDirectoryConfig זה שינוי אופציונלי. הגדרת Service Directory עבור הכלי.

RecognitionResult

תוצאת זיהוי הדיבור לקלט האודיו.

שדות
transcript	string זה שינוי אופציונלי. פלחים של דיבור המשתמש שחוברו יחד ונלכדו במהלך התור הנוכחי.

RedactionConfig

הגדרות שמנחות איך לטפל במידע אישי רגיש.

שדות
enable_redaction	bool זה שינוי אופציונלי. אם הערך הוא true, הצנזורה תופעל בתרחישי רישום שונים ביומן, כולל היסטוריית השיחות, Cloud Logging והקלטת אודיו.
inspect_template	string זה שינוי אופציונלי. DLP בודק את שם התבנית כדי להגדיר זיהוי של סוגי מידע אישי רגיש. פורמט: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string זה שינוי אופציונלי. שם תבנית לביטול הזיהוי ב-DLP כדי להנחות איך לבטל את הזיהוי של התוכן. פורמט: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

הגדרה משותפת לחיבור לסוכן A2A מרוחק.

שדות
api_authentication	ApiAuthentication זה שינוי אופציונלי. הגדרת האימות להפעלת הסוכן המרוחק. אופציונלי אם הפניה למרשם כבר מטפלת באימות.
input_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות משתני הקלט של סוכן מרוחק לשמות משתנים של GECX.
output_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות משתני הפלט של הסוכן המרוחק לשמות משתנים של GECX.
streaming_enabled	bool זה שינוי אופציונלי. האם הסטרימינג מופעל עבור הסוכן המרוחק.
context_id	string זה שינוי אופציונלי. אם השדה לא ריק, האינטראקציות עם סוכן A2A מרוחק ישתמשו במזהה ההקשר הזה. השדה context_id יכול להתייחס למשתנה של סשן כמו $context.variables.order_agent_session_id.
שדה איחוד agent_spec. מפרט של הסוכן המרוחק. הערך agent_spec יכול להיות רק אחד מהבאים:
agent_card	AgentCard זה שינוי אופציונלי. כרטיס הסוכן המלא מוגדר בשורה.
agent_registry	string זה שינוי אופציונלי. הפניה לסוכן ב-Agent Registry. פורמט: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

מייצג כלי שמאפשר לסוכן להתקשר לסוכן מרוחק אחר.

שדות
name	string חובה. שם הכלי.
description	string חובה. תיאור הכלי.
agent_card	AgentCard חובה. כרטיס הסוכן של הסוכן המרוחק שהכלי הזה מפעיל.
api_authentication	ApiAuthentication זה שינוי אופציונלי. הגדרת האימות להפעלת הסוכן המרוחק.
stateful_agent	bool זה שינוי אופציונלי. כשההגדרה מופעלת, האינטראקציה בין אפליקציית CXAS לבין הסוכן המרוחק תשתף את אותו הקשר. אם הסוכן המרוחק מחזיר context_id, הוא יישמר למשך כל הסשן של כלי הסוכן המרוחק הזה.
input_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות משתני הקלט של סוכן מרוחק לשמות משתנים של GECX.
output_variable_mapping	map<string, string> זה שינוי אופציונלי. מיפוי של שמות משתני הפלט של הסוכן המרוחק לשמות משתנים של GECX.

RestoreAppVersionRequest

הודעת בקשה בשביל AgentService.RestoreAppVersion

שדות
name	string חובה. שם המשאב של גרסת האפליקציה שרוצים לשחזר.

RestoreAppVersionResponse

בסוג הזה אין שדות.

הודעת תגובה ל-AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

בקשת הודעה עבור ToolService.RetrieveToolSchema.

שדות
parent	string חובה. שם המשאב של האפליקציה שאליה שייך הכלי או ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}
שדה איחוד tool_identifier. המזהה של הכלי שאליו רוצים לאחזר את הסכימה. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string זה שינוי אופציונלי. השם של הכלי שאליו רוצים לאחזר את הסכימה. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool זה שינוי אופציונלי. הכלי בערכת הכלים שאחריו רוצים לאחזר את הסכימה. רק כלי אחד צריך להתאים לפרדיקט מתוך ערכת הכלים. אחרת, תוחזר שגיאה.

RetrieveToolSchemaResponse

הודעת תגובה ל-ToolService.RetrieveToolSchema.

שדות
input_schema	Schema הסכימה של פרמטרי הקלט של הכלי.
output_schema	Schema הסכימה של פרמטרים של פלט הכלי.
שדה איחוד tool_identifier. המזהה של הכלי שאליו הסכימה מתייחסת. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string השם של הכלי שאליו הסכימה מתייחסת. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool כלי ערכת הכלים שהסכימה מיועדת לו.

RetrieveToolsRequest

בקשת הודעה עבור ToolService.RetrieveTools.

שדות
toolset	string חובה. השם של ערכת הכלים שרוצים לאחזר את הכלים שלה. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string זה שינוי אופציונלי. המזהים של הכלים שיש לאחזר מתוך ערכת הכלים. אם לא תציינו ערך בשדה הזה, כל הכלים בערכת הכלים יוחזרו.
bypass_persistence_config	bool זה שינוי אופציונלי. אם הערך הוא true, הכלים שיוחזרו יכללו תיאורים וסכימות גולמיים ישירות מהשרת, בלי לעבור דרך הגדרות קבועות מאוחסנות (שינויים או תמונות מצב).

RetrieveToolsResponse

הודעת תגובה ל-ToolService.RetrieveTools.

שדות
tools[]	Tool רשימת הכלים שכלולים בערכת הכלים שצוינה.

RunSessionRequest

בקשת הודעה עבור SessionService.RunSession.

שדות
config	SessionConfig חובה. ההגדרה של הסשן.
inputs[]	SessionInput חובה. נתונים שהוזנו לסשן.

RunSessionResponse

הודעת תגובה ל-SessionService.RunSession.

שדות
outputs[]	SessionOutput הפלטים של הסשן.

סכימה

מייצג קבוצת משנה נבחרת של אובייקט סכימה של OpenAPI 3.0.

שדות
type	Schema.Type חובה. סוג הנתונים.
properties	map<string, Schema> זה שינוי אופציונלי. מאפיינים של Type.OBJECT.
required[]	string זה שינוי אופציונלי. מאפיינים נדרשים של Type.OBJECT.
description	string זה שינוי אופציונלי. תיאור הנתונים.
items	Schema זה שינוי אופציונלי. סכימה של רכיבי Type.ARRAY.
nullable	bool זה שינוי אופציונלי. מציין אם הערך יכול להיות null.
unique_items	bool זה שינוי אופציונלי. מציינים שהפריטים במערך צריכים להיות ייחודיים. ההגדרה הזו רלוונטית רק ל-TYPE.ARRAY.
prefix_items[]	Schema זה שינוי אופציונלי. סכימות של רכיבים ראשוניים מסוג Type.ARRAY.
additional_properties	Schema זה שינוי אופציונלי. יכול להיות ערך בוליאני או אובייקט, שקובע את הנוכחות של מאפיינים נוספים.
any_of[]	Schema זה שינוי אופציונלי. הערך צריך להיות מאומת מול כל אחת (אחת או יותר) מהסכימות המשניות ברשימה.
enum[]	string זה שינוי אופציונלי. ערכים אפשריים של רכיב מסוג פרימיטיבי עם פורמט enum. דוגמאות: 1. אפשר להגדיר כיוון כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. אפשר להגדיר את מספר הדירה כך : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value זה שינוי אופציונלי. ערך ברירת המחדל של הנתונים.
ref	string זה שינוי אופציונלי. מאפשר הפניות עקיפות בין צמתי סכימה. הערך צריך להיות הפניה תקינה לרכיב צאצא של רכיב הבסיס defs. לדוגמה, הסכימה הבאה מגדירה הפניה לצומת סכימה בשם Pet: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string הערך של המאפיין pet הוא הפניה לצומת הסכימה שנקרא Pet. פרטים נוספים זמינים בכתובת https://json-schema.org/understanding-json-schema/structuring.
defs	map<string, Schema> זה שינוי אופציונלי. מפה של הגדרות לשימוש על ידי ref. מותר להשתמש בה רק ברמת הבסיס של הסכימה.
title	string זה שינוי אופציונלי. השם של הסכימה.
min_items	int64 זה שינוי אופציונלי. מספר מינימלי של רכיבים עבור Type.ARRAY.
max_items	int64 זה שינוי אופציונלי. מספר הרכיבים המקסימלי עבור Type.ARRAY.
minimum	double זה שינוי אופציונלי. ערך מינימלי ל-Type.INTEGER ול-Type.NUMBER.
maximum	double זה שינוי אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER.

סוג

סוגי נתונים של OpenAPI.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED	לא צוין סוג.
STRING	סוג מחרוזת.
INTEGER	סוג Integer.
NUMBER	סוג המספר.
BOOLEAN	סוג בוליאני.
OBJECT	סוג האובייקט.
ARRAY	סוג המערך.

SecuritySettings

הגדרות אבטחה ברמת הפרויקט או המיקום ב-CES.

שדות
name	string מזהה. המזהה הייחודי של הגדרות האבטחה. פורמט: projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy זה שינוי אופציונלי. הגדרות שקשורות לשליטה בנקודות קצה.
create_time	Timestamp פלט בלבד. הזמן שבו נוצרו הגדרות האבטחה.
update_time	Timestamp פלט בלבד. השעה של העדכון האחרון של הגדרות האבטחה.
etag	string פלט בלבד. תג Etag של הגדרות האבטחה.

ServiceAccountAuthConfig

הגדרות לאימות באמצעות חשבון שירות מותאם אישית.

שדות
service_account	string חובה. כתובת האימייל של חשבון השירות שמשמש לאימות. מערכת CES משתמשת בחשבון השירות הזה כדי להחליף אסימון גישה, ואז אסימון הגישה נשלח בכותרת Authorization של הבקשה. לחשבון השירות צריך להיות מוקצה התפקיד roles/iam.serviceAccountTokenCreator לסוכן השירות של CES‏ service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string זה שינוי אופציונלי. היקפי ההרשאות של OAuth שרוצים להעניק. אם לא מציינים היקף, המערכת משתמשת בהיקף ברירת המחדל https://www.googleapis.com/auth/cloud-platform.

ServiceAgentIdTokenAuthConfig

בסוג הזה אין שדות.

הגדרות לאימות באמצעות טוקן של מזהה שנוצר מסוכן שירות.

ServiceDirectoryConfig

הגדרות לכלים שמשתמשים ב-Service Directory.

שדות
service	string חובה. השם של שירות Service Directory. פורמט: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} המיקום של ספריית השירותים צריך להיות זהה למיקום של האפליקציה.

SessionConfig

ההגדרה של הסשן.

שדות
session	string חובה. המזהה הייחודי של הסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig זה שינוי אופציונלי. הגדרות לעיבוד האודיו שמתקבל.
output_audio_config	OutputAudioConfig זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו.
historical_contexts[]	Message זה שינוי אופציונלי. ההקשר ההיסטורי של הסשן, כולל נתוני קלט של משתמשים, תשובות של נציגים והודעות אחרות. בדרך כלל, סוכן CES מנהל את הסשן באופן אוטומטי, כך שהלקוח לא צריך למלא את השדה הזה באופן מפורש. עם זאת, הלקוח יכול לבטל את ההקשרים ההיסטוריים כדי לכפות על הסשן להתחיל ממצב מסוים.
entry_agent	string זה שינוי אופציונלי. הסוכן שאליו מוקצה הטיפול בסשן. אם לא מציינים את הפרמטר הזה, הסשן יטופל על ידי root agent של האפליקציה. הפורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string זה שינוי אופציונלי. הפריסה של האפליקציה שבה נעשה שימוש בסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string זה שינוי אופציונלי. אזור הזמן של המשתמש. אם מציינים אזור זמן, הסוכן ישתמש בו למשתנים שקשורים לתאריך ולשעה. אחרת, הסוכן ישתמש באזור הזמן שצוין ב-App.time_zone_settings. הפורמט הוא אזור הזמן במסד הנתונים של אזורי הזמן של IANA, למשל America/Los_Angeles.
use_tool_fakes	bool זה שינוי אופציונלי. האם להשתמש ב-tool fakes בסשן. אם השדה הזה מוגדר, הסוכן ינסה להשתמש בזיופים של כלים במקום להפעיל את הכלים האמיתיים.
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters זה שינוי אופציונלי. ‫QueryParameters לשליחה לסוכן Dialogflow המרוחק כששליטת הסשן מועברת לסוכן המרוחק.
enable_text_streaming	bool זה שינוי אופציונלי. האם להפעיל סטרימינג של פלט טקסט מהמודל. כברירת מחדל, פלט הטקסט מהמודל נאסף לפני שהוא נשלח ללקוח. הערה: האפשרות הזו נתמכת רק בסשנים של טקסט (לא קולי) דרך StreamRunSession או BidiRunSession.
exclude_diagnostic_info	bool זה שינוי אופציונלי. האם להחריג פרטי אבחון מפלט הסשן.

RemoteDialogflowQueryParameters

‫QueryParameters לשליחה לסוכן Dialogflow המרוחק כששליטת הסשן מועברת לסוכן המרוחק.

שדות
webhook_headers	map<string, string> זה שינוי אופציונלי. כותרות ה-HTTP שיישלחו כ-webhook_headers ב-QueryParameters.
payload	Struct זה שינוי אופציונלי. המטען הייעודי (payload) שיישלח ב-QueryParameters.
end_user_metadata	Struct זה שינוי אופציונלי. המטא-נתונים של משתמש הקצה שיישלחו ב-QueryParameters.

SessionInput

קלט לסשן.

שדות
will_continue	bool זה שינוי אופציונלי. סימון שמציין אם ההודעה הנוכחית היא קטע מקלט גדול יותר בסשן של סטרימינג דו-כיווני. אם הערך הוא true, הסוכן ידחה את העיבוד עד שהוא יקבל הודעה נוספת עם הערך will_continue שהוא false, או עד שהמערכת תזהה נקודת קצה בקלט האודיו. הערה: השדה הזה לא רלוונטי לקלט של אודיו ו-DTMF, כי הם תמיד מעובדים באופן אוטומטי על סמך אות סיום השיחה.
שדה איחוד input_type. סוג הקלט. הערך input_type יכול להיות רק אחד מהבאים:
text	string זה שינוי אופציונלי. נתוני טקסט ממשתמש הקצה.
dtmf	string זה שינוי אופציונלי. ספרות DTMF ממשתמש הקצה.
audio	bytes זה שינוי אופציונלי. נתוני אודיו ממשתמש הקצה.
tool_responses	ToolResponses זה שינוי אופציונלי. תוצאות ההרצה של קריאות הכלים מהלקוח.
image	Image זה שינוי אופציונלי. נתוני תמונות ממשתמש הקצה.
blob	Blob זה שינוי אופציונלי. נתוני Blob ממשתמש הקצה.
variables	Struct זה שינוי אופציונלי. משתנים לפי הקשר של הסשן, עם שם כמפתח. הסוכן CES ישתמש רק במשתנים שהוגדרו באפליקציה. משתנים לא מזוהים עדיין יישלחו אל [סוכן Dialogflow][Agent.RemoteDialogflowAgent] כפרמטרים נוספים של הסשן.
event	Event זה שינוי אופציונלי. קלט האירוע.

SessionOutput

פלט של הסשן.

שדות
turn_index	int32 מציין את הסדר הרציף של תור השיחה שאליו שייך הפלט הזה, החל מ-1.
turn_completed	bool אם הערך הוא true, סוכן ה-CES זיהה את סוף תור השיחה הנוכחי ולא יספק פלט נוסף לתור הזה.
diagnostic_info	SessionOutput.DiagnosticInfo זה שינוי אופציונלי. פרטי האבחון מכילים פרטי ביצוע במהלך עיבוד הקלט. השדה הזה מאוכלס רק ב-SessionOutput האחרון (עם turn_completed=true) בכל תור.
שדה איחוד output_type. סוג הפלט. הערך output_type יכול להיות רק אחד מהבאים:
text	string פלט טקסט מסוכן CES.
audio	bytes פלט אודיו מהסוכן של CES.
tool_calls	ToolCalls מבקשים מהלקוח להפעיל את הכלים.
citations	Citations ציטוטים שמספקים את פרטי המקור של הטקסט שנוצר על ידי הסוכן.
google_search_suggestions	GoogleSearchSuggestions ההצעות שמוחזרות מחיפוש Google כתוצאה מהפעלת GoogleSearchTool.
end_session	EndSession מציין שהסשן הסתיים.
payload	Struct מטען ייעודי (payload) בהתאמה אישית עם פלט מובנה מסוכן ה-CES.
image	Image תמונה שנוצרה על ידי סוכן CES.
progress	string עדכון התקדמות ביניים מהסוכן של CES.

DiagnosticInfo

מכיל פרטי הרצה במהלך העיבוד.

שדות
messages[]	Message רשימת ההודעות שהתקבלו במהלך העיבוד.
root_span	Span מעקב אחר עיבוד הבקשה כולה, שמיוצג כטווח בסיס. הטווח הזה יכול להכיל טווחי צאצאים מקוננים לפעולות ספציפיות.

Span

יחידה לוגית למעקב היא יחידת עבודה או פעולה יחידה במהלך עיבוד הבקשה.

שדות
name	string פלט בלבד. שם הטווח.
start_time	Timestamp פלט בלבד. שעת ההתחלה של טווח הזמן.
end_time	Timestamp פלט בלבד. שעת הסיום של טווח הזמן.
duration	Duration פלט בלבד. משך הזמן של הטווח.
attributes	Struct פלט בלבד. מאפייני מפתח/ערך שמשויכים לטווח.
child_spans[]	Span פלט בלבד. טווחים משניים שמוטמעים בטווח הזה.

SynthesizeSpeechConfig

הגדרות לגבי אופן הסינתזה של תשובת הסוכן.

שדות
voice	string זה שינוי אופציונלי. שם הקול. אם לא מוגדרת שפה, השירות יבחר קול על סמך הפרמטרים האחרים, כמו language_code. רשימת הקולות הזמינים מופיעה במאמר שפות וקולות נתמכים של Cloud Text-to-Speech.
speaking_rate	double זה שינוי אופציונלי. קצב הדיבור/המהירות בטווח [0.25, 2.0]. ‫1.0 היא המהירות הרגילה של הקול הספציפי. ‫2.0 מהיר פי שניים, ו-0.5 מהיר פי חצי. ערכים מחוץ לטווח [0.25, 2.0] יחזירו שגיאה.
model	string זה שינוי אופציונלי. המודל שמשמש לסינתזת אודיו. הערכים הנתמכים כרגע: – gemini-3.1-flash-tts-preview אם השדה ריק, המערכת משתמשת ב-Chirp3-HD.
instruction	string זה שינוי אופציונלי. ההוראה שמשמשת לסינתזת דיבור כשמשתמשים במודל גנרטיבי.

SystemTool

כלי מערכת מוגדר מראש.

שדות
name	string חובה. השם של כלי המערכת.
description	string פלט בלבד. תיאור כלי המערכת.

TimeZoneSettings

הגדרות אזור הזמן של האפליקציה.

שדות
time_zone	string זה שינוי אופציונלי. אזור הזמן של האפליקציה ממסד הנתונים של אזורי הזמן, למשל, America/Los_Angeles, Europe/Paris.

TlsConfig

הגדרת TLS.

שדות
ca_certs[]	TlsConfig.CaCert חובה. מציינת רשימה של אישורי CA מותאמים אישית שמותרים לאימות HTTPS.

CaCert

אישור ה-CA.

שדות
display_name	string חובה. השם של אישורי ה-CA המותאמים אישית שמותרים. אפשר להשתמש בזה כדי להבחין בין אישורי CA מותאמים אישית.
cert	bytes חובה. אישורי CA מותאמים אישית שמותרים (בפורמט DER) לאימות HTTPS. ההגדרה הזו מבטלת את מאגר האישורים של SSL שמוגדר כברירת מחדל. אם הרשימה ריקה או לא מצוינת, CES ישתמש במאגר האישורים שמוגדר כברירת מחדל של Google כדי לאמת אישורים. הערה: חשוב לוודא שאישורי שרת ה-HTTPS חתומים עם 'שם חלופי לנושא'. לדוגמה, אפשר להשתמש בפקודה הבאה כדי לחתום על אישור באופן עצמאי: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

כלי

כלי מייצג פעולה שאגנט ה-CES יכול לבצע כדי להשיג יעדים מסוימים.

שדות
name	string מזהה. שם המשאב של הכלי. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool} לכלים עצמאיים. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} לכלים שאוחזרו מתוך ערכת כלים. הכלים האלה הם דינמיים ומוציאים פלט בלבד. אי אפשר להפנות אליהם ישירות במקום שבו נדרש כלי.
display_name	string פלט בלבד. השם המוצג של הכלי, שנגזר מסוג הכלי. לדוגמה, השם המוצג של [ClientFunction][Tool.ClientFunction] נגזר מהמאפיין name שלו.
execution_type	ExecutionType זה שינוי אופציונלי. סוג הביצוע של הכלי.
timeout	Duration זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת הכלי. אם לא מגדירים את משך הזמן הקצוב לתפוגה, ברירת המחדל היא 30 שניות לכלים של SYNCHRONOUS ו-60 שניות לכלים של ASYNCHRONOUS.
create_time	Timestamp פלט בלבד. חותמת זמן של מועד יצירת הכלי.
update_time	Timestamp פלט בלבד. חותמת זמן של מועד העדכון האחרון של הכלי.
etag	string תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
generated_summary	string פלט בלבד. אם הכלי נוצר על ידי עוזר ה-LLM, השדה הזה מכיל סיכום תיאורי של היצירה.
tool_fake_config	ToolFakeConfig זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלי במצב מזויף.
read_only	bool פלט בלבד. מציין אם הכלי הוא לקריאה בלבד. אם הערך הוא True, המשתמש לא יכול לשנות את הכלי.
שדה איחוד tool_type. סוג הכלי. הערך tool_type יכול להיות רק אחד מהבאים:
client_function	ClientFunction זה שינוי אופציונלי. פונקציית הלקוח.
open_api_tool	OpenApiTool זה שינוי אופציונלי. כלי ה-API הפתוח.
google_search_tool	GoogleSearchTool זה שינוי אופציונלי. כלי חיפוש Google.
connector_tool	ConnectorTool זה שינוי אופציונלי. הכלי Integration Connector.
data_store_tool	DataStoreTool זה שינוי אופציונלי. הכלי למאגר נתונים.
python_function	PythonFunction זה שינוי אופציונלי. כלי הפונקציה של Python.
mcp_tool	McpTool זה שינוי אופציונלי. כלי ה-MCP. אי אפשר ליצור או לעדכן כלי MCP ישירות, והוא מנוהל על ידי ערכת הכלים של MCP.
file_search_tool	FileSearchTool זה שינוי אופציונלי. כלי לחיפוש קבצים.
system_tool	SystemTool זה שינוי אופציונלי. כלי המערכת.
agent_tool	AgentTool זה שינוי אופציונלי. כלי הסוכן.
widget_tool	WidgetTool זה שינוי אופציונלי. כלי הווידג'טים.
remote_agent_tool	RemoteAgentTool זה שינוי אופציונלי. כלי הסוכן המרוחק.

ToolCall

בקשה מהלקוח או מהסוכן להפעיל את הכלי שצוין.

שדות
id	string זה שינוי אופציונלי. המזהה הייחודי של קריאת הכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם בשדה ToolResponse.
display_name	string פלט בלבד. השם המוצג של הכלי.
args	Struct זה שינוי אופציונלי. פרמטרי הקלט והערכים של הכלי בפורמט אובייקט JSON.
parent_tool_call_id	string פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה.
agent_name	string פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו.
שדה איחוד tool_identifier. המזהה של הכלי להפעלה. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string זה שינוי אופציונלי. שם הכלי להפעלה. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool זה שינוי אופציונלי. הכלי להרצה מתוך ערכת הכלים.

ToolCalls

הבקשה ללקוח להפעיל את הכלים ולהחזיר את תוצאות ההפעלה לפני המשך הסשן.

שדות
tool_calls[]	ToolCall זה שינוי אופציונלי. רשימת הקריאות לכלי לביצוע.

ToolFakeConfig

הגדרות של אופן הפעולה של הכלי במצב מזויף.

שדות
enable_fake_mode	bool זה שינוי אופציונלי. אם הכלי משתמש במצב מזויף.
שדה איחוד tool_response. התשובה היא סטטית או שהיא מסופקת על ידי פונקציית Python. הערך tool_response יכול להיות רק אחד מהבאים:
code_block	CodeBlock זה שינוי אופציונלי. בלוק קוד שיופעל במקום קריאה אמיתית לכלי.

ToolResponse

תוצאת ההפעלה של כלי ספציפי מהלקוח או מהסוכן.

שדות
id	string זה שינוי אופציונלי. מזהה התשובה התואם של tool call.
display_name	string פלט בלבד. השם המוצג של הכלי.
response	Struct חובה. תוצאת ההפעלה של הכלי בפורמט אובייקט JSON. משתמשים במפתח 'output' כדי לציין את התגובה של הכלי ובמפתח 'error' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות output ו-error, כל התגובה נחשבת לתוצאת ההפעלה של הכלי.
parent_tool_call_id	string פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה.
agent_name	string פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו.
שדה איחוד tool_identifier. המזהה של הכלי שהופעל. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים:
tool	string זה שינוי אופציונלי. שם הכלי להפעלה. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool זה שינוי אופציונלי. הכלי בערכת הכלים שהופעל.

ToolResponses

תוצאות ההפעלה של קריאות הכלים המבוקשות מהלקוח.

שדות
tool_responses[]	ToolResponse זה שינוי אופציונלי. רשימת תוצאות ההרצה של הכלי.

ערכת כלים

ערכת כלים מייצגת קבוצה של כלים שמנוהלים באופן דינמי, והסוכן יכול להשתמש בהם.

שדות
name	string מזהה. המזהה הייחודי של ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string זה שינוי אופציונלי. השם המוצג של ערכת הכלים. המזהה חייב להיות ייחודי באותה אפליקציה.
description	string זה שינוי אופציונלי. תיאור של ערכת הכלים.
timeout	Duration זה שינוי אופציונלי. הזמן הקצוב לתפוגה של הרצת ערכת הכלים. אם לא מוגדר ערך, פסק הזמן שמוגדר כברירת מחדל הוא 30 שניות עבור ערכות כלים של SYNCHRONOUS ו-60 שניות עבור ערכות כלים של ASYNCHRONOUS.
create_time	Timestamp פלט בלבד. חותמת זמן של מועד יצירת ערכת הכלים.
update_time	Timestamp פלט בלבד. חותמת זמן של מועד העדכון האחרון של ערכת הכלים.
etag	string תג ETag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
execution_type	ExecutionType זה שינוי אופציונלי. סוג הביצוע של הכלים בערכת הכלים.
tool_fake_config	ToolFakeConfig זה שינוי אופציונלי. הגדרות של אופן הפעולה של הכלים במצב מזויף.
שדה איחוד toolset_type. סוג ערכת הכלים. הערך toolset_type יכול להיות רק אחד מהבאים:
mcp_toolset	McpToolset זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוצעים על ידי שרת ה-MCP.
open_api_toolset	OpenApiToolset זה שינוי אופציונלי. ערכת כלים שמכילה רשימה של כלים שמוגדרים על ידי סכימת OpenAPI.
connector_toolset	ConnectorToolset זה שינוי אופציונלי. ערכת כלים שיוצרת כלים מחיבור Integration Connectors.

ToolsetTool

כלי שנוצר מתוך ערכת כלים.

שדות
toolset	string חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string זה שינוי אופציונלי. מזהה הכלי לסינון הכלים כדי לאחזר את הסכימה שלהם.

TransferRule

כלל להעברה לסוכן ספציפי.

שדות
child_agent	string חובה. שם המשאב של הסוכן הצאצא שהכלל חל עליו. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction חובה. כיוון ההעברה.
שדה איחוד rule_type. סוג הכלל. הערך rule_type יכול להיות רק אחד מהבאים:
deterministic_transfer	TransferRule.DeterministicTransfer זה שינוי אופציונלי. כלל שמעביר באופן מיידי לסוכן היעד כשהתנאי מתקיים.
disable_planner_transfer	TransferRule.DisablePlannerTransfer זה שינוי אופציונלי. כלל שמונע מהמתכנן להעביר את השיחה לסוכן היעד.

DeterministicTransfer

כלל העברה דטרמיניסטי. אם התנאי מתקיים, מתבצעת ההעברה.

שדות
שדה איחוד condition_type. התנאי להערכה. הערך condition_type יכול להיות רק אחד מהבאים:
expression_condition	ExpressionCondition זה שינוי אופציונלי. כלל שמעריך תנאי של מצב סשן. אם התנאי מקבל את הערך True, ההעברה מתבצעת.
python_code_condition	PythonCodeCondition זה שינוי אופציונלי. כלל שמשתמש בבלוק קוד של Python כדי להעריך את התנאים. אם התנאי מקבל את הערך True, ההעברה מתבצעת.

כיוון

כיוון ההעברה.

טיפוסים בני מנייה (enum)
DIRECTION_UNSPECIFIED	כיוון לא מוגדר.
PARENT_TO_CHILD	העברה מסוכן ראשי לסוכן הבן.
CHILD_TO_PARENT	העברה מסוכן הילד לסוכן הראשי.

DisablePlannerTransfer

כלל שמונע את ההעברה של המתכנן לסוכן היעד.

שדות
expression_condition	ExpressionCondition חובה. אם התנאי מקבל את הערך true, אי אפשר יהיה להעביר את המתכנן לסוכן היעד.

TriggerAction

הפעולה שמתבצעת כשמתקיים תנאי מוקדם מסוים.

שדות
שדה איחוד action. הפעולה שצריך לבצע. הערך action יכול להיות רק אחד מהבאים:
respond_immediately	TriggerAction.RespondImmediately זה שינוי אופציונלי. לשלוח מיד תשובה שהוגדרה מראש.
transfer_agent	TriggerAction.TransferAgent זה שינוי אופציונלי. להעביר את השיחה לנציג אחר.
generative_answer	TriggerAction.GenerativeAnswer זה שינוי אופציונלי. שליחת תשובה גנרטיבית.

GenerativeAnswer

הנציג יגיב מיד עם תשובה גנרטיבית.

שדות
prompt	string חובה. הפרומפט שמשמש ליצירת התשובה.

RespondImmediately

הנציג יגיב מיד בתשובה שהוגדרה מראש.

שדות
responses[]	TriggerAction.Response חובה. התשובות המוכנות מראש שהסוכן יכול לבחור מתוכן. התשובה נבחרת באופן אקראי.

תשובה

מייצג תשובה מהסוכן.

שדות
text	string חובה. הטקסט שהסוכן צריך להגיב עליו.
disabled	bool זה שינוי אופציונלי. האם התשובה מושבתת. התשובות המושבתות לא נמצאות בשימוש של הסוכן.

TransferAgent

הנציג יעביר את השיחה לנציג אחר.

שדות
agent	string חובה. שם הסוכן שאליו תועבר השיחה. הסוכן צריך להיות באותו אפליקציה שבה נמצא הסוכן הנוכחי. פורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

בקשת הודעה עבור AgentService.UpdateAgent.

שדות
agent	Agent חובה. הסוכן לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

UpdateAppRequest

בקשת הודעה עבור AgentService.UpdateApp.

שדות
app	App חובה. האפליקציה שרוצים לעדכן.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

UpdateAppVersionRequest

בקשת הודעה עבור AgentService.UpdateAppVersion.

שדות
app_version	AppVersion חובה. גרסת האפליקציה לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. רשימת השדות לעדכון. אם השדות ריקים, הם display_name ו-description יעודכנו.

UpdateDeploymentRequest

בקשת הודעה עבור AgentService.UpdateDeployment.

שדות
deployment	Deployment חובה. הפריסה לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. רשימת השדות לעדכון.

UpdateExampleRequest

בקשת הודעה עבור AgentService.UpdateExample.

שדות
example	Example חובה. הדוגמה לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

UpdateGuardrailRequest

בקשת הודעה עבור AgentService.UpdateGuardrail.

שדות
guardrail	Guardrail חובה. הגדרת ה-guardrail שרוצים לעדכן.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

UpdateToolRequest

בקשת הודעה עבור AgentService.UpdateTool.

שדות
tool	Tool חובה. הכלי לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

UpdateToolsetRequest

בקשת הודעה עבור AgentService.UpdateToolset.

שדות
toolset	Toolset חובה. ערכת הכלים לעדכון.
update_mask	FieldMask זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו.

VpcScSettings

ההגדרות של VPC-SC לאפליקציה.

שדות
allowed_origins[]	string זה שינוי אופציונלי. מקורות HTTP(s) המותרים שאליהם כלי OpenAPI באפליקציה יכולים להתקשר ישירות כשהשירות VPC Service Controls מופעל. המחרוזות האלה צריכות להיות זהות למקור, כולל היציאה אם היא צוינה. לדוגמה, 'https://example.com' או 'https://example.com:443'. הרשימה הזו עדיין לא חלה על כלי Python שעשויים לבצע קריאות HTTP ישירות.

WebSearchQuery

מייצג שאילתת חיפוש יחידה באינטרנט ואת כתובת ה-URI של החיפוש שמשויכת אליה.

שדות
query	string הטקסט של שאילתת החיפוש.
uri	string ה-URI של דף תוצאות החיפוש ב-Google עבור השאילתה.

WhatsAppCredentials

פרטי כניסה זמניים של מטא לשילוב מובנה של וואטסאפ.

שדות
auth_code	string חובה. קוד האימות של Meta שמופיע בתהליך ההרשמה המוטמע.
pin	string חובה. קוד האימות בן 6 הספרות שנוצר על ידי המשתמש לאימות דו-שלבי.
phone_number	string חובה. מספר הטלפון שרוצים להירשם איתו לוואטסאפ.
business_account_id	string חובה. מזהה החשבון העסקי שבו יש להשתמש עבור מספר הטלפון.
waba_id	string חובה. מספר החשבון ב-WhatsApp Business.
conversation_profile_id	string זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה.

WidgetTool

מייצג כלי לווידג'ט שהסוכן יכול להפעיל. כשהסוכן בוחר בכלי, הוא מחזיר את הווידג'ט ללקוח. הלקוח אחראי לעיבוד הווידג'ט וליצירת שאילתת המשתמש הבאה כדי להמשיך את האינטראקציה עם הסוכן.

שדות
name	string חובה. השם המוצג של כלי הווידג'ט.
description	string זה שינוי אופציונלי. התיאור של כלי הווידג'ט.
widget_type	WidgetTool.WidgetType זה שינוי אופציונלי. סוג כלי הווידג'ט. אם לא מציינים סוג, ברירת המחדל היא CUSTOMIZED.
ui_config	Struct זה שינוי אופציונלי. הגדרות הרינדור של הווידג'ט.
data_mapping	WidgetTool.DataMapping זה שינוי אופציונלי. המיפוי שמגדיר איך נתונים מכלי מקור ממופים לפרמטרים של הקלט בווידג'ט.
text_response_config	WidgetTool.TextResponseConfig זה שינוי אופציונלי. הגדרה של תשובות טקסט שתמיד נכללות.
שדה איחוד input. הקלט של כלי הווידג'ט. הערך input יכול להיות רק אחד מהבאים:
parameters	Schema זה שינוי אופציונלי. פרמטרי הקלט של כלי הווידג'ט.

DataMapping

הגדרות למיפוי נתונים מכלי מקור לפרמטרים של קלט בווידג'ט.

שדות
source_tool_name	string זה שינוי אופציונלי. שם המשאב של הכלי שמספק את הנתונים לווידג'ט (למשל, כלי חיפוש או פונקציה בהתאמה אישית). פורמט: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> זה שינוי אופציונלי. מיפוי של שדות פרמטרים של קלט בווידג'ט לשדות הפלט התואמים של כלי המקור.
python_function	PythonFunction זה שינוי אופציונלי. הגדרות לפונקציית Python שמשמשת להמרת הפלט של כלי המקור לפורמט הקלט של הווידג'ט.
mode	WidgetTool.DataMapping.Mode זה שינוי אופציונלי. מצב מיפוי הנתונים.
python_script (deprecated)	string הפריט הזה הוצא משימוש. הוצא משימוש: במקומו צריך להשתמש ב-python_function.

מצב

האסטרטגיה שמשמשת למיפוי נתונים מכלי המקור לווידג'ט.

טיפוסים בני מנייה (enum)
MODE_UNSPECIFIED	מצב לא מוגדר.
FIELD_MAPPING	משתמשים במפה field_mappings כדי לבצע טרנספורמציה של נתונים.
PYTHON_SCRIPT	משתמשים ב-python_script לטרנספורמציה של נתונים.

TextResponseConfig

ההגדרה של תגובת הטקסט שמוחזרת עם הווידג'ט.

שדות
type	WidgetTool.TextResponseConfig.Type זה שינוי אופציונלי. האסטרטגיה למתן תשובת הטקסט.
static_text	string זה שינוי אופציונלי. תשובת הטקסט הסטטית שמוחזרת כשהסוג הוא STATIC.
text_response_instruction	string זה שינוי אופציונלי. הוראה למודל השפה הגדול (LLM) לגבי אופן יצירת תשובת הטקסט. הערך הזה משמש כתיאור של פרמטר התגובה הטקסטואלית אם הסוג הוא LLM_GENERATED.

סוג

מגדיר איך נוצרת תשובה שהיא טקסט.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED	סוג לא מוגדר.
NONE	מודל ה-LLM מחליט באופן דינמי אם ליצור תשובה טקסטואלית לצד הווידג'ט, על סמך הקשר של השיחה.
LLM_GENERATED	המודל הגדול של השפה נדרש במפורש ליצור תשובה שהיא טקסט.
STATIC	תמיד נעשה שימוש בתגובה סטטית מוגדרת מראש.

WidgetType

כל סוגי הווידג'טים הזמינים. יכול להיות שבעתיד נוסיף ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
WIDGET_TYPE_UNSPECIFIED	סוג הווידג'ט לא צוין.
CUSTOM	סוג הווידג'ט המותאם אישית.
PRODUCT_CAROUSEL	ווידג'ט של קרוסלת מוצרים.
PRODUCT_DETAILS	ווידג'ט של פרטי מוצר.
QUICK_ACTIONS	ווידג'ט של פעולות מהירות.
PRODUCT_COMPARISON	ווידג'ט להשוואת מוצרים.
ADVANCED_PRODUCT_DETAILS	ווידג'ט מתקדם של פרטי מוצר.
SHORT_FORM	ווידג'ט של סרטון קצר.
OVERALL_SATISFACTION	ווידג'ט של שביעות רצון כללית.
ORDER_SUMMARY	ווידג'ט של סיכום ההזמנה.
APPOINTMENT_DETAILS	ווידג'ט של פרטי הפגישה.
APPOINTMENT_SCHEDULER	ווידג'ט לקביעת פגישות.
CONTACT_FORM	ווידג'ט של טופס ליצירת קשר.