Índice
AgentService(interfaz)AssistantService(interfaz)EvaluationService(interfaz)SessionService(interfaz)ToolService(interfaz)WidgetService(interfaz)Action(mensaje)Action.EntityOperation(mensaje)Action.EntityOperation.OperationType(enum)ActiveTurnInfo(mensaje)ActiveTurnInfo.Status(enum)Agent(mensaje)Agent.AgentToolset(mensaje)Agent.LlmAgent(mensaje)Agent.RemoteA2aAgent(mensaje)Agent.RemoteDialogflowAgent(mensaje)AgentCard(mensaje)AgentInterface(mensaje)AgentRegistryDeployment(mensaje)AgentSkill(mensaje)AgentTool(mensaje)AgentTransfer(mensaje)AggregatedMetrics(mensaje)AggregatedMetrics.HallucinationMetrics(mensaje)AggregatedMetrics.MetricsByAppVersion(mensaje)AggregatedMetrics.MetricsByTurn(mensaje)AggregatedMetrics.SemanticSimilarityMetrics(mensaje)AggregatedMetrics.ToolCallLatencyMetrics(mensaje)AggregatedMetrics.ToolMetrics(mensaje)AggregatedMetrics.TurnLatencyMetrics(mensaje)AmbientSoundConfig(mensaje)AmbientSoundConfig.PrebuiltAmbientNoise(enum)ApiAuthentication(mensaje)ApiKeyConfig(mensaje)ApiKeyConfig.RequestLocation(enum)App(mensaje)App.ToolExecutionMode(enum)App.VariableDeclaration(mensaje)AppSnapshot(mensaje)AppVersion(mensaje)ArtifactChunk(mensaje)ArtifactChunk.State(enum)AssistantChunk(mensaje)AssistantConfirmationRequest(mensaje)AssistantConfirmationRequest.Target(mensaje)AssistantConfirmationResponse(mensaje)AssistantMessage(mensaje)AssistantOutput(mensaje)AssistantSession(mensaje)AssistantSessionArtifact(mensaje)AssistantSessionState(enum)AssistantSuggestion(mensaje)AssistantSuggestion.Icon(enum)AssistantSuggestion.LoadSession(mensaje)AssistantSuggestion.Source(enum)AudioEncoding(enum)AudioProcessingConfig(mensaje)AudioRecordingConfig(mensaje)BargeInConfig(mensaje)BatchDeleteConversationsRequest(mensaje)BatchDeleteConversationsResponse(mensaje)BearerTokenConfig(mensaje)BidiSessionClientMessage(mensaje)BidiSessionServerMessage(mensaje)BigQueryExportSettings(mensaje)Blob(mensaje)Callback(mensaje)CancelAssistantTurnRequest(mensaje)CancelAssistantTurnResponse(mensaje)Changelog(mensaje)ChannelProfile(mensaje)ChannelProfile.ChannelType(enum)ChannelProfile.InstagramConfig(mensaje)ChannelProfile.PersonaProperty(mensaje)ChannelProfile.PersonaProperty.Persona(enum)ChannelProfile.WebWidgetConfig(mensaje)ChannelProfile.WebWidgetConfig.Modality(enum)ChannelProfile.WebWidgetConfig.SecuritySettings(mensaje)ChannelProfile.WebWidgetConfig.Theme(enum)ChannelProfile.WhatsAppConfig(mensaje)ChatAiAssistantRequest(mensaje)ChatAiAssistantResponse(mensaje)Chunk(mensaje)Citations(mensaje)Citations.CitedChunk(mensaje)Citations.InlineCitation(mensaje)ClientCertificateSettings(mensaje)ClientFunction(mensaje)CloudLoggingSettings(mensaje)CodeBlock(mensaje)ConnectorTool(mensaje)ConnectorToolset(mensaje)Conversation(mensaje)Conversation.ChannelType(enum)Conversation.InputType(enum)Conversation.Source(enum)Conversation.Turn(mensaje)ConversationLoggingSettings(mensaje)CreateAgentRequest(mensaje)CreateAppRequest(mensaje)CreateAppVersionRequest(mensaje)CreateAssistantSessionRequest(mensaje)CreateDeploymentRequest(mensaje)CreateEvaluationDatasetRequest(mensaje)CreateEvaluationExpectationRequest(mensaje)CreateEvaluationRequest(mensaje)CreateExampleRequest(mensaje)CreateGuardrailRequest(mensaje)CreateScheduledEvaluationRunRequest(mensaje)CreateToolRequest(mensaje)CreateToolsetRequest(mensaje)CustomVoiceSample(mensaje)CustomVoiceSample.VoiceInstructionMode(enum)CustomVoiceSample.Warning(mensaje)CustomVoiceSample.Warning.WarningType(enum)DashboardSettings(mensaje)DataStore(mensaje)DataStore.ConnectorConfig(mensaje)DataStore.DataStoreType(enum)DataStore.DocumentProcessingMode(enum)DataStoreSettings(mensaje)DataStoreSettings.Engine(mensaje)DataStoreSettings.Engine.Type(enum)DataStoreTool(mensaje)DataStoreTool.BoostSpec(mensaje)DataStoreTool.BoostSpec.ConditionBoostSpec(mensaje)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec(mensaje)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(enum)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(mensaje)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(enum)DataStoreTool.BoostSpecs(mensaje)DataStoreTool.DataStoreSource(mensaje)DataStoreTool.EngineSource(mensaje)DataStoreTool.FilterParameterBehavior(enum)DataStoreTool.GroundingConfig(mensaje)DataStoreTool.ModalityConfig(mensaje)DataStoreTool.ModalityConfig.ModalityType(enum)DataStoreTool.RewriterConfig(mensaje)DataStoreTool.SnippetsConfig(mensaje)DataStoreTool.SummarizationConfig(mensaje)DeleteAgentRequest(mensaje)DeleteAppRequest(mensaje)DeleteAppVersionRequest(mensaje)DeleteAssistantSessionRequest(mensaje)DeleteConversationRequest(mensaje)DeleteDeploymentRequest(mensaje)DeleteEvaluationDatasetRequest(mensaje)DeleteEvaluationExpectationRequest(mensaje)DeleteEvaluationRequest(mensaje)DeleteEvaluationResultRequest(mensaje)DeleteEvaluationRunOperationMetadata(mensaje)DeleteEvaluationRunRequest(mensaje)DeleteExampleRequest(mensaje)DeleteGuardrailRequest(mensaje)DeleteScheduledEvaluationRunRequest(mensaje)DeleteToolRequest(mensaje)DeleteToolsetRequest(mensaje)DeployChannelResponse(mensaje)Deployment(mensaje)Deployment.Modality(enum)EndSession(mensaje)EndUserAuthConfig(mensaje)EndUserAuthConfig.Oauth2AuthCodeConfig(mensaje)EndUserAuthConfig.Oauth2JwtBearerConfig(mensaje)EndpointControlPolicy(mensaje)EndpointControlPolicy.EnforcementScope(enum)ErrorHandlingSettings(mensaje)ErrorHandlingSettings.EndSessionConfig(mensaje)ErrorHandlingSettings.ErrorHandlingStrategy(enum)ErrorHandlingSettings.FallbackResponseConfig(mensaje)Evaluation(mensaje)Evaluation.Golden(mensaje)Evaluation.GoldenExpectation(mensaje)Evaluation.GoldenTurn(mensaje)Evaluation.Scenario(mensaje)Evaluation.Scenario.Milestone(mensaje)Evaluation.Scenario.TaskCompletionBehavior(enum)Evaluation.Scenario.UserFact(mensaje)Evaluation.Scenario.UserGoalBehavior(enum)Evaluation.ScenarioExpectation(mensaje)Evaluation.ScenarioExpectation.ToolExpectation(mensaje)Evaluation.Step(mensaje)EvaluationConfig(mensaje)EvaluationConfig.EvaluationChannel(enum)EvaluationDataset(mensaje)EvaluationErrorInfo(mensaje)EvaluationErrorInfo.ErrorType(enum)EvaluationExpectation(mensaje)EvaluationExpectation.LlmCriteria(mensaje)EvaluationMetricsConfig(mensaje)EvaluationMetricsConfig.ComparisonType(enum)EvaluationMetricsConfig.ExpectationsMetMetricsConfig(mensaje)EvaluationMetricsConfig.GoldenMetricsConfig(mensaje)EvaluationMetricsConfig.HallucinationMetricsConfig(mensaje)EvaluationMetricsConfig.ScenarioMetricsConfig(mensaje)EvaluationMetricsConfig.SemanticSimilarityMetricsConfig(mensaje)EvaluationMetricsConfig.ToolCorrectnessMetricsConfig(mensaje)EvaluationMetricsConfig.UserGoalMetMetricsConfig(mensaje)EvaluationMetricsThresholds(mensaje)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds(mensaje)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds(mensaje)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds(mensaje)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel(enum)EvaluationMetricsThresholds.HallucinationMetricBehavior(enum)EvaluationMetricsThresholds.ToolMatchingSettings(mensaje)EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior(enum)EvaluationPersona(mensaje)EvaluationPersona.SpeechConfig(mensaje)EvaluationPersona.SpeechConfig.BackgroundEnvironment(enum)EvaluationResult(mensaje)EvaluationResult.EvaluationExpectationResult(mensaje)EvaluationResult.ExecutionState(enum)EvaluationResult.GoldenExpectationOutcome(mensaje)EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult(mensaje)EvaluationResult.GoldenResult(mensaje)EvaluationResult.GoldenResult.TurnReplayResult(mensaje)EvaluationResult.HallucinationResult(mensaje)EvaluationResult.Outcome(enum)EvaluationResult.OutcomeMetadata(enum)EvaluationResult.OverallToolInvocationResult(mensaje)EvaluationResult.ScenarioExpectationOutcome(mensaje)EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall(mensaje)EvaluationResult.ScenarioResult(mensaje)EvaluationResult.ScenarioResult.MilestoneResult(mensaje)EvaluationResult.ScenarioResult.MilestoneResult.MilestoneStatus(enum)EvaluationResult.ScenarioRubricOutcome(mensaje)EvaluationResult.SemanticSimilarityResult(mensaje)EvaluationResult.SpanLatency(mensaje)EvaluationResult.SpanLatency.Type(enum)EvaluationResult.TaskCompletionResult(mensaje)EvaluationResult.ToolCallLatency(mensaje)EvaluationResult.UserGoalSatisfactionResult(mensaje)EvaluationRun(mensaje)EvaluationRun.EvaluationRunState(enum)EvaluationRun.EvaluationRunSummary(mensaje)EvaluationRun.EvaluationType(enum)EvaluationRun.Progress(mensaje)EvaluationRunCachingSettings(mensaje)EvaluationRunCachingSettings.EvaluationRunCachingMode(enum)EvaluationSettings(mensaje)EvaluationSettings.ScenarioConversationInitiator(enum)EvaluationSettings.ScenarioExecutionMode(enum)EvaluationToolCallBehaviour(enum)Event(mensaje)Example(mensaje)ExecuteToolRequest(mensaje)ExecuteToolResponse(mensaje)ExecutionType(enum)ExperimentConfig(mensaje)ExperimentConfig.State(enum)ExperimentConfig.VersionRelease(mensaje)ExperimentConfig.VersionRelease.TrafficAllocation(mensaje)ExportAppRequest(mensaje)ExportAppRequest.ExportFormat(enum)ExportAppResponse(mensaje)ExportEvaluationResultsOperationMetadata(mensaje)ExportEvaluationResultsRequest(mensaje)ExportEvaluationResultsResponse(mensaje)ExportEvaluationRunsOperationMetadata(mensaje)ExportEvaluationRunsRequest(mensaje)ExportEvaluationRunsResponse(mensaje)ExportEvaluationsRequest(mensaje)ExportEvaluationsResponse(mensaje)ExportOptions(mensaje)ExportOptions.ExportFormat(enum)ExpressionCondition(mensaje)FileContext(mensaje)FileContext.FileBytes(mensaje)FileSearchTool(mensaje)FileSearchTool.CorpusType(enum)GenerateAppResourceOperationMetadata(mensaje)GenerateAppResourceOperationMetadata.GenerationType(enum)GenerateAppResourceRequest(mensaje)GenerateAppResourceRequest.AppGenerationConfig(mensaje)GenerateAppResourceRequest.AppVersionContext(mensaje)GenerateAppResourceRequest.EvaluationGenerationConfig(mensaje)GenerateAppResourceRequest.EvaluationPersonasGenerationConfig(mensaje)GenerateAppResourceRequest.HillClimbingFixConfig(mensaje)GenerateAppResourceRequest.QualityReportGenerationConfig(mensaje)GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm(enum)GenerateAppResourceRequest.RefineInstructions(mensaje)GenerateAppResourceRequest.ToolGenerationConfig(mensaje)GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig(mensaje)GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig(mensaje)GenerateAppResourceResponse(mensaje)GenerateAppResourceResponse.AppResources(mensaje)GenerateAppResourceResponse.Evaluations(mensaje)GenerateAppResourceResponse.GenerateResultInfo(mensaje)GenerateAppResourceResponse.Tools(mensaje)GenerateChatTokenRequest(mensaje)GenerateChatTokenResponse(mensaje)GenerateEvaluationOperationMetadata(mensaje)GenerateEvaluationRequest(mensaje)GenerateEvaluationRequest.EvaluationType(enum)GenerateOnboardingSuggestionsRequest(mensaje)GenerateOnboardingSuggestionsResponse(mensaje)GenerateOnboardingSuggestionsResponse.UserProfile(enum)GetAgentRequest(mensaje)GetAppRequest(mensaje)GetAppVersionRequest(mensaje)GetAssistantSessionRequest(mensaje)GetChangelogRequest(mensaje)GetConversationRequest(mensaje)GetDeploymentRequest(mensaje)GetEvaluationDatasetRequest(mensaje)GetEvaluationExpectationRequest(mensaje)GetEvaluationRequest(mensaje)GetEvaluationResultRequest(mensaje)GetEvaluationRunRequest(mensaje)GetExampleRequest(mensaje)GetGuardrailRequest(mensaje)GetScheduledEvaluationRunRequest(mensaje)GetSecuritySettingsRequest(mensaje)GetToolRequest(mensaje)GetToolsetRequest(mensaje)GoAway(mensaje)GoogleSearchSuggestions(mensaje)GoogleSearchTool(mensaje)GoogleSearchTool.PromptConfig(mensaje)Guardrail(mensaje)Guardrail.CodeCallback(mensaje)Guardrail.ContentFilter(mensaje)Guardrail.ContentFilter.MatchType(enum)Guardrail.LlmPolicy(mensaje)Guardrail.LlmPolicy.PolicyScope(enum)Guardrail.LlmPromptSecurity(mensaje)Guardrail.LlmPromptSecurity.DefaultSecuritySettings(mensaje)Guardrail.ModelSafety(mensaje)Guardrail.ModelSafety.HarmBlockThreshold(enum)Guardrail.ModelSafety.HarmCategory(enum)Guardrail.ModelSafety.SafetySetting(mensaje)Guardrail.Supervisor(mensaje)Guardrail.Supervisor.DetectionMode(enum)Guardrail.Supervisor.Type(enum)Image(mensaje)ImportAppRequest(mensaje)ImportAppRequest.ImportOptions(mensaje)ImportAppRequest.ImportOptions.ConflictResolutionStrategy(enum)ImportAppResponse(mensaje)ImportEvaluationsOperationMetadata(mensaje)ImportEvaluationsRequest(mensaje)ImportEvaluationsRequest.ConversationList(mensaje)ImportEvaluationsRequest.ImportOptions(mensaje)ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy(enum)ImportEvaluationsResponse(mensaje)InputAudioConfig(mensaje)InstagramCredentials(mensaje)InterruptionSignal(mensaje)LanguageSettings(mensaje)LatencyReport(mensaje)LatencyReport.CallbackLatency(mensaje)LatencyReport.GuardrailLatency(mensaje)LatencyReport.LatencyMetrics(mensaje)LatencyReport.LlmCallLatency(mensaje)LatencyReport.ToolLatency(mensaje)ListAgentsRequest(mensaje)ListAgentsResponse(mensaje)ListAppVersionsRequest(mensaje)ListAppVersionsResponse(mensaje)ListAppsRequest(mensaje)ListAppsResponse(mensaje)ListAssistantSessionsRequest(mensaje)ListAssistantSessionsResponse(mensaje)ListChangelogsRequest(mensaje)ListChangelogsResponse(mensaje)ListConversationsRequest(mensaje)ListConversationsResponse(mensaje)ListDeploymentsRequest(mensaje)ListDeploymentsResponse(mensaje)ListEvaluationDatasetsRequest(mensaje)ListEvaluationDatasetsResponse(mensaje)ListEvaluationExpectationsRequest(mensaje)ListEvaluationExpectationsResponse(mensaje)ListEvaluationResultsRequest(mensaje)ListEvaluationResultsResponse(mensaje)ListEvaluationRunsRequest(mensaje)ListEvaluationRunsResponse(mensaje)ListEvaluationsRequest(mensaje)ListEvaluationsResponse(mensaje)ListExamplesRequest(mensaje)ListExamplesResponse(mensaje)ListGuardrailsRequest(mensaje)ListGuardrailsResponse(mensaje)ListScheduledEvaluationRunsRequest(mensaje)ListScheduledEvaluationRunsResponse(mensaje)ListToolsRequest(mensaje)ListToolsResponse(mensaje)ListToolsetsRequest(mensaje)ListToolsetsResponse(mensaje)LoggingSettings(mensaje)McpTool(mensaje)McpTool.State(enum)McpToolDefinition(mensaje)McpToolOverride(mensaje)McpToolset(mensaje)Message(mensaje)MetricAnalysisSettings(mensaje)MockConfig(mensaje)MockConfig.UnmatchedToolCallBehavior(enum)MockedToolCall(mensaje)ModelSettings(mensaje)ModelSettings.ThinkingLevel(enum)OAuthConfig(mensaje)OAuthConfig.OauthGrantType(enum)OpenApiTool(mensaje)OpenApiToolset(mensaje)OperationCompletedEvent(mensaje)OperationMetadata(mensaje)OptimizationConfig(mensaje)OptimizationConfig.OptimizationStatus(enum)OptionQuestionsChunk(mensaje)OptionQuestionsChunk.Option(mensaje)OptionQuestionsChunk.Question(mensaje)OutputAudioConfig(mensaje)PersonaRunConfig(mensaje)PythonCodeCondition(mensaje)PythonFunction(mensaje)QualityReport(mensaje)QualityReport.AgentIssues(mensaje)QualityReport.Issue(mensaje)RecognitionResult(mensaje)RedactionConfig(mensaje)RemoteA2aConfig(mensaje)RemoteAgentTool(mensaje)RestoreAppVersionRequest(mensaje)RestoreAppVersionResponse(mensaje)RetrieveToolSchemaRequest(mensaje)RetrieveToolSchemaResponse(mensaje)RetrieveToolsRequest(mensaje)RetrieveToolsResponse(mensaje)RunAssistantRequest(mensaje)RunAssistantRequest.InteractionType(enum)RunAssistantResponse(mensaje)RunEvaluationOperationMetadata(mensaje)RunEvaluationRequest(mensaje)RunEvaluationResponse(mensaje)RunEvaluationResultMetricsOperationMetadata(mensaje)RunEvaluationResultMetricsRequest(mensaje)RunEvaluationResultMetricsResponse(mensaje)RunSessionRequest(mensaje)RunSessionResponse(mensaje)ScheduledEvaluationRun(mensaje)ScheduledEvaluationRun.SchedulingConfig(mensaje)ScheduledEvaluationRun.SchedulingConfig.Frequency(enum)Schema(mensaje)Schema.Type(enum)SecuritySettings(mensaje)ServiceAccountAuthConfig(mensaje)ServiceAgentIdTokenAuthConfig(mensaje)ServiceDirectoryConfig(mensaje)SessionCheckpoint(mensaje)SessionConfig(mensaje)SessionConfig.RemoteDialogflowQueryParameters(mensaje)SessionInput(mensaje)SessionInput.RecordingControl(enum)SessionOutput(mensaje)SessionOutput.DiagnosticInfo(mensaje)Span(mensaje)StreamChatAiAssistantRequest(mensaje)StreamChatAiAssistantRequest.ClientCapability(enum)StreamChatAiAssistantResponse(mensaje)SynthesizeSpeechConfig(mensaje)SystemTool(mensaje)TestPersonaVoiceRequest(mensaje)TestPersonaVoiceResponse(mensaje)TimeZoneSettings(mensaje)TlsConfig(mensaje)TlsConfig.CaCert(mensaje)Tool(mensaje)ToolCall(mensaje)ToolCalls(mensaje)ToolFakeConfig(mensaje)ToolResponse(mensaje)ToolResponses(mensaje)Toolset(mensaje)ToolsetTool(mensaje)TransferRule(mensaje)TransferRule.DeterministicTransfer(mensaje)TransferRule.Direction(enum)TransferRule.DisablePlannerTransfer(mensaje)TriggerAction(mensaje)TriggerAction.GenerativeAnswer(mensaje)TriggerAction.RespondImmediately(mensaje)TriggerAction.Response(mensaje)TriggerAction.TransferAgent(mensaje)TurnCompletedEvent(mensaje)TurnCompletedEvent.Reason(enum)TurnHandoffEvent(mensaje)TurnHandoffEvent.Reason(enum)TurnMetadata(mensaje)TurnMetadata.ContractStreamingPhase(enum)TurnResumeSnapshot(mensaje)TypedPayload(mensaje)UiEvent(mensaje)UpdateAgentRequest(mensaje)UpdateAppRequest(mensaje)UpdateAppVersionRequest(mensaje)UpdateDeploymentRequest(mensaje)UpdateEvaluationDatasetRequest(mensaje)UpdateEvaluationExpectationRequest(mensaje)UpdateEvaluationRequest(mensaje)UpdateExampleRequest(mensaje)UpdateGuardrailRequest(mensaje)UpdateScheduledEvaluationRunRequest(mensaje)UpdateSecuritySettingsRequest(mensaje)UpdateToolRequest(mensaje)UpdateToolsetRequest(mensaje)UploadEvaluationAudioRequest(mensaje)UploadEvaluationAudioResponse(mensaje)UserResponseSuggestions(mensaje)VpcScSettings(mensaje)WebSearchQuery(mensaje)WhatsAppCredentials(mensaje)WidgetTool(mensaje)WidgetTool.DataMapping(mensaje)WidgetTool.DataMapping.Mode(enum)WidgetTool.TextResponseConfig(mensaje)WidgetTool.TextResponseConfig.Type(enum)WidgetTool.WidgetType(enum)
AgentService
Es el servicio que administra los recursos relacionados con los agentes en Gemini Enterprise for Customer Engagement (CES).
| BatchDeleteConversations |
|---|
|
Borra por lotes las conversaciones especificadas.
|
| CreateAgent |
|---|
|
Crea un agente nuevo en la app determinada.
|
| CreateApp |
|---|
|
Crea una app nueva en el proyecto y la ubicación determinados.
|
| CreateAppVersion |
|---|
|
Crea una versión nueva de la app en la app determinada.
|
| CreateDeployment |
|---|
|
Crea una implementación nueva en la app determinada.
|
| CreateExample |
|---|
|
Crea un ejemplo nuevo en la app determinada.
|
| CreateGuardrail |
|---|
|
Crea una nueva barandilla en la app determinada.
|
| CreateTool |
|---|
|
Crea una herramienta nueva en la app determinada.
|
| CreateToolset |
|---|
|
Crea un nuevo conjunto de herramientas en la app determinada.
|
| DeleteAgent |
|---|
|
Borra el agente especificado.
|
| DeleteApp |
|---|
|
Borra la app especificada.
|
| DeleteAppVersion |
|---|
|
Borra la versión de la app especificada.
|
| DeleteConversation |
|---|
|
Borra la conversación especificada.
|
| DeleteDeployment |
|---|
|
Borra la implementación especificada.
|
| DeleteExample |
|---|
|
Borra el ejemplo especificado.
|
| DeleteGuardrail |
|---|
|
Borra la barandilla especificada.
|
| DeleteTool |
|---|
|
Borra la herramienta especificada.
|
| DeleteToolset |
|---|
|
Borra el conjunto de herramientas especificado.
|
| ExportApp |
|---|
|
Exporta la app especificada.
|
| GenerateAppResource |
|---|
|
Genera recursos específicos (p.ej., un agente) en la app con el asistente de LLM.
|
| GetAgent |
|---|
|
Obtiene los detalles del agente especificado.
|
| GetApp |
|---|
|
Obtiene detalles de la app especificada.
|
| GetAppVersion |
|---|
|
Obtiene detalles de la versión de la app especificada.
|
| GetChangelog |
|---|
|
Obtiene el registro de cambios especificado.
|
| GetConversation |
|---|
|
Obtiene los detalles de la conversación especificada.
|
| GetDeployment |
|---|
|
Obtiene los detalles de la implementación especificada.
|
| GetExample |
|---|
|
Obtiene detalles del ejemplo especificado.
|
| GetGuardrail |
|---|
|
Obtiene los detalles de la protección especificada.
|
| GetSecuritySettings |
|---|
|
Recupera la configuración de seguridad del proyecto y la ubicación.
|
| GetTool |
|---|
|
Obtiene detalles de la herramienta especificada.
|
| GetToolset |
|---|
|
Obtiene detalles del conjunto de herramientas especificado.
|
| ImportApp |
|---|
|
Importa la app especificada.
|
| ListAgents |
|---|
|
Enumera los agentes de la app determinada.
|
| ListAppVersions |
|---|
|
Enumera todas las versiones de la app determinada.
|
| ListApps |
|---|
|
Enumera las apps en la ubicación y el proyecto determinados.
|
| ListChangelogs |
|---|
|
Enumera los registros de cambios de la app especificada.
|
| ListConversations |
|---|
|
Enumera las conversaciones de la app determinada.
|
| ListDeployments |
|---|
|
Enumera las implementaciones en la app determinada.
|
| ListExamples |
|---|
|
Enumera los ejemplos de la app determinada.
|
| ListGuardrails |
|---|
|
Enumera las protecciones de la app determinada.
|
| ListTools |
|---|
|
Enumera las herramientas de la app determinada.
|
| ListToolsets |
|---|
|
Enumera los conjuntos de herramientas de la app determinada.
|
| RestoreAppVersion |
|---|
|
Restablece la versión de la app especificada. Se creará una nueva versión de la app a partir del borrador actual y se reemplazará el borrador actual por la versión de la app especificada.
|
| UpdateAgent |
|---|
|
Actualiza el agente especificado.
|
| UpdateApp |
|---|
|
Actualiza la app especificada.
|
| UpdateAppVersion |
|---|
|
Actualiza la versión de la app especificada.
|
| UpdateDeployment |
|---|
|
Actualiza la implementación especificada.
|
| UpdateExample |
|---|
|
Actualiza el ejemplo especificado.
|
| UpdateGuardrail |
|---|
|
Actualiza la barandilla especificada.
|
| UpdateSecuritySettings |
|---|
|
Actualiza la configuración de seguridad del proyecto y la ubicación.
|
| UpdateTool |
|---|
|
Actualiza la herramienta especificada.
|
| UpdateToolset |
|---|
|
Actualiza el conjunto de herramientas especificado.
|
AssistantService
Es el servicio que administra los recursos relacionados con el asistente en el Paquete de interacción con los clientes (CES). El asistente, Arc, es un agente conversacional incorporado en las aplicaciones de CES para ayudar a los usuarios a crear sus agentes.
| ChatAiAssistant |
|---|
|
Ejecuta Arc, el asistente de IA, para la sesión de asistente especificada.
|
| CreateAssistantSession |
|---|
|
Crea una nueva sesión de asistente en la app determinada.
|
| DeleteAssistantSession |
|---|
|
Borra la sesión de asistente especificada.
|
| GetAssistantSession |
|---|
|
Obtiene detalles de la sesión de asistente especificada.
|
| ListAssistantSessions |
|---|
|
Enumera todas las sesiones de asistente en la app determinada.
|
| RunAssistant |
|---|
|
Ejecuta el agente de asistencia para la sesión de asistencia especificada.
|
EvaluationService
EvaluationService expone métodos para realizar evaluaciones de la app de CES.
| CreateEvaluation |
|---|
|
Crea una evaluación.
|
| CreateEvaluationDataset |
|---|
|
Crea un conjunto de datos de evaluación.
|
| CreateEvaluationExpectation |
|---|
|
Crea una expectativa de evaluación.
|
| CreateScheduledEvaluationRun |
|---|
|
Crea una ejecución de evaluación programada.
|
| DeleteEvaluation |
|---|
|
Borra una evaluación.
|
| DeleteEvaluationDataset |
|---|
|
Borra un conjunto de datos de evaluación.
|
| DeleteEvaluationExpectation |
|---|
|
Borra una expectativa de evaluación.
|
| DeleteEvaluationResult |
|---|
|
Borra un resultado de evaluación.
|
| DeleteEvaluationRun |
|---|
|
Borra una ejecución de evaluación.
|
| DeleteScheduledEvaluationRun |
|---|
|
Borra una ejecución de evaluación programada.
|
| ExportEvaluationResults |
|---|
|
Exporta los resultados de las evaluaciones.
|
| ExportEvaluationRuns |
|---|
|
Exporta ejecuciones de evaluaciones.
|
| ExportEvaluations |
|---|
|
Exporta evaluaciones.
|
| GenerateEvaluation |
|---|
|
Crea una evaluación de referencia a partir de una conversación.
|
| GetEvaluation |
|---|
|
Obtiene los detalles de la evaluación especificada.
|
| GetEvaluationDataset |
|---|
|
Obtiene los detalles del conjunto de datos de evaluación especificado.
|
| GetEvaluationExpectation |
|---|
|
Obtiene detalles de la expectativa de evaluación especificada.
|
| GetEvaluationResult |
|---|
|
Obtiene los detalles del resultado de la evaluación especificado.
|
| GetEvaluationRun |
|---|
|
Obtiene los detalles de la ejecución de evaluación especificada.
|
| GetScheduledEvaluationRun |
|---|
|
Obtiene los detalles de la ejecución de evaluación programada especificada.
|
| ImportEvaluations |
|---|
|
Importa evaluaciones a la app.
|
| ListEvaluationDatasets |
|---|
|
Enumera todos los conjuntos de datos de evaluación de la app determinada.
|
| ListEvaluationExpectations |
|---|
|
Enumera todas las expectativas de evaluación de la app determinada.
|
| ListEvaluationResults |
|---|
|
Enumera todos los resultados de una evaluación determinada.
|
| ListEvaluationRuns |
|---|
|
Enumera todas las ejecuciones de evaluación en la app determinada.
|
| ListEvaluations |
|---|
|
Enumera todas las evaluaciones de la app determinada.
|
| ListScheduledEvaluationRuns |
|---|
|
Enumera todas las ejecuciones de evaluación programadas en la app determinada.
|
| RunEvaluation |
|---|
|
Ejecuta una evaluación de la app.
|
| RunEvaluationResultMetrics |
|---|
|
Ejecuta métricas en un resultado de evaluación existente.
|
| TestPersonaVoice |
|---|
|
Prueba la voz de un personaje. También acepta un arquetipo predeterminado.
|
| UpdateEvaluation |
|---|
|
Actualiza una evaluación.
|
| UpdateEvaluationDataset |
|---|
|
Actualiza un conjunto de datos de evaluación.
|
| UpdateEvaluationExpectation |
|---|
|
Actualiza una expectativa de evaluación.
|
| UpdateScheduledEvaluationRun |
|---|
|
Actualiza una ejecución de evaluación programada.
|
| UploadEvaluationAudio |
|---|
|
Sube audio para usarlo en las evaluaciones de referencia. Almacena el audio en el bucket de Cloud Storage definido en "App.logging_settings.evaluation_audio_recording_config.gcs_bucket" y devuelve una transcripción.
|
SessionService
El servicio de sesión proporciona APIs para interactuar con los agentes de CES.
| BidiRunSession |
|---|
|
Establece una conexión de transmisión bidireccional con el agente de CES. El agente procesa entradas multimodales continuas (p.ej., texto y audio) y genera transmisiones de salida multimodales en tiempo real. --- Flujo de solicitudes del cliente --- El cliente transmite las solicitudes en el siguiente orden:
--- Transmisión de respuesta del servidor --- Para cada turno de interacción, el agente transmite mensajes en la siguiente secuencia:
--- Audio Best Practices --- 1. Transmisión: Transmite
|
| CancelAssistantTurn |
|---|
|
Cancela el turno en curso de la sesión del asistente, si lo hay: la detención explícita del usuario para un turno que se ejecuta de forma independiente de cualquier transmisión. Una cancelación que llega a una tarea que no aloja el turno lo interrumpe a través de la época del turno de la sesión, lo que lo finaliza dentro de una renovación de la asignación.
|
| GenerateOnboardingSuggestions |
|---|
|
Genera sugerencias de integración personalizadas para el estado cero de Arc: clasifica al usuario que realiza la solicitud (nuevo, explorando o recurrente) a partir de su historial de sesiones de asistente en la app y devuelve chips de sugerencias (reanudar una sesión, continuar el trabajo o comenzar algo nuevo) para renderizar antes de que se envíe cualquier mensaje.
|
| RunSession |
|---|
|
Inicia una interacción de un solo turno con el agente de CES dentro de una sesión.
|
| StreamChatAiAssistant |
|---|
|
Ejecuta Arc, el asistente de IA, para la sesión de asistente especificada en un formato de transmisión.
|
| StreamRunSession |
|---|
|
Inicia una interacción de un solo turno con el agente de CES. Usa la transmisión del servidor para entregar resultados incrementales y respuestas parciales a medida que se generan. De forma predeterminada, las respuestas completas (p.ej., mensajes de devoluciones de llamada o respuestas completas de LLM) se envían al cliente en cuanto están disponibles. Para habilitar la transmisión de fragmentos de texto individuales directamente desde el modelo, establece
|
ToolService
El servicio de herramientas proporciona APIs para interactuar con las herramientas de CES.
| ExecuteTool |
|---|
|
Ejecuta la herramienta especificada con los argumentos proporcionados.
|
| RetrieveToolSchema |
|---|
|
Recupera el esquema de la herramienta determinada. El esquema se calcula sobre la marcha para la instancia determinada de la herramienta.
|
| RetrieveTools |
|---|
|
Recupera la lista de herramientas incluidas en el conjunto de herramientas especificado.
|
WidgetService
Proporciona APIs para que los widgets interactúen con las APIs de CES.
| GenerateChatToken |
|---|
|
Genera un token con alcance de sesión para que el widget de chat se autentique con las APIs de sesión.
|
Acción
Es la configuración de una acción que usará la herramienta. Nota: Puede ser una acción o una operación. Consulta https://cloud.google.com/integration-connectors/docs/entities-operation-action para obtener más detalles.
| Campos | |
|---|---|
input_fields[] |
Es opcional. Son los campos de entidad que se usarán como entradas para la operación. Si no se especifica ningún campo, se usarán todos los campos de la entidad. |
output_fields[] |
Es opcional. Son los campos de entidad que se devolverán de la operación. Si no se especifica ningún campo, se devolverán todos los campos de la entidad. |
Campo de unión action_spec. Especificación de una acción que se debe configurar para que la herramienta la use. action_spec puede ser solo uno de los parámetros siguientes: |
|
connection_action_id |
Es el ID de una acción de conexión que usará la herramienta. |
entity_operation |
Es la configuración de la operación de entidad que usará la herramienta. |
EntityOperation
Especificación de la operación CRUD de la entidad.
| Campos | |
|---|---|
entity_id |
Obligatorio. Es el ID de la entidad. |
operation |
Obligatorio. Es la operación que se realizará en la entidad. |
OperationType
Es la operación que se realizará en la entidad.
| Enums | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
No se especificó el tipo de operación. No es válido, por lo que fallará la creación o actualización de ConnectorTool. |
LIST |
Operación de lista. |
GET |
Obtener operación. |
CREATE |
Crea una operación. |
UPDATE |
Operación de actualización. |
DELETE |
Borra la operación. |
ActiveTurnInfo
Información de conexión en vivo para un turno de sesión que se está ejecutando, que se desconectó de su cliente o que se estacionó para que lo recoja otra tarea del servidor.
| Campos | |
|---|---|
turn_id |
Identifica el turno; se repite en las instantáneas de reanudación de la API de transmisión. |
status |
Es el estado actual del archivo adjunto. |
start_time |
Solo salida. Cuándo comenzó el turno |
last_progress_time |
Solo salida. Cuándo se guardó el progreso por última vez en el turno. |
orphan_deadline_time |
Solo salida. Cuándo se cerrará el turno si no se conecta ningún cliente. |
Estado
Cómo se relaciona actualmente el turno en ejecución con los clientes y las tareas del servidor.
| Enums | |
|---|---|
STATUS_UNSPECIFIED |
Sin especificar. |
RUNNING |
El turno se está ejecutando con al menos un cliente conectado. |
DISCONNECTED |
El turno se está ejecutando sin ningún cliente conectado. |
RESUMING |
El turno se estaciona para la recogida: la siguiente conexión lo continúa. |
ABANDONED |
El arrendamiento del servidor del turno venció y ninguna tarea lo controla. La próxima lectura lo sella como parcial confirmado. No se puede adjuntar. |
Agente
Un agente actúa como el componente básico que proporciona instrucciones al modelo de lenguaje grande (LLM) para ejecutar tareas específicas.
| Campos | |
|---|---|
name |
Es el identificador. El identificador único del agente. Formato: |
display_name |
Obligatorio. Es el nombre visible del agente. |
description |
Es opcional. Descripción del agente legible por humanos. |
model_settings |
Es opcional. Son los parámetros de configuración del modelo de LLM. |
instruction |
Es opcional. Son las instrucciones para que el modelo de LLM guíe el comportamiento del agente. |
tools[] |
Es opcional. Es la lista de herramientas disponibles para el agente. Formato: |
child_agents[] |
Es opcional. Es la lista de agentes secundarios en el árbol de agentes. Formato: |
before_agent_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
after_agent_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al agente. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
before_model_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
after_model_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
before_tool_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán antes de que se invoque la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
after_tool_callbacks[] |
Es opcional. Son las devoluciones de llamada que se ejecutarán después de que se invoque la herramienta. Si hay varias invocaciones de herramientas, la devolución de llamada se ejecutará varias veces. Las devoluciones de llamada proporcionadas se ejecutan de forma secuencial en el orden exacto en que se proporcionan en la lista. Si una devolución de llamada muestra una respuesta anulada, la ejecución se detiene y se omiten las devoluciones de llamada restantes. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el agente. |
update_time |
Solo salida. Marca de tiempo de la última actualización del agente. |
guardrails[] |
Es opcional. Es la lista de barreras de seguridad para el agente. Formato: |
etag |
Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
toolsets[] |
Es opcional. Es la lista de conjuntos de herramientas para el agente. |
generated_summary |
Solo salida. Si el asistente de LLM genera el agente, este campo contiene un resumen descriptivo de la generación. |
transfer_rules[] |
Es opcional. Reglas de transferencia de agentes Si coinciden varias reglas, se usará la primera de la lista. |
validation_errors[] |
Solo salida. Parámetros de configuración incorrectos o errores en el agente que pueden afectar su calidad. |
Campo de unión agent_type. Es el tipo de agente. agent_type puede ser solo uno de los parámetros siguientes: |
|
llm_agent |
Es opcional. Es el tipo de agente predeterminado. |
remote_dialogflow_agent |
Es opcional. Es el agente remoto de Dialogflow que se usará para la ejecución del agente. Si se establece este campo, se ignorarán todas las demás propiedades a nivel del agente. Nota: Si el agente de Dialogflow está en un proyecto diferente al de la app, debes otorgar |
remote_a2a_agent |
Es opcional. El agente A2A remoto que se usará para la ejecución del agente. |
AgentToolset
Un conjunto de herramientas con una selección de sus herramientas.
| Campos | |
|---|---|
toolset |
Obligatorio. Es el nombre del recurso del conjunto de herramientas. Formato: |
tool_ids[] |
Es opcional. Son los IDs de las herramientas para filtrar el conjunto de herramientas. |
LlmAgent
Este tipo no tiene campos.
Es el tipo de agente predeterminado. El agente usa las instrucciones y las devoluciones de llamada especificadas en él para realizar la tarea con un modelo de lenguaje grande.
RemoteA2aAgent
Es el agente que transferirá la ejecución a un agente A2A remoto.
| Campos | |
|---|---|
a2a_config |
Obligatorio. Es la configuración de la conexión de A2A. |
RemoteDialogflowAgent
Es el agente que transferirá la ejecución a un agente remoto de Dialogflow CX. El agente de Dialogflow procesará las consultas posteriores del usuario hasta que finalice la sesión o el flujo, y el control se transferirá de vuelta al agente de CES superior.
| Campos | |
|---|---|
agent |
Obligatorio. Es el nombre del recurso del agente de Dialogflow. Formato: |
flow_id |
Es opcional. Es el ID del flujo en el agente de Dialogflow. |
environment_id |
Es opcional. Es el ID de entorno del agente de Dialogflow que se usará para la ejecución del agente. Si no se especifica, se usará el entorno de borrador. |
input_variable_mapping |
Es opcional. La asignación de los nombres de las variables de la app a los nombres de los parámetros de sesión de Dialogflow que se enviarán al agente de Dialogflow como entrada. |
output_variable_mapping |
Es opcional. Es la asignación de los nombres de los parámetros de sesión de Dialogflow a los nombres de las variables de la app que se enviarán de vuelta al agente de CES después de que finalice la ejecución del agente de Dialogflow. |
respect_response_interruption_settings |
Es opcional. Indica si se debe respetar la configuración de interrupción a nivel del mensaje establecida en el agente de Dialogflow.
|
language_code_variable |
Es opcional. Es el nombre de la variable que contiene el código de idioma que se usará para la sesión de Dialogflow. Si no se especifica, se usará el código de idioma predeterminado del agente de Dialogflow. |
AgentCard
AgentCard transmite información clave sobre un agente remoto. Es una versión reducida de AgentCard definida en el protocolo A2A https://a2a-protocol.org/dev/specification/#441-agentcard
| Campos | |
|---|---|
name |
Obligatorio. Nombre del agente legible por humanos. |
description |
Obligatorio. Una descripción del dominio de acción o espacio de solución del agente. |
supported_interfaces[] |
Obligatorio. Es una lista ordenada de interfaces compatibles. Se prefiere la primera entrada. |
version |
Obligatorio. Es la versión del agente. |
skills[] |
Obligatorio. Las habilidades representan una unidad de capacidad que un agente puede realizar. Esto puede ser un poco abstracto, pero representa un conjunto de acciones más enfocado en el que es muy probable que el agente tenga éxito. |
AgentInterface
Declara una combinación de una URL de destino, un transporte y una versión de protocolo para interactuar con el agente. Esto permite que los agentes expongan la misma funcionalidad a través de varios mecanismos de vinculación de protocolos.
| Campos | |
|---|---|
url |
Obligatorio. Es la URL en la que está disponible esta interfaz. Debe ser una URL HTTPS absoluta válida en producción. Ejemplo: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
protocol_binding |
Obligatorio. Es la vinculación de protocolo admitida en esta URL. Esta es una cadena de formato abierto que se puede extender fácilmente para otras vinculaciones de protocolo. Los principales que se admiten oficialmente son |
tenant |
Es el ID de usuario que se usará en la solicitud cuando se llame al agente. |
protocol_version |
Obligatorio. Es la versión del protocolo A2A que expone esta interfaz. Usa la versión secundaria compatible más reciente por versión principal. Ejemplos: "0.3", "1.0" |
AgentRegistryDeployment
Configuración y estado de la implementación de Agent Registry.
| Campos | |
|---|---|
agent_registry_service_name |
Es opcional. Solo salida. Es el nombre del recurso del servicio de Agent Registry implementado. Formato: |
AgentSkill
Representa una capacidad o función distinta que un agente puede realizar.
| Campos | |
|---|---|
id |
Obligatorio. Es un identificador único para la habilidad del agente. |
name |
Obligatorio. Es un nombre legible por humanos para la habilidad. |
description |
Obligatorio. Es una descripción detallada de la habilidad. |
tags[] |
Obligatorio. Un conjunto de palabras clave que describen las capacidades de la habilidad. |
examples[] |
Instrucciones o situaciones de ejemplo que esta habilidad puede controlar. |
input_modes[] |
Es el conjunto de tipos de contenido multimedia de entrada admitidos para esta habilidad, que anula los valores predeterminados del agente. |
output_modes[] |
Es el conjunto de tipos de medios de salida admitidos para esta habilidad, que anula los valores predeterminados del agente. |
AgentTool
Representa una herramienta que permite que el agente llame a otro agente.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta del agente. |
description |
Es opcional. Descripción del propósito de la herramienta. |
agent |
Es opcional. Es el nombre del recurso del agente que es el punto de entrada de la herramienta. Formato: |
AgentTransfer
Representa un evento que indica la transferencia de una conversación a un agente diferente.
| Campos | |
|---|---|
target_agent |
Obligatorio. Es el agente al que se transfiere la conversación. El agente se encargará de la conversación a partir de este punto. Formato: |
display_name |
Solo salida. Es el nombre visible del agente. |
AggregatedMetrics
Son las métricas agregadas para una evaluación o un conjunto de datos de evaluación.
| Campos | |
|---|---|
metrics_by_app_version[] |
Solo salida. Son las métricas agregadas, agrupadas por ID de versión de la app. |
HallucinationMetrics
Métricas para los resultados de alucinaciones.
| Campos | |
|---|---|
score |
Solo salida. La puntuación promedio de alucinaciones (de 0 a 1). |
MetricsByAppVersion
Son las métricas agregadas por versión de la app.
| Campos | |
|---|---|
app_version_id |
Solo salida. Es el ID de la versión de la app. |
tool_metrics[] |
Solo salida. Métricas de cada herramienta en esta versión de la app |
semantic_similarity_metrics[] |
Solo salida. Métricas de similitud semántica en esta versión de la app. |
hallucination_metrics[] |
Solo salida. Métricas de alucinación en esta versión de la app. |
tool_call_latency_metrics[] |
Solo salida. Métricas de la latencia de las llamadas a herramientas en esta versión de la app. |
turn_latency_metrics[] |
Solo salida. Métricas de la latencia de turnos en esta versión de la app. |
pass_count |
Solo salida. Es la cantidad de veces que se aprobó la evaluación. |
fail_count |
Solo salida. Es la cantidad de veces que falló la evaluación. |
metrics_by_turn[] |
Solo salida. Son las métricas agregadas por turno dentro de esta versión de la app. |
MetricsByTurn
Métricas agregadas por turno.
| Campos | |
|---|---|
turn_index |
Solo salida. Es el índice de turno (basado en 0). |
tool_metrics[] |
Solo salida. Son las métricas de cada herramienta en este turno. |
semantic_similarity_metrics[] |
Solo salida. Son las métricas de similitud semántica dentro de este turno. |
hallucination_metrics[] |
Solo salida. Métricas de alucinación en este turno. |
tool_call_latency_metrics[] |
Solo salida. Métricas de la latencia de la llamada a la herramienta en este turno. |
turn_latency_metrics[] |
Solo salida. Métricas de la latencia de turno dentro de este turno. |
SemanticSimilarityMetrics
Métricas para los resultados de similitud semántica.
| Campos | |
|---|---|
score |
Solo salida. La puntuación promedio de similitud semántica (0-4). |
ToolCallLatencyMetrics
Métricas de la latencia de las llamadas a herramientas.
| Campos | |
|---|---|
tool |
Solo salida. Es el nombre de la herramienta. |
average_latency |
Solo salida. La latencia promedio de las llamadas a la herramienta. |
ToolMetrics
Métricas para una sola herramienta.
| Campos | |
|---|---|
tool |
Solo salida. Es el nombre de la herramienta. |
pass_count |
Solo salida. La cantidad de veces que se aprobó la herramienta. |
fail_count |
Solo salida. Es la cantidad de veces que falló la herramienta. |
TurnLatencyMetrics
Métricas de latencia de turnos.
| Campos | |
|---|---|
average_latency |
Solo salida. Es la latencia promedio de los turnos. |
AmbientSoundConfig
Configuración del sonido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.
| Campos | |
|---|---|
volume_gain_db |
Es opcional. Es la ganancia de volumen (en dB) del volumen nativo normal que admite el ruido ambiental, en el rango [-96.0, 16.0]. Si no se establece, o se establece en un valor de 0.0 (dB), se reproducirá en la amplitud de la señal nativa normal. Un valor de -6.0 (dB) se reproducirá aproximadamente a la mitad de la amplitud de la señal nativa normal. Un valor de +6.0 (dB) se reproducirá aproximadamente al doble de la amplitud de la señal nativa normal. Recomendamos no superar los +10 (dB) ya que, por lo general, no hay un aumento efectivo en la sonoridad para ningún valor superior. |
Campo de unión source. Es el ruido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. source puede ser solo uno de los parámetros siguientes: |
|
prebuilt_ambient_noise |
Es opcional. Obsoleto: |
gcs_uri |
Es opcional. Ruido ambiental como un archivo WAV de 16 kHz de un solo canal almacenado en Cloud Storage. Nota: Asegúrate de que el agente de servicio de CES |
prebuilt_ambient_sound |
Es opcional. Es el nombre del sonido ambiental predeterminado. Los valores válidos son los siguientes: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" |
PrebuiltAmbientNoise
Ruido ambiental precompilado.
| Enums | |
|---|---|
PREBUILT_AMBIENT_NOISE_UNSPECIFIED |
No especificado. |
RETAIL_STORE |
Ruido ambiental de una tienda minorista. |
CONVENTION_HALL |
Ruido ambiental de una sala de convenciones. |
OUTDOOR |
Ruido ambiental de una calle. |
ApiAuthentication
Es la información de autenticación necesaria para las llamadas a la API.
| Campos | |
|---|---|
Campo de unión auth_config. Es la configuración de autenticación. auth_config puede ser solo uno de los parámetros siguientes: |
|
api_key_config |
Es opcional. Configuración para la autenticación con clave de API. |
oauth_config |
Es opcional. Configuración de OAuth. |
service_agent_id_token_auth_config |
Es opcional. Es la configuración para la autenticación con tokens de ID generada a partir del agente de servicio de CES. |
service_account_auth_config |
Es opcional. Es la configuración para la autenticación de la cuenta de servicio. |
bearer_token_config |
Es opcional. Es la configuración para la autenticación de token del portador. |
ApiKeyConfig
Parámetros de configuración para la autenticación con la clave de API.
| Campos | |
|---|---|
key_name |
Obligatorio. Es el nombre del parámetro o del encabezado de la clave de API. P. ej., Si la solicitud a la API es "https://example.com/act?X-Api-Key= |
api_key_secret_version |
Obligatorio. Es el nombre del recurso de la versión del Secret de Secret Manager que almacena la clave de API. Formato: Nota: Debes otorgar el rol |
request_location |
Obligatorio. Es la ubicación de la clave en la solicitud. |
RequestLocation
La ubicación de la clave de API en la solicitud.
| Enums | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
Sin especificar. No se debe usar este valor. |
HEADER |
Representa la clave en el encabezado HTTP. |
QUERY_STRING |
Representa la clave en la cadena de consulta. |
App
Una app funciona como un contenedor de nivel superior para un grupo de agentes, incluidos el agente raíz y sus agentes secundarios, junto con sus configuraciones asociadas. Estos agentes trabajan juntos para lograr objetivos específicos dentro del contexto de la app.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la app. Formato: |
display_name |
Obligatorio. Es el nombre visible de la app. |
description |
Es opcional. Es la descripción legible por humanos de la app. |
pinned |
Es opcional. Indica si la app está fijada en la lista de apps. |
root_agent |
Es opcional. El agente raíz es el punto de entrada de la app. Formato: |
language_settings |
Es opcional. La configuración de idioma de la app |
time_zone_settings |
Es opcional. Es la configuración de la zona horaria de la app. |
audio_processing_config |
Es opcional. Es la configuración del procesamiento de audio de la app. |
logging_settings |
Es opcional. Es la configuración de registro de la app. |
error_handling_settings |
Es opcional. Configuración de manejo de errores de la app. |
model_settings |
Es opcional. La configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y protecciones) pueden anular estos parámetros de configuración según sea necesario. |
tool_execution_mode |
Es opcional. Es el modo de ejecución de la herramienta para la app. Si no se proporciona, se establecerá de forma predeterminada en PARALLEL. |
evaluation_metrics_thresholds |
Es opcional. Son los umbrales de evaluación de la app. |
variable_declarations[] |
Es opcional. Las declaraciones de las variables. |
predefined_variable_declarations[] |
Solo salida. Son las declaraciones de variables predefinidas para la app. |
global_instruction |
Es opcional. Son instrucciones para todos los agentes de la app. Puedes usar esta instrucción para configurar una identidad o personalidad estable en todos los agentes. |
guardrails[] |
Es opcional. Es la lista de protecciones de la app. Formato: |
data_store_settings |
Es opcional. Es la configuración del almacén de datos de la app. |
default_channel_profile |
Es opcional. Es el perfil de canal predeterminado que usa la app. |
metadata |
Es opcional. Son los metadatos sobre la app. Este campo se puede usar para almacenar información adicional relevante para los detalles de la app o los usos previstos. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la app. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la app. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
deployment_count |
Solo salida. Es la cantidad de implementaciones en la app. |
client_certificate_settings |
Es opcional. Es la configuración predeterminada del certificado de cliente para la app. |
vpc_sc_settings |
Es opcional. La configuración de VPC-SC para la app. |
locked |
Es opcional. Indica si la app está bloqueada para cambios. Si la app está bloqueada, se rechazarán las modificaciones en sus recursos. |
evaluation_personas[] |
Es opcional. Son los perfiles de evaluación de la app. Este campo se usa para definir los perfiles que se pueden usar para la evaluación. Se puede definir un máximo de 30 arquetipos de cliente. |
evaluation_settings |
Es opcional. Es la configuración de evaluación de la app. |
validation_errors[] |
Solo salida. Configuraciones incorrectas o advertencias en la app |
dashboard_settings |
Es opcional. Configuración del panel específica de la app para vincular y configurar los paneles de Estadísticas de Contact Center. |
ToolExecutionMode
Define el comportamiento de ejecución de las herramientas si el agente selecciona varias herramientas al mismo tiempo.
| Enums | |
|---|---|
TOOL_EXECUTION_MODE_UNSPECIFIED |
Modo de ejecución de la herramienta no especificado. El valor predeterminado es PARALLEL. |
PARALLEL |
Si se seleccionan varias herramientas, se ejecutarán en paralelo, con el mismo ToolContext. |
SEQUENTIAL |
Si se seleccionan varias herramientas, se ejecutarán de forma secuencial. La siguiente herramienta solo se ejecutará después de que se complete la anterior y pueda ver el ToolContext actualizado de la herramienta anterior. |
VariableDeclaration
Define la estructura y los metadatos de una variable.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la variable. El nombre debe comenzar con una letra o un guion bajo, y solo puede contener letras, números o guiones bajos. |
description |
Obligatorio. Es la descripción de la variable. |
schema |
Obligatorio. Es el esquema de la variable. |
AppSnapshot
Una instantánea de la app
| Campos | |
|---|---|
app |
Es opcional. La configuración básica de la app |
agents[] |
Es opcional. Es la lista de agentes de la app. |
tools[] |
Es opcional. Lista de herramientas de la app. |
examples[] |
Es opcional. Es la lista de ejemplos en la app. |
guardrails[] |
Es opcional. Lista de barreras de seguridad en la app. |
toolsets[] |
Es opcional. Es la lista de conjuntos de herramientas de la app. |
AppVersion
En Paquete de interacción con los clientes (CES), una versión de la app es una instantánea de la app en un momento específico. Es inmutable y no se puede modificar una vez que se crea.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la versión de la app. Formato: |
display_name |
Es opcional. Es el nombre visible de la versión de la app. |
description |
Es opcional. Es la descripción de la versión de la app. |
creator |
Solo salida. Es el correo electrónico del usuario que creó la versión de la app. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la versión de la app. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la versión de la app. |
snapshot |
Solo salida. La instantánea de la app cuando se crea la versión. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
ArtifactChunk
Un fragmento transmitido de un artefacto de documento (p.ej., un TDD de Markdown) que genera el asistente. Los cambios de contenido se transmiten mientras se escribe el documento para que los clientes puedan renderizar una vista previa en vivo. El fragmento FINALIZED lleva el URI de Cloud Storage una vez que se conserva el archivo.
| Campos | |
|---|---|
artifact_id |
Identificador del artefacto, estable en todos los fragmentos de un artefacto dentro de la transmisión. |
display_name |
Es el nombre del archivo que se muestra al usuario, p.ej., "hotel_booking_tdd.md". Se establece en STARTED (y se repite en FINALIZED). |
mime_type |
Es el tipo de medio de IANA del contenido del artefacto, p.ej., "text/markdown". |
content_delta |
Contenido incremental de artefactos. Se establece en fragmentos DELTA. |
gcs_uri |
Es el objeto de Cloud Storage en el que se conservó el artefacto. Se establece en los fragmentos FINALIZADOS. |
state |
Es la posición del ciclo de vida de este fragmento. |
target_app |
Solo salida. La app para la que se produjo este artefacto, cuando se produjo para una. Formato: |
Estado
Es la posición del ciclo de vida de este fragmento dentro del flujo del artefacto.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valor predeterminado sin usar. |
STARTED |
El asistente comenzó a generar el artefacto. |
DELTA |
Un incremento de contenido; se establece content_delta. |
FINALIZED |
Se conservó el artefacto; se estableció gcs_uri. |
FAILED |
Se produjo un error en la generación o la persistencia, por lo que no se guardó el artefacto. |
CLOSED |
El documento terminó de transmitirse: su contenido se entregó por completo a través de fragmentos de content_delta. Es posible que la persistencia continúe; se envía un fragmento FINALIZED con un gcs_uri si se guarda el artefacto y cuando se guarda. |
AssistantChunk
Un fragmento de datos en un mensaje del asistente.
| Campos | |
|---|---|
create_time |
Es opcional. Es la marca de tiempo de cuando se creó o emitió el fragmento. |
Campo de unión data. Son los datos del fragmento. data puede ser solo uno de los parámetros siguientes: |
|
text |
Es opcional. Datos de texto. |
thought |
Es opcional. Pensamiento generado por el modelo. |
payload |
Es opcional. Carga útil que contiene respuestas estructuradas, como el informe de calidad, el nombre de la versión del agente, las respuestas sugeridas, etcétera. |
typed_payload |
Es opcional. Es la carga útil con tipo que contiene respuestas estructuradas. |
AssistantConfirmationRequest
Es una pregunta o confirmación de bloqueo que el asistente necesita que se responda antes de que pueda continuar una acción del agente. El agente que realiza la solicitud se pausa y se reanuda solo cuando la respuesta llega en un StreamChatAiAssistantRequest.confirmation_response posterior.
| Campos | |
|---|---|
confirmation_id |
Es el identificador que correlaciona esta solicitud con su respuesta. Es opaco para los clientes; se debe repetir de forma literal en la solicitud de respuesta. |
context |
Contexto que describe lo que se confirma (p.ej., la acción que el agente quiere realizar o la pregunta que necesita responder). Se renderiza como texto sin formato, no como Markdown. |
positive_label |
Es la etiqueta de la acción de aprobación de una confirmación binaria (p.ej., "Publicar"). No se establece cuando se propaga |
negative_label |
Etiqueta para la acción de rechazo de una confirmación binaria (p.ej., "Todavía no"). No se establece cuando se propaga |
questions[] |
Formulario de confirmación de opción múltiple. Cuando se propaga, la tarjeta renderiza una lista de opciones seleccionables y el submit_text de la opción elegida (o el texto de formato libre del usuario) se devuelve como |
tool |
Es el nombre de la llamada a la herramienta en la que se detuvo el agente (p.ej., "update_app") para el encabezado de la tarjeta. No se establece para preguntas puras. |
agent_name |
Es la etiqueta de visualización del agente que generó la confirmación (p.ej., |
expire_time |
Es el tiempo después del cual ya no se puede responder esta confirmación. Una tarjeta vencida se renderiza como inactiva y el servidor rechaza la confirmación en el siguiente turno para que el agente pausado no espere de forma indefinida. |
targets[] |
Todo lo que cambiará la acción confirmada, para que la consola pueda renderizar "Actualizar 2 apps" y una insignia por app. Se deja vacío para las tarjetas heredadas de un solo objetivo. |
Objetivo
Un recurso que cambiará la acción confirmada.
| Campos | |
|---|---|
resource |
Es el recurso que cambiará, como un nombre de recurso completo. |
display_name |
Es el nombre visible del recurso o la app para la tarjeta. |
action |
La acción, p.ej., |
target_app |
Es la app a la que pertenece el recurso o está vacía para una acción con alcance de ubicación, como crear una app. Formato: |
AssistantConfirmationResponse
Es la respuesta del usuario a un AssistantConfirmationRequest, que se envía en la siguiente llamada a SessionService.StreamChatAiAssistant para reanudar el agente en pausa.
| Campos | |
|---|---|
confirmation_id |
La |
Campo de unión response. Es la respuesta del usuario. response puede ser solo uno de los parámetros siguientes: |
|
confirmed |
Respuesta binaria: true aprueba la acción pausada, false la rechaza. |
answer_text |
El submit_text de la opción elegida o el texto de formato libre del usuario. Se cancela la acción pausada y se entrega el texto al agente para que actúe en consecuencia. |
AssistantMessage
Es un mensaje en una sesión de asistente.
| Campos | |
|---|---|
role |
Obligatorio. Es el rol dentro de la conversación "user" o "model". |
chunks[] |
Es opcional. Contenido del mensaje como fragmentos. |
event_time |
Obligatorio. Es la marca de tiempo del momento en que se envió o recibió el mensaje. |
attached_gcs_uris[] |
Es opcional. Son los URIs de Cloud Storage para los archivos que subió el usuario durante este turno. Esto permite que los archivos adjuntos se conserven y se rendericen en la IU del historial de sesiones. Ejemplo: "gs://cxas-transient-uploads/uuid/prd.pdf" |
AssistantOutput
El resultado del agente asistente.
| Campos | |
|---|---|
message |
Obligatorio. La respuesta del agente asistente. |
user_response_suggestions |
Solo salida. Son las respuestas sugeridas del usuario del agente de asistencia. |
AssistantSession
Una sesión de asistente representa una conversación entre un usuario y el agente de asistencia.
| Campos | |
|---|---|
name |
Obligatorio. Es el identificador. Es el identificador único de la sesión. Formato: |
requestor |
Solo salida. Es el usuario que inició la sesión. |
messages[] |
Es opcional. Es el historial de mensajes de la sesión. |
state |
Solo salida. El estado de la sesión de asistencia. |
create_time |
Solo salida. Es la hora en la que se creó la sesión de asistencia. |
update_time |
Solo salida. La hora en la que se actualizó la sesión del asistente por última vez. |
user_response_suggestions |
Solo salida. Son las respuestas sugeridas del usuario del agente de asistencia. |
display_name |
Es opcional. Es el nombre visible de la sesión de asistencia. |
artifacts[] |
Solo salida. Artefactos de documentos (p.ej., TDD generados en Markdown) producidos por el asistente en esta sesión. Solo punteros; el contenido del archivo se encuentra en el bucket de Cloud Storage del cliente. |
session_checkpoint |
Solo salida. Es el punto de control de la sesión que contiene la intención del usuario y el resumen del historial continuo. |
active_turn |
Solo salida. Información del archivo adjunto para el turno que se está ejecutando actualmente en esta sesión. No se establece cuando no se está ejecutando ningún turno. |
touched_apps[] |
Solo salida. Son las apps a las que se orientó o que se cambiaron en esta sesión (solo para sesiones con alcance de proyecto), para las etiquetas de historial. Formato: |
AssistantSessionArtifact
Es un artefacto de documento que genera el asistente dentro de una sesión y que se almacena como un archivo en el bucket de Cloud Storage del cliente.
| Campos | |
|---|---|
id |
Solo salida. Es el identificador único del artefacto dentro de la sesión. |
display_name |
Solo salida. Es el nombre del archivo que se muestra al usuario, p.ej., "hotel_booking_tdd.md". |
gcs_uri |
Solo salida. Es el objeto de Cloud Storage que contiene el contenido del artefacto. Ejemplo: "gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md" |
mime_type |
Solo salida. Es el tipo de medio de IANA del contenido del artefacto, p.ej., "text/markdown". |
create_time |
Solo salida. Cuándo se conservó el artefacto. |
turn_index |
Solo salida. Es el índice del mensaje en [AssistantSession.messages] cuyo turno produjo el artefacto, para colocar el chip del artefacto cuando se restablece el historial. |
AssistantSessionState
Es el estado de la sesión de asistente.
| Enums | |
|---|---|
ASSISTANT_SESSION_STATE_UNSPECIFIED |
Es el valor predeterminado. Este valor se usa si no se especifica el estado. |
PROCESSING |
El agente asistente está procesando la solicitud como una tarea de larga duración. |
IDLE |
El agente asistente está inactivo y no tiene solicitudes ni respuestas pendientes. |
PENDING_REVIEW |
El agente asistente terminó de procesar una tarea de larga duración y tiene una respuesta lista para el usuario. |
AssistantSuggestion
Un solo chip de sugerencias de incorporación personalizado para el estado cero de Arc.
| Campos | |
|---|---|
suggestion_id |
Es el identificador estable de esta sugerencia, que los clientes devuelven en el registro de interacciones. |
label |
Es la etiqueta del chip que se muestra al usuario (60 caracteres como máximo). |
rationale |
Explicación breve opcional de por qué se muestra esta sugerencia (cuadro de información o ventana emergente de justificación). |
icon |
Es la sugerencia de ícono para el chip. |
source |
Cómo se generó esta sugerencia |
candidate_type |
Es el tipo de candidato de la tabla de reglas en minúsculas con guiones medios (p.ej., "resume-pending-review") para las métricas. |
Campo de unión action. Qué sucede cuando se activa el chip action puede ser solo uno de los parámetros siguientes: |
|
seed_prompt |
Completa previamente el compositor con este texto; el usuario lo revisa y lo envía. |
load_session |
Abre una sesión existente de Gemini. |
send_message |
Completa previamente el compositor con este texto y envíalo de inmediato. Solo se usa para chips de respuesta rápida dentro de una conversación de incorporación activa. |
Ícono
Es la sugerencia de ícono para el chip.
| Enums | |
|---|---|
ICON_UNSPECIFIED |
Ícono sin especificar. |
RESUME |
Reanudar una sesión anterior |
BUILD |
Crea algo nuevo. |
EVALUATE |
Sugerencia relacionada con la evaluación. |
DEPLOY |
Sugerencia relacionada con la Deployment. |
EXPLORE |
Sugerencia de exploración o descubrimiento. |
FIX |
Corregir un error o un estado de falla |
LoadSession
Son los parámetros de la acción load_session.
| Campos | |
|---|---|
assistant_session_id |
Es el identificador de la sesión del asistente que se abrirá (el segmento final del nombre del recurso AssistantSession). |
Fuente
Cómo se generó esta sugerencia
| Enums | |
|---|---|
SOURCE_UNSPECIFIED |
Origen sin especificar. |
RULE |
Candidato de tabla de reglas determinista con fraseo de plantilla. |
LLM_RANKED |
Candidato de la tabla de reglas reclasificado y reformulado por el paso de reformulación del LLM. |
AudioEncoding
AudioEncoding especifica el formato de codificación de los datos de audio.
| Enums | |
|---|---|
AUDIO_ENCODING_UNSPECIFIED |
Codificación de audio no especificada. |
LINEAR16 |
Codificación de audio PCM lineal de 16 bits. |
MULAW |
Las muestras de 8 bits que comprimen las muestras de audio de 14 bits mediante la ley PCMU/mu-law de G.711. |
ALAW |
Muestras de 8 bits que comprimen muestras de audio de 14 bits con la ley A/PCMU G.711. |
AudioProcessingConfig
Es la configuración de cómo se debe procesar y entregar el audio de entrada y salida.
| Campos | |
|---|---|
synthesize_speech_configs |
Es opcional. Configuración de cómo se debe sintetizar la respuesta del agente, asignando el código de idioma a Si no se encuentra la configuración del código de idioma especificado, se usará la configuración del código de idioma raíz. Por ejemplo, si el mapa contiene "en-us" y "en", y el código de idioma especificado es "en-gb", se usará la configuración "en". Nota: El código de idioma no distingue mayúsculas de minúsculas. |
barge_in_config |
Es opcional. Configura el comportamiento del agente para las actividades de interrupción del usuario. |
inactivity_timeout |
Es opcional. Es la duración de la inactividad del usuario (sin voz ni interacción) antes de que el agente le solicite que vuelva a participar. Si no se establece, el agente no le solicitará al usuario que vuelva a interactuar. |
ambient_sound_config |
Es opcional. Configuración del sonido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. |
custom_voice_samples[] |
Es opcional. Configura muestras de voz personalizadas para la clonación de voz. |
AudioRecordingConfig
Es la configuración de cómo se deben grabar las interacciones de audio.
| Campos | |
|---|---|
gcs_bucket |
Es opcional. El bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe empezar con "gs://". Elige una ubicación de bucket que cumpla con tus requisitos de residencia de datos. Nota: Si el bucket de Cloud Storage está en un proyecto diferente al de la app, debes otorgar el permiso |
gcs_path_prefix |
Es opcional. Es el prefijo de la ruta de acceso de Cloud Storage para las grabaciones de audio. Este prefijo puede incluir los siguientes marcadores de posición, que se sustituirán de forma dinámica en el momento de la publicación: - $project: ID del proyecto - $location: ubicación de la app - $app: ID de la app - $date: fecha de la sesión en formato AAAA-MM-DD - $session: ID de la sesión Si no se especifica el prefijo de la ruta de acceso, se usará el prefijo predeterminado |
BargeInConfig
Es la configuración de cómo se deben controlar las actividades de interrupción del usuario.
| Campos | |
|---|---|
disable_barge_in |
Es opcional. Obsoleto: Inhabilita la interrupción del usuario mientras el agente está hablando. Si es verdadero, se ignorará la entrada del usuario durante la reproducción de la respuesta del agente. |
barge_in_awareness |
Es opcional. Si está habilitado, el agente adaptará su próxima respuesta en función de la suposición de que el usuario no escuchó el mensaje anterior completo del agente. No se debe usar en situaciones en las que las respuestas del agente se muestran de forma visual. |
BatchDeleteConversationsRequest
Mensaje de solicitud para AgentService.BatchDeleteConversations.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se borrarán las conversaciones. Formato: |
conversations[] |
Obligatorio. Son los nombres de los recursos de las conversaciones que se borrarán. |
BatchDeleteConversationsResponse
Mensaje de respuesta para AgentService.BatchDeleteConversations.
| Campos | |
|---|---|
deleted_conversations[] |
Es la lista de conversaciones que se borraron correctamente. |
failed_conversations[] |
Es la lista de conversaciones que no se pudieron borrar. |
error_messages[] |
Es opcional. Es una lista de mensajes de error asociados con las conversaciones que no se pudieron borrar. |
BearerTokenConfig
Son los parámetros de configuración para la autenticación con un token del portador.
| Campos | |
|---|---|
token |
Obligatorio. Es el token del portador. Debe tener el formato |
BidiSessionClientMessage
Es el mensaje de nivel superior que envía el cliente para el método SessionService.BidiRunSession.
| Campos | |
|---|---|
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes: |
|
config |
Es opcional. Es el mensaje de configuración inicial de la sesión. |
realtime_input |
Es opcional. Es la entrada en tiempo real de la sesión. |
BidiSessionServerMessage
Es el mensaje de nivel superior que se devuelve del método SessionService.BidiRunSession.
| Campos | |
|---|---|
Campo de unión message_type. El tipo de mensaje. message_type puede ser solo uno de los parámetros siguientes: |
|
session_output |
Es opcional. Resultado del procesamiento del agente de CES. |
recognition_result |
Es opcional. Es el resultado del reconocimiento de voz en tiempo real para la entrada de audio. |
interruption_signal |
Es opcional. Indica que se interrumpió la respuesta de audio del agente. |
end_session |
Es opcional. Indica que la sesión finalizó. |
go_away |
Es opcional. Indica que el servidor se desconectará pronto y que el cliente debe cerrar parcialmente y reiniciar la conexión. |
BigQueryExportSettings
Es la configuración para describir los comportamientos de exportación de BigQuery de la app.
| Campos | |
|---|---|
enabled |
Es opcional. Indica si la exportación de BigQuery está habilitada. |
project |
Es opcional. El ID del proyecto del conjunto de datos de BigQuery al que se exportarán los datos. Nota: Si el conjunto de datos de BigQuery está en un proyecto diferente al de la app, debes otorgar el rol |
dataset |
Es opcional. Es el ID del conjunto de datos de BigQuery al que se exportarán los datos. |
BLOB
Representa una entrada o salida de BLOB en la conversación.
| Campos | |
|---|---|
mime_type |
Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen. |
data |
Obligatorio. Son los bytes sin procesar del BLOB. |
Devolución de llamada
Una devolución de llamada define la lógica personalizada que se ejecutará en varias etapas de la interacción del agente.
| Campos | |
|---|---|
description |
Es opcional. Es una descripción legible por humanos de la devolución de llamada. |
disabled |
Es opcional. Indica si la devolución de llamada está inhabilitada. El agente ignora las devoluciones de llamada inhabilitadas. |
proactive_execution_enabled |
Es opcional. Si se habilita, la devolución de llamada también se ejecutará en los resultados intermedios del modelo. Este parámetro de configuración solo afecta a la devolución de llamada posterior al modelo. HABILITA CON PRECAUCIÓN. Por lo general, la devolución de llamada After model solo debe ejecutarse después de recibir todas las respuestas del modelo. Habilitar la ejecución proactiva puede tener implicaciones negativas en el costo y la latencia de la ejecución, y solo debe habilitarse en situaciones excepcionales. |
Campo de unión callback. Es la devolución de llamada que se ejecutará. callback puede ser solo uno de los parámetros siguientes: |
|
python_code |
Obligatorio. Es el código de Python que se ejecutará para la devolución de llamada. |
CancelAssistantTurnRequest
Solicita cancelar el turno en curso de una sesión de asistente.
| Campos | |
|---|---|
name |
Obligatorio. Es la sesión del asistente cuyo turno en curso se cancelará. |
turn_id |
Es opcional. Es el turno que se cancelará. Si se deja vacío, se cancelará el turno que se esté ejecutando. Una cancelación que nombra un turno que ya no es el que se está ejecutando no tiene efecto. |
CancelAssistantTurnResponse
Respuesta para CancelAssistantTurn.
| Campos | |
|---|---|
cancelled |
Indica si se encontró un turno en curso y se solicitó que se detuviera (directamente en esta tarea o a través de una interrupción de época para un turno alojado en otro lugar). |
Registro de cambios
Los registros de cambios representan un cambio realizado en la app o en un recurso dentro de ella.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único del registro de cambios. Formato: |
author |
Solo salida. Es la dirección de correo electrónico del autor del cambio. |
display_name |
Solo salida. Es el nombre visible del cambio. Por lo general, debe ser el nombre visible del recurso que se modificó. |
description |
Solo salida. Descripción del cambio, que suele capturar los campos modificados en el recurso. |
resource |
Solo salida. Es el recurso que se modificó. |
resource_type |
Solo salida. Es el tipo de recurso que se modificó. |
action |
Solo salida. Es la acción que se realizó en el recurso. |
original_resource |
Solo salida. Es el recurso original antes del cambio. |
new_resource |
Solo salida. Es el recurso nuevo después del cambio. |
dependent_resources[] |
Solo salida. Son los recursos dependientes que se cambiaron. |
create_time |
Solo salida. Es la hora en que se realizó el cambio. |
sequence_number |
Solo salida. Es el número de secuencia que aumenta de forma monótona del registro de cambios. |
ChannelProfile
Un ChannelProfile configura el comportamiento del agente para un canal de comunicación específico, como la IU web o la telefonía.
| Campos | |
|---|---|
profile_id |
Es opcional. Es el identificador único del perfil del canal. |
channel_type |
Es opcional. Es el tipo de perfil del canal. |
persona_property |
Es opcional. Es la propiedad de la persona del perfil del canal. |
web_widget_config |
Es opcional. La configuración del widget web. |
whatsapp_config |
Es opcional. Es la configuración específica de las implementaciones de WhatsApp. |
instagram_config |
Es opcional. Configuración específica para las implementaciones de Instagram. |
disable_dtmf |
Es opcional. Indica si se debe inhabilitar la DTMF (multifrecuencia de dos tonos). |
disable_barge_in_control |
Es opcional. Indica si se debe inhabilitar el control de interrupción del usuario en la conversación. - true: Las interrupciones del usuario se inhabilitan mientras el agente habla. - false: El agente conserva el control automático sobre cuándo el usuario puede interrumpir. |
noise_suppression_level |
Es opcional. Es el nivel de reducción de ruido del perfil del canal. Los valores disponibles son "low", "moderate", "high" y "very_high". |
ChannelType
Es el tipo de perfil del canal.
| Enums | |
|---|---|
UNKNOWN |
Tipo de canal desconocido. |
WEB_UI |
Canal de IU web. |
API |
Canal de la API |
TWILIO |
Canal de Twilio. |
GOOGLE_TELEPHONY_PLATFORM |
Canal de la plataforma de telefonía de Google. |
CONTACT_CENTER_AS_A_SERVICE |
Canal de centro de contacto como servicio (CCaaS). |
CONTACT_CENTER_AS_A_SERVICE_CHAT |
Canal de centro de contacto como servicio (chat de CCaaS). |
FIVE9 |
Canal de Five9. |
CONTACT_CENTER_INTEGRATION |
Canal de integración de centros de contacto de terceros. |
WHATSAPP |
Canal de WhatsApp |
INSTAGRAM |
Canal de Instagram |
InstagramConfig
Configuración específica para las implementaciones de Instagram.
| Campos | |
|---|---|
instagram_account_id |
Obligatorio. Es el ID de la cuenta de Instagram. |
display_name |
Solo salida. Es el nombre de la página de Meta de la empresa que se recuperó. |
thumbnail_url |
Solo salida. Es la URL de la miniatura del perfil de Meta de la empresa que se recuperó. |
description |
Solo salida. La descripción de la página o el perfil de Meta de la empresa. |
PersonaProperty
Representa la propiedad de perfil de un canal.
| Campos | |
|---|---|
persona |
Es opcional. La personalidad del canal |
Personificación
La personalidad del canal
| Enums | |
|---|---|
UNKNOWN |
Persona DESCONOCIDA. |
CONCISE |
El agente mantiene las respuestas concisas y directas. |
CHATTY |
El agente proporciona contexto, explicaciones y detalles adicionales. |
WebWidgetConfig
Mensaje de configuración para el widget web.
| Campos | |
|---|---|
modality |
Es opcional. La modalidad del widget web. |
theme |
Es opcional. Es el tema del widget web. |
web_widget_title |
Es opcional. Es el título del widget web. |
security_settings |
Es opcional. La configuración de seguridad del widget web. |
Modalidad
Es la modalidad del widget web.
| Enums | |
|---|---|
MODALITY_UNSPECIFIED |
Modalidad desconocida. |
CHAT_AND_VOICE |
El widget admite la entrada de chat y voz. |
VOICE_ONLY |
El widget solo admite la entrada de voz. |
CHAT_ONLY |
El widget solo admite la entrada de chat. |
CHAT_VOICE_AND_VIDEO |
El widget admite entradas de chat, voz y video. |
SecuritySettings
Configuración de seguridad del widget web.
| Campos | |
|---|---|
enable_public_access |
Es opcional. Indica si está habilitado el acceso público al widget web. Si es |
enable_origin_check |
Es opcional. Indica si está habilitada la verificación de origen para el widget web. Si es |
allowed_origins[] |
Es opcional. Son los orígenes que pueden alojar el widget web. RFC 6454 define un origen. Si está vacío, se permiten todos los orígenes. Se permite un máximo de 100 orígenes. Ejemplo: "https://example.com" |
enable_recaptcha |
Es opcional. Indica si la verificación de reCAPTCHA para el widget web está habilitada. |
Tema
Es el tema del widget web.
| Enums | |
|---|---|
THEME_UNSPECIFIED |
Tema desconocido. |
LIGHT |
Tema claro. |
DARK |
Tema oscuro |
WhatsAppConfig
Es la configuración específica de las implementaciones de WhatsApp.
| Campos | |
|---|---|
waba_id |
Obligatorio. Es el ID de la cuenta de WhatsApp Business. |
phone_number_id |
Obligatorio. Es el ID del número de teléfono de Meta. |
phone_number |
Es opcional. Es el número de teléfono en formato E.164. |
display_name |
Solo salida. Es el nombre de la página de Meta de la empresa que se recuperó. |
thumbnail_url |
Solo salida. Es la URL de la miniatura del perfil de Meta de la empresa que se recuperó. |
description |
Solo salida. La descripción de la página o el perfil de Meta de la empresa. |
ChatAiAssistantRequest
Mensaje de solicitud para AssistantService.ChatAiAssistant.
| Campos | |
|---|---|
app |
Obligatorio. La app para la que se ejecutará el asistente. Formato: |
assistant_session |
Obligatorio. Es la sesión del asistente que se usará para ejecutarlo. Formato: |
message |
Obligatorio. Es el mensaje que se enviará al agente de asistencia. |
attached_gcs_uris[] |
Es opcional. Son los URIs de Cloud Storage para los archivos que subió el usuario durante este turno. Ejemplo: "gs://cxas-transient-uploads/uuid/prd.pdf" |
context_token |
Es opcional. Es el token de contexto de integración opaco que devuelve |
ChatAiAssistantResponse
Mensaje de respuesta para AssistantService.ChatAiAssistant.
| Campos | |
|---|---|
event_id |
Identificador único para el evento. |
event_time |
Es la marca de tiempo de cuando ocurrió el evento. |
ui_event |
Es opcional. Es la carga útil del evento de IU. |
Campo de unión event. Es la carga útil del evento. event puede ser solo uno de los parámetros siguientes: |
|
text_chunk |
Token de texto (para transmitir las respuestas de Gemini palabra por palabra) |
status_message |
Actualización de estado simple |
session_checkpoint |
Es el evento de resumen de compactación o punto de control de la sesión que contiene la intención del usuario y el resumen continuo. |
Bandinsecto
Es un fragmento de contenido dentro de un mensaje.
| Campos | |
|---|---|
Campo de unión data. Datos de fragmentos data puede ser solo uno de los parámetros siguientes: |
|
text |
Es opcional. Datos de texto. |
transcript |
Es opcional. Es la transcripción asociada al audio. |
blob |
Es opcional. Datos de BLOB. |
payload |
Es opcional. Datos de carga útil personalizados. |
image |
Es opcional. Son los datos de la imagen. |
tool_call |
Es opcional. Es la solicitud de ejecución de la herramienta. |
tool_response |
Es opcional. Es la respuesta de la ejecución de la herramienta. |
agent_transfer |
Es opcional. Evento de transferencia de agente. |
updated_variables |
Un struct representa las variables que se actualizaron en la conversación, con clave por nombres de variables. |
default_variables |
Un struct representa las variables predeterminadas al inicio de la conversación, con clave por nombres de variables. |
Citas
Son las citas asociadas con la respuesta del agente.
| Campos | |
|---|---|
cited_chunks[] |
Es una lista de los fragmentos de información citados. |
inline_citations[] |
Es opcional. Es la lista de citas intercaladas en la respuesta del agente. |
CitedChunk
Es un fragmento de información citada.
| Campos | |
|---|---|
uri |
Es el URI que se usa para la cita. |
title |
Es el título del documento citado. |
text |
Es el texto que se usa para la cita. |
requires_attribution |
Indica si esta cita requiere que se muestre la atribución a los usuarios finales. |
InlineCitation
Una cita intercalada en el texto de la respuesta.
| Campos | |
|---|---|
start_index |
Es el índice de inicio (en bytes) del segmento de texto en la respuesta del agente. |
end_index |
Es el índice final (en bytes) del segmento de texto en la respuesta del agente. |
cited_chunk_indices[] |
Son los índices de los fragmentos citados que respaldan este segmento de texto. Los índices hacen referencia a los elementos de |
ClientCertificateSettings
Configuración de los certificados de cliente personalizados.
| Campos | |
|---|---|
tls_certificate |
Obligatorio. Es el certificado TLS codificado en formato PEM. Esta cadena debe incluir las líneas de encabezado de inicio y de pie de página de finalización. |
private_key |
Obligatorio. Es el nombre del recurso de la versión del Secret de SecretManager que almacena la clave privada codificada en formato PEM. Formato: |
passphrase |
Es opcional. Es el nombre del recurso de la versión del Secret de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Debe dejarse sin configurar si la clave privada no está encriptada. Formato: |
ClientFunction
Representa una función del cliente que el agente puede invocar. Cuando el agente elige la herramienta, el control se transfiere al cliente. El cliente es responsable de ejecutar la función y devolver el resultado como un ToolResponse para continuar la interacción con el agente.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la función. |
description |
Es opcional. Es la descripción de la función. |
parameters |
Es opcional. Es el esquema de los parámetros de la función. |
response |
Es opcional. Es el esquema de la respuesta de la función. |
CloudLoggingSettings
Es la configuración para describir los comportamientos de Cloud Logging de la app.
| Campos | |
|---|---|
enable_cloud_logging |
Es opcional. Indica si se debe habilitar Cloud Logging para las sesiones. |
CodeBlock
Un bloque de código que se ejecutará en lugar de una llamada a la herramienta real.
| Campos | |
|---|---|
python_code |
Obligatorio. Código de Python que se invocará en el modo de simulación de la herramienta. Firma de función de Python esperada - Para detectar todas las llamadas a la herramienta: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Para detectar una llamada a la herramienta específica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Si la función devuelve None, se invocará la herramienta real. |
ConnectorTool
Un ConnectorTool permite conexiones a diferentes integraciones. Consulta https://cloud.google.com/integration-connectors/docs/overview.
| Campos | |
|---|---|
connection |
Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: |
action |
Obligatorio. Es la acción que debe usar la herramienta. |
auth_config |
Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes a la API de Integration Connectors. Puedes anularla con una configuración de autenticación de usuario final diferente. Nota: La conexión debe tener habilitada la anulación de la autenticación para especificar una configuración de EUC aquí; de lo contrario, fallará la creación de ConnectorTool. Consulta https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para obtener más detalles. |
name |
Es opcional. Es el nombre de la herramienta que puede usar el agente para decidir si llamar a esta ConnectorTool. |
description |
Es opcional. Es la descripción de la herramienta que el agente puede usar para decidir si llamar a esta ConnectorTool. |
ConnectorToolset
Es un conjunto de herramientas que genera herramientas a partir de una conexión de Integration Connectors.
| Campos | |
|---|---|
connection |
Obligatorio. Es el nombre completo del recurso de la conexión de Integration Connectors a la que se hace referencia. Formato: |
auth_config |
Es opcional. Configura cómo se controla la autenticación en Integration Connectors. De forma predeterminada, se pasa una autenticación de administrador en las solicitudes a la API de Integration Connectors. Puedes anularla con una configuración de autenticación de usuario final diferente. Nota: La conexión debe tener habilitada la anulación de la autenticación para especificar una configuración de EUC aquí; de lo contrario, fallará la creación del conjunto de herramientas. Consulta: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connector_actions[] |
Obligatorio. Es la lista de acciones del conector o de operaciones de entidad para las que se generarán herramientas. |
Conversación
Una conversación representa una interacción entre un usuario final y la app de CES.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la conversación. Formato: |
start_time |
Solo salida. Es la marca de tiempo de cuando se creó la conversación. |
end_time |
Solo salida. Es la marca de tiempo del momento en que se completó la conversación. |
turns[] |
Obligatorio. Los turnos de la conversación. |
turn_count |
Solo salida. Es la cantidad de turnos en la conversación. |
channel_type |
OBSOLETO. En su lugar, usa |
source |
Solo salida. Indica la fuente de la conversación. |
input_types[] |
Solo salida. Son los tipos de entrada de la conversación. |
entry_agent |
Solo salida. Es el agente que maneja la conversación inicialmente. Si no se especifica, el agente raíz controla la conversación. Formato: |
deployment |
Solo salida. Es la implementación de la app que se usa para procesar la conversación. Formato: |
app_version |
Solo salida. Es la versión de la app que se usa para procesar la conversación. Formato: |
language_code |
Solo salida. Es el código de idioma de la conversación. |
messages[] |
Obsoleto. En su lugar, usa turnos. |
ChannelType
Es el tipo de canal de la conversación.
| Enums | |
|---|---|
CHANNEL_TYPE_UNSPECIFIED |
Es un tipo de canal no especificado. |
TEXT |
La conversación solo contiene mensajes de texto entre el usuario final y el agente. |
AUDIO |
La conversación contiene mensajes de audio entre el usuario final y el agente. |
MULTIMODAL |
Son los mensajes multimodales de la conversación (p.ej., imágenes) entre el usuario final y el agente. |
InputType
Es el tipo de mensaje de entrada.
| Enums | |
|---|---|
INPUT_TYPE_UNSPECIFIED |
Es un tipo de entrada sin especificar. |
INPUT_TYPE_TEXT |
Entrada de texto. |
INPUT_TYPE_EVENT |
Entrada del evento. |
INPUT_TYPE_AUDIO |
Entrada de audio. |
INPUT_TYPE_IMAGE |
Entrada de imagen. |
INPUT_TYPE_BLOB |
Entrada de BLOB. |
INPUT_TYPE_TOOL_RESPONSE |
Entrada de respuesta de la herramienta de función del cliente. |
INPUT_TYPE_VARIABLES |
Entrada de variables. |
Fuente
Es la fuente de la conversación.
| Enums | |
|---|---|
SOURCE_UNSPECIFIED |
Origen sin especificar. |
LIVE |
La conversación es del usuario final en vivo. |
SIMULATOR |
La conversación es del simulador. |
EVAL |
La conversación es de la evaluación. |
AGENT_TOOL |
La conversación proviene de una herramienta de agente. La herramienta de agente ejecuta el agente en una sesión independiente, que se conserva para realizar pruebas y depuraciones. |
Turno
Toda la información sobre un solo turno en la conversación.
| Campos | |
|---|---|
messages[] |
Es opcional. Es la lista de mensajes en el turno de conversación, incluidas las entradas del usuario, las respuestas del agente y los eventos intermedios durante el procesamiento. |
root_span |
Es opcional. Es el intervalo raíz del procesamiento de la acción. |
user_intended_text |
Es opcional. Es el texto de verdad fundamental previsto del emisor simulado (Polysynth). Solo se propaga cuando se habilitan las métricas de tasa de errores de palabras. |
ConversationLoggingSettings
Es la configuración para describir los comportamientos de registro de conversaciones de la app.
| Campos | |
|---|---|
disable_conversation_logging |
Es opcional. Indica si se debe inhabilitar el registro de conversaciones para las sesiones. |
retention_window |
Es opcional. Controla el período de retención de la conversación. Si no se establece, la conversación se conservará durante 365 días. |
CreateAgentRequest
Mensaje de solicitud para AgentService.CreateAgent.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará un agente. |
agent_id |
Es opcional. Es el ID que se usará para el agente, que se convertirá en el componente final del nombre del recurso del agente. Si no se proporciona, se asignará automáticamente un ID único para el agente. |
agent |
Obligatorio. El agente que se creará. |
CreateAppRequest
Mensaje de solicitud para AgentService.CreateApp.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la ubicación en la que se creará una app. |
app_id |
Es opcional. Es el ID que se usará para la app, que se convertirá en el componente final del nombre del recurso de la app. Si no se proporciona, se asignará automáticamente un ID único para la app. |
app |
Obligatorio. La app que se creará. |
CreateAppVersionRequest
Mensaje de solicitud para AgentService.CreateAppVersion
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará una versión de la app. |
app_version_id |
Es opcional. Es el ID que se usará para la versión de la app, que se convertirá en el componente final del nombre del recurso de la versión de la app. Si no se proporciona, se asignará automáticamente un ID único para la versión de la app. |
app_version |
Obligatorio. Es la versión de la app que se creará. |
CreateAssistantSessionRequest
Mensaje de solicitud para AssistantService.CreateAssistantSession.
| Campos | |
|---|---|
parent |
Obligatorio. La app para crear la sesión del asistente en formato: |
assistant_session_id |
Es opcional. Es el ID que se usará para la sesión de Gemini, que se convertirá en el componente final del nombre del recurso de la sesión de Gemini. Si no se proporciona, se asignará automáticamente un ID único para la sesión del asistente. |
assistant_session_messages[] |
Es opcional. Son los mensajes con los que se inicializa la sesión del asistente. |
CreateDeploymentRequest
Mensaje de solicitud para AgentService.CreateDeployment.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app superior. Formato: |
deployment_id |
Es opcional. Es el ID que se usará para la implementación, que se convertirá en el componente final del nombre del recurso de la implementación. Si no se proporciona, se asignará automáticamente un ID único para la implementación. |
deployment |
Obligatorio. La implementación que se creará. |
CreateEvaluationDatasetRequest
Mensaje de solicitud para EvaluationService.CreateEvaluationDataset.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app para la que se creará la evaluación. Formato: |
evaluation_dataset_id |
Es opcional. Es el ID que se usará para el conjunto de datos de evaluación, que se convertirá en el componente final del nombre del recurso del conjunto de datos de evaluación. Si no se proporciona, se asignará automáticamente un ID único para la evaluación. |
evaluation_dataset |
Obligatorio. Es el conjunto de datos de evaluación que se creará. |
CreateEvaluationExpectationRequest
Mensaje de solicitud para EvaluationService.CreateEvaluationExpectation.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app para la que se creará la expectativa de evaluación. Formato: |
evaluation_expectation_id |
Es opcional. Es el ID que se usará para la expectativa de evaluación, que se convertirá en el componente final del nombre del recurso de la expectativa de evaluación. Si no se proporciona, se asignará automáticamente un ID único para la expectativa de evaluación. |
evaluation_expectation |
Obligatorio. Es la expectativa de evaluación que se creará. |
CreateEvaluationRequest
Mensaje de solicitud para EvaluationService.CreateEvaluation.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app para la que se creará la evaluación. Formato: |
evaluation_id |
Es opcional. Es el ID que se usará para la evaluación, que se convertirá en el componente final del nombre del recurso de la evaluación. Si no se proporciona, se asignará automáticamente un ID único para la evaluación. |
evaluation |
Obligatorio. Es la evaluación que se creará. |
CreateExampleRequest
Mensaje de solicitud para AgentService.CreateExample.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará un ejemplo. |
example_id |
Es opcional. Es el ID que se usará para el ejemplo, que se convertirá en el componente final del nombre del recurso del ejemplo. Si no se proporciona, se asignará automáticamente un ID único para el ejemplo. |
example |
Obligatorio. Es el ejemplo que se creará. |
CreateGuardrailRequest
Mensaje de solicitud para AgentService.CreateGuardrail.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará una barandilla. |
guardrail_id |
Es opcional. Es el ID que se usará para la barandilla, que se convertirá en el componente final del nombre del recurso de la barandilla. Si no se proporciona, se asignará automáticamente un ID único para la protección. |
guardrail |
Obligatorio. La protección que se creará. |
CreateScheduledEvaluationRunRequest
Mensaje de solicitud para EvaluationService.CreateScheduledEvaluationRun.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app para la que se creará la ejecución de evaluación programada. Formato: |
scheduled_evaluation_run_id |
Es opcional. Es el ID que se usará para la ejecución de la evaluación programada, que se convertirá en el componente final del nombre del recurso de la ejecución de la evaluación programada. Si no se proporciona, se asignará automáticamente un ID único. |
scheduled_evaluation_run |
Obligatorio. Es la ejecución de la evaluación programada que se creará. |
CreateToolRequest
Mensaje de solicitud para AgentService.CreateTool.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará una herramienta. |
tool_id |
Es opcional. Es el ID que se usará para la herramienta, que se convertirá en el componente final del nombre del recurso de la herramienta. Si no se proporciona, se asignará automáticamente un ID único para la herramienta. |
tool |
Obligatorio. La herramienta que se creará. |
CreateToolsetRequest
Mensaje de solicitud para AgentService.CreateToolset.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app en la que se creará un conjunto de herramientas. |
toolset_id |
Es opcional. Es el ID que se usará para el conjunto de herramientas, que se convertirá en el componente final del nombre del recurso del conjunto de herramientas. Si no se proporciona, se asignará automáticamente un ID único para el conjunto de herramientas. |
toolset |
Obligatorio. Es el conjunto de herramientas que se creará. |
CustomVoiceSample
Es la configuración de una muestra de voz personalizada que se usa para la clonación de voz.
| Campos | |
|---|---|
name |
Es opcional. Es el nombre definido por el usuario para la muestra de voz personalizada. |
voice_sample_gcs_uri |
Es opcional. Es el URI de Cloud Storage de la muestra de audio para la clonación de voz. La muestra de audio debe ser un archivo WAV de 24 kHz y un solo canal. |
consent_audio_gcs_uri |
Es opcional. Audio de consentimiento para la clonación de voz. |
voice_instruction |
Es opcional. Son las instrucciones en lenguaje natural para el estilo, el tono, el ritmo o la pronunciación de la voz. |
preview_audio_content |
Solo salida. Es el audio de vista previa sintetizado para la voz personalizada, con formato WAV canónico (LINEAR16, 24 kHz, 16 bits, mono). |
preview_text |
Es opcional. Texto para sintetizar el audio de vista previa de la voz personalizada. |
warnings[] |
Solo salida. Son los mensajes de advertencia que se encontraron durante el procesamiento de la clonación de voz (p.ej., nivel de audio bajo). |
voice_instruction_mode |
Es opcional. Es el modo de instrucción para la muestra de voz. Si no se especifica, se establece de forma predeterminada como NO_INSTRUCTION. |
VoiceInstructionMode
Es el modo de instrucción para la muestra de voz.
| Enums | |
|---|---|
VOICE_INSTRUCTION_MODE_UNSPECIFIED |
Indica que no se especificó el modo de instrucción. La configuración predeterminada es NO_INSTRUCTION. |
NO_INSTRUCTION |
No se usarán instrucciones por voz. |
GENERATE_INSTRUCTION |
La IA generará automáticamente la instrucción de voz a partir de la muestra de audio. |
CUSTOM_INSTRUCTION |
Instrucción de voz personalizada que proporciona el usuario. |
Advertencia
Es un mensaje de advertencia que se encuentra durante el procesamiento de la muestra de voz.
| Campos | |
|---|---|
message |
Solo salida. Es una descripción legible por humanos de la advertencia. |
type |
Solo salida. Es el tipo de advertencia. |
WarningType
Es el tipo de advertencia que se encontró durante el procesamiento de la muestra de voz.
| Enums | |
|---|---|
WARNING_TYPE_UNSPECIFIED |
Indica que no se especificó el tipo de advertencia. |
LOW_AUDIO_LEVEL |
El nivel de audio de la muestra de voz es demasiado bajo (p.ej., amplitud RMS baja). |
DashboardSettings
Es la configuración de los paneles asociados con la app, que se muestran en la vista de Monitoring.
| Campos | |
|---|---|
default_dashboard |
Es opcional. Es el nombre del recurso del panel predeterminado de Estadísticas de Contact Center asociado con la app. Este es el panel que se mostrará cuando los usuarios naveguen a la vista de Supervisión de la app. Formato: |
DataStore
Es un recurso de DataStore en Vertex AI Search.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre completo del recurso del DataStore. Formato: |
type |
Solo salida. Es el tipo de almacén de datos. Este campo es de solo lectura y lo completa el servidor. |
document_processing_mode |
Solo salida. Es el modo de procesamiento de documentos para la conexión del almacén de datos. Solo se establece para los almacenes de datos PUBLIC_WEB y UNSTRUCTURED. |
display_name |
Solo salida. Es el nombre visible del almacén de datos. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el almacén de datos. |
connector_config |
Solo salida. Es la configuración del conector para la conexión del almacén de datos. |
ConnectorConfig
Es la configuración del conector para la conexión del almacén de datos.
| Campos | |
|---|---|
collection |
Es el nombre del recurso de la colección a la que pertenece el almacén de datos. |
collection_display_name |
Es el nombre visible de la colección a la que pertenece el almacén de datos. |
data_source |
Es el nombre de la fuente de datos. Por ejemplo: |
DataStoreType
Es el tipo de almacén de datos.
| Enums | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
No especificado. Este valor indica que no se especificó el tipo de almacén de datos, por lo que no se usará durante la búsqueda. |
PUBLIC_WEB |
Un almacén de datos que contiene contenido web público. |
UNSTRUCTURED |
Un almacén de datos que contiene datos privados no estructurados. |
FAQ |
Es un almacén de datos que contiene datos estructurados que se usan como preguntas frecuentes. |
CONNECTOR |
Un almacén de datos que es un conector a un servicio propio o de terceros. |
DocumentProcessingMode
Es el modo de procesamiento de documentos del almacén de datos.
| Enums | |
|---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
No especificado. |
DOCUMENTS |
Los documentos se procesan como documentos. |
CHUNKS |
Los documentos se convierten en fragmentos. |
DataStoreSettings
Configuración relacionada con el almacén de datos de la app.
| Campos | |
|---|---|
engines[] |
Solo salida. Son los motores de la app. |
Motor
Un motor al que se conectan los almacenes de datos. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
| Campos | |
|---|---|
name |
Solo salida. Es el nombre del recurso del motor. Formato: |
type |
Solo salida. Es el tipo de motor. |
Tipo
Es el tipo de motor. Consulta la documentación disponible en https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType y https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Indica que no se especificó el tipo de motor. |
ENGINE_TYPE_SEARCH |
Es el motor SOLUTION_TYPE_SEARCH de la app. Todos los almacenes de datos del conector que se agreguen a la app se agregarán a este motor. |
ENGINE_TYPE_CHAT |
Es el tipo de motor de chat. Es el motor SOLUTION_TYPE_CHAT de la app. Todos los almacenes de datos del conector que se agreguen a la app se agregarán a este motor. |
DataStoreTool
Es la herramienta para recuperar datos del almacén de datos o del motor de Vertex AI Search para fundamentar las respuestas. Acepta un almacén de datos o un motor, pero no ambos. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta del almacén de datos. |
description |
Es opcional. Es la descripción de la herramienta. |
boost_specs[] |
Es opcional. Especificación de mejora para mejorar ciertos documentos. |
modality_configs[] |
Es opcional. Son los parámetros de configuración de la modalidad para el almacén de datos. |
filter_parameter_behavior |
Es opcional. Es el comportamiento del parámetro de filtro. |
Campo de unión search_source. Define la fuente de búsqueda, ya sea un solo DataStore o un motor. search_source puede ser solo uno de los parámetros siguientes: |
|
data_store_source |
Es opcional. Busca en un solo DataStore específico. |
engine_source |
Es opcional. Busca dentro de un motor (potencialmente en varios almacenes de datos). |
BoostSpec
Especificación de mejora para mejorar ciertos documentos.
| Campos | |
|---|---|
condition_boost_specs[] |
Obligatorio. Es una lista de especificaciones de boosting. |
ConditionBoostSpec
Especificación de mejora para una condición.
| Campos | |
|---|---|
condition |
Obligatorio. Es una expresión que especifica una condición de aumento. La sintaxis es la misma que la de la expresión de filtro. Actualmente, la única condición admitida es una lista de códigos de idioma BCP-47. Ejemplo: Para impulsar las sugerencias en los idiomas en o fr: (lang_code: ANY("en", "fr")) |
boost |
Es opcional. Es la intensidad del boosting, que debe estar en [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0. Si se establece en 1.0, las sugerencias se promocionan de forma significativa. Sin embargo, esto no significa necesariamente que el primer resultado será una sugerencia con boosting. Si se establece en -1.0, las sugerencias se descenderán de nivel de forma significativa. Sin embargo, es posible que se sigan mostrando otras sugerencias pertinentes. Si se establece en 0.0, no se aplica ningún aumento. Se ignora la condición de mejora. |
boost_control_spec |
Es opcional. Especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente. |
BoostControlSpec
Especificación para la clasificación personalizada según el valor del atributo especificado por el cliente. Proporciona más controles para la clasificación personalizada que la combinación simple (condición, aumento) anterior.
| Campos | |
|---|---|
field_name |
Es opcional. Es el nombre del campo cuyo valor se usará para determinar el importe de la mejora. |
attribute_type |
Es opcional. Es el tipo de atributo que se usará para determinar el importe de la mejora. El valor del atributo se puede derivar del valor del campo field_name especificado. En el caso de los valores numéricos, es sencillo, es decir, attribute_value = numerical_field_value. Sin embargo, en el caso de la actualización, attribute_value = (time.now() - datetime_field_value). |
interpolation_type |
Es opcional. Es el tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación. |
control_points[] |
Es opcional. Son los puntos de control que se usan para definir la curva. La función monótona (definida a través del interpolation_type anterior) pasa por los puntos de control que se indican aquí. |
AttributeType
Es el atributo (o la función) al que se aplicará la clasificación personalizada.
| Enums | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
AttributeType sin especificar. |
NUMERICAL |
El valor del campo numérico se usará para actualizar de forma dinámica el importe de la mejora. En este caso, el valor del atributo (el valor x) del punto de control será el valor real del campo numérico para el que se especifica boost_amount. |
FRESHNESS |
Para el caso de uso de actualidad, el valor del atributo será la duración entre la hora actual y la fecha en el campo de fecha y hora especificado. El valor debe tener el formato de un valor XSD dayTimeDuration (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es el siguiente: [nD][T[nH][nM][nS]]. P.ej., 5D, 3DT12H30M, T24H. |
ControlPoint
Son los puntos de control que se usan para definir la curva. La curva definida a través de estos puntos de control solo puede aumentar o disminuir de forma monótona (se aceptan valores constantes).
| Campos | |
|---|---|
attribute_value |
Es opcional. Puede ser una de las siguientes opciones: 1. Es el valor numérico del campo. 2. La especificación de duración para la actualización: El valor debe tener el formato de un valor XSD |
boost_amount |
Es opcional. Es el valor entre -1 y 1 por el que se aumentará la puntuación si el atributo attribute_value se evalúa con el valor especificado anteriormente. |
InterpolationType
Es el tipo de interpolación que se aplicará. El valor predeterminado será lineal (lineal por partes).
| Enums | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
No se especificó el tipo de interpolación. En este caso, se establece de forma predeterminada en Lineal. |
LINEAR |
Se aplicará la interpolación lineal por partes. |
BoostSpecs
Especificaciones de mejora para mejorar ciertos documentos Para obtener más información, consulta https://cloud.google.com/generative-ai-app-builder/docs/boosting.
| Campos | |
|---|---|
data_stores[] |
Obligatorio. Es el almacén de datos en el que se aplica la configuración de aumento. Es el nombre completo del recurso del almacén de datos, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Obligatorio. Es una lista de especificaciones de boosting. |
DataStoreSource
Es la configuración para buscar en un DataStore específico.
| Campos | |
|---|---|
filter |
Es opcional. Especificación del filtro para el DataStore. Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
data_store |
Es opcional. El almacén de datos. |
EngineSource
Es la configuración para buscar dentro de un motor, lo que podría orientarse a almacenes de datos específicos.
| Campos | |
|---|---|
engine |
Obligatorio. Es el nombre completo del recurso del motor. Formato: |
data_store_sources[] |
Es opcional. Se usa para segmentar almacenes de datos específicos dentro del motor. Si está vacío, la búsqueda se aplica a todos los almacenes de datos asociados con el motor. |
filter |
Es opcional. Es un filtro que se aplica a la búsqueda en todo el motor. No es relevante y no se usa si se proporciona "data_store_sources". Consulta: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
FilterParameterBehavior
Comportamiento del parámetro de filtro.
| Enums | |
|---|---|
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED |
Comportamiento predeterminado del filtro. Incluye el parámetro de filtro para los almacenes de datos del conector. Para el resto de los tipos de almacenes de datos, se omite el parámetro de entrada del filtro. |
ALWAYS_INCLUDE |
Incluye siempre el parámetro de filtro para todos los tipos de almacenes de datos. |
NEVER_INCLUDE |
El parámetro de filtro nunca se incluye en la lista de parámetros de la herramienta, independientemente del tipo de almacén de datos. |
GroundingConfig
Configuración de la fundamentación.
| Campos | |
|---|---|
grounding_level |
Es opcional. Es el umbral de fundamentación de la respuesta según las fuentes recuperadas. El valor tiene un rango configurable de [1, 5]. El nivel se usa para establecer un umbral de fundamentación de la respuesta, lo que significa que todas las respuestas con una puntuación de fundamentación inferior al umbral volverán a mostrar solo fragmentos relevantes. Por ejemplo, un nivel de 3 significa que la puntuación de fundamentación debe ser de 3 o más para que se devuelva la respuesta. |
disabled |
Es opcional. Indica si la fundamentación está inhabilitada. |
ModalityConfig
Si se especifica, se aplicará la configuración dada para la modalidad especificada.
| Campos | |
|---|---|
modality_type |
Obligatorio. Es el tipo de modalidad. |
rewriter_config |
Es opcional. Es la configuración del reescritor. |
summarization_config |
Es opcional. Es la configuración de resumen. |
grounding_config |
Es opcional. Es la configuración de la fundamentación. |
snippets_config |
Es opcional. Es la configuración de los fragmentos. |
ModalityType
Es el tipo de modalidad.
| Enums | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
Tipo de modalidad sin especificar. |
TEXT |
Modalidad de texto. |
AUDIO |
Modalidad de audio. |
RewriterConfig
Configuración del reescritor.
| Campos | |
|---|---|
model_settings |
Obligatorio. Son los parámetros de configuración del modelo de LLM. |
prompt |
Es opcional. La definición de la instrucción. Si no se establece, se usará la instrucción predeterminada. |
disabled |
Es opcional. Indica si el reescritor está inhabilitado. |
SnippetsConfig
Configuración de los fragmentos.
| Campos | |
|---|---|
enable_snippets |
Es opcional. Indica si los fragmentos están habilitados. |
max_snippets |
Es opcional. Es la cantidad de fragmentos que se devolverán por consulta. Si no se establece, devuelve todos los fragmentos del servicio de forma predeterminada. |
SummarizationConfig
Es la configuración de resumen.
| Campos | |
|---|---|
model_settings |
Es opcional. Son los parámetros de configuración del modelo de LLM. |
prompt |
Es opcional. La definición de la instrucción. Si no se establece, se usará la instrucción predeterminada. |
disabled |
Es opcional. Indica si el resumen está inhabilitado. |
DeleteAgentRequest
Mensaje de solicitud para AgentService.DeleteAgent.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del agente que se borrará. |
force |
Es opcional. Indica si se debe borrar el agente de forma forzosa, incluso si otras apps, agentes o ejemplos aún hacen referencia a él.
|
etag |
Es opcional. Es la etag actual del agente. Si no se proporciona una etag, la eliminación reemplazará cualquier cambio simultáneo. Si se proporciona una etag y no coincide con la etag actual del agente, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteAppRequest
Mensaje de solicitud para AgentService.DeleteApp.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la app que se borrará. |
etag |
Es opcional. Es la etag actual de la app. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la app, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteAppVersionRequest
Mensaje de solicitud para AgentService.DeleteAppVersion.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la versión de la app que se borrará. |
etag |
Es opcional. Es la etag actual de la versión de la app. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la versión de la app, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteAssistantSessionRequest
Mensaje de solicitud para AssistantService.DeleteAssistantSession.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la sesión de asistente que se borrará. Formato: |
DeleteConversationRequest
Mensaje de solicitud para AgentService.DeleteConversation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la conversación que se borrará. |
source |
Es opcional. Indica la fuente de la conversación. Si no se establece, se aplicará Source.Live de forma predeterminada. |
DeleteDeploymentRequest
Mensaje de solicitud para AgentService.DeleteDeployment.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la implementación que se borrará. Formato: |
etag |
Es opcional. Es la etag de la implementación. Si se proporciona una etag y no coincide con la etag actual de la implementación, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteEvaluationDatasetRequest
Mensaje de solicitud para EvaluationService.DeleteEvaluationDataset.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del conjunto de datos de evaluación que se borrará. |
etag |
Es opcional. La etag actual del conjunto de datos de evaluación. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del conjunto de datos de evaluación, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteEvaluationExpectationRequest
Mensaje de solicitud para EvaluationService.DeleteEvaluationExpectation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la expectativa de evaluación que se borrará. |
etag |
Es opcional. Es la etag actual de la expectativa de evaluación. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la expectativa de evaluación, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteEvaluationRequest
Mensaje de solicitud para EvaluationService.DeleteEvaluation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la evaluación que se borrará. |
force |
Es opcional. Indica si se debe borrar la evaluación de forma forzosa, incluso si los conjuntos de datos de evaluación aún hacen referencia a ella.
|
etag |
Es opcional. Es la etag actual de la evaluación. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la evaluación, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteEvaluationResultRequest
Mensaje de solicitud para EvaluationService.DeleteEvaluationResult.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del resultado de la evaluación que se borrará. |
DeleteEvaluationRunOperationMetadata
Este tipo no tiene campos.
Metadatos de la operación para EvaluationService.DeleteEvaluationRun.
DeleteEvaluationRunRequest
Mensaje de solicitud para EvaluationService.DeleteEvaluationRun.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la ejecución de evaluación que se borrará. |
DeleteExampleRequest
Mensaje de solicitud para AgentService.DeleteExample.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del ejemplo que se borrará. |
etag |
Es opcional. La ETag actual del ejemplo. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del ejemplo, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteGuardrailRequest
Mensaje de solicitud para AgentService.DeleteGuardrail.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la barandilla de seguridad que se borrará. |
force |
Es opcional. Indica si se debe borrar la barandilla de seguridad de forma forzosa, incluso si la app o los agentes aún hacen referencia a ella.
|
etag |
Es opcional. La etag actual de la barandilla. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la barandilla de seguridad, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteScheduledEvaluationRunRequest
Mensaje de solicitud para EvaluationService.DeleteScheduledEvaluationRun.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la ejecución de evaluación programada que se borrará. |
etag |
Es opcional. Es la etag de ScheduledEvaluationRun. Si se proporciona, debe coincidir con la etiqueta de entidad del servidor. |
DeleteToolRequest
Mensaje de solicitud para AgentService.DeleteTool.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la herramienta que se borrará. |
force |
Es opcional. Indica si se debe borrar la herramienta de forma forzosa, incluso si los agentes o ejemplos aún hacen referencia a ella.
|
etag |
Es opcional. La ETag actual de la herramienta. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual de la herramienta, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeleteToolsetRequest
Mensaje de solicitud para AgentService.DeleteToolset.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del conjunto de herramientas que se borrará. |
force |
Es opcional. Indica si se debe borrar de forma forzada el conjunto de herramientas, incluso si la app o los agentes aún hacen referencia a él.
|
etag |
Es opcional. La ETag actual del conjunto de herramientas. Si no se proporciona una etag, la eliminación reemplazará los cambios simultáneos. Si se proporciona una etag y no coincide con la etag actual del conjunto de herramientas, se bloqueará la eliminación y se devolverá un error ABORTED. |
DeployChannelResponse
Mensaje de respuesta para AgentService.DeployChannel.
| Campos | |
|---|---|
deployment |
Es el objeto Deployment creado. |
Implementación
Una implementación representa una versión inmutable y consultable de la app. Se usa para implementar una versión de la app con un perfil de canal específico.
| Campos | |
|---|---|
name |
Es el identificador. Es el nombre del recurso de la implementación. Formato: |
display_name |
Obligatorio. Es el nombre visible de la implementación. |
app_version |
Es opcional. Es el nombre del recurso de la versión de la app que se implementará. Formato: |
channel_profile |
Obligatorio. Es el perfil de canal que se usa en la implementación. |
create_time |
Solo salida. Es la marca de tiempo de la creación de esta implementación. |
update_time |
Solo salida. Es la marca de tiempo de la última actualización de esta implementación. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
experiment_config |
Es opcional. Es la configuración del experimento para la implementación. |
whatsapp_credentials |
Es opcional. Solo entrada. Son las credenciales efímeras de WhatsApp que se requieren cuando se configura un perfil de canal de WhatsApp. |
instagram_credentials |
Es opcional. Solo entrada. Se requieren credenciales efímeras de Instagram cuando se configura un perfil de canal de Instagram. |
model_settings |
Es opcional. Es la configuración del modelo para la implementación. Anula la configuración del modelo establecida a nivel de la app o del agente. Nota: La anulación de la configuración del modelo a nivel de la Deployment está restringida por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo. |
modality |
Es opcional. Es la modalidad de la implementación. Nota: La anulación de la modalidad a nivel de la Deployment está restringida por una lista de entidades permitidas. Comunícate con el equipo de CXAS para habilitar este campo. |
agent_registry_deployment |
Es opcional. Es la configuración para implementar esta implementación en el Registro de agentes. Si está presente, esta implementación se publicará en Agent Registry. |
Modalidad
Es la modalidad de la implementación.
| Enums | |
|---|---|
MODALITY_UNSPECIFIED |
Modalidad desconocida. |
MODALITY_TEXT |
Modalidad de texto. |
MODALITY_VOICE |
Modalidad de voz. |
MODALITY_VIDEO |
Modalidad de video. |
EndSession
Indica que la sesión finalizó, ya sea porque se completó correctamente (p.ej., el usuario dice "¡Adiós!") ) o una derivación a un agente.
El agente no procesará más entradas después de que se finalice la sesión, y el cliente deberá cerrar parcialmente la conexión y desconectarse después de recibir todas las respuestas restantes del agente.
| Campos | |
|---|---|
metadata |
Es opcional. Proporciona información adicional sobre el indicador de finalización de la sesión, como el motivo por el que finalizó. |
EndUserAuthConfig
Es la configuración de autenticación del usuario final que se usa para las llamadas de conexión. Los valores de los campos deben ser los nombres de las variables de contexto en el formato $context.variables.<name_of_variable>.
| Campos | |
|---|---|
Campo de unión auth_config. Es la configuración de autenticación. auth_config puede ser solo uno de los parámetros siguientes: |
|
oauth2_auth_code_config |
Autenticación con código de autorización de OAuth 2.0. |
oauth2_jwt_bearer_config |
Autenticación de otorgamiento de autorización de OAuth 2.0 de perfil de JWT |
Oauth2AuthCodeConfig
Es la configuración de autenticación del código de autorización de OAuth 2.0.
| Campos | |
|---|---|
oauth_token |
Obligatorio. Es el nombre del parámetro del token de OAuth que se pasará. Debe tener el formato |
Oauth2JwtBearerConfig
Configuración de la autenticación de la concesión de autorización de OAuth 2.0 del perfil de JWT.
| Campos | |
|---|---|
issuer |
Obligatorio. Es el nombre del parámetro de la entidad emisora que se pasará. Debe tener el formato |
subject |
Obligatorio. Es el nombre del parámetro del asunto que se pasará. Debe tener el formato |
client_key |
Obligatorio. Es el nombre del parámetro del cliente que se pasará. Debe tener el formato |
EndpointControlPolicy
Define la política de control de extremos a nivel de proyecto o ubicación.
| Campos | |
|---|---|
enforcement_scope |
Es opcional. Es el alcance en el que se aplica la lista allowed_origins de esta política. |
allowed_origins[] |
Es opcional. Son los orígenes HTTP(S) permitidos a los que las herramientas de la app pueden llamar directamente. La aplicación de la política depende del valor de enforcement_scope y del estado de VPC-SC del proyecto. Si no se proporciona un número de puerto, se permitirán todos los puertos. De lo contrario, el número de puerto debe coincidir exactamente. Por ejemplo, "https://example.com" coincidirá con "https://example.com:443" y cualquier otro puerto. "https://example.com:443" solo coincidirá con "https://example.com:443". |
EnforcementScope
Define el alcance en el que se aplica la lista allowed_origins de esta política.
| Enums | |
|---|---|
ENFORCEMENT_SCOPE_UNSPECIFIED |
Sin especificar. Esta política se tratará como VPCSC_ONLY. |
VPCSC_ONLY |
Esta política solo se aplica cuando VPC-SC está activo. |
ALWAYS |
Esta política se aplica SIEMPRE, independientemente del estado de VPC-SC. |
ErrorHandlingSettings
Parámetros de configuración para describir cómo se deben controlar los errores en la app
| Campos | |
|---|---|
error_handling_strategy |
Es opcional. Es la estrategia que se usará para el manejo de errores. |
fallback_response_config |
Es opcional. Configuración para controlar las respuestas de resguardo. |
end_session_config |
Es opcional. Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores de LLM). |
EndSessionConfig
Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores de LLM).
| Campos | |
|---|---|
escalate_session |
Es opcional. Indica si se debe derivar la sesión en |
ErrorHandlingStrategy
Define la estrategia para controlar errores.
| Enums | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
Estrategia de manejo de errores no especificada. |
NONE |
No se habilita ningún control específico. |
FALLBACK_RESPONSE |
Se devolverá un mensaje de resguardo al usuario en caso de que se produzcan errores del sistema (p.ej., errores del LLM). |
END_SESSION |
Se emitirá un indicador EndSession en caso de errores del sistema (p.ej., errores del LLM). |
FallbackResponseConfig
Configuración para controlar las respuestas de resguardo.
| Campos | |
|---|---|
custom_fallback_messages |
Es opcional. Son los mensajes de resguardo en caso de errores del sistema (p.ej., errores de LLM), asignados por el código de idioma admitido. |
max_fallback_attempts |
Es opcional. Es la cantidad máxima de intentos de resguardo que se deben realizar antes de que el agente emita el indicador |
Evaluación
Una evaluación representa toda la información necesaria para simular y evaluar un agente.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de esta evaluación. Formato: |
display_name |
Obligatorio. Es el nombre visible de la evaluación definido por el usuario. Es único dentro de una app. |
description |
Es opcional. Descripción definida por el usuario de la evaluación. |
tags[] |
Es opcional. Son etiquetas definidas por el usuario para categorizar la evaluación. |
evaluation_datasets[] |
Solo salida. Es la lista de conjuntos de datos de evaluación a los que pertenece la evaluación. Formato: |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la evaluación. |
created_by |
Solo salida. Es el usuario que creó la evaluación. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la evaluación. |
last_updated_by |
Solo salida. Es el usuario que actualizó la evaluación por última vez. |
evaluation_runs[] |
Solo salida. Son los EvaluationRuns con los que se asocia esta evaluación. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
aggregated_metrics |
Solo salida. Son las métricas agregadas para esta evaluación en todas las ejecuciones. |
last_completed_result |
Solo salida. Es el resultado de la evaluación más reciente. |
invalid |
Solo salida. Indica si la evaluación no es válida. Esto puede suceder si una evaluación hace referencia a una herramienta, un conjunto de herramientas o un agente que se borró. |
last_ten_results[] |
Solo salida. Los últimos 10 resultados de esta evaluación. Esto solo se propaga si include_last_ten_results se establece como verdadero en ListEvaluationsRequest o GetEvaluationRequest. |
evaluation_metrics_threshold_override |
Es opcional. Anula los umbrales de las métricas para esta evaluación específica. |
evaluation_metrics_config_override |
Es opcional. Anula la configuración de métricas para esta evaluación específica. |
Campo de unión inputs. Las entradas para la evaluación inputs solo pueden ser una de las siguientes: |
|
golden |
Es opcional. Son los pasos de referencia que se evaluarán. |
scenario |
Es opcional. Es la configuración de una situación. |
Golden
Los pasos necesarios para reproducir una conversación de referencia.
| Campos | |
|---|---|
turns[] |
Obligatorio. Son los turnos de oro necesarios para reproducir una conversación de oro. La cantidad máxima de turnos permitidos es 100. |
evaluation_expectations[] |
Es opcional. Son las expectativas de evaluación con las que se evalúa la conversación reproducida. Formato: |
GoldenExpectation
Representa un solo requisito que se puede verificar.
| Campos | |
|---|---|
note |
Es opcional. Es una nota para este requisito, útil para informar cuando fallan verificaciones específicas. P. ej., "Check_Payment_Tool_Called". |
skip_evaluation |
Es opcional. Si se establece como verdadero, no se evaluará esta expectativa específica. |
expectation_level_metrics_thresholds_override |
Es opcional. Anula las métricas a nivel del paso. |
agent_response_semantic_similarity_metrics_config_override |
Es opcional. Anulaciones para las métricas de similitud semántica de agent_response. |
agent_response_hallucination_metrics_config_override |
Es opcional. Anulaciones para las métricas de alucinación de agent_response. |
comparison_type |
Es opcional. Es el tipo de comparación que se usará para la verificación de expectativas. |
Campo de unión condition. Es la verificación real que se debe realizar. condition puede ser solo uno de los parámetros siguientes: |
|
tool_call |
Es opcional. Verifica que se haya llamado a una herramienta específica con los parámetros. |
tool_response |
Es opcional. Verifica que una herramienta específica haya tenido la respuesta esperada. |
agent_response |
Es opcional. Verifica que el agente haya respondido con la respuesta correcta. El rol "agent" está implícito. |
agent_transfer |
Es opcional. Verifica que el agente haya transferido la conversación a otro agente. |
updated_variables |
Es opcional. Verifica que el agente haya actualizado las variables de sesión a los valores esperados. También se usa para capturar las actualizaciones de las variables del agente para las evaluaciones de referencia. |
mock_tool_response |
Es opcional. La respuesta de la herramienta que se simulará, con los parámetros de interés especificados. El LLM alucinará los parámetros que no se especifiquen. |
no_tool_calls |
Es opcional. Verifica que no se haya llamado a ninguna herramienta durante este turno. |
GoldenTurn
Un turno de referencia define un solo turno en una conversación de referencia.
| Campos | |
|---|---|
steps[] |
Obligatorio. Los pasos necesarios para reproducir una conversación de referencia. |
root_span |
Es opcional. Es el intervalo raíz del turno de oro para procesar y mantener la información de audio. El URI del audio debe contener audio guardado con una tasa de muestreo de 16 kHz. |
turn_level_metrics_thresholds_override |
Es opcional. Anulaciones para los umbrales de métricas a nivel del turno. |
hallucination_metric_behavior_override |
Es opcional. Anulación del comportamiento de la métrica de alucinación a nivel de turno. |
Situación
La configuración de una situación
| Campos | |
|---|---|
task |
Obligatorio. Es la tarea a la que se orientará la situación. |
user_facts[] |
Es opcional. Son los hechos del usuario que usará la situación. |
max_turns |
Es opcional. Es la cantidad máxima de turnos que se simularán. El valor máximo permitido es 100. El valor predeterminado es 100. |
rubrics[] |
Obligatorio. Son las rúbricas con las que se evaluará la situación. |
scenario_expectations[] |
Obligatorio. ScenarioExpectations para evaluar la conversación que produce la simulación de usuarios |
variable_overrides |
Es opcional. Variables o parámetros de sesión como contexto para la sesión, con clave por nombres de variables. Los miembros de este struct anularán los valores predeterminados que establezca el sistema. Ten en cuenta que estos son diferentes de los hechos del usuario, que son hechos conocidos por el usuario. Las variables son parámetros que conoce el agente, p.ej., el MDN (número de teléfono) que pasa el sistema de telefonía. |
task_completion_behavior |
Es opcional. Obsoleto. En su lugar, usa user_goal_behavior. |
user_goal_behavior |
Es opcional. El comportamiento esperado del objetivo del usuario. |
evaluation_expectations[] |
Es opcional. Son las expectativas de evaluación con las que se evaluará la conversación producida por la simulación. Formato: |
milestones[] |
Es opcional. Los hitos de esta situación. |
scenario_execution_mode |
Es opcional. Es el modo de ejecución para las evaluaciones de situaciones. |
Logro
Representa un solo hito en la situación. Se usa para guiar el comportamiento del simulador de usuario para que siga un protocolo. El simulador de usuario ejecuta el hito de forma secuencial y solo continúa con el siguiente si se cumple el success_criteria de ese hito.
| Campos | |
|---|---|
goal |
Obligatorio. Es el objetivo del hito. |
max_turn_count |
Es opcional. Es la cantidad máxima de turnos para este hito. |
success_criteria |
Es opcional. Los criterios de éxito del hito. |
protocol |
Es opcional. Son los lineamientos que el agente debe seguir durante la conversación. |
static_utterance |
Es opcional. Es un enunciado estático que el simulador enviará exactamente, en lugar de generar de forma dinámica la entrada del usuario. |
event |
Es opcional. Es una entrada de evento que se envía en lugar de la generación dinámica. |
TaskCompletionBehavior
Es el comportamiento esperado de la tarea del usuario. Esto se usa para determinar si la situación es exitosa.
| Enums | |
|---|---|
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED |
Comportamiento no especificado. Se establecerá de forma predeterminada en TASK_SATISFIED. |
TASK_SATISFIED |
La tarea del usuario se debe completar correctamente. |
TASK_REJECTED |
Se debe rechazar la tarea del usuario. |
UserFact
Son datos sobre el usuario como un par clave-valor.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del dato del usuario. |
value |
Obligatorio. Es el valor del hecho del usuario. |
UserGoalBehavior
El comportamiento esperado del objetivo del usuario. Esto se usa para determinar si la situación es exitosa.
| Enums | |
|---|---|
USER_GOAL_BEHAVIOR_UNSPECIFIED |
Comportamiento no especificado. Se establecerá de forma predeterminada en USER_GOAL_SATISFIED. |
USER_GOAL_SATISFIED |
El objetivo del usuario debe completarse correctamente. |
USER_GOAL_REJECTED |
Se debe rechazar el objetivo del usuario. |
USER_GOAL_IGNORED |
Ignora el estado del objetivo del usuario. |
ScenarioExpectation
Es la expectativa para evaluar la conversación que produce la simulación.
| Campos | |
|---|---|
Campo de unión expectation. Es la expectativa para evaluar la conversación que produce la simulación. expectation puede ser solo uno de los parámetros siguientes: |
|
tool_expectation |
Es opcional. Es el par de llamada a la herramienta y respuesta que se evaluará. |
agent_response |
Es opcional. Es la respuesta del agente que se evaluará. |
ToolExpectation
Es el par de llamada a la herramienta y respuesta que se evaluará.
| Campos | |
|---|---|
expected_tool_call |
Obligatorio. La llamada a la herramienta esperada, con los parámetros de interés especificados. El LLM alucinará los parámetros que no se especifiquen. |
mock_tool_response |
Obligatorio. La respuesta de la herramienta que se simulará, con los parámetros de interés especificados. El LLM alucinará los parámetros que no se especifiquen. |
Paso
Un paso define una acción singular que se producirá durante la evaluación.
| Campos | |
|---|---|
Campo de unión step. Es el paso que se debe realizar. step puede ser solo uno de los parámetros siguientes: |
|
user_input |
Es opcional. Entrada del usuario para la conversación. |
agent_transfer |
Es opcional. Transferir la conversación a otro agente |
expectation |
Es opcional. Ejecuta una expectativa en el turno actual. |
EvaluationConfig
EvaluationConfig establece los parámetros de configuración para ejecutar la evaluación.
| Campos | |
|---|---|
input_audio_config |
Es opcional. Es la configuración para procesar el audio de entrada. |
output_audio_config |
Es opcional. Es la configuración para generar el audio de salida. |
evaluation_channel |
Es opcional. Es el canal que se evaluará. |
tool_call_behaviour |
Es opcional. Especifica si la evaluación debe usar llamadas a la herramienta reales o herramientas falsas. |
EvaluationChannel
Es el canal que se evaluará.
| Enums | |
|---|---|
EVALUATION_CHANNEL_UNSPECIFIED |
Canal de evaluación no especificado. |
TEXT |
Canal de evaluación solo de texto. |
AUDIO |
Canal de evaluación de audio. |
EvaluationDataset
Un conjunto de datos de evaluación representa un conjunto de evaluaciones que se agrupan en función de etiquetas compartidas.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de este conjunto de datos de evaluación. Formato: |
display_name |
Obligatorio. Es el nombre visible definido por el usuario del conjunto de datos de evaluación. Es único dentro de una app. |
evaluations[] |
Es opcional. Son las evaluaciones que se incluyen en este conjunto de datos. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el conjunto de datos de evaluación. |
update_time |
Solo salida. Marca de tiempo de la última actualización del conjunto de datos de evaluación. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
created_by |
Solo salida. Es el usuario que creó el conjunto de datos de evaluación. |
last_updated_by |
Solo salida. Es el usuario que actualizó por última vez el conjunto de datos de evaluación. |
aggregated_metrics |
Solo salida. Son las métricas agregadas para este conjunto de datos de evaluación en todas las ejecuciones. |
EvaluationErrorInfo
Información sobre un error que se produjo durante la ejecución de una evaluación.
| Campos | |
|---|---|
error_type |
Solo salida. Es el tipo de error. |
error_message |
Solo salida. Mensaje de error. |
session_id |
Solo salida. Es el ID de sesión de la conversación que causó el error. |
user_facing_error_message |
Solo salida. Es el mensaje de error para el usuario. |
ErrorType
El tipo de error
| Enums | |
|---|---|
ERROR_TYPE_UNSPECIFIED |
Tipo de error no especificado. |
RUNTIME_FAILURE |
Se produjo un error durante la ejecución del entorno de ejecución. |
CONVERSATION_RETRIEVAL_FAILURE |
No se pudo recuperar la conversación del entorno de ejecución de CES. |
METRIC_CALCULATION_FAILURE |
No se pudo calcular una métrica o un resultado. |
EVALUATION_UPDATE_FAILURE |
No se pudo actualizar la evaluación. |
QUOTA_EXHAUSTED |
Se agotó la cuota. |
USER_SIMULATION_FAILURE |
Se produjo un error durante la simulación del usuario. |
EvaluationExpectation
Una expectativa de evaluación representa un criterio específico con el que se evalúa.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de esta expectativa de evaluación. Formato: |
display_name |
Obligatorio. Es el nombre visible definido por el usuario. Debe ser único dentro de la app. |
tags[] |
Es opcional. Etiquetas definidas por el usuario para las expectativas. Se puede usar para filtrar las expectativas. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la expectativa de evaluación. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la expectativa de evaluación. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
Campo de unión criteria. La definición de los criterios que se usan para la evaluación. criteria puede ser solo uno de los parámetros siguientes: |
|
llm_criteria |
Es opcional. Criterios de evaluación basados en una instrucción de LLM. |
LlmCriteria
Es la configuración de los criterios de evaluación basados en LLM.
| Campos | |
|---|---|
prompt |
Obligatorio. Son las instrucciones o el prompt que se proporcionan al juez de LLM. |
EvaluationMetricsConfig
Configura las métricas para una evaluación.
| Campos | |
|---|---|
golden_metrics_config |
Es opcional. Configuración de las métricas de oro para la evaluación. |
scenario_metrics_config |
Es opcional. Es la configuración de las métricas del caso para la evaluación. |
ComparisonType
Son los tipos de comparación admitidos para verificar la respuesta del agente.
| Enums | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
Tipo de comparación no especificado. El comportamiento predeterminado es SEMANTIC_SIMILARITY para las respuestas del agente y las llamadas a la herramienta. |
EQUALS |
Coincidencia exacta de cadena. |
CONTAINS |
Coincidencia de subcadena (verifica si la cadena esperada está contenida en la respuesta real) |
SEMANTIC_SIMILARITY |
Coincidencia de similitud semántica (evalúa la similitud de significado con un LLM). |
ExpectationsMetMetricsConfig
Es la configuración de las métricas de nivel de expectativa para la evaluación. Para inhabilitar la métrica, configura el mensaje, pero no establezcas el campo enable_expectations_met_metrics como verdadero (o establécelo explícitamente como falso). Para anular la configuración y volver al comportamiento predeterminado, omite el mensaje por completo.
| Campos | |
|---|---|
enable_expectations_met_metrics |
Es opcional. Indica si se deben calcular las métricas de nivel de expectativa para la evaluación. |
GoldenMetricsConfig
Configuración de las métricas de oro para la evaluación.
| Campos | |
|---|---|
semantic_similarity_metrics_config |
Es opcional. Es la configuración global de las métricas de similitud semántica. |
tool_correctness_metrics_config |
Es opcional. Es la configuración de las métricas de corrección de la herramienta a nivel de turno. |
step_tool_correctness_metrics_config |
Es opcional. Es la configuración de las métricas de corrección de la herramienta a nivel de paso. |
HallucinationMetricsConfig
Es la configuración de las métricas de alucinación para la evaluación. Para inhabilitar la métrica, configura el mensaje, pero no establezcas el campo enable_hallucination_metrics como verdadero (o establécelo explícitamente como falso). Para anular la configuración y recurrir al comportamiento predeterminado, omite el mensaje por completo.
| Campos | |
|---|---|
enable_hallucination_metrics |
Es opcional. Indica si se deben calcular las métricas de alucinación para la evaluación. |
ScenarioMetricsConfig
Es la configuración de las métricas del caso para la evaluación.
| Campos | |
|---|---|
user_goal_met_metrics_config |
Es opcional. Es la configuración de las métricas de cumplimiento de objetivos del usuario. |
expectations_met_metrics_config |
Es opcional. Es la configuración de las métricas de nivel de expectativa. |
SemanticSimilarityMetricsConfig
Es la configuración de las métricas de similitud para la evaluación. Para inhabilitar la métrica, configura el mensaje, pero no establezcas el campo enable_semantic_similarity_metrics como verdadero (o establécelo explícitamente como falso). Para anular la configuración y recurrir al comportamiento predeterminado, omite el mensaje por completo.
| Campos | |
|---|---|
enable_semantic_similarity_metrics |
Es opcional. Indica si se deben calcular las métricas de similitud semántica para la evaluación. |
ToolCorrectnessMetricsConfig
Es la configuración de las métricas de corrección para la evaluación. Para inhabilitar la métrica, configura el mensaje, pero no establezcas el campo enable_tool_correctness_metrics como verdadero (o establécelo explícitamente como falso). Para anular la configuración y volver al comportamiento predeterminado, omite el mensaje por completo.
| Campos | |
|---|---|
enable_tool_correctness_metrics |
Es opcional. Indica si se deben calcular las métricas de corrección de la herramienta para la evaluación. |
UserGoalMetMetricsConfig
Es la configuración de las métricas de cumplimiento de objetivos del usuario para la evaluación. Para inhabilitar la métrica, configura el mensaje, pero no establezcas el campo enable_user_goal_met_metrics como verdadero (o establécelo explícitamente como falso). Para anular la configuración y volver al comportamiento predeterminado, omite el mensaje por completo.
| Campos | |
|---|---|
enable_user_goal_met_metrics |
Es opcional. Indica si se deben calcular las métricas de cumplimiento de los objetivos del usuario para la evaluación. |
EvaluationMetricsThresholds
Configuración de umbral para las métricas en una evaluación.
| Campos | |
|---|---|
golden_evaluation_metrics_thresholds |
Es opcional. Los umbrales de las métricas de evaluación de referencia. |
hallucination_metric_behavior |
Es opcional. Obsoleto: Usa |
golden_hallucination_metric_behavior |
Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de referencia. |
scenario_hallucination_metric_behavior |
Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de situaciones. |
GoldenEvaluationMetricsThresholds
Configuración de las evaluaciones de referencia.
| Campos | |
|---|---|
turn_level_metrics_thresholds |
Es opcional. Son los umbrales de las métricas a nivel del turno. |
expectation_level_metrics_thresholds |
Es opcional. Son los umbrales de las métricas de nivel de expectativa. |
tool_matching_settings |
Es opcional. La configuración de coincidencia de la herramienta. Una llamada a la herramienta adicional es una llamada a la herramienta que está presente en la ejecución, pero que no coincide con ninguna llamada a la herramienta en la expectativa de referencia. |
ExpectationLevelMetricsThresholds
Son los umbrales de las métricas a nivel de la expectativa.
| Campos | |
|---|---|
tool_invocation_parameter_correctness_threshold |
Es opcional. Es el umbral de éxito para la corrección de los parámetros de invocación de herramientas individuales. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0. |
TurnLevelMetricsThresholds
Umbrales de métricas a nivel de turno
| Campos | |
|---|---|
semantic_similarity_channel |
Es opcional. Es el canal de similitud semántica que se usará para la evaluación. |
semantic_similarity_success_threshold |
Es opcional. Es el umbral de éxito para la similitud semántica. Debe ser un número entero entre 0 y 4. El valor predeterminado es >= 3. |
overall_tool_invocation_correctness_threshold |
Es opcional. Es el umbral de éxito para la corrección general de la invocación de herramientas. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0. |
SemanticSimilarityChannel
Es el canal de similitud semántica que se usará.
| Enums | |
|---|---|
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED |
Métrica sin especificar. La configuración predeterminada es TEXT. |
TEXT |
Usa la similitud semántica de texto. |
AUDIO |
Usa la similitud semántica de audio. |
HallucinationMetricBehavior
El comportamiento de la métrica de alucinación. Independientemente del comportamiento, la métrica siempre se calculará. La diferencia es que, cuando se inhabilita, la métrica no se usa para calcular la puntuación de evaluación general.
| Enums | |
|---|---|
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED |
Comportamiento de la métrica de alucinación no especificado. |
DISABLED |
Inhabilitar la métrica de alucinación. |
ENABLED |
Habilita la métrica de alucinación. |
ToolMatchingSettings
Configuración para las llamadas a la herramienta que coincidan.
| Campos | |
|---|---|
extra_tool_call_behavior |
Es opcional. Comportamiento para las llamadas a herramientas adicionales. La configuración predeterminada es FAIL. |
ExtraToolCallBehavior
Define el comportamiento cuando se encuentra una llamada a la herramienta adicional. Una llamada a la herramienta adicional es una llamada a la herramienta que está presente en la ejecución, pero que no coincide con ninguna llamada a la herramienta en la expectativa de referencia.
| Enums | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
Comportamiento no especificado. La configuración predeterminada es FAIL. |
FAIL |
Falla la evaluación si se encuentra una llamada a la herramienta adicional. |
ALLOW |
Permitir la llamada a la herramienta adicional. |
EvaluationPersona
Un arquetipo representa a un usuario final en una evaluación.
| Campos | |
|---|---|
name |
Obligatorio. Es el identificador único del perfil. Formato: |
description |
Es opcional. La descripción del arquetipo. |
display_name |
Obligatorio. Es el nombre visible del perfil. Es único dentro de una app. |
personality |
Obligatorio. Es una instrucción para el agente sobre cómo comportarse en la evaluación. |
speech_config |
Es opcional. Configuración de cómo suena el personaje (parámetros de configuración de TTS) |
SpeechConfig
Configuración para la generación de Text-to-Speech.
| Campos | |
|---|---|
speaking_rate |
Es opcional. Es la velocidad del habla. 1.0 es normal. Los valores más bajos son más lentos (p.ej., 0.8) y los más altos son más rápidos (p.ej., 1.5). Es útil para probar cómo el agente maneja a las personas que hablan rápido. |
environment |
Es opcional. El entorno de audio simulado. |
voice_id |
Es opcional. Es el identificador o acento de voz específico que se usará. Ejemplo: "en-US-Wavenet-D" o "en-GB-Standard-A" |
BackgroundEnvironment
Entorno de audio simulado.
| Enums | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
No se especificó el entorno en segundo plano. |
CALL_CENTER |
Entorno del centro de atención telefónica. |
TRAFFIC |
Entorno con ruido de tráfico. |
KIDS_NOISE |
Entorno con ruido de niños. |
CAFE |
Entorno de cafetería. |
EvaluationResult
Un resultado de evaluación representa el resultado de ejecutar una evaluación.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único del resultado de la evaluación. Formato: |
display_name |
Obligatorio. Es el nombre visible del resultado de la evaluación. Es único dentro de una evaluación. De forma predeterminada, tiene el siguiente formato: " |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el resultado de la evaluación. |
evaluation_status |
Solo salida. Es el resultado de la evaluación. Solo se completa si execution_state es COMPLETE. |
evaluation_run |
Solo salida. Es la ejecución de la evaluación que produjo este resultado. Formato: |
persona |
Solo salida. Es el perfil que se usa para generar la conversación para el resultado de la evaluación. |
error_info |
Solo salida. Es la información de error del resultado de la evaluación. |
error |
Solo salida. Obsoleto: Usa |
initiated_by |
Solo salida. Es el usuario que inició la ejecución de la evaluación que generó este resultado. |
app_version |
Solo salida. Es la versión de la app que se usó para generar la conversación que dio lugar a este resultado. Formato: |
app_version_display_name |
Solo salida. Es el nombre visible del |
changelog |
Solo salida. Es el registro de cambios de la versión de la app en la que se ejecutó la evaluación. Se completa si el usuario ejecuta la evaluación en la versión más reciente o en el borrador. |
changelog_create_time |
Solo salida. Es la hora de creación del registro de cambios de la versión de la app con la que se ejecutó la evaluación. Se completa si el usuario ejecuta la evaluación en la versión más reciente o en el borrador. |
execution_state |
Solo salida. Es el estado de la ejecución del resultado de la evaluación. |
evaluation_metrics_thresholds |
Solo salida. Son los umbrales de evaluación del resultado. |
config |
Solo salida. Es la configuración que se usó en la ejecución de la evaluación que generó este resultado. |
golden_run_method |
Solo salida. Es el método que se usa para ejecutar la evaluación de referencia. |
root_span |
Solo salida. El intervalo raíz de la ejecución de la evaluación, que incluye información sobre cada paso de la evaluación. |
outcome_metadata |
Solo salida. Son los metadatos de resultado de la evaluación. Solo se completa si execution_state es COMPLETE. |
Campo de unión result. Es el resultado de la evaluación. Solo se propaga cuando execution_state es COMPLETED. result puede ser solo uno de los parámetros siguientes: |
|
golden_result |
Solo salida. Es el resultado de una evaluación de referencia. |
scenario_result |
Solo salida. Es el resultado de la evaluación de un caso. |
EvaluationExpectationResult
Es el resultado de una sola expectativa de evaluación.
| Campos | |
|---|---|
evaluation_expectation |
Solo salida. La expectativa de la evaluación. Formato: |
prompt |
Solo salida. La instrucción que se usó para la evaluación. |
outcome |
Solo salida. Es el resultado de la expectativa de evaluación. |
explanation |
Solo salida. Es la explicación del resultado. |
ExecutionState
Es el estado de la ejecución del resultado de la evaluación.
| Enums | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
No se especificó el estado de ejecución del resultado de la evaluación. |
QUEUED |
La ejecución del resultado de la evaluación está en cola. |
RUNNING |
Se está ejecutando el resultado de la evaluación. |
COMPLETED |
Se completó la ejecución del resultado de la evaluación. |
ERROR |
No se pudo ejecutar el resultado de la evaluación debido a un error interno. |
CANCELLED |
Se canceló la ejecución del resultado de la evaluación. |
GoldenExpectationOutcome
Especifica la expectativa y el resultado de esa expectativa.
| Campos | |
|---|---|
expectation |
Solo salida. La expectativa que se evaluó. |
outcome |
Solo salida. Es el resultado de la expectativa. |
semantic_similarity_result |
Solo salida. Es el resultado de la verificación de similitud semántica. |
tool_invocation_result |
Solo salida. Es el resultado de la verificación de invocación de la herramienta. |
Campo de unión result. El resultado de la expectativa. result puede ser solo uno de los parámetros siguientes: |
|
observed_tool_call |
Solo salida. Es el resultado de la expectativa de la llamada a la herramienta. |
observed_tool_response |
Solo salida. Es el resultado de la expectativa de respuesta de la herramienta. |
observed_agent_response |
Solo salida. Es el resultado de la expectativa de respuesta del agente. |
observed_agent_transfer |
Solo salida. Es el resultado de la expectativa de transferencia del agente. |
observed_payload |
Solo salida. Es una carga útil personalizada observada. No hay expectativas para las cargas útiles personalizadas. Esto solo se usa para el cálculo de métricas. El resultado siempre es SKIPPED. |
ToolInvocationResult
Es el resultado de la verificación de invocación de la herramienta.
| Campos | |
|---|---|
outcome |
Solo salida. Es el resultado de la verificación de invocación de la herramienta. Esto se determina comparando el parámetro parameter_correctness_score con el umbral. Si la puntuación es igual o superior al umbral, el resultado será PASS. De lo contrario, el resultado será FAIL. |
explanation |
Solo salida. Es una explicación en texto libre del resultado de la invocación de la herramienta. |
parameter_correctness_score |
Solo salida. Es la puntuación de corrección del parámetro de invocación de la herramienta. Esto indica el porcentaje de parámetros de la llamada a la herramienta esperada que también estuvieron presentes en la llamada a la herramienta real. |
GoldenResult
Es el resultado de una evaluación de referencia.
| Campos | |
|---|---|
turn_replay_results[] |
Solo salida. Es el resultado de ejecutar cada turno de la conversación de referencia. |
evaluation_expectation_results[] |
Solo salida. Los resultados de la evaluación. |
TurnReplayResult
Es el resultado de ejecutar un solo turno de la conversación de referencia.
| Campos | |
|---|---|
conversation |
Solo salida. Es la conversación que se generó para este turno. |
expectation_outcome[] |
Solo salida. El resultado de cada expectativa. |
hallucination_result |
Solo salida. Es el resultado de la verificación de alucinaciones. |
tool_invocation_score |
Solo salida. Obsoleto. En su lugar, usa OverallToolInvocationResult. |
turn_latency |
Solo salida. Es la duración del giro. |
tool_call_latencies[] |
Solo salida. La latencia de cada llamada a la herramienta en el turno. |
semantic_similarity_result |
Solo salida. Es el resultado de la verificación de similitud semántica. |
overall_tool_invocation_result |
Solo salida. Es el resultado de la verificación general de la invocación de la herramienta. |
error_info |
Solo salida. Información sobre el error que se produjo durante este turno. |
span_latencies[] |
Solo salida. Es la latencia de los intervalos en el turno. |
tool_ordered_invocation_score |
Solo salida. La puntuación general de invocación ordenada de la herramienta para este turno. Esto indica el porcentaje general de herramientas del turno esperado que se invocaron en el orden esperado. |
HallucinationResult
Es el resultado de la verificación de alucinaciones para un solo turno.
| Campos | |
|---|---|
label |
Solo salida. Es la etiqueta asociada con cada puntuación. Puntuación 1: Justificada Puntuación 0: No justificada Puntuación -1: No hay afirmación para evaluar |
explanation |
Solo salida. Es la explicación de la puntuación de alucinación. |
score |
Solo salida. Es la puntuación de alucinación. Puede ser -1, 0 o 1. |
Resultado
Es el resultado de la evaluación o expectativa.
| Enums | |
|---|---|
OUTCOME_UNSPECIFIED |
No se especificó el resultado de la evaluación. |
PASS |
Se aprobó la evaluación o expectativa. En el caso de una evaluación, esto significa que se cumplieron todas las expectativas. |
FAIL |
No se pudieron cumplir las expectativas o la evaluación. En el caso de una evaluación, esto significa que no se cumplió al menos una expectativa. |
SKIPPED |
Se omitió la evaluación o expectativa. |
OutcomeMetadata
Son los metadatos sobre el resultado de la evaluación.
| Enums | |
|---|---|
OUTCOME_METADATA_UNSPECIFIED |
Metadatos de resultado sin especificar. |
GRACEFUL_HANDOFF |
La evaluación dio como resultado una transferencia fluida a un representante humano. |
OverallToolInvocationResult
Es el resultado de la verificación general de la invocación de la herramienta.
| Campos | |
|---|---|
outcome |
Solo salida. Es el resultado de la verificación de invocación de la herramienta. Esto se determina comparando el tool_invocation_score con el overall_tool_invocation_correctness_threshold. Si la puntuación es igual o superior al umbral, el resultado será PASS. De lo contrario, el resultado será FAIL. |
tool_invocation_score |
Es la puntuación general de invocación de herramientas para este turno. Esto indica el porcentaje general de herramientas del turno esperado que se invocaron. |
ScenarioExpectationOutcome
Es el resultado de una expectativa de situación.
| Campos | |
|---|---|
expectation |
Solo salida. La expectativa que se evaluó. |
outcome |
Solo salida. Es el resultado de ScenarioExpectation. |
Campo de unión result. El resultado de la expectativa. result puede ser solo uno de los parámetros siguientes: |
|
observed_tool_call |
Solo salida. Es la llamada a la herramienta observada. |
observed_agent_response |
Solo salida. La respuesta observada del agente. |
ObservedToolCall
La llamada a la herramienta y la respuesta observadas.
| Campos | |
|---|---|
tool_call |
Solo salida. Es la llamada a la herramienta observada. |
tool_response |
Solo salida. La respuesta de la herramienta observada. |
ScenarioResult
Es el resultado de la evaluación de un caso.
| Campos | |
|---|---|
conversation |
Solo salida. La conversación que se generó en la situación |
task |
Solo salida. Es la tarea que se usó cuando se ejecutó la situación para este resultado. |
user_facts[] |
Solo salida. Son los datos del usuario que usó la situación para este resultado. |
expectation_outcomes[] |
Solo salida. El resultado de cada expectativa. |
rubric_outcomes[] |
Solo salida. El resultado de la rúbrica. |
hallucination_result[] |
Solo salida. Es el resultado de la verificación de alucinaciones. Habrá un resultado de alucinación para cada turno de la conversación. |
task_completion_result |
Solo salida. Es el resultado de la verificación de finalización de la tarea. |
tool_call_latencies[] |
Solo salida. La latencia de cada ejecución de llamada a la herramienta en la conversación. |
user_goal_satisfaction_result |
Solo salida. Es el resultado de la verificación de satisfacción del objetivo del usuario. |
span_latencies[] |
Solo salida. La latencia de los intervalos en la conversación. |
evaluation_expectation_results[] |
Solo salida. Los resultados de la evaluación. |
milestone_results[] |
Solo salida. Los resultados de cada hito de la situación |
all_expectations_satisfied |
Solo salida. Indica si se cumplieron todas las expectativas para este turno. |
task_completed |
Solo salida. Indica si la tarea se completó para este turno. Este es un compuesto de todas las expectativas satisfechas, sin alucinaciones y con la satisfacción de los objetivos del usuario. |
MilestoneResult
Representa el resultado de la ejecución de un hito.
| Campos | |
|---|---|
milestone |
Solo salida. Es el hito del que se hace un seguimiento. |
status |
Solo salida. Es el estado actual del hito. |
justification |
Solo salida. Es la justificación del estado actual. |
MilestoneStatus
Es el estado del logro.
| Enums | |
|---|---|
MILESTONE_STATUS_UNSPECIFIED |
Indica que no se especificó el estado. |
NOT_STARTED |
El hito aún no comenzó. |
IN_PROGRESS |
El hito está en curso. |
COMPLETED |
El hito se completó correctamente. |
ScenarioRubricOutcome
El resultado de la evaluación con la rúbrica.
| Campos | |
|---|---|
rubric |
Solo salida. Es la rúbrica que se usó para evaluar la conversación. |
score_explanation |
Solo salida. Es la respuesta del evaluador a la rúbrica. |
score |
Solo salida. La puntuación de la conversación según la rúbrica. |
SemanticSimilarityResult
Es el resultado de la verificación de similitud semántica.
| Campos | |
|---|---|
label |
Solo salida. Es la etiqueta asociada con cada puntuación. Puntuación 4: Totalmente coherente Puntuación 3: Mayormente coherente Puntuación 2: Parcialmente coherente (omisiones menores) Puntuación 1: En gran medida incoherente (omisiones importantes) Puntuación 0: Completamente incoherente o contradictorio |
explanation |
Solo salida. Es la explicación de la puntuación de similitud semántica. |
outcome |
Solo salida. Es el resultado de la verificación de similitud semántica. Esto se determina comparando la puntuación con el semantic_similarity_success_threshold. Si la puntuación es igual o superior al umbral, el resultado será PASS. De lo contrario, el resultado será FAIL. |
score |
Solo salida. Es la puntuación de similitud semántica. Puede ser 0, 1, 2, 3 o 4. |
SpanLatency
La latencia de la ejecución de un intervalo.
| Campos | |
|---|---|
type |
Solo salida. Es el tipo de intervalo. |
display_name |
Solo salida. Es el nombre visible del intervalo. Se aplica a los intervalos de herramientas y protecciones. |
start_time |
Solo salida. Es la hora de inicio del intervalo. |
end_time |
Solo salida. Es la hora de finalización del intervalo. |
execution_latency |
Solo salida. La latencia del intervalo. |
Campo de unión identifier. Es el identificador del elemento específico según su tipo. identifier puede ser solo uno de los parámetros siguientes: |
|
resource |
Solo salida. Es el nombre del recurso de los intervalos de la protección o la herramienta. |
toolset |
Solo salida. Es el identificador de la herramienta del conjunto de herramientas. |
model |
Solo salida. Es el nombre del intervalo de LLM. |
callback |
Solo salida. Es el nombre del intervalo de devolución de llamada del usuario. |
Tipo
Es el tipo de intervalo. Es posible que se agreguen más valores en el futuro.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Valor predeterminado. Este valor no se usa. |
TOOL |
Intervalo de llamada a la herramienta. |
USER_CALLBACK |
Es el intervalo de devolución de llamada del usuario. |
GUARDRAIL |
Intervalo de la protección. |
LLM |
Intervalo de LLM. |
TaskCompletionResult
Es el resultado de la verificación de finalización de la tarea para la conversación.
| Campos | |
|---|---|
label |
Solo salida. Es la etiqueta asociada con cada puntuación. Puntuación 1: Tarea completada Puntuación 0: Tarea no completada Puntuación -1: Objetivo del usuario no definido |
explanation |
Solo salida. Es la explicación de la puntuación de finalización de la tarea. |
score |
Solo salida. Es la puntuación de finalización de la tarea. Puede ser -1, 0 o 1 |
ToolCallLatency
Es la latencia de la ejecución de una llamada a la herramienta.
| Campos | |
|---|---|
tool |
Solo salida. Es el nombre de la herramienta que se ejecutó. Formato: |
display_name |
Solo salida. Es el nombre visible de la herramienta. |
start_time |
Solo salida. Es la hora de inicio de la ejecución de la llamada a la herramienta. |
end_time |
Solo salida. Es la hora de finalización de la ejecución de la llamada a la herramienta. |
execution_latency |
Solo salida. Es la latencia de la ejecución de la llamada a la herramienta. |
UserGoalSatisfactionResult
Es el resultado de una verificación de satisfacción del objetivo del usuario para una conversación.
| Campos | |
|---|---|
label |
Solo salida. Es la etiqueta asociada con cada puntuación. Puntuación 2: Transferencia correcta Puntuación 1: Tarea del usuario satisfecha Puntuación 0: Tarea del usuario no satisfecha Puntuación -1: Tarea del usuario no especificada |
explanation |
Solo salida. Es la explicación de la puntuación de satisfacción de la tarea del usuario. |
score |
Solo salida. Es la puntuación de satisfacción del usuario con la tarea. Puede ser -1, 0, 1, 2. |
EvaluationRun
Una ejecución de evaluación representa todos los resultados de una ejecución de evaluación.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la ejecución de la evaluación. Formato: |
display_name |
Es opcional. Es el nombre visible definido por el usuario de la ejecución de la evaluación. El valor predeterminado es " |
evaluation_results[] |
Solo salida. Son los resultados de la evaluación que forman parte de esta ejecución. Formato: |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la ejecución de la evaluación. |
initiated_by |
Solo salida. Es el usuario que inició la ejecución de la evaluación. |
app_version |
Solo salida. Es la versión de la app que se evaluará. Formato: |
app_version_display_name |
Solo salida. Es el nombre visible del |
changelog |
Solo salida. Es el registro de cambios de la versión de la app en la que se ejecutó la evaluación. Se completa si el usuario ejecuta la evaluación en la versión más reciente o en el borrador. |
changelog_create_time |
Solo salida. Es la hora de creación del registro de cambios de la versión de la app con la que se ejecutó la evaluación. Se completa si el usuario ejecuta la evaluación en la versión más reciente o en el borrador. |
evaluations[] |
Solo salida. Son las evaluaciones que forman parte de esta ejecución. La lista puede contener evaluaciones de cualquier tipo. Este campo es mutuamente exclusivo con |
evaluation_dataset |
Solo salida. Es el conjunto de datos de evaluación con el que se asocia esta ejecución. Este campo es mutuamente exclusivo con |
evaluation_type |
Solo salida. Es el tipo de evaluaciones de esta ejecución. |
state |
Solo salida. Es el estado de la ejecución de la evaluación. |
progress |
Solo salida. El progreso de la ejecución de la evaluación. |
config |
Solo salida. Es la configuración que se usa en la ejecución. |
error |
Solo salida. Obsoleto: Usa error_info en su lugar. Se encontraron errores durante la ejecución. |
error_info |
Solo salida. Información de error para la ejecución de la evaluación. |
evaluation_run_summaries |
Solo salida. Es el mapa del nombre de la evaluación a EvaluationRunSummary. |
latency_report |
Solo salida. Es el informe de latencia de la ejecución de la evaluación. |
run_count |
Solo salida. Es la cantidad de veces que se ejecutaron las evaluaciones dentro de la ejecución. |
persona_run_configs[] |
Solo salida. Es la configuración que se usará para la ejecución por perfil. |
optimization_config |
Es opcional. Es la configuración para ejecutar el paso de optimización después de la ejecución de la evaluación. Si no se establece, no se ejecutará el paso de optimización. |
scheduled_evaluation_run |
Solo salida. Es el nombre del recurso de ejecución de la evaluación programada que creó esta ejecución de la evaluación. Este campo solo se configura si la ejecución de la evaluación se creó mediante una ejecución de evaluación programada. Formato: |
golden_run_method |
Solo salida. Es el método que se usa para ejecutar la evaluación. |
operation |
Solo salida. Es la operación que creó esta ejecución de evaluación. Formato: |
EvaluationRunState
Es el estado de la ejecución de la evaluación.
| Enums | |
|---|---|
EVALUATION_RUN_STATE_UNSPECIFIED |
No se especificó el estado de la ejecución de la evaluación. |
QUEUED |
Indica que la ejecución de la evaluación está en cola. |
RUNNING |
La ejecución de evaluación está en curso. |
COMPLETED |
Se completó la ejecución de la evaluación. |
ERROR |
La ejecución de la evaluación tiene un error. |
CANCELLED |
Se canceló la ejecución de la evaluación. |
EvaluationRunSummary
Contiene el resumen de los recuentos de resultados aprobados y fallidos de una evaluación específica en una ejecución de evaluación.
| Campos | |
|---|---|
passed_count |
Solo salida. Es la cantidad de resultados aprobados para la evaluación asociada en esta ejecución. |
failed_count |
Solo salida. Es la cantidad de resultados con errores de la evaluación asociada en esta ejecución. |
error_count |
Solo salida. Es la cantidad de resultados de error de la evaluación asociada en esta ejecución. |
EvaluationType
Es el tipo de evaluaciones de esta ejecución. Es posible que se agreguen más valores en el futuro.
| Enums | |
|---|---|
EVALUATION_TYPE_UNSPECIFIED |
No se especificó el tipo de evaluación. |
GOLDEN |
Evaluación de referencia. |
SCENARIO |
Evaluación de situaciones |
MIXED |
Indica que la ejecución incluye una combinación de evaluaciones de referencia y de situaciones. |
Progreso
El progreso de la ejecución de la evaluación.
| Campos | |
|---|---|
total_count |
Solo salida. Es la cantidad total de resultados de la evaluación en esta ejecución. |
failed_count |
Solo salida. Cantidad de resultados de evaluación completados con un resultado de FALLA. (EvaluationResult.execution_state es COMPLETED y EvaluationResult.evaluation_status es FAIL). |
error_count |
Solo salida. Es la cantidad de resultados de la evaluación que no se pudieron ejecutar. (EvaluationResult.execution_state es ERROR). |
completed_count |
Solo salida. Es la cantidad de resultados de la evaluación que finalizaron correctamente. (EvaluationResult.execution_state es COMPLETED). |
passed_count |
Solo salida. Es la cantidad de resultados de evaluación completados con un resultado de APROBADO. (EvaluationResult.execution_state es COMPLETED y EvaluationResult.evaluation_status es PASS). |
cancelled_count |
Solo salida. Es la cantidad de resultados de la evaluación que se cancelaron. (EvaluationResult.execution_state es CANCELLED). |
EvaluationRunCachingSettings
Configuración para el almacenamiento en caché de la ejecución de la evaluación.
| Campos | |
|---|---|
run_caching_mode |
Es opcional. Es el modo de almacenamiento en caché que se usará para la ejecución de la evaluación. Si no se establece, el valor predeterminado es FORCE_RUN. |
EvaluationRunCachingMode
Es el comportamiento de almacenamiento en caché del resultado de la evaluación. Controla si se debe devolver el último resultado de la evaluación completada (si existe) o ejecutar una nueva evaluación.
| Enums | |
|---|---|
EVALUATION_RUN_CACHING_MODE_UNSPECIFIED |
No se especificó el modo de almacenamiento en caché de la ejecución. |
FORCE_RUN |
Ejecuta siempre una simulación en vivo completa, independientemente de si existen registros de cambios. |
SKIP_IF_UNCHANGED |
Omitir la ejecución y copiar los resultados verificados anteriores si no mutó ninguna dependencia, el canal de evaluación y el método de ejecución son los mismos. |
EvaluationSettings
Es la configuración de la evaluación.
| Campos | |
|---|---|
scenario_conversation_initiator |
Es opcional. Quién inicia la conversación en una evaluación de situación. |
golden_run_method |
Es opcional. Es el método predeterminado que se usa para ejecutar evaluaciones de referencia. Se usará si no se especifica golden_run_method en RunEvaluationRequest. |
golden_evaluation_tool_call_behaviour |
Es opcional. Configura el comportamiento predeterminado de las llamadas a herramientas para las evaluaciones de referencia. |
scenario_evaluation_tool_call_behaviour |
Es opcional. Configura el comportamiento predeterminado de las llamadas a la herramienta para las evaluaciones de situaciones. |
metrics_config |
Es opcional. Configura las métricas predeterminadas para las evaluaciones. |
scenario_execution_mode |
Es opcional. Es el modo de ejecución para las evaluaciones de situaciones. Si no se proporciona, se usará QUALITY_OPTIMIZED de forma predeterminada. |
evaluation_run_caching_settings |
Es opcional. Es la configuración de almacenamiento en caché que se usará para la ejecución de la evaluación. |
ScenarioConversationInitiator
Determina quién inicia la conversación en una sesión de evaluación de situaciones.
| Enums | |
|---|---|
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED |
Sin especificar. La configuración predeterminada es USER. |
USER |
El usuario inicia la conversación. |
AGENT |
El agente inicia la conversación. |
ScenarioExecutionMode
Es el modo de ejecución para las evaluaciones de situaciones.
| Enums | |
|---|---|
SCENARIO_EXECUTION_MODE_UNSPECIFIED |
Modo de ejecución no especificado. La configuración predeterminada es QUALITY_OPTIMIZED. |
QUALITY_OPTIMIZED |
Modo optimizado para calidad. |
SPEED_OPTIMIZED |
Modo optimizado para velocidad. |
EvaluationToolCallBehaviour
Configura el comportamiento de la llamada a la herramienta para las ejecuciones de evaluación.
| Enums | |
|---|---|
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED |
Comportamiento de llamada a la herramienta no especificado. Se establecerá de forma predeterminada en llamadas a herramientas reales. |
REAL |
Usa llamadas a herramientas reales. |
FAKE |
Usa llamadas a herramientas falsas. |
Evento
Entrada del evento.
| Campos | |
|---|---|
event |
Obligatorio. Es el nombre del evento. |
variables |
Es opcional. Son las variables adicionales asociadas con el evento. |
Ejemplo
Un ejemplo representa una conversación de muestra entre el usuario y los agentes.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único del ejemplo. Formato: |
display_name |
Obligatorio. Es el nombre visible del ejemplo. |
description |
Es opcional. Descripción legible por humanos del ejemplo. |
entry_agent |
Es opcional. Es el agente que maneja la conversación inicialmente. Si no se especifica, el ejemplo representa una conversación que controla el agente raíz. Formato: |
messages[] |
Es opcional. Es la colección de mensajes que conforman la conversación. |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el ejemplo. |
update_time |
Solo salida. Marca de tiempo de la última actualización del ejemplo. |
invalid |
Solo salida. El ejemplo puede dejar de ser válido si se borran los recursos de referencia. Los ejemplos no válidos no se usarán como ejemplos de aprendizaje con pocos ejemplos. |
etag |
Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
ExecuteToolRequest
Mensaje de solicitud para ToolService.ExecuteTool.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: |
args |
Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON. |
mock_config |
Es opcional. Configuración de simulación para la ejecución de la herramienta. Si se establece este campo, las herramientas que llaman a otras herramientas se simularán según los patrones y las respuestas proporcionados. |
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutará. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
Es opcional. Es la herramienta del conjunto de herramientas que se ejecutará. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error. |
Campo de unión tool_execution_context. El contexto adicional que se proporcionará para la ejecución de la herramienta tool_execution_context puede ser solo uno de los siguientes: |
|
variables |
Es opcional. Son las variables que están disponibles para la ejecución de la herramienta. |
context |
Es opcional. El [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment para obtener más detalles) que se pasará a la herramienta de Python. |
ExecuteToolResponse
Mensaje de respuesta para ToolService.ExecuteTool.
| Campos | |
|---|---|
response |
Es el resultado de la ejecución de la herramienta en formato de objeto JSON. Usa la clave "output" para especificar la respuesta de la herramienta y la clave "error" para especificar los detalles del error (si los hay). Si no se especifican las claves "output" y "error", toda la "response" se trata como el resultado de la ejecución de la herramienta. |
variables |
Son los valores de las variables al final de la ejecución de la herramienta. |
citations |
Son citas que proporcionan la información de la fuente para la ejecución de la herramienta. |
google_search_suggestions |
Son las sugerencias que se devuelven de la Búsqueda de Google como resultado de invocar la herramienta de Búsqueda de Google durante la ejecución de la herramienta. |
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutó. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es el nombre de la herramienta que se ejecutó. Formato: |
toolset_tool |
Es la herramienta del conjunto de herramientas que se ejecutó. |
ExecutionType
Es el tipo de ejecución de la herramienta o el conjunto de herramientas.
| Enums | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
No se especificó el tipo de ejecución. Si no se especifica, el número predeterminado es SYNCHRONOUS. |
SYNCHRONOUS |
La herramienta se ejecuta de forma síncrona. La sesión se bloquea hasta que la herramienta devuelve un resultado. |
ASYNCHRONOUS |
La herramienta se ejecuta de forma asíncrona. La sesión continuará mientras se ejecuta la herramienta. |
ExperimentConfig
Experimenta para la implementación.
| Campos | |
|---|---|
version_release |
Es opcional. Es la versión de lanzamiento del experimento. |
Estado
Es el estado del experimento.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Significa que el estado no se especificó. |
PENDING |
Obsoleto: Este estado ya no se usa. |
RUNNING |
Estado de ejecución. El experimento se está ejecutando y es válido. |
DONE |
Obsoleto: Este estado ya no se usa. |
EXPIRED |
Obsoleto: Este estado ya no se usa. |
VersionRelease
Es la versión de lanzamiento del experimento.
| Campos | |
|---|---|
state |
Es opcional. Es el estado del lanzamiento de la versión. |
traffic_allocations[] |
Es opcional. Son las asignaciones de tráfico para el lanzamiento de la versión. |
TrafficAllocation
Es la asignación de tráfico para el lanzamiento de la versión.
| Campos | |
|---|---|
id |
Es opcional. Es el ID de la asignación de tráfico. Cadena de formato libre, de hasta 128 caracteres. |
traffic_percentage |
Es opcional. Porcentaje de tráfico de la asignación de tráfico. Los valores mínimo y máximo son 0 y 100, respectivamente. |
app_version |
Es opcional. Es la versión de la app de la asignación de tráfico. Formato: |
ExportAppRequest
Mensaje de solicitud para AgentService.ExportApp.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la app que se exportará. |
export_format |
Obligatorio. Es el formato en el que se exportará la app. |
gcs_uri |
Es opcional. Es el URI de Google Cloud Storage al que se exportará la app. El formato de este URI debe ser |
app_version |
Es opcional. Es el nombre del recurso de la versión de la app que se exportará. Formato: |
ExportFormat
Es el formato de exportación de la app.
| Enums | |
|---|---|
EXPORT_FORMAT_UNSPECIFIED |
No se especifica el formato de exportación. |
JSON |
El formato de exportación es JSON. |
YAML |
El formato de exportación es YAML. |
ExportAppResponse
Mensaje de respuesta para AgentService.ExportApp.
| Campos | |
|---|---|
Campo de unión app. La app exportada. app puede ser solo uno de los siguientes: |
|
app_content |
Es la carpeta de la app comprimida como un archivo ZIP. |
app_uri |
Es el URI de Google Cloud Storage al que se exportó la app. |
ExportEvaluationResultsOperationMetadata
Este tipo no tiene campos.
Metadatos de la operación para EvaluationService.ExportEvaluationResults.
ExportEvaluationResultsRequest
Mensaje de solicitud para EvaluationService.ExportEvaluationResults.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la evaluación desde la que se exportarán los resultados. Formato: |
names[] |
Obligatorio. Son los nombres de los recursos de los resultados de la evaluación que se exportarán. |
export_options |
Es opcional. Son las opciones de exportación para los resultados de la evaluación. |
ExportEvaluationResultsResponse
Mensaje de respuesta para EvaluationService.ExportEvaluationResults.
| Campos | |
|---|---|
Campo de unión evaluation_results. Son los resultados de la evaluación exportados. evaluation_results puede ser solo uno de los parámetros siguientes: |
|
evaluation_results_content |
Es el contenido de los resultados de la evaluación exportados. Se propagará si no se especificó gcs_uri en la solicitud. |
evaluation_results_uri |
Es la carpeta del URI de Google Cloud Storage en la que se escribieron los resultados de la evaluación exportados. Se propagará si se especificó gcs_uri en la solicitud. |
ExportEvaluationRunsOperationMetadata
Este tipo no tiene campos.
Metadatos de la operación para EvaluationService.ExportEvaluationRuns.
ExportEvaluationRunsRequest
Mensaje de solicitud para EvaluationService.ExportEvaluationRuns.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app desde la que se exportarán las ejecuciones de evaluación. Formato: |
names[] |
Obligatorio. Son los nombres de los recursos de las ejecuciones de evaluación que se exportarán. |
export_options |
Es opcional. Son las opciones de exportación para las ejecuciones de evaluación. |
ExportEvaluationRunsResponse
Mensaje de respuesta para EvaluationService.ExportEvaluationRuns.
| Campos | |
|---|---|
Campo de unión evaluation_runs. Son las ejecuciones de evaluación exportadas. evaluation_runs puede ser solo uno de los parámetros siguientes: |
|
evaluation_runs_content |
Es el contenido de las ejecuciones de evaluación exportadas. Se propagará si no se especificó gcs_uri en la solicitud. |
evaluation_runs_uri |
Es la carpeta del URI de Google Cloud Storage en la que se escribieron las ejecuciones de evaluación exportadas. Se propagará si se especificó gcs_uri en la solicitud. |
ExportEvaluationsRequest
Mensaje de solicitud para EvaluationService.ExportEvaluations.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app desde la que se exportarán las evaluaciones. Formato: |
names[] |
Obligatorio. Son los nombres de los recursos de las evaluaciones que se exportarán. |
export_options |
Es opcional. Son las opciones de exportación para las evaluaciones. |
include_evaluation_results |
Es opcional. Incluye los resultados de la evaluación en la exportación. Se debe establecer al menos uno de los parámetros include_evaluation_results o include_evaluations. |
include_evaluations |
Es opcional. Incluye evaluaciones en la exportación. Se debe establecer al menos uno de los parámetros include_evaluation_results o include_evaluations. |
ExportEvaluationsResponse
Mensaje de respuesta para EvaluationService.ExportEvaluations.
| Campos | |
|---|---|
failed_evaluations |
Solo salida. Un mapa de los nombres de los recursos de evaluación que no se pudieron exportar, con el motivo por el que fallaron. |
Campo de unión evaluations. Son las evaluaciones exportadas. evaluations puede ser solo uno de los parámetros siguientes: |
|
evaluations_content |
Es el contenido de las evaluaciones exportadas. Se propagará si no se especificó gcs_uri en la solicitud. |
evaluations_uri |
Es la carpeta del URI de Google Cloud Storage en la que se escribieron las evaluaciones exportadas. Se propagará si se especificó gcs_uri en la solicitud. |
ExportOptions
Son las opciones para exportar recursos de evaluación de CES.
| Campos | |
|---|---|
export_format |
Es opcional. Es el formato en el que se exportarán los resultados de la evaluación. El valor predeterminado es JSON si no se especifica. |
gcs_uri |
Es opcional. Es el URI de Google Cloud Storage en el que se escribirán los resultados de la evaluación exportados. |
ExportFormat
Es el formato en el que se exportarán los elementos. El valor predeterminado es JSON si no se especifica.
| Enums | |
|---|---|
EXPORT_FORMAT_UNSPECIFIED |
Formato no especificado. |
JSON |
o JSON. |
YAML |
en formato YAML. |
ExpressionCondition
Es la condición de expresión basada en el estado de la sesión.
| Campos | |
|---|---|
expression |
Obligatorio. Es la representación de cadena de la condición cloud.api.Expression. |
FileContext
Son los archivos que se usarán como contexto. Los archivos se pueden proporcionar como bytes sin procesar.
| Campos | |
|---|---|
Campo de unión file. Se proporcionó el archivo como contexto. file puede ser solo uno de los parámetros siguientes: |
|
file_bytes |
Es opcional. Es el archivo proporcionado como bytes sin procesar. |
FileBytes
Es el archivo proporcionado como bytes sin procesar.
| Campos | |
|---|---|
file_name |
Obligatorio. Es el nombre del archivo proporcionado como bytes sin procesar. |
mime_type |
Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen. |
data |
Obligatorio. Son los bytes sin procesar del archivo. |
FileSearchTool
La herramienta de búsqueda de archivos permite al agente buscar en los archivos que subió el desarrollador de la app o del agente. Tiene ajustes predeterminados para ofrecer una búsqueda de calidad relativamente buena en los archivos subidos y un resumen de los resultados recuperados.
| Campos | |
|---|---|
corpus_type |
Es opcional. Es el tipo de corpus. El valor predeterminado es FULLY_MANAGED. |
name |
Obligatorio. Es el nombre de la herramienta. |
description |
Es opcional. Es la descripción de la herramienta. |
file_corpus |
Es opcional. Es el corpus en el que se almacenan los archivos. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
CorpusType
Es el tipo de corpus de RAG de Vertex.
| Enums | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
Tipo de corpus no especificado. |
USER_OWNED |
El usuario crea el corpus y es su propietario. |
FULLY_MANAGED |
El agente crea el corpus. |
GenerateAppResourceOperationMetadata
Metadatos de la operación para AgentService.GenerateAppResource.
| Campos | |
|---|---|
generation_type |
Solo salida. Es el tipo de operación. |
message |
Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde. |
create_time |
Es solo de salida. Indica la hora a la que se creó la operación. |
end_time |
Es solo de salida. Indica la hora a la que finalizó la operación. |
target |
Solo salida. Es el nombre del recurso de la app con la que está asociada la operación. Formato: |
partial_errors[] |
Solo salida. Son los mensajes de error del proceso de generación de recursos. |
GenerationType
Es el tipo de operación de generación.
| Enums | |
|---|---|
GENERATION_TYPE_UNSPECIFIED |
Tipo de operación sin especificar. |
AGENT_RESTRUCTURE |
Es el tipo de reestructuración de las instrucciones del agente. |
AGENT_REFINE |
Tipo de mejora de las instrucciones del agente. |
AGENT_CREATE |
Creación de agentes a partir de un tipo. |
TOOL_CREATE |
Es el tipo de creación de la herramienta. |
SCENARIO_CREATE |
Es el tipo de creación de la situación. |
SCENARIO_CREATE_FROM_TRANSCRIPTS |
Tipo de creación de situaciones a partir de transcripciones. |
EVALUATION_PERSONA_CREATE |
Es el tipo de generación de personas de evaluación. |
QUALITY_REPORT_CREATE |
Es el tipo de generación de informes de calidad. |
INSTRUCTION_FOLLOWING_FIX |
Es el tipo de corrección de seguimiento de instrucciones (se usa para las correcciones de escalada de colinas). |
GenerateAppResourceRequest
Mensaje de solicitud para AgentService.GenerateAppResource.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app para la que se generará el recurso. |
refine_instructions[] |
Es opcional. Es la lista de instrucciones de perfeccionamiento que se usarán para perfeccionar el recurso. |
tool_generation_config |
Es opcional. Es la configuración que se usará para generar la herramienta. |
app_generation_config |
Es opcional. Es la configuración que se usará para generar los agentes y las herramientas. |
evaluation_generation_config |
Es opcional. Es la configuración que se usará para generar las evaluaciones. |
evaluation_personas_generation_config |
Es opcional. La configuración que se usará para generar los arquetipos de evaluación. |
quality_report_generation_config |
Es opcional. Es la configuración que se usará para generar el informe de calidad. |
hill_climbing_fix_config |
Es opcional. Es la configuración que se usará para las correcciones de ascenso de colinas. |
Campo de unión resource. Es el recurso que se generará. resource puede ser solo uno de los parámetros siguientes: |
|
agent |
El recurso del agente que usará el asistente de LLM puede estar vacío para generar un agente nuevo. |
tool |
El recurso de herramienta que usará el asistente de LLM puede estar vacío para generar una herramienta nueva. |
toolset |
El recurso del conjunto de herramientas que usará el asistente de LLM puede estar vacío para generar un conjunto de herramientas nuevo. |
app_version_context |
Es el contexto de la versión de la app que especifica la instantánea base y el agente de destino. |
AppGenerationConfig
Es la configuración que se usará para generar la app.
| Campos | |
|---|---|
context |
Es opcional. El contexto que describe los requisitos de los agentes y las herramientas que se generarán. |
file_contexts[] |
Es opcional. Los archivos que se usarán como contexto. |
dataset_id |
Es opcional. Es el conjunto de datos de estadísticas que se usará para recuperar los datos de la conversación y generar los agentes y las herramientas. Formato: |
generate_evaluations |
Es opcional. Indica si se deben generar las evaluaciones para la app. Si es verdadero, se usará el contexto proporcionado para generar los datos de las evaluaciones. |
gcs_location |
Es opcional. Es la ubicación de Cloud Storage en la que se almacenarán los datos de preguntas y respuestas generados que usará la herramienta de Datastore. Estos datos se generan solo cuando se usan datos de conversación como fuente de entrada. La ubicación debe estar en el mismo proyecto que la app. Formato: |
AppVersionContext
Es el contexto de la versión de la app que especifica la instantánea base y el agente de destino.
| Campos | |
|---|---|
app_version |
Es el nombre del recurso de la versión de la app que usará el asistente de LLM. Formato: |
agent_resource_name |
Es el nombre del recurso del agente de destino que usará el asistente de LLM. Formato: |
EvaluationGenerationConfig
Es la configuración que se usará para generar las evaluaciones.
| Campos | |
|---|---|
dataset_id |
Es opcional. Es el conjunto de datos de estadísticas que se usará para recuperar los datos de las conversaciones y generar las evaluaciones. Formato: |
EvaluationPersonasGenerationConfig
Este tipo no tiene campos.
La configuración que se usará para generar los arquetipos de evaluación.
HillClimbingFixConfig
Es la configuración que se usará para las correcciones de ascenso de colinas.
| Campos | |
|---|---|
quality_report |
Obligatorio. El informe de calidad que se usó para informar la corrección de la instrucción. |
QualityReportGenerationConfig
Es la configuración que se usará para generar el informe de calidad.
| Campos | |
|---|---|
evaluation_run |
Obligatorio. Es la ejecución de evaluación que se usa para fundamentar el análisis del informe de calidad. |
algorithm |
Es opcional. Es el algoritmo de atribución de pérdidas que se usará. |
LossAttributionAlgorithm
Es el algoritmo que se usará para la atribución de pérdidas.
| Enums | |
|---|---|
LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED |
Sin especificar. |
APP_CENTRIC |
Atribución de pérdidas centrada en las apps Trata la app como una sola unidad. |
AGENT_CENTRIC |
Atribución de pérdidas centrada en el agente. Atribuye la pérdida a agentes individuales. |
RefineInstructions
Son las instrucciones que se usarán para definir mejor una parte del recurso. La parte del recurso se puede especificar con un índice de inicio, un índice de finalización y una máscara de campo. Por ejemplo, si deseas definir mejor una parte de las instrucciones del agente, puedes especificar el índice del primer carácter de las instrucciones, el índice del último carácter de las instrucciones y la máscara de campo como "instrucciones".
| Campos | |
|---|---|
start_index |
Obligatorio. Es el primer carácter (inclusive) del texto que se definirá mejor. |
end_index |
Obligatorio. Es el último carácter (inclusive) del texto que se definirá mejor. |
field_mask |
Obligatorio. Es el campo del recurso que se está definiendo mejor. Solo se permite un campo por RefineInstructions. Si se definen mejor las instrucciones del agente, la máscara de campo debe ser "instructions". |
instructions |
Obligatorio. Son las instrucciones para definir mejor el recurso. |
ToolGenerationConfig
Es la configuración que se usará para generar una herramienta.
| Campos | |
|---|---|
context |
Es opcional. Es el contexto que describe la herramienta que se generará. Este campo puede estar vacío si se proporcionan la solicitud y la respuesta de la herramienta. |
file_contexts[] |
Es opcional. Los archivos que se usarán como contexto. |
open_api_toolset_generation_config |
Es opcional. Es la configuración que se usará para generar un esquema de OpenAPI. |
OpenApiToolsetGenerationConfig
Es la configuración que se usará para generar un esquema de OpenAPI.
| Campos | |
|---|---|
uri |
Obligatorio. Es el URI base de la herramienta. |
operation_generation_configs[] |
Obligatorio. Es la lista de operaciones que se agregarán al esquema de API abierta. |
OperationGenerationConfig
Es la configuración que se usará para generar una operación en el esquema de OpenAPI.
| Campos | |
|---|---|
method |
Obligatorio. Es el URI de la herramienta. Esto debe incluir parámetros de consulta y de ruta, si los hay. |
path |
Obligatorio. Es la ruta de acceso de la herramienta que se agregará al URI base. Esto debe incluir parámetros de consulta y de ruta, si los hay. |
request_json |
Obligatorio. Es una solicitud de ejemplo a la herramienta en formato JSON. Omite este paso si la herramienta no admite el cuerpo de la solicitud. |
response_json |
Obligatorio. Es una respuesta de ejemplo de la herramienta en formato JSON. |
GenerateAppResourceResponse
Mensaje de respuesta para AgentService.GenerateAppResource.
| Campos | |
|---|---|
generate_result_info |
Información adicional sobre el resultado generado. |
Campo de unión generated_resource. Es el recurso generado. generated_resource puede ser solo uno de los parámetros siguientes: |
|
agent |
Agente generado por el asistente de LLM. |
toolset |
Es el conjunto de herramientas que genera el asistente de LLM. Admite la generación de esquemas del conjunto de herramientas de Open API. |
app_snapshot |
Instantánea de la app generada por el asistente de LLM. Esta instantánea contiene la app, los agentes y las herramientas que generó el asistente de LLM. |
tools |
Es la lista de herramientas que genera el asistente de LLM. |
evaluations |
Son las evaluaciones que genera el asistente de LLM. |
app_resources |
Los recursos de la app que genera el asistente de LLM |
quality_report |
El informe de calidad generado por el asistente de LLM. |
AppResources
Es la lista de recursos de la app que genera el asistente de LLM.
| Campos | |
|---|---|
app_snapshot |
La instantánea de la app que genera el asistente de LLM. Esta instantánea contiene la app, los agentes y las herramientas que generó el asistente de LLM. |
evaluations[] |
Es la lista de evaluaciones generadas por el asistente de LLM. |
Evaluaciones
Es la lista de evaluaciones generadas por el asistente de LLM.
| Campos | |
|---|---|
evaluations[] |
Es la lista de evaluaciones generadas. |
GenerateResultInfo
Esto proporciona información adicional sobre el resultado generado.
| Campos | |
|---|---|
explanation |
Es una explicación de los cambios en el recurso generado. |
Herramientas
Es la lista de herramientas que genera el asistente de LLM.
| Campos | |
|---|---|
tools[] |
Es la lista de herramientas que genera el asistente de LLM. |
GenerateChatTokenRequest
Mensaje de solicitud para WidgetService.GenerateChatToken.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la sesión para la que se generará el token de chat. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session} |
deployment |
Obligatorio. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} |
recaptcha_token |
Es opcional. Es el token de reCAPTCHA que genera el widget de chat del cliente. |
live_handoff_enabled |
Es opcional. Indica si la transferencia en vivo está habilitada para la sesión. |
GenerateChatTokenResponse
Mensaje de respuesta para WidgetService.GenerateChatToken.
| Campos | |
|---|---|
chat_token |
Es el token con alcance de sesión para que el widget de chat se autentique con las APIs de sesión. |
expire_time |
Es la hora en la que vence el token de chat. |
GenerateEvaluationOperationMetadata
Este tipo no tiene campos.
Metadatos de la operación para EvaluationService.GenerateEvaluation.
GenerateEvaluationRequest
Mensaje de solicitud para EvaluationService.GenerateEvaluation.
| Campos | |
|---|---|
conversation |
Obligatorio. Es la conversación para la que se creará la evaluación de referencia. Formato: |
source |
Es opcional. Indica la fuente de la conversación. Si no se establece, se buscará en todas las fuentes. |
evaluation_type |
Es opcional. Es el tipo de evaluación que se generará. El valor predeterminado es GOLDEN si no se especifica. |
EvaluationType
Es el tipo de evaluación que se generará.
| Enums | |
|---|---|
EVALUATION_TYPE_UNSPECIFIED |
Indica un tipo no especificado. La configuración predeterminada es GOLDEN. |
GOLDEN |
Evaluación de referencia. |
SCENARIO |
Evaluación de situaciones |
GenerateOnboardingSuggestionsRequest
Mensaje de solicitud para SessionService.GenerateOnboardingSuggestions.
| Campos | |
|---|---|
name |
Obligatorio. La app cuyo estado cero se está renderizando. Formato: |
max_suggestions |
Es opcional. Es la cantidad máxima de sugerencias que se devolverán. El valor predeterminado es 4 cuando no se establece. |
GenerateOnboardingSuggestionsResponse
Mensaje de respuesta para SessionService.GenerateOnboardingSuggestions.
| Campos | |
|---|---|
user_profile |
Es la clasificación del historial del usuario que realiza la solicitud. |
suggestions[] |
Sugerencias personalizadas, clasificadas primero por relevancia. |
context_token |
Es el token opaco que captura la instantánea de incorporación que se usó para generar estas sugerencias. Los clientes lo repiten en el primer |
UserProfile
Clasificación del historial del usuario que realiza la solicitud con el asistente en esta app.
| Enums | |
|---|---|
USER_PROFILE_UNSPECIFIED |
Perfil sin especificar. |
NEW |
No hay sesiones de asistente que contengan mensajes. |
EXPLORING |
Una o dos sesiones de asistente que contienen mensajes. |
RETURNING |
Más de dos sesiones de asistente que contienen mensajes. |
GetAgentRequest
Mensaje de solicitud para AgentService.GetAgent.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del agente que se recuperará. |
GetAppRequest
Mensaje de solicitud para AgentService.GetApp.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la app que se recuperará. |
GetAppVersionRequest
Mensaje de solicitud para AgentService.GetAppVersion.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la versión de la app que se recuperará. |
GetAssistantSessionRequest
Mensaje de solicitud para AssistantService.GetAssistantSession.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la sesión del asistente que se recuperará. Formato: |
GetChangelogRequest
Mensaje de solicitud para AgentService.GetChangelog.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del registro de cambios que se recuperará. |
GetConversationRequest
Mensaje de solicitud para AgentService.GetConversation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la conversación que se recuperará. |
source |
Es opcional. Indica la fuente de la conversación. Si no se establece, se buscará en todas las fuentes. |
GetDeploymentRequest
Mensaje de solicitud para AgentService.GetDeployment.
| Campos | |
|---|---|
name |
Obligatorio. El nombre de la implementación. Formato: |
GetEvaluationDatasetRequest
Mensaje de solicitud para EvaluationService.GetEvaluationDataset.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del conjunto de datos de evaluación que se recuperará. |
GetEvaluationExpectationRequest
Mensaje de solicitud para EvaluationService.GetEvaluationExpectation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la expectativa de evaluación que se recuperará. |
GetEvaluationRequest
Mensaje de solicitud para EvaluationService.GetEvaluation.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la evaluación que se recuperará. |
GetEvaluationResultRequest
Mensaje de solicitud para EvaluationService.GetEvaluationResult.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del resultado de la evaluación que se recuperará. |
GetEvaluationRunRequest
Mensaje de solicitud para EvaluationService.GetEvaluationRun.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la ejecución de la evaluación que se recuperará. |
GetExampleRequest
Mensaje de solicitud para AgentService.GetExample.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del ejemplo que se recuperará. |
GetGuardrailRequest
Mensaje de solicitud para AgentService.GetGuardrail.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la barandilla de seguridad que se recuperará. |
GetScheduledEvaluationRunRequest
Mensaje de solicitud para EvaluationService.GetScheduledEvaluationRun.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la ejecución de la evaluación programada que se recuperará. |
GetSecuritySettingsRequest
Mensaje de solicitud para AgentService.GetSecuritySettings.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la configuración de seguridad que se recuperará. Formato: |
GetToolRequest
Mensaje de solicitud para AgentService.GetTool.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la herramienta que se recuperará. |
GetToolsetRequest
Mensaje de solicitud para AgentService.GetToolset.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso del conjunto de herramientas que se recuperará. |
GoAway
Este tipo no tiene campos.
Indica que el servidor se desconectará pronto y que el cliente debe cerrar parcialmente y reiniciar la conexión.
GoogleSearchSuggestions
Sugerencias de búsqueda de Google Search Tool.
| Campos | |
|---|---|
htmls[] |
Estilo HTML y CSS compatible para las sugerencias de búsqueda. El HTML y CSS proporcionados se adaptan automáticamente a la configuración del dispositivo, lo que la muestra en modo oscuro o claro según lo indicado por |
web_search_queries[] |
Es la lista de consultas que se usaron para realizar la búsqueda de Google junto con los URI de los resultados de la búsqueda que forman las sugerencias de búsqueda. |
GoogleSearchTool
Representa una herramienta para realizar búsquedas web en Google con el objetivo de fundamentar la información. Consulta https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta. |
description |
Es opcional. Descripción del propósito de la herramienta. |
context_urls[] |
Es opcional. El contenido se recuperará directamente de estas URLs para el contexto y la fundamentación. Ejemplo: "https://example.com/path.html". Se permite un máximo de 20 URLs. |
preferred_domains[] |
Es opcional. Especifica los dominios a los que se deben restringir los resultados de la búsqueda. Ejemplo: "example.com", "another.site". Se puede especificar un máximo de 20 dominios. |
exclude_domains[] |
Es opcional. Es la lista de dominios que se excluirán de los resultados de la búsqueda. Ejemplo: "example.com". Se puede excluir un máximo de 2,000 dominios. |
prompt_config |
Es opcional. Son las instrucciones de la instrucción que se pasan al planificador sobre cómo se deben procesar los resultados de la búsqueda para texto y voz. |
PromptConfig
Son los parámetros de configuración de instrucciones que usa el modelo cuando procesa o resume los resultados de la Búsqueda de Google.
| Campos | |
|---|---|
text_prompt |
Es opcional. Define la instrucción que se usa para las instrucciones del sistema cuando se interactúa con el agente en conversaciones de chat. Si no se establece, se usará la instrucción predeterminada. |
voice_prompt |
Es opcional. Define la instrucción que se usa para las instrucciones del sistema cuando se interactúa con el agente en conversaciones de voz. Si no se establece, se usará la instrucción predeterminada. |
Barrera de protección
La barrera de seguridad contiene una lista de verificaciones y balances para mantener a los agentes seguros.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la barandilla de seguridad. Formato: |
display_name |
Obligatorio. Es el nombre visible de la barandilla. |
description |
Es opcional. Descripción de la barrera de seguridad. |
enabled |
Es opcional. Indica si la barandilla está habilitada. |
action |
Es opcional. Es la acción que se debe realizar cuando se activa la barrera de protección. |
create_time |
Solo salida. Es la marca de tiempo de la creación de la barandilla de seguridad. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la barandilla. |
etag |
Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
Campo de unión guardrail_type. Es el tipo de barrera de seguridad. guardrail_type puede ser solo uno de los parámetros siguientes: |
|
content_filter |
Es opcional. Es una barrera que prohíbe que se use cierto contenido en la conversación. |
llm_prompt_security |
Es opcional. Es una protección que bloquea la conversación si la instrucción se considera no segura según la clasificación del LLM. |
llm_policy |
Es opcional. Es la barrera que bloquea la conversación si se considera que la respuesta del LLM incumple la política según la clasificación del LLM. |
model_safety |
Es opcional. Es una protección que bloquea la conversación si la respuesta del LLM se considera no segura según la configuración de seguridad del modelo. |
code_callback |
Es opcional. Es una barrera de protección que puede bloquear la conversación según el resultado de la ejecución de la devolución de llamada. |
supervisor |
Es opcional. Es la protección que ejecuta la intervención del supervisor. |
CodeCallback
Es la barrera que bloquea la conversación según las devoluciones de llamada de código proporcionadas.
| Campos | |
|---|---|
before_agent_callback |
Es opcional. Es la devolución de llamada que se ejecutará antes de que se llame al agente. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - 'decision': 'OK' o 'TRIGGER'. - "reason": Una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior. |
after_agent_callback |
Es opcional. Es la devolución de llamada que se ejecutará después de que se llame al agente. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - 'decision': 'OK' o 'TRIGGER'. - "reason": Una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior. |
before_model_callback |
Es opcional. Es la devolución de llamada que se ejecutará antes de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - 'decision': 'OK' o 'TRIGGER'. - "reason": Una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior. |
after_model_callback |
Es opcional. Es la devolución de llamada que se ejecutará después de que se llame al modelo. Si hay varias llamadas al modelo, la devolución de llamada se ejecutará varias veces. Se espera que cada función de devolución de llamada devuelva una estructura (p.ej., un diccionario o un objeto) que contenga, al menos, lo siguiente: - 'decision': 'OK' o 'TRIGGER'. - "reason": Una cadena que explica la decisión. Una decisión de "ACTIVACIÓN" puede detener el procesamiento posterior. |
ContentFilter
Es una barrera que prohíbe que se use cierto contenido en la conversación.
| Campos | |
|---|---|
banned_contents[] |
Es opcional. Lista de frases prohibidas. Se aplica tanto a las entradas del usuario como a las respuestas del agente. |
banned_contents_in_user_input[] |
Es opcional. Lista de frases prohibidas. Solo se aplica a las entradas de los usuarios. |
banned_contents_in_agent_response[] |
Es opcional. Lista de frases prohibidas. Solo se aplica a las respuestas del agente. |
match_type |
Obligatorio. Es el tipo de concordancia del filtro de contenido. |
disregard_diacritics |
Es opcional. Si es verdadero, se ignoran los signos diacríticos durante la coincidencia. |
sensitive_words_exemptions[] |
Es opcional. Son las entradas de la lista de palabras sensibles que permite esta barandilla de seguridad. Solo es válido cuando match_type es SENSITIVE_WORDS. Cada valor debe ser igual a una entrada de la lista (no distingue mayúsculas de minúsculas, se ignoran los espacios en blanco circundantes); los demás valores no tienen efecto. Se aplica solo a esta barandilla de seguridad. Un máximo de 1,000 entradas de hasta 256 caracteres cada una. |
MatchType
Es el tipo de concordancia del filtro de contenido.
| Enums | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
No se especificó el tipo de concordancia. |
SIMPLE_STRING_MATCH |
El contenido se compara con las subcadenas carácter por carácter. |
WORD_BOUNDARY_STRING_MATCH |
El contenido solo coincide si el patrón que se encuentra en el texto está rodeado de delimitadores de palabras. Las frases prohibidas también pueden contener delimitadores de palabras. |
REGEXP_MATCH |
El contenido se compara con la sintaxis de expresiones regulares. |
SENSITIVE_WORDS |
El contenido se compara con una lista de palabras y frases sensibles administrada por el sistema. Si adjuntas una barandilla con este tipo de coincidencia a una app o un agente, se reemplazará el filtro predeterminado de palabras sensibles para los agentes afectados. Inhabilita la barandilla para inhabilitar el filtro predeterminado. |
LlmPolicy
Es la barrera que bloquea la conversación si se considera que la respuesta del LLM incumple la política según la clasificación del LLM.
| Campos | |
|---|---|
max_conversation_messages |
Es opcional. Cuando verifiques esta política, considera los últimos "n" mensajes de la conversación. Si no se establece, se usará un valor predeterminado de 10. |
model_settings |
Es opcional. Configuración del modelo |
prompt |
Obligatorio. Mensaje de política. Admite marcadores de posición de variables de sesión ( |
policy_scope |
Obligatorio. Define cuándo aplicar la verificación de la política durante la conversación. Si se establece en |
fail_open |
Es opcional. Si se produce un error durante la verificación de la política, se produce un error de apertura y no se activa la barandilla. |
allow_short_utterance |
Es opcional. De forma predeterminada, la verificación de la política de LLM se omite para las expresiones cortas. Si habilitas este parámetro de configuración, se aplicará la verificación de políticas a todas las expresiones, incluidas las que normalmente se omitirían. |
PolicyScope
Define cuándo aplicar la verificación de la política durante la conversación.
| Enums | |
|---|---|
POLICY_SCOPE_UNSPECIFIED |
No se especificó el permiso de la política. |
USER_QUERY |
La verificación de políticas se activa con la entrada del usuario. |
AGENT_RESPONSE |
La verificación de políticas se activa en la respuesta del agente. Aplicar este permiso de política generará latencia adicional antes de que el agente pueda responder. |
USER_QUERY_AND_AGENT_RESPONSE |
La verificación de políticas se activa tanto en la entrada del usuario como en la respuesta del agente. Aplicar este permiso de política generará latencia adicional antes de que el agente pueda responder. |
LlmPromptSecurity
Es una protección que bloquea la conversación si la entrada se considera insegura según la clasificación del LLM.
| Campos | |
|---|---|
fail_open |
Es opcional. Determina el comportamiento cuando la barrera de seguridad encuentra un error de LLM. - Si es verdadero, se omite la barrera de protección. - Si es falso (predeterminado), la barandilla se activa o bloquea. Nota: Si se proporciona una política personalizada, este campo se ignora en favor de la configuración "fail_open" de la política. |
Campo de unión security_config. Define el modo de configuración de seguridad. El usuario debe elegir una de las siguientes opciones de configuración. security_config puede ser solo uno de los parámetros siguientes: |
|
default_settings |
Es opcional. Usa la configuración de seguridad predeterminada del sistema. Para seleccionar este modo, incluye un mensaje "default_settings" vacío en la solicitud. El servidor completará el campo "default_prompt_template" en la respuesta. |
custom_policy |
Es opcional. Usa una LlmPolicy definida por el usuario para configurar la barrera de seguridad. |
DefaultSecuritySettings
Configuración de los parámetros de seguridad predeterminados del sistema.
| Campos | |
|---|---|
default_prompt_template |
Solo salida. Es la plantilla de instrucciones predeterminada que usa el sistema. Este campo tiene fines de visualización para mostrarle al usuario qué instrucción usa el sistema de forma predeterminada. Es OUTPUT_ONLY. |
ModelSafety
Anulaciones de la configuración de seguridad del modelo. Cuando se establece, se anula la configuración predeterminada y se activa la barandilla si la respuesta se considera no segura.
| Campos | |
|---|---|
safety_settings[] |
Obligatorio. Lista de parámetros de configuración de seguridad. |
HarmBlockThreshold
Niveles de umbral basados en la probabilidad para el bloqueo.
| Enums | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Umbral de bloqueo de daño no especificado. |
BLOCK_LOW_AND_ABOVE |
Bloquea el umbral bajo y superior (es decir, bloquea más). |
BLOCK_MEDIUM_AND_ABOVE |
Bloquea el umbral medio y superior. |
BLOCK_ONLY_HIGH |
Bloquea solo el umbral alto (es decir, bloquea menos). |
BLOCK_NONE |
No bloquear. |
OFF |
Desactiva el filtro de seguridad. |
HarmCategory
Categoría de daño.
| Enums | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
No se especifica la categoría de daño. |
HARM_CATEGORY_HATE_SPEECH |
La categoría de daño es la incitación al odio o a la violencia. |
HARM_CATEGORY_DANGEROUS_CONTENT |
La categoría de daño es el contenido peligroso. |
HARM_CATEGORY_HARASSMENT |
La categoría de daño es el hostigamiento. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
La categoría de daño es el contenido sexual explícito. |
HARM_CATEGORY_PROFANITY |
La categoría de daño es el lenguaje obsceno. |
HARM_CATEGORY_TOXIC |
La categoría de daño es tóxica. |
SafetySetting
Configuración de seguridad.
| Campos | |
|---|---|
category |
Obligatorio. La categoría de daño. |
threshold |
Obligatorio. El umbral de bloqueo de daño. |
Supervisor
Es la protección que ejecuta la intervención del supervisor.
| Campos | |
|---|---|
type |
Es opcional. Es el tipo de supervisor. |
detection_mode |
Es opcional. Es el modo de detección del supervisor. |
DetectionMode
Es el modo de detección del supervisor.
| Enums | |
|---|---|
DETECTION_MODE_UNSPECIFIED |
No se especificó el modo de detección. El valor predeterminado es NON_BLOCKING. |
NON_BLOCKING |
Modo de detección sin bloqueo. La respuesta no se bloquea cuando la detección del supervisor está en curso. |
BLOCKING |
Modo de detección de bloqueo. La respuesta se bloquea cuando la detección del supervisor está en curso. |
Tipo
Es el tipo de supervisor.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
El tipo no está especificado. |
INVALID_TEXT |
Tipo de problema de texto no válido. |
LANGUAGE_SHIFT |
Es el tipo de problema de cambio de idioma. |
SPEAKER_SHIFT |
Es el tipo de problema de cambio de interlocutor. |
AUDIO_MISMATCH |
Tipo de problema de discrepancia de audio. |
MISSING_TOOL_CALL |
Falta el tipo de problema de llamada a la herramienta. |
CUSTOM |
Tipo de problema personalizado. |
CHOPPY_AUDIO |
Tipo de problema de audio entrecortado. |
PROFANITY |
Es el tipo de problema de lenguaje obsceno del agente. |
Imagen
Representa una entrada o salida de imagen en la conversación.
| Campos | |
|---|---|
mime_type |
Obligatorio. Es el tipo de MIME estándar de IANA de los datos de origen. Los tipos de imágenes compatibles incluyen los siguientes: * image/png * image/jpeg * image/webp |
data |
Obligatorio. Son los bytes sin procesar de la imagen. |
alt_text |
Es opcional. Es el texto alternativo de la imagen. |
ImportAppRequest
Mensaje de solicitud para AgentService.ImportApp.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso superior con la ubicación de la app que se importará. |
display_name |
Es opcional. Es el nombre visible de la app que se importará. * Si la app se crea durante la importación y se especifica el nombre visible, la app importada usará este nombre visible. Si se detecta un conflicto con una app existente, se agregará una marca de tiempo al nombre visible para que sea único. * Si la app se vuelve a importar, no se debe establecer este campo. Si proporcionas un nombre visible durante la reimportación, se producirá un error INVALID_ARGUMENT. |
app_id |
Es opcional. Es el ID que se usará para la app importada. * Si no se especifica, se asignará automáticamente un ID único para la app. * De lo contrario, la app importada usará este ID como el componente final del nombre de su recurso. Si ya existe una app con el mismo ID en la ubicación especificada del proyecto, se reemplazará el contenido de la app existente. |
import_options |
Es opcional. Son las opciones que rigen el proceso de importación de la app. |
ignore_app_lock |
Es opcional. Parámetro para anular el bloqueo de apps durante la importación. Si se establece como verdadero, el proceso de importación ignorará el bloqueo de apps. |
Campo de unión app. Es la app que se importará. app puede ser solo uno de los parámetros siguientes: |
|
gcs_uri |
Es el URI de Google Cloud Storage desde el que se importará la app. El formato de este URI debe ser |
app_content |
Son los bytes sin procesar que representan el archivo ZIP comprimido con la estructura de carpetas de la app. |
Campo de unión json_patch. Los parches JSON que se aplicarán a la app importada. json_patch solo puede ser uno de los siguientes: |
|
json_patch_content |
Es opcional. Es el contenido del parche como una cadena JSON. |
json_patch_gcs_uri |
Es opcional. Un URI de Cloud Storage que apunta a un archivo JSON que contiene los parches. |
ImportOptions
Son las opciones de configuración para el proceso de importación de la app. Estas opciones controlan cómo se comporta la importación, en especial cuando surgen conflictos con los datos de la app existentes.
| Campos | |
|---|---|
conflict_resolution_strategy |
Es opcional. Es la estrategia que se usará para resolver conflictos durante la importación. |
validate_only |
Es opcional. Es la marca para ejecutar el proceso de importación de forma de prueba. Si se establece como verdadero, el proceso de importación solo realizará validaciones y no hará cambios en la app existente ni creará una nueva. |
ConflictResolutionStrategy
Define la estrategia para controlar los conflictos cuando ya existe una app con el mismo ID o cuando los recursos importados (como agentes, herramientas, etc.) tienen los mismos nombres visibles que los recursos existentes dentro de esa app.
| Enums | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
No se especificó la estrategia de resolución de conflictos. |
REPLACE |
Reemplaza los datos existentes por los datos importados. Si ya existe una app con el mismo app_id, su contenido se actualizará según la app importada. - Los recursos (app, agentes, herramientas, ejemplos, barreras de seguridad y conjuntos de herramientas) de la app importada que tengan el mismo nombre visible que los recursos existentes reemplazarán a los existentes. - Se crearán los recursos importados con nombres visibles nuevos. - Los recursos existentes que no tengan un nombre visible coincidente en la app importada no se modificarán. |
OVERWRITE |
Reemplaza los datos existentes por los datos importados. Si ya existe una app con el mismo app_id, su contenido se reemplazará por el de la app importada. Se borrarán los recursos existentes (agentes, herramientas, ejemplos, barreras de seguridad y conjuntos de herramientas) de la app. - Los recursos importados se crearán como recursos nuevos. |
ImportAppResponse
Mensaje de respuesta para AgentService.ImportApp.
| Campos | |
|---|---|
name |
Es el nombre del recurso de la app que se importó. |
warnings[] |
Son mensajes de advertencia que se generan durante el proceso de importación. Si se producen errores en recursos específicos, no se incluirán en la app importada y el error se mencionará aquí. |
ImportEvaluationsOperationMetadata
Representa los metadatos de la operación de larga duración para EvaluationService.ImportEvaluations.
| Campos | |
|---|---|
create_time |
Es solo de salida. Indica la hora a la que se creó la operación. |
end_time |
Es solo de salida. Indica la hora a la que finalizó la operación. |
status_message |
Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde. |
ImportEvaluationsRequest
Mensaje de solicitud para EvaluationService.ImportEvaluations.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app a la que se importarán las evaluaciones. Formato: |
import_options |
Es opcional. Son las opciones que rigen el proceso de importación de las evaluaciones. |
Campo de unión source. Es la fuente de las evaluaciones desde la que se importará. source puede ser solo uno de los parámetros siguientes: |
|
conversation_list |
Son las conversaciones desde las que se importarán las evaluaciones. |
gcs_uri |
Es el URI de Google Cloud Storage desde el que se importarán las evaluaciones. El formato de este URI debe ser |
csv_content |
Son los bytes sin procesar que representan el archivo CSV con la estructura de las evaluaciones. |
ConversationList
Es una lista de nombres de recursos de conversación.
| Campos | |
|---|---|
conversations[] |
Es opcional. Nombres de recursos de conversación. |
ImportOptions
Son las opciones de configuración para el proceso de importación de evaluaciones. Estas opciones controlan el comportamiento de la importación, en especial cuando surgen conflictos con los datos de evaluaciones existentes.
| Campos | |
|---|---|
conflict_resolution_strategy |
Es opcional. Es la estrategia que se usará para resolver conflictos durante la importación. |
ConflictResolutionStrategy
Define la estrategia para controlar los conflictos cuando ya existe una evaluación con el mismo ID de evaluación en la app.
| Enums | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
No se especificó la estrategia de resolución de conflictos. |
OVERWRITE |
Reemplazar la evaluación existente por la nueva |
SKIP |
Conservar la evaluación existente y omitir la nueva |
DUPLICATE |
Conservar la evaluación existente y duplicar la nueva como una evaluación nueva |
ImportEvaluationsResponse
Mensaje de respuesta para EvaluationService.ImportEvaluations.
| Campos | |
|---|---|
evaluations[] |
Es la lista de evaluaciones que se importaron a la app. |
evaluation_results[] |
Es la lista de resultados de la evaluación que se importaron a la app. |
evaluation_runs[] |
Es la lista de ejecuciones de evaluación que se importaron a la app. |
error_messages[] |
Es opcional. Es una lista de mensajes de error asociados con las evaluaciones que no se pudieron importar. |
import_failure_count |
Es la cantidad de evaluaciones que no se pudieron importar por completo o que se importaron con uno o más errores. |
evaluation_result_import_failure_count |
Es la cantidad de resultados de la evaluación que no se importaron por completo o que se importaron con uno o más errores. |
evaluation_run_import_failure_count |
Es la cantidad de ejecuciones de evaluación que no se pudieron importar por completo o que se importaron con uno o más errores. |
InputAudioConfig
InputAudioConfig configura cómo el agente de CES debe interpretar los datos de audio entrantes.
| Campos | |
|---|---|
audio_encoding |
Obligatorio. La codificación de los datos de audio de entrada. |
sample_rate_hertz |
Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de entrada. |
noise_suppression_level |
Es opcional. Indica si se debe habilitar la reducción de ruido en el audio de entrada. Los valores disponibles son "low", "moderate", "high" y "very_high". |
InstagramCredentials
Credenciales efímeras de Meta para la integración nativa de Instagram
| Campos | |
|---|---|
auth_code |
Obligatorio. Es el código de autenticación de Meta que proporciona el flujo de registro incorporado. |
conversation_profile_id |
Es opcional. Es el ID del perfil de conversación que se usará para la implementación. |
InterruptionSignal
Indica que se interrumpió la respuesta de audio del agente. El cliente debe detener de inmediato cualquier reproducción de audio actual (p.ej., debido a la interrupción del usuario o a la generación de una nueva respuesta del agente).
| Campos | |
|---|---|
barge_in |
Indica si la interrupción se debe a un evento de interrupción del usuario. |
LanguageSettings
La configuración de idioma de la app
| Campos | |
|---|---|
default_language_code |
Es opcional. Es el código de idioma predeterminado de la app. |
supported_language_codes[] |
Es opcional. Es la lista de códigos de idioma que admite la app, además de |
enable_multilingual_support |
Es opcional. Habilita la compatibilidad multilingüe. Si es |
fallback_action |
Es opcional. Obsoleto: Esta función ya no es compatible. En su lugar, usa Puede ser una acción predefinida o una llamada a la herramienta personalizada. Los valores válidos son los siguientes: - El nombre de recurso completo de una herramienta, que activa la ejecución de una herramienta específica. - Una acción predefinida del sistema, como "derivar" o "salir", que activa un indicador |
LatencyReport
Es el informe de latencia de la ejecución de la evaluación.
| Campos | |
|---|---|
tool_latencies[] |
Solo salida. Lista sin ordenar. Métricas de latencia para cada herramienta. |
callback_latencies[] |
Solo salida. Lista sin ordenar. Métricas de latencia para cada devolución de llamada |
guardrail_latencies[] |
Solo salida. Lista sin ordenar. Métricas de latencia para cada barandilla de seguridad. |
llm_call_latencies[] |
Solo salida. Lista sin ordenar. Métricas de latencia para cada llamada al LLM |
session_count |
Solo salida. Es la cantidad total de sesiones consideradas en el informe de latencia. |
CallbackLatency
Son las métricas de latencia para una sola devolución de llamada.
| Campos | |
|---|---|
stage |
Solo salida. Es la etapa de la devolución de llamada. |
latency_metrics |
Solo salida. Son las métricas de latencia de la devolución de llamada. |
GuardrailLatency
Métricas de latencia para una sola barandilla de seguridad.
| Campos | |
|---|---|
guardrail |
Solo salida. Es el nombre de la barandilla. Formato: |
guardrail_display_name |
Solo salida. Es el nombre visible de la barandilla de seguridad. |
latency_metrics |
Solo salida. Son las métricas de latencia de la barandilla de seguridad. |
LatencyMetrics
Métricas de latencia de un componente.
| Campos | |
|---|---|
p50_latency |
Solo salida. Es la latencia del percentil 50. |
p90_latency |
Solo salida. Es la latencia del percentil 90. |
p99_latency |
Solo salida. La latencia del percentil 99. |
call_count |
Solo salida. Es la cantidad de veces que se llamó al recurso. |
LlmCallLatency
Son las métricas de latencia para una sola llamada de LLM.
| Campos | |
|---|---|
model |
Solo salida. El nombre del modelo. |
latency_metrics |
Solo salida. Las métricas de latencia de la llamada al LLM. |
ToolLatency
Métricas de latencia para una sola herramienta.
| Campos | |
|---|---|
tool_display_name |
Solo salida. Es el nombre visible de la herramienta. |
latency_metrics |
Solo salida. Son las métricas de latencia de la herramienta. |
Campo de unión tool_identifier. Es el identificador de la herramienta. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Solo salida. Formato: |
toolset_tool |
Solo salida. Es el identificador de la herramienta del conjunto de herramientas. |
ListAgentsRequest
Mensaje de solicitud para AgentService.ListAgents.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los agentes. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los agentes. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListAgentsResponse
Mensaje de respuesta para AgentService.ListAgents.
| Campos | |
|---|---|
agents[] |
La lista de agentes. |
next_page_token |
Es un token que se puede enviar como |
ListAppVersionsRequest
Mensaje de solicitud para AgentService.ListAppVersions.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las versiones. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las versiones de la app. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListAppVersionsResponse
Mensaje de respuesta para AgentService.ListAppVersions.
| Campos | |
|---|---|
app_versions[] |
Es la lista de versiones de la app. |
next_page_token |
Es un token que se puede enviar como |
ListAppsRequest
Mensaje de solicitud para AgentService.ListApps.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la ubicación desde la que se enumeran las apps. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las apps. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListAppsResponse
Mensaje de respuesta para AgentService.ListApps.
| Campos | |
|---|---|
apps[] |
Es la lista de apps. |
next_page_token |
Es un token que se puede enviar como |
unreachable[] |
Lista sin ordenar. Ubicaciones a las que no se pudo llegar. |
ListAssistantSessionsRequest
Mensaje de solicitud para AssistantService.ListAssistantSessions.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app de la que se enumerarán las sesiones del asistente. Formato: |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las sesiones del asistente. Consulta https://google.aip.dev/160 para obtener más detalles. |
ListAssistantSessionsResponse
Mensaje de respuesta para AssistantService.ListAssistantSessions.
| Campos | |
|---|---|
assistant_sessions[] |
Es la lista de sesiones del asistente. |
next_page_token |
Es opcional. Es un token que se puede enviar como |
ListChangelogsRequest
Mensaje de solicitud para AgentService.ListChangelogs.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los registros de cambios. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los registros de cambios. Consulta https://google.aip.dev/160 para obtener más detalles. La cadena de filtro se puede usar para filtrar por Ejemplos: * |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListChangelogsResponse
Mensaje de respuesta para AgentService.ListChangelogs.
| Campos | |
|---|---|
changelogs[] |
Es la lista de registros de cambios. |
next_page_token |
Es un token que se puede enviar como |
ListConversationsRequest
Mensaje de solicitud para AgentService.ListConversations.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las conversaciones. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las conversaciones. Consulta https://google.aip.dev/160 para obtener más detalles. |
source |
Es opcional. Indica la fuente de la conversación. Si no se establece, se aplicará Source.Live de forma predeterminada. Se dará de baja y se reemplazará por el campo |
sources[] |
Es opcional. Indica las fuentes de las conversaciones. Si no se establece, se aplicarán todas las fuentes disponibles de forma predeterminada. |
ListConversationsResponse
Mensaje de respuesta para AgentService.ListConversations.
| Campos | |
|---|---|
conversations[] |
La lista de conversaciones. |
next_page_token |
Es un token que se puede enviar como |
ListDeploymentsRequest
Mensaje de solicitud para AgentService.ListDeployments.
| Campos | |
|---|---|
parent |
Obligatorio. Es la app superior. Formato: |
page_size |
Es opcional. Es la cantidad máxima de implementaciones que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50 implementaciones. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000. |
page_token |
Es opcional. Un token de página, recibido desde una llamada Cuando se pagina, todos los demás parámetros proporcionados a |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListDeploymentsResponse
Mensaje de respuesta para AgentService.ListDeployments.
| Campos | |
|---|---|
deployments[] |
Es la lista de implementaciones. |
next_page_token |
Un token, que se puede enviar como |
ListEvaluationDatasetsRequest
Mensaje de solicitud para EvaluationService.ListEvaluationDatasets.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los conjuntos de datos de evaluación. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los conjuntos de datos de evaluación. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name", "create_time" y "update_time". Los campos de hora se ordenan de forma descendente, y el campo de nombre se ordena de forma ascendente. Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListEvaluationDatasetsResponse
Mensaje de respuesta para EvaluationService.ListEvaluationDatasets.
| Campos | |
|---|---|
evaluation_datasets[] |
Es la lista de conjuntos de datos de evaluación. |
next_page_token |
Es un token que se puede enviar como |
ListEvaluationExpectationsRequest
Mensaje de solicitud para EvaluationService.ListEvaluationExpectations.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las expectativas de evaluación. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las expectativas de evaluación. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name", "create_time" y "update_time". Los campos de hora se ordenan de forma descendente, y el campo de nombre se ordena de forma ascendente. Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListEvaluationExpectationsResponse
Mensaje de respuesta para EvaluationService.ListEvaluationExpectations.
| Campos | |
|---|---|
evaluation_expectations[] |
Es la lista de expectativas de evaluación. |
next_page_token |
Es un token que se puede enviar como |
ListEvaluationResultsRequest
Mensaje de solicitud para EvaluationService.ListEvaluationResults.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la evaluación de la que se enumerarán los resultados. Para filtrar por ejecución de evaluación, usa |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los resultados de la evaluación. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name", "create_time" y "update_time". Los campos de hora se ordenan de forma descendente, y el campo de nombre se ordena de forma ascendente. Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListEvaluationResultsResponse
Mensaje de respuesta para EvaluationService.ListEvaluationResults.
| Campos | |
|---|---|
evaluation_results[] |
Es la lista de resultados de la evaluación. |
next_page_token |
Es un token que se puede enviar como |
ListEvaluationRunsRequest
Mensaje de solicitud para EvaluationService.ListEvaluationRuns.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las ejecuciones de evaluación. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las ejecuciones de evaluación. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name", "create_time" y "update_time". Los campos de hora se ordenan de forma descendente, y el campo de nombre se ordena de forma ascendente. Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListEvaluationRunsResponse
Mensaje de respuesta para EvaluationService.ListEvaluationRuns.
| Campos | |
|---|---|
evaluation_runs[] |
Es la lista de ejecuciones de evaluación. |
next_page_token |
Es un token que se puede enviar como |
ListEvaluationsRequest
Mensaje de solicitud para EvaluationService.ListEvaluations.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las evaluaciones. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Obsoleto: Usa evaluation_filter y evaluation_run_filter en su lugar. |
evaluation_filter |
Es opcional. Es el filtro que se aplicará a la evaluación cuando se enumeren las evaluaciones. Consulta https://google.aip.dev/160 para obtener más detalles. Campos admitidos: evaluation_datasets |
evaluation_run_filter |
Es opcional. Es la cadena de filtro para los campos de los recursos EvaluationRun asociados. Consulta https://google.aip.dev/160 para obtener más detalles. Campos admitidos: create_time, initiated_by, app_version_display_name |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name", "create_time" y "update_time". Los campos de hora se ordenan de forma descendente, y el campo de nombre se ordena de forma ascendente. Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
last_ten_results |
Es opcional. Indica si se deben incluir los últimos 10 resultados de cada evaluación en la respuesta. |
ListEvaluationsResponse
Mensaje de respuesta para EvaluationService.ListEvaluations.
| Campos | |
|---|---|
evaluations[] |
Es la lista de evaluaciones. |
next_page_token |
Es un token que se puede enviar como |
ListExamplesRequest
Mensaje de solicitud para AgentService.ListExamples.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los ejemplos. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los ejemplos. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListExamplesResponse
Mensaje de respuesta para AgentService.ListExamples.
| Campos | |
|---|---|
examples[] |
Es la lista de ejemplos. |
next_page_token |
Es un token que se puede enviar como |
ListGuardrailsRequest
Mensaje de solicitud para AgentService.ListGuardrails.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las protecciones. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las barreras de seguridad. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListGuardrailsResponse
Mensaje de respuesta para AgentService.ListGuardrails.
| Campos | |
|---|---|
guardrails[] |
Es la lista de barreras de seguridad. |
next_page_token |
Es un token que se puede enviar como |
ListScheduledEvaluationRunsRequest
Mensaje de solicitud para EvaluationService.ListScheduledEvaluationRuns.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las ejecuciones de evaluación programadas. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las ejecuciones de evaluación programadas. Consulta https://google.aip.dev/160 para obtener más detalles. Actualmente, admite el filtrado por: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id |
order_by |
Es opcional. Es el campo por el que se ordenará. Los campos admitidos son: "name" (ascendente), "create_time" (descendente), "update_time" (descendente), "next_scheduled_execution" (ascendente) y "last_completed_run.create_time" (descendente). Si no se incluye, "update_time" será el valor predeterminado. Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListScheduledEvaluationRunsResponse
Mensaje de respuesta para EvaluationService.ListScheduledEvaluationRuns.
| Campos | |
|---|---|
scheduled_evaluation_runs[] |
Es la lista de ejecuciones de evaluación programadas. |
next_page_token |
Es un token que se puede enviar como |
ListToolsRequest
Mensaje de solicitud para AgentService.ListTools.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán las herramientas. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren las herramientas. Usa "include_system_tools=true" para incluir herramientas del sistema en la respuesta. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListToolsResponse
Mensaje de respuesta para AgentService.ListTools.
| Campos | |
|---|---|
tools[] |
Es la lista de herramientas. |
next_page_token |
Es un token que se puede enviar como |
ListToolsetsRequest
Mensaje de solicitud para AgentService.ListToolsets.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app de la que se enumerarán los conjuntos de herramientas. |
page_size |
Es opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. |
page_token |
Es opcional. Es el valor de |
filter |
Es opcional. Es el filtro que se aplicará cuando se enumeren los conjuntos de herramientas. Consulta https://google.aip.dev/160 para obtener más detalles. |
order_by |
Es opcional. Es el campo por el que se ordenará. Solo se admiten "name" y "create_time". Consulta https://google.aip.dev/132#ordering para obtener más detalles. |
ListToolsetsResponse
Mensaje de respuesta para AgentService.ListToolsets.
| Campos | |
|---|---|
toolsets[] |
Es la lista de conjuntos de herramientas. |
next_page_token |
Es un token que se puede enviar como |
LoggingSettings
Es la configuración que describe los comportamientos de registro de la app.
| Campos | |
|---|---|
redaction_config |
Es opcional. Es la configuración de cómo se deben ocultar los datos sensibles. |
audio_recording_config |
Es opcional. Configuración de cómo se deben grabar las interacciones de audio. El audio está sujeto a ocultamiento según lo configurado en |
unredacted_audio_recording_config |
Es opcional. Configura una grabación adicional de audio sin ocultar. Esto se puede usar para mantener una copia de audio sin procesar cuando se |
bigquery_export_settings |
Es opcional. Configura los comportamientos de BigQuery Export para la app. Los datos de la conversación están sujetos a ocultamiento, según se configura en |
unredacted_bigquery_export_settings |
Es opcional. Configura los comportamientos de exportación de BigQuery para la app. Los datos de conversación sin ocultar se exportarán a las tablas de BigQuery si están habilitados. |
cloud_logging_settings |
Es opcional. Es la configuración para describir los comportamientos de Cloud Logging de la app. |
conversation_logging_settings |
Es opcional. Es la configuración para describir los comportamientos de registro de conversaciones de la app. |
evaluation_audio_recording_config |
Es opcional. Es la configuración de cómo se deben grabar las interacciones de audio para la evaluación. De forma predeterminada, la grabación de audio no está habilitada para las sesiones de evaluación. |
metric_analysis_settings |
Es opcional. Son los parámetros de configuración que describen los comportamientos de recopilación de datos de conversaciones para la canalización de análisis de LLM de la app. |
required_recording_consent |
Es opcional. Si la app debe indicar qué se puede grabar antes de que se guarde cualquier elemento. Cuando es verdadero, una sesión comienza con la grabación desactivada y permanece desactivada hasta que el cliente envía Cuando se establece en |
McpTool
Es una herramienta de MCP. Consulta https://modelcontextprotocol.io/specification/2025-06-18/server/tools para obtener más detalles.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta de MCP. |
name_override |
Es opcional. Es la anulación del nombre de la herramienta de MCP. Este campo se completa si el nombre se anuló con una anulación de Toolset. |
description |
Es opcional. La descripción de la herramienta de MCP. |
input_schema |
Es opcional. Es el esquema de los argumentos de entrada de la herramienta de MCP. |
output_schema |
Es opcional. Es el esquema de los argumentos de salida de la herramienta de MCP. |
server_address |
Obligatorio. La dirección del servidor de MCP, p.ej., "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte de HTTP transmitible. Es igual a server_address en McpToolset. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles. |
api_authentication |
Es opcional. Es la información de autenticación necesaria para ejecutar la herramienta en el servidor de MCP. En el caso de la autenticación con token del portador, el token solo se aplica a la ejecución de herramientas, no a la lista de herramientas. Esto requiere que las herramientas se puedan enumerar sin autenticación. |
tls_config |
Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que el cliente debe confiar. |
service_directory_config |
Es opcional. Configuración del Directorio de servicios para VPC-SC, que se usa para resolver nombres de servicios dentro de un perímetro. |
custom_headers |
Es opcional. Son los encabezados personalizados que se enviarán en la solicitud al servidor de MCP. Los valores deben tener el formato |
state |
Solo salida. Es el estado de disponibilidad dinámica de la herramienta en el servidor externo. |
Estado
Representa el estado de disponibilidad dinámica de la herramienta.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Es el estado predeterminado. |
ACTIVE |
La herramienta está disponible y el servidor la ofrece de forma activa. |
INACTIVE |
La herramienta está configurada o fijada, pero el servidor no la ofrece actualmente. |
STALE |
La herramienta existe en el servidor, pero no coincide con la versión del servidor. |
McpToolDefinition
Es el contenedor de los elementos de definición principales de una herramienta que se capturan. Los esquemas de la instantánea se usan tal como están y no se pueden anular.
| Campos | |
|---|---|
description |
Solo salida. La descripción de la herramienta de MCP. Esto se puede anular con |
input_schema |
Solo salida. Es el esquema de los argumentos de entrada de la herramienta de MCP. |
output_schema |
Solo salida. Es el esquema de los argumentos de salida de la herramienta de MCP. |
McpToolOverride
Anulaciones asociadas con una herramienta determinada en un conjunto de herramientas. Esto permite "fijar" o "anular" las definiciones de herramientas del servidor dinámico externo.
| Campos | |
|---|---|
tool |
Obligatorio. Es el nombre original de la herramienta tal como lo emite el servidor de MCP. |
name_override |
Es opcional. Si está presente, la herramienta usa este nombre en el agente en lugar del nombre original. Esto se usa principalmente como un alias si el servidor de MCP ofrece herramientas con nombres poco claros. |
description_override |
Es opcional. Si está presente, la herramienta usa esta descripción en lugar de la original del servidor. |
snapshot |
Solo salida. Si está presente, esta herramienta se "fija" y usa los valores de la instantánea como resguardos si el servidor deja de estar disponible temporalmente o si no hay ninguna anulación presente. |
McpToolset
Es un conjunto de herramientas que contiene una lista de herramientas que ofrece el servidor de MCP.
| Campos | |
|---|---|
server_address |
Obligatorio. La dirección del servidor de MCP, por ejemplo, "https://example.com/mcp/". Si el servidor se compila con el SDK de MCP, la URL debe tener el sufijo "/mcp/". Solo se admiten servidores basados en el transporte de HTTP transmitible. Consulta https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para obtener más detalles. |
api_authentication |
Es opcional. Es la información de autenticación necesaria para acceder a las herramientas y ejecutarlas en el servidor de MCP. En el caso de la autenticación con token del portador, el token solo se aplica a la ejecución de herramientas, no a la lista de herramientas. Esto requiere que las herramientas se puedan enumerar sin autenticación. |
service_directory_config |
Es opcional. Configuración del Directorio de servicios para VPC-SC, que se usa para resolver nombres de servicios dentro de un perímetro. |
tls_config |
Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que el cliente debe confiar. |
custom_headers |
Es opcional. Son los encabezados personalizados que se enviarán en la solicitud al servidor de MCP. Los valores deben tener el formato |
tool_overrides[] |
Es opcional. Anulaciones para herramientas individuales dentro de este conjunto de herramientas. Esto permite anular detalles específicos, como descripciones o nombres, o fijar los estados de las herramientas para que no sean completamente dinámicos. |
Mensaje
Es un mensaje dentro de una conversación.
| Campos | |
|---|---|
role |
Es opcional. Es el rol dentro de la conversación, p.ej., usuario, agente. |
chunks[] |
Es opcional. Es el contenido del mensaje como una serie de fragmentos. |
event_time |
Es opcional. Es la marca de tiempo del momento en que se envió o recibió el mensaje. No se debe usar si el mensaje forma parte de un |
MetricAnalysisSettings
Es la configuración para describir los comportamientos de recopilación de datos de conversaciones para la canalización de métricas de análisis de LLM.
| Campos | |
|---|---|
llm_metrics_opted_out |
Es opcional. Indica si se deben recopilar datos de conversación para las métricas de análisis de LLM. Si se establece como verdadero, no se recopilarán datos de conversación para las métricas de análisis de LLM; de lo contrario, se recopilarán datos de conversación. |
MockConfig
Configuración de llamadas a herramientas simuladas para la sesión.
| Campos | |
|---|---|
mocked_tool_calls[] |
Es opcional. Todas las llamadas a la herramienta que se simularán durante la sesión. |
unmatched_tool_call_behavior |
Obligatorio. Comportamiento de las llamadas a la herramienta que no coinciden con ningún patrón de argumentos en mocked_tool_calls. |
UnmatchedToolCallBehavior
Qué hacer cuando una llamada a la herramienta no coincide con ninguna llamada a la herramienta simulada.
| Enums | |
|---|---|
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
Valor predeterminado. Este valor no se usa. |
FAIL |
Arroja un error para cualquier llamada a la herramienta que no coincida con un patrón de entrada esperado simulado. |
PASS_THROUGH |
Para las llamadas a herramientas que no coincidan, pasa la llamada a la herramienta real. |
MockedToolCall
Una llamada a la herramienta simulada.
Expresa la herramienta de destino y un patrón con el que se deben comparar los argumentos o las entradas de esa herramienta. Si el patrón coincide, se devolverá la respuesta simulada.
| Campos | |
|---|---|
tool |
Es opcional. Obsoleto. Usa tool_identifier en su lugar. |
expected_args_pattern |
Obligatorio. Es un patrón que se compara con los argumentos o las entradas de todas las llamadas a la herramienta enviadas. Si las entradas de la llamada a la herramienta coinciden con este patrón, se devolverá el resultado simulado. |
mock_response |
Es opcional. La respuesta o el resultado simulados que se devolverán si los argumentos o las entradas de la llamada a la herramienta coinciden con el patrón. |
Campo de unión tool_identifier. Es el identificador de la herramienta que se simulará. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool_id |
Es opcional. Es el nombre de la herramienta que se simulará. Formato: |
toolset |
Es opcional. Es el conjunto de herramientas para simular. |
ModelSettings
La configuración del modelo contiene varios parámetros de configuración para el modelo de LLM.
| Campos | |
|---|---|
model |
Es opcional. Es el modelo de LLM que debe usar el agente. Si no se establece, el agente heredará el modelo de su agente superior. |
thinking_level |
Es opcional. Es el nivel de razonamiento del modelo. |
temperature |
Es opcional. Si se establece, se usará esta temperatura para el modelo de LLM. La temperatura controla la aleatoriedad de las respuestas del modelo. Las temperaturas más bajas producen respuestas más predecibles. Las temperaturas más altas producen respuestas más creativas. |
ThinkingLevel
Es la configuración del nivel de razonamiento del modelo.
| Enums | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
No se especificó el nivel de pensamiento. |
DEFAULT |
Nivel de razonamiento predeterminado. |
LOW |
Nivel de razonamiento bajo. |
MEDIUM |
Nivel de razonamiento medio. |
HIGH |
Nivel de razonamiento alto. |
OAuthConfig
Parámetros de configuración para la autenticación con OAuth.
| Campos | |
|---|---|
oauth_grant_type |
Obligatorio. Tipos de permisos de OAuth |
client_id |
Obligatorio. Es el ID de cliente del proveedor de OAuth. |
client_secret_version |
Obligatorio. Es el nombre del recurso de la versión del Secret de Secret Manager que almacena el secreto del cliente. Formato: Nota: Debes otorgar el rol |
token_endpoint |
Obligatorio. Es el extremo del token en el proveedor de OAuth que se intercambiará por un token de acceso. |
scopes[] |
Es opcional. Son los permisos de OAuth que se otorgarán. |
OauthGrantType
Tipos de permisos de OAuth Solo se admite el otorgamiento de credenciales de cliente.
| Enums | |
|---|---|
OAUTH_GRANT_TYPE_UNSPECIFIED |
Sin especificar. La configuración predeterminada es CLIENT_CREDENTIAL. |
CLIENT_CREDENTIAL |
Representa el flujo de credenciales de cliente. |
OpenApiTool
Es una herramienta de API remota definida por un esquema de OpenAPI.
| Campos | |
|---|---|
open_api_schema |
Obligatorio. Es el esquema de OpenAPI en formato JSON o YAML. |
name |
Es opcional. Es el nombre de la herramienta. Si no se proporciona, el nombre de la herramienta se derivará del esquema de OpenAPI, de |
description |
Es opcional. Es la descripción de la herramienta. Si no se proporciona, la descripción de la herramienta se derivará del esquema de OpenAPI, de |
api_authentication |
Es opcional. Es la información de autenticación que requiere la API. |
tls_config |
Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados en los que confiará el cliente. |
service_directory_config |
Es opcional. Configuración del Directorio de servicios. |
ignore_unknown_fields |
Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API. |
url |
Es opcional. Es la URL del servidor del esquema de OpenAPI. Este campo solo se establece en las herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL del servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema. |
OpenApiToolset
Un conjunto de herramientas que contiene una lista de herramientas definidas por un esquema de OpenAPI.
| Campos | |
|---|---|
open_api_schema |
Obligatorio. Es el esquema de OpenAPI del conjunto de herramientas. |
api_authentication |
Es opcional. Es la información de autenticación que requiere la API. |
tls_config |
Es opcional. Es la configuración de TLS. Incluye los certificados de servidor personalizados. |
service_directory_config |
Es opcional. Configuración del Directorio de servicios. |
ignore_unknown_fields |
Es opcional. Si es verdadero, el agente ignorará los campos desconocidos en la respuesta de la API para todas las operaciones definidas en el esquema de OpenAPI. |
url |
Es opcional. Es la URL del servidor del esquema de OpenAPI. Este campo solo se establece en los conjuntos de herramientas de las dependencias del entorno durante el proceso de exportación si el esquema contiene una URL de servidor. Durante el proceso de importación, si esta URL está presente en las dependencias del entorno y el esquema tiene el marcador de posición $env_var, se reemplazará el marcador de posición en el esquema. |
OperationCompletedEvent
Es el evento que envía el cliente o el trabajador en segundo plano para reanudar una sesión de asistente después de que se completa una operación de larga duración (LRO) asíncrona.
| Campos | |
|---|---|
operation_name |
Es el nombre del recurso de la operación (p.ej., |
target_resource_name |
Es el recurso principal al que se orienta o que produce la operación (p.ej., ID de ejecución de la evaluación, ID de la app o ID del conjunto de datos). |
operation_type |
Es el tipo de operación o el nombre de la herramienta (p.ej., "run_evaluation", "copy_app", "export_app"). |
status |
Es el estado de la ejecución de la operación (p.ej., "SUCCEEDED", "FAILED", "CANCELLED"). |
deduplication_token |
Es un token de anulación de duplicación opcional (p.ej., UUID) para evitar la ejecución de turnos duplicados desde pestañas del navegador simultáneas. |
error |
Estado de error canónico opcional si la operación falló. |
metadata |
Metadatos de resultados estructurados opcionales (p.ej., pass_rate, total_examples, export_uri). |
OperationMetadata
Representa los metadatos de la operación de larga duración.
| Campos | |
|---|---|
create_time |
Es solo de salida. Indica la hora a la que se creó la operación. |
end_time |
Es solo de salida. Indica la hora a la que finalizó la operación. |
status_message |
Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde. |
requested_cancellation |
Es solo de salida. Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron con éxito tienen el valor |
OptimizationConfig
Es la configuración para ejecutar el paso de optimización después de la ejecución de la evaluación.
| Campos | |
|---|---|
generate_loss_report |
Es opcional. Indica si se debe generar un informe de pérdidas. |
assistant_session |
Solo salida. Es la sesión del asistente que se usará para la optimización en función de esta ejecución de evaluación. Formato: |
report_summary |
Solo salida. Es el resumen del informe de pérdida. |
should_suggest_fix |
Solo salida. Indica si se debe sugerir una corrección para las pérdidas. |
status |
Solo salida. Es el estado de la ejecución de la optimización. |
error_message |
Solo salida. Es el mensaje de error si falla la ejecución de la optimización. |
loss_report |
Solo salida. Es el informe de pérdidas generado. |
OptimizationStatus
Es el estado de la ejecución de la optimización.
| Enums | |
|---|---|
OPTIMIZATION_STATUS_UNSPECIFIED |
No se especificó el estado de optimización. |
RUNNING |
La optimización se está ejecutando. |
COMPLETED |
Se completó la optimización. |
ERROR |
No se pudo realizar la optimización debido a un error interno. |
OptionQuestionsChunk
Son opciones de aclaración estructuradas que el asistente le pide al usuario que elija, traducidas del lado del servidor fuera del turno del modelo (el bloque de opciones se quita del texto transmitido y persistente). La consola renderiza una lista de opciones navegable con el teclado que se fija sobre el cuadro de redacción.
| Campos | |
|---|---|
questions[] |
Las preguntas que se hicieron en este turno. Si hay más de una entrada, se activa el paginador "1 de N" de la consola. |
Opción
Una sola opción seleccionable.
| Campos | |
|---|---|
title |
Título corto de la opción en texto sin formato (sin lenguaje de marcado ni numeración). |
details |
Detalles opcionales de compensación que se muestran como texto secundario. |
submit_text |
Texto del mensaje opcional que se enviará cuando se elija la opción; el valor predeterminado es |
Pregunta
Una pregunta con sus opciones.
| Campos | |
|---|---|
question |
Es el texto del encabezado de la pregunta. |
options[] |
Son las opciones que se pueden seleccionar, en orden de presentación. |
OutputAudioConfig
OutputAudioConfig configura cómo el agente de CES debe sintetizar las respuestas de audio salientes.
| Campos | |
|---|---|
audio_encoding |
Obligatorio. Es la codificación de los datos de audio de salida. |
sample_rate_hertz |
Obligatorio. Es la tasa de muestreo (en hercios) de los datos de audio de salida. |
PersonaRunConfig
Es la configuración para ejecutar una evaluación de un rol específico.
| Campos | |
|---|---|
persona |
Es opcional. Es el perfil que se usará para la evaluación. Formato: |
task_count |
Es opcional. La cantidad de tareas que se ejecutarán para el perfil. |
PythonCodeCondition
Bloque de código de Python para evaluar la condición.
| Campos | |
|---|---|
python_code |
Obligatorio. Es el código de Python que se ejecutará. |
PythonFunction
Una herramienta de función de Python.
| Campos | |
|---|---|
name |
Es opcional. Es el nombre de la función de Python que se ejecutará. Debe coincidir con el nombre de una función de Python definida en el código de Python. Distingue mayúsculas de minúsculas. Si no se proporciona el nombre, se usará la primera función definida en el código de Python. |
python_code |
Es opcional. Es el código de Python que se ejecutará para la herramienta. |
description |
Solo salida. Es la descripción de la función de Python, analizada a partir de la cadena de documentación del código de Python. |
service_directory_config |
Es opcional. Es la configuración del Directorio de servicios para la herramienta. |
QualityReport
Es el informe que describe los problemas de calidad identificados en la app.
| Campos | |
|---|---|
issues[] |
Es opcional. Los problemas agrupados por agente. |
evaluation_runs[] |
Es opcional. Es una lista de ejecuciones de evaluación que se usan para generar el informe de calidad. Formato: |
general_issues[] |
Es opcional. Son problemas generales que no son específicos de ningún agente. |
AgentIssues
Son los problemas identificados para un solo agente.
| Campos | |
|---|---|
agent |
Es opcional. Es el nombre del agente con el que se relacionan los problemas. Formato: |
issues[] |
Es opcional. Es la lista de problemas encontrados para este agente. |
Problema
El problema identificado
| Campos | |
|---|---|
description |
Es opcional. Descripción del problema encontrado. |
occurrence_count |
Es opcional. La cantidad de veces que ocurrió este problema |
proposed_solution |
Es opcional. Es la solución propuesta para corregir el problema modificando las instrucciones o las herramientas. |
RecognitionResult
Es el resultado del reconocimiento de voz para la entrada de audio.
| Campos | |
|---|---|
transcript |
Es opcional. Son los segmentos de voz del usuario concatenados que se capturaron durante el turno actual. |
RedactionConfig
Es la configuración para indicar cómo se deben controlar los datos sensibles.
| Campos | |
|---|---|
enable_redaction |
Es opcional. Si es |
inspect_template |
Es opcional. Nombre de la plantilla de inspección de DLP para configurar la detección de tipos de datos sensibles. Formato: |
deidentify_template |
Es opcional. Nombre de la plantilla de desidentificación de DLP para indicar cómo desidentificar el contenido. Formato: |
RemoteA2aConfig
Es la configuración compartida para conectarse a un agente A2A remoto.
| Campos | |
|---|---|
api_authentication |
Es opcional. Es la configuración de autenticación para llamar al agente remoto. Es opcional si la referencia del registro ya controla la autenticación. |
input_variable_mapping |
Es opcional. Asignación de nombres de variables de entrada del agente remoto a nombres de variables de GECX. |
output_variable_mapping |
Es opcional. Asignación de nombres de variables de salida del agente remoto a nombres de variables de GECX. |
streaming_enabled |
Es opcional. Indica si la transmisión está habilitada para el agente remoto. |
context_id |
Es opcional. Si no está vacío, las interacciones con el agente A2A remoto usarán este ID de contexto. Este campo context_id puede hacer referencia a una variable de sesión como |
Campo de unión agent_spec. Especificación del agente remoto. agent_spec puede ser solo uno de los parámetros siguientes: |
|
agent_card |
Es opcional. La tarjeta de agente completa definida de forma intercalada. |
agent_registry |
Es opcional. Referencia al agente en Agent Registry. Formato: |
RemoteAgentTool
Representa una herramienta que permite que el agente llame a otro agente remoto.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta. |
description |
Obligatorio. Es la descripción de la herramienta. |
agent_card |
Obligatorio. La tarjeta del agente remoto que invoca esta herramienta. |
api_authentication |
Es opcional. Es la configuración de autenticación para llamar al agente remoto. |
stateful_agent |
Es opcional. Cuando se habilita, la interacción entre la app de CXAS y el agente remoto compartirá el mismo contexto. Si el agente remoto devuelve un context_id, este se conservará durante toda la sesión de esta herramienta de agente remoto. |
input_variable_mapping |
Es opcional. Asignación de nombres de variables de entrada del agente remoto a nombres de variables de GECX. |
output_variable_mapping |
Es opcional. Asignación de nombres de variables de salida del agente remoto a nombres de variables de GECX. |
RestoreAppVersionRequest
Mensaje de solicitud para AgentService.RestoreAppVersion
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la versión de la app que se restablecerá. |
RestoreAppVersionResponse
Este tipo no tiene campos.
Mensaje de respuesta para AgentService.RestoreAppVersion
RetrieveToolSchemaRequest
Mensaje de solicitud para ToolService.RetrieveToolSchema.
| Campos | |
|---|---|
parent |
Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: |
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se recuperará el esquema. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es opcional. Es el nombre de la herramienta para la que se recuperará el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
Es opcional. Es la herramienta del conjunto de herramientas para la que se recuperará el esquema. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error. |
RetrieveToolSchemaResponse
Mensaje de respuesta para ToolService.RetrieveToolSchema.
| Campos | |
|---|---|
input_schema |
Es el esquema de los parámetros de entrada de la herramienta. |
output_schema |
Es el esquema de los parámetros de salida de la herramienta. |
Campo de unión tool_identifier. Es el identificador de la herramienta para la que se aplica el esquema. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es el nombre de la herramienta para la que se creó el esquema. Formato: |
toolset_tool |
Es la herramienta del conjunto de herramientas para la que se creó el esquema. |
RetrieveToolsRequest
Mensaje de solicitud para ToolService.RetrieveTools.
| Campos | |
|---|---|
toolset |
Obligatorio. Es el nombre del conjunto de herramientas del que se recuperarán las herramientas. Formato: |
tool_ids[] |
Es opcional. Son los identificadores de las herramientas que se recuperarán del conjunto de herramientas. Si está vacío, se devolverán todas las herramientas del conjunto. |
bypass_persistence_config |
Es opcional. Si es verdadero, las herramientas devueltas contendrán descripciones y esquemas sin procesar directamente del servidor, lo que omitirá cualquier configuración de persistencia almacenada (anulaciones o instantáneas). |
RetrieveToolsResponse
Mensaje de respuesta para ToolService.RetrieveTools.
| Campos | |
|---|---|
tools[] |
Es la lista de herramientas que se incluyen en el conjunto de herramientas especificado. |
RunAssistantRequest
Mensaje de solicitud para AssistantService.RunAssistant.
| Campos | |
|---|---|
app |
Obligatorio. La app para la que se ejecutará el asistente. Formato: |
assistant_session |
Obligatorio. Es la sesión del asistente que se usará para ejecutarlo. Formato: |
message |
Obligatorio. Es el mensaje que se enviará al agente de asistencia. |
interaction_type |
Es opcional. Son los diferentes tipos de interacción para el mensaje del asistente. |
InteractionType
Es el tipo de interacción del mensaje enviado al asistente.
| Enums | |
|---|---|
INTERACTION_TYPE_UNSPECIFIED |
Es el valor predeterminado. Este valor se usa si no se especifica el tipo. |
NEW_MESSAGE |
El mensaje es una entrada del usuario. La entrada del usuario se proporciona en la lista de fragmentos. |
POLL |
El mensaje es para sondear el estado de la sesión del asistente. |
DISMISS |
El mensaje es para descartar la sesión de asistencia pendiente de revisión. Esto cambiará el estado de la sesión del asistente a inactivo. |
RunAssistantResponse
Mensaje de respuesta para AssistantService.RunAssistant.
| Campos | |
|---|---|
output |
Obligatorio. El resultado del agente asistente. |
state |
Solo salida. El estado de la sesión de asistencia. |
RunEvaluationOperationMetadata
Metadatos de la operación para EvaluationService.RunEvaluation.
| Campos | |
|---|---|
evaluations[] |
Solo salida. Es la lista de evaluaciones que se ejecutaron. Formato: |
evaluation_run |
Solo salida. La ejecución de la evaluación que se creó. Formato: |
create_time |
Es solo de salida. Indica la hora a la que se creó la operación. |
end_time |
Solo salida. Es la hora en que se completó la operación. |
verb |
Solo salida. Es el verbo de la operación. |
cancel_requested |
Solo salida. Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron con éxito tienen el valor |
RunEvaluationRequest
Mensaje de solicitud para EvaluationService.RunEvaluation.
| Campos | |
|---|---|
app |
Obligatorio. Es la app que se evaluará. Formato: |
evaluations[] |
Es opcional. Es la lista de evaluaciones que se ejecutarán. Formato: |
evaluation_dataset |
Es opcional. Un conjunto de datos de evaluación para ejecutar. Formato: |
display_name |
Es opcional. Es el nombre visible de la ejecución de la evaluación. |
app_version |
Es opcional. Es la versión de la app que se evaluará. Se puede establecer como máximo uno de los valores |
config |
Es opcional. Es la configuración que se usará para la ejecución. |
persona_run_configs[] |
Es opcional. Es la configuración que se usará para la ejecución por perfil. |
optimization_config |
Es opcional. Es la configuración para ejecutar el paso de optimización después de la ejecución de la evaluación. Si no se establece, no se ejecutará el paso de optimización. |
scheduled_evaluation_run |
Es opcional. Es el nombre del recurso de Si se establece este campo, el campo |
golden_run_method |
Es opcional. Es el método para ejecutar la evaluación si se trata de una evaluación de referencia. Si no se establece, el valor predeterminado es STABLE. |
generate_latency_report |
Es opcional. Indica si se debe generar un informe de latencia para la ejecución de la evaluación. |
evaluation_run_caching_settings |
Es opcional. Es la configuración de almacenamiento en caché que se usará para la ejecución de la evaluación. |
run_count |
Es opcional. La cantidad de veces que se ejecuta la evaluación. Si no se establece, el valor predeterminado es 1 por ejemplo de referencia y 5 por situación. |
RunEvaluationResponse
Mensaje de respuesta para EvaluationService.RunEvaluation.
| Campos | |
|---|---|
evaluation_run |
Es el nombre de la ejecución de evaluación que se creó. Formato: |
RunEvaluationResultMetricsOperationMetadata
Este tipo no tiene campos.
Metadatos de la operación para EvaluationService.RunEvaluationResultMetrics.
RunEvaluationResultMetricsRequest
Mensaje de solicitud para EvaluationService.RunEvaluationResultMetrics.
| Campos | |
|---|---|
evaluation_result_id |
Obligatorio. Es el resultado de la evaluación para el que se ejecutarán las métricas. Formato: |
RunEvaluationResultMetricsResponse
Mensaje de respuesta para EvaluationService.RunEvaluationResultMetrics.
| Campos | |
|---|---|
status |
Solo salida. Es el estado del cálculo de las métricas de los resultados de la evaluación. |
RunSessionRequest
Mensaje de solicitud para SessionService.RunSession.
| Campos | |
|---|---|
config |
Obligatorio. Es la configuración de la sesión. |
inputs[] |
Obligatorio. Son las entradas de la sesión. |
RunSessionResponse
Mensaje de respuesta para SessionService.RunSession.
| Campos | |
|---|---|
outputs[] |
Son los resultados de la sesión. |
ScheduledEvaluationRun
Representa una configuración de ejecución de evaluación programada.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la configuración de ejecución de la evaluación programada. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId} |
display_name |
Obligatorio. Es el nombre visible definido por el usuario de la configuración de ejecución de la evaluación programada. |
request |
Obligatorio. Es el RunEvaluationRequest que se programará. |
description |
Es opcional. Es la descripción definida por el usuario de la ejecución de evaluación programada. |
scheduling_config |
Obligatorio. Es la configuración del momento y la frecuencia con la que se ejecutan las evaluaciones. |
active |
Es opcional. Indica si esta configuración está activa |
last_completed_run |
Solo salida. Es la última EvaluationRun exitosa de esta ejecución programada. Formato: |
total_executions |
Solo salida. La cantidad total de veces que se ejecutó esta ejecución |
next_scheduled_execution_time |
Solo salida. La próxima vez que se programe la ejecución de este elemento |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la ejecución de la evaluación programada. |
created_by |
Solo salida. Es el usuario que creó la ejecución de la evaluación programada. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la evaluación. |
last_updated_by |
Solo salida. Es el usuario que actualizó la evaluación por última vez. |
etag |
Solo salida. Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
SchedulingConfig
Detalles de la configuración de la programación de evaluaciones
| Campos | |
|---|---|
frequency |
Obligatorio. La frecuencia con la que se ejecuta la evaluación |
start_time |
Obligatorio. Marca de tiempo en la que debe comenzar la evaluación. |
days_of_week[] |
Es opcional. Son los días de la semana en los que se ejecutará la evaluación. Solo se aplica a las frecuencias semanales y quincenales. 1 es lunes, 2 es martes, ..., 7 es domingo. |
Frecuencia
Las frecuencias con las que se pueden ejecutar las evaluaciones
| Enums | |
|---|---|
FREQUENCY_UNSPECIFIED |
No se especifica la frecuencia. |
NONE |
Indica una ejecución programada única que no se debe repetir |
DAILY |
Ejecuta la evaluación todos los días. |
WEEKLY |
Ejecuta la evaluación semanalmente. |
BIWEEKLY |
Ejecutar la evaluación cada dos semanas |
Esquema
Representa un subconjunto selecto de un objeto de esquema de OpenAPI 3.0.
| Campos | |
|---|---|
type |
Obligatorio. Es el tipo de datos. |
properties |
Es opcional. Propiedades de Type.OBJECT. |
required[] |
Es opcional. Propiedades obligatorias de Type.OBJECT. |
description |
Es opcional. La descripción de los datos. |
items |
Es opcional. Esquema de los elementos de Type.ARRAY. |
nullable |
Es opcional. Indica si el valor puede ser nulo. |
unique_items |
Es opcional. Indica que los elementos del array deben ser únicos. Solo se aplica a TYPE.ARRAY. |
prefix_items[] |
Es opcional. Esquemas de los elementos iniciales de Type.ARRAY. |
additional_properties |
Es opcional. Puede ser un booleano o un objeto, y controla la presencia de propiedades adicionales. |
any_of[] |
Es opcional. El valor se debe validar con cualquiera (uno o más) de los subesquemas de la lista. |
enum[] |
Es opcional. Valores posibles del elemento de tipo primitivo con formato de enumeración. Ejemplos: 1. Podemos definir la dirección de la siguiente manera : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir el número de departamento de la siguiente manera : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Es opcional. Es el valor predeterminado de los datos. |
ref |
Es opcional. Permite referencias indirectas entre nodos de esquema. El valor debe ser una referencia válida a un elemento secundario de la raíz Por ejemplo, el siguiente esquema define una referencia a un nodo de esquema llamado "Pet": El valor de la propiedad "pet" es una referencia al nodo de esquema llamado "Pet". Consulta los detalles en https://json-schema.org/understanding-json-schema/structuring. |
defs |
Es opcional. Es un mapa de definiciones que usa |
title |
Es opcional. Es el título del esquema. |
min_items |
Es opcional. Es la cantidad mínima de elementos para Type.ARRAY. |
max_items |
Es opcional. Es la cantidad máxima de elementos para Type.ARRAY. |
minimum |
Es opcional. Es el valor mínimo para Type.INTEGER y Type.NUMBER. |
maximum |
Es opcional. Es el valor máximo para Type.INTEGER y Type.NUMBER. |
Tipo
Tipos de datos de OpenAPI.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Indica un tipo no especificado. |
STRING |
Tipo de cadena. |
INTEGER |
Tipo de número entero. |
NUMBER |
Tipo de número. |
BOOLEAN |
Tipo booleano. |
OBJECT |
Es el tipo de objeto. |
ARRAY |
Es el tipo de array. |
SecuritySettings
Configuración de seguridad a nivel de proyecto o ubicación para CES.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único de la configuración de seguridad. Formato: |
endpoint_control_policy |
Es opcional. Configuración relacionada con el control de extremos. |
create_time |
Solo salida. Es la hora de creación de la configuración de seguridad. |
update_time |
Solo salida. Es la hora de la última actualización de la configuración de seguridad. |
etag |
Solo salida. Etag de la configuración de seguridad. |
ServiceAccountAuthConfig
Son los parámetros de configuración para la autenticación con una cuenta de servicio personalizada.
| Campos | |
|---|---|
service_account |
Obligatorio. Es la dirección de correo electrónico de la cuenta de servicio que se usa para la autenticación. CES usa esta cuenta de servicio para intercambiar un token de acceso, que luego se envía en el encabezado La cuenta de servicio debe tener el rol |
scopes[] |
Es opcional. Son los permisos de OAuth que se otorgarán. Si no se especifica, se usa el permiso predeterminado |
ServiceAgentIdTokenAuthConfig
Este tipo no tiene campos.
Parámetros de configuración para la autenticación con el token de ID generado a partir del agente de servicio.
ServiceDirectoryConfig
Configuración de las herramientas que usan el Directorio de servicios.
| Campos | |
|---|---|
service |
Obligatorio. Es el nombre del servicio del Directorio de servicios. Formato: |
SessionCheckpoint
Es el punto de control de la sesión que contiene la intención del usuario inferida para el título y la IU de la sesión.
| Campos | |
|---|---|
user_intent |
Es el objetivo o tema inferido del usuario para la sesión (p.ej., "Creación de un agente de asistencia para comercio electrónico"). |
SessionConfig
Es la configuración de la sesión.
| Campos | |
|---|---|
session |
Obligatorio. Es el identificador único de la sesión. Formato: |
input_audio_config |
Es opcional. Es la configuración para procesar el audio de entrada. |
output_audio_config |
Es opcional. Es la configuración para generar el audio de salida. |
historical_contexts[] |
Es opcional. Es el contexto histórico de la sesión, incluidas las entradas del usuario, las respuestas del agente y otros mensajes. Por lo general, el agente de CES administra la sesión automáticamente, por lo que el cliente no necesita propagar este campo de forma explícita. Sin embargo, el cliente puede anular de forma opcional los contextos históricos para forzar el inicio de la sesión desde un estado determinado. |
entry_agent |
Es opcional. Es el agente de entrada que controlará la sesión. Si no se especifica, la sesión se controlará con el |
deployment |
Es opcional. Es la implementación de la app que se usará para la sesión. Formato: |
time_zone |
Es opcional. Es la zona horaria del usuario. Si se proporciona, el agente usará la zona horaria para las variables relacionadas con la fecha y la hora. De lo contrario, el agente usará la zona horaria especificada en App.time_zone_settings. El formato es la zona horaria de la base de datos de zonas horarias de IANA, p.ej., "America/Los_Angeles". |
use_tool_fakes |
Es opcional. Indica si se deben usar simulaciones de herramientas para la sesión. Si se establece este campo, el agente intentará usar simulaciones de herramientas en lugar de llamar a las herramientas reales. |
remote_dialogflow_query_parameters |
Es opcional. QueryParameters que se enviarán al agente remoto de Dialogflow cuando se transfiera el control de la sesión al agente remoto. |
enable_text_streaming |
Es opcional. Indica si se debe transmitir la salida de texto del modelo al cliente de forma incremental a medida que se genera. La configuración predeterminada es
NOTA: Esto solo se admite para sesiones de texto (sin voz) con |
include_llm_thought_summary |
Es opcional. Indica si se deben incluir resúmenes de pensamientos del LLM en los resultados de la sesión. |
exclude_diagnostic_info |
Es opcional. Indica si se debe excluir la información de diagnóstico del resultado de la sesión. |
include_progress_update |
Es opcional. Indica si se debe incluir la actualización de procesamiento intermedio para el cliente. Si está habilitada, la actualización se enviará de vuelta en |
RemoteDialogflowQueryParameters
QueryParameters que se enviarán al agente remoto de Dialogflow cuando se transfiera el control de la sesión al agente remoto.
| Campos | |
|---|---|
webhook_headers |
Es opcional. Son los encabezados HTTP que se enviarán como webhook_headers en QueryParameters. |
payload |
Es opcional. Es la carga útil que se enviará en QueryParameters. |
end_user_metadata |
Es opcional. Son los metadatos del usuario final que se enviarán en QueryParameters. |
SessionInput
Es la entrada de la sesión.
| Campos | |
|---|---|
will_continue |
Es opcional. Es una marca para indicar si el mensaje actual es un fragmento de una entrada más grande en la sesión de transmisión bidireccional. Cuando se establece en NOTA: Este campo no se aplica a las entradas de audio y DTMF, ya que siempre se procesan automáticamente según la señal de finalización. |
recording_control |
Es opcional. Si la conversación se puede grabar y registrar a partir de este momento. Usa esta opción cuando la app, en lugar del agente, decida qué se puede conservar, por ejemplo, cuando el usuario final deba dar su consentimiento para que se lo grabe antes de que se pueda almacenar cualquier información sobre la llamada. El valor permanece vigente hasta que el cliente envía uno diferente, por lo que solo se debe enviar cuando cambia la respuesta. Lo que esté vigente cuando se complete un turno decide ese turno, tanto si su audio llega al bucket de grabación como si su transcripción llega al historial de conversaciones, BigQuery y Cloud Logging. Abarca tanto el lado del agente como el del usuario final. Los turnos que se completan antes de que el cliente envíe este campo por primera vez se registran según la configuración de registro de la app, como si el campo no existiera. Si más de una entrada en la misma solicitud lo establece, gana la última. |
Campo de unión input_type. Es el tipo de entrada. input_type puede ser solo uno de los parámetros siguientes: |
|
text |
Es opcional. Son los datos de texto del usuario final. |
dtmf |
Es opcional. Dígitos de DTMF del usuario final. |
audio |
Es opcional. Son los datos de audio del usuario final. |
tool_responses |
Es opcional. Son los resultados de la ejecución de las llamadas a la herramienta desde el cliente. |
image |
Es opcional. Son los datos de imagen del usuario final. |
blob |
Es opcional. Son los datos de BLOB del usuario final. |
variables |
Es opcional. Son las variables contextuales de la sesión, con clave por nombre. El agente de CES solo usará las variables declaradas en la app. Las variables no reconocidas se seguirán enviando al [agente de Dialogflow][Agent.RemoteDialogflowAgent] como parámetros de sesión adicionales. |
event |
Es opcional. Entrada del evento. |
RecordingControl
Es posible que se registre y se guarde lo que la app haya decidido.
Esta enumeración es extensible; es posible que se agreguen valores nuevos en el futuro.
| Enums | |
|---|---|
RECORDING_CONTROL_UNSPECIFIED |
La app no controla la grabación. La configuración de registro de la app decide, como lo hace para cada sesión que nunca establece este campo. |
RECORDING_ENABLED |
A partir de este momento, es posible que se grabe y registre la conversación. |
RECORDING_DISABLED |
Es posible que la conversación no se grabe ni se registre a partir de este momento. |
SessionOutput
Es el resultado de la sesión.
| Campos | |
|---|---|
turn_index |
Indica el orden secuencial del turno de conversación al que pertenece este resultado, a partir de 1. |
turn_completed |
Si es verdadero, el agente de CES detectó el final del turno de conversación actual y no proporcionará más resultados para este turno. |
diagnostic_info |
Es opcional. La información de diagnóstico contiene detalles de ejecución durante el procesamiento de la entrada. Solo se completa en el último SessionOutput (con |
Campo de unión output_type. Es el tipo de resultado. output_type puede ser solo uno de los parámetros siguientes: |
|
text |
Es el texto de salida del agente de CES. |
audio |
Es el audio de salida del agente de CES. |
tool_calls |
Solicita que el cliente ejecute las herramientas. |
citations |
Son citas que proporcionan la información de la fuente del texto generado por el agente. |
google_search_suggestions |
Son las sugerencias que se devuelven de la Búsqueda de Google como resultado de invocar el |
end_session |
Indica que la sesión finalizó. |
payload |
Carga útil personalizada con resultados estructurados del agente de CES. |
image |
Imagen de salida del agente de CES. |
progress |
Actualización intermedia del progreso del agente de CES. |
DiagnosticInfo
Contiene detalles de ejecución durante el procesamiento.
| Campos | |
|---|---|
messages[] |
Es la lista de los mensajes que se produjeron durante el procesamiento. |
root_span |
Un seguimiento de todo el procesamiento de la solicitud, representado como un intervalo raíz. Este intervalo puede contener intervalos secundarios anidados para operaciones específicas. |
Intervalo
Un intervalo es una unidad de trabajo o una sola operación durante el procesamiento de la solicitud.
| Campos | |
|---|---|
name |
Solo salida. Es el nombre del intervalo. |
start_time |
Solo salida. Es la hora de inicio del intervalo. |
end_time |
Solo salida. Es la hora de finalización del intervalo. |
duration |
Solo salida. La duración del intervalo. |
attributes |
Solo salida. Son los atributos de par clave-valor asociados con el intervalo. |
child_spans[] |
Solo salida. Son los intervalos secundarios que están anidados en este intervalo. |
StreamChatAiAssistantRequest
Mensaje de solicitud para SessionService.StreamChatAiAssistant.
| Campos | |
|---|---|
name |
Obligatorio. Es la sesión del asistente que se usará para ejecutarlo. Formato: |
message |
Es opcional. Es el mensaje que se enviará al agente de asistencia. Puede estar vacío cuando se establece |
attached_gcs_uris[] |
Es opcional. Son los URIs de Cloud Storage para los archivos que subió el usuario durante este turno. Ejemplo: "gs://cxas-transient-uploads/uuid/prd.pdf" |
context_token |
Es opcional. Es el token de contexto de integración opaco que devuelve |
confirmation_response |
Es opcional. Es la respuesta del usuario a un |
client_capabilities[] |
Es opcional. Son las funciones de respuesta que este cliente puede renderizar. El servidor solo emite eventos que necesitan una capacidad (p.ej., |
operation_completed_event |
Es opcional. Reanuda una sesión de asistente que se detuvo mientras esperaba que se completara una operación de larga duración administrada por el cliente. |
resume_from_sequence_number |
Es opcional. Cursor opcional para reanudar y volver a reproducir eventos de un turno en curso o completado. |
attach_only |
Es opcional. Es una marca opcional para adjuntar a un turno en curso existente sin enviar un mensaje nuevo. |
ClientCapability
Son las funciones de respuesta que puede declarar un cliente.
| Enums | |
|---|---|
CLIENT_CAPABILITY_UNSPECIFIED |
Capacidad no especificada; se ignora. |
CONFIRMATION_CARDS |
El cliente renderiza las tarjetas AssistantConfirmationRequest y las responde a través de confirmation_response. |
CLIENT_MANAGED_LRO |
El cliente administra las operaciones de larga duración fuera de banda sondeando la operación y enviando operation_completed_event para reanudar el turno. Si no se declara, el servidor administra el sondeo de LRO y completa el turno de forma intercalada. |
PROJECT_SCOPE |
El cliente renderiza eventos de alcance del proyecto: tarjetas typed_payload, target_app en llamadas a la herramienta y respuestas, targets en solicitudes de confirmación y touched_apps en la finalización del turno. |
StreamChatAiAssistantResponse
Mensaje de respuesta para SessionService.StreamChatAiAssistant.
| Campos | |
|---|---|
event_id |
Identificador único para el evento. |
event_time |
Es la marca de tiempo de cuando ocurrió el evento. |
ui_event |
Es opcional. Es la carga útil del evento de IU. |
turn_metadata |
Es opcional. Metadatos a nivel de turno y categorización de intents |
sequence_number |
Es opcional. Es el número de secuencia que aumenta de forma monótona para este turno de sesión. |
turn_in_progress |
Es opcional. Indica si el turno aún se está ejecutando de forma activa en segundo plano. |
Campo de unión event. Es la carga útil del evento. event puede ser solo uno de los parámetros siguientes: |
|
text_chunk |
Token de texto (para transmitir las respuestas de Gemini palabra por palabra) |
status |
Actualización de estado simple. |
thought_chunk |
Es el fragmento de texto de pensamiento (el razonamiento del agente antes de generar la respuesta). |
tool_call |
Es el evento de ejecución de la llamada a la herramienta. |
tool_response |
Es el evento de respuesta de la llamada a la herramienta. |
artifact_chunk |
Evento de artefacto de documento generado (deltas de vista previa en vivo + puntero final de Cloud Storage). |
option_questions_chunk |
Son las opciones de aclaración estructuradas que se analizan a partir del turno del modelo. La consola los renderiza como una lista de opciones seleccionables en lugar de texto sin procesar. |
confirmation_request |
Es una confirmación de bloqueo en la que se detuvo el agente. El agente se reanuda cuando la respuesta llega en el |
session_checkpoint |
Es el evento de resumen de compactación o punto de control de la sesión que contiene la intención del usuario y el resumen continuo. |
resume_snapshot |
Es una repetición compactada de un turno en curso, que se envía como el primer evento de cada conexión o reanudación antes de cualquier evento en vivo. El cliente reemplaza cualquier estado renderizado de forma local para este turno por el contenido de la instantánea. |
handoff |
Le indica al cliente que se vuelva a conectar de forma silenciosa con resume_from_sequence_number: la tarea que entrega esta transmisión desaparecerá y el turno continuará en otro lugar. No es un error; la transmisión se completa con normalidad después de este evento. |
turn_completed |
Finalizó el turno. Se envía como el último evento de cada turno, en la transmisión original y en cada transmisión adjunta o reanudada, para que los clientes puedan finalizar el turno con una señal explícita en lugar de inferirla del cierre de la transmisión. |
SynthesizeSpeechConfig
Es la configuración de cómo se debe sintetizar la respuesta del agente.
| Campos | |
|---|---|
voice |
Opcional. El nombre de la voz. Si no se configura, el servicio elegirá una voz según los otros parámetros, como language_code. Para obtener la lista de voces disponibles, consulta Voces y lenguajes compatibles de Cloud Text-to-Speech. |
speaking_rate |
Es opcional. La velocidad de habla en el rango [0.25, 2.0]. 1.0 es la velocidad nativa normal que admite la voz específica. 2.0 es el doble de rápido y 0.5 es la mitad. Los valores fuera del rango [0.25, 2.0] devolverán un error. |
model |
Es opcional. Es el modelo que se usa para sintetizar audio. Valores admitidos actualmente: - "gemini-3.1-flash-tts-preview" Si está vacío, se usa Chirp3-HD. |
instruction |
Es opcional. Es la instrucción que se usa para sintetizar la voz cuando se usa un modelo generativo. |
SystemTool
Herramienta del sistema predefinida.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la herramienta del sistema. |
description |
Solo salida. Es la descripción de la herramienta del sistema. |
TestPersonaVoiceRequest
Mensaje de solicitud para EvaluationService.TestPersonaVoice.
| Campos | |
|---|---|
app |
Obligatorio. Es el nombre del recurso de la app para la que se probará la voz de la persona. Formato: |
persona_id |
Obligatorio. Es el ID de la persona para la que se probará la voz. También acepta "default". |
text |
Obligatorio. Es el texto con el que se probará la voz. |
TestPersonaVoiceResponse
Mensaje de respuesta para EvaluationService.TestPersonaVoice.
| Campos | |
|---|---|
audio |
Son los bytes de datos de audio de la voz sintetizada. |
TimeZoneSettings
Es la configuración de la zona horaria de la app.
| Campos | |
|---|---|
time_zone |
Es opcional. Es la zona horaria de la app de la base de datos de zonas horarias, p.ej., America/Los_Angeles, Europe/Paris. |
TlsConfig
Es la configuración de TLS.
| Campos | |
|---|---|
ca_certs[] |
Obligatorio. Especifica una lista de certificados de AC personalizados permitidos para la verificación de HTTPS. |
CaCert
Es el certificado de la AC.
| Campos | |
|---|---|
display_name |
Obligatorio. Es el nombre de los certificados de la AC personalizados permitidos. Esto se puede usar para eliminar la ambigüedad de los certificados de la AC personalizados. |
cert |
Obligatorio. Son los certificados de la AC personalizados permitidos (en formato DER) para la verificación de HTTPS. Esto anula el almacén de confianza de SSL predeterminado. Si este campo está vacío o no se especifica, CES usará el almacén de confianza predeterminado de Google para verificar los certificados. Nota: Asegúrate de que los certificados del servidor HTTPS estén firmados con "subject alt name". Por ejemplo, un certificado se puede autofirmar con el siguiente comando: |
Herramienta
Una herramienta representa una acción que el agente de CES puede realizar para lograr ciertos objetivos.
| Campos | |
|---|---|
name |
Es el identificador. Es el nombre del recurso de la herramienta. Formato:
Estas herramientas son dinámicas y solo de salida; no se puede hacer referencia a ellas directamente donde se espera una herramienta. |
display_name |
Solo salida. Es el nombre visible de la herramienta, que se deriva según su tipo. Por ejemplo, el nombre visible de una [ClientFunction][Tool.ClientFunction] se deriva de su propiedad |
execution_type |
Es opcional. Es el tipo de ejecución de la herramienta. |
timeout |
Es opcional. Es el tiempo de espera para la ejecución de la herramienta. Si no se establece, el tiempo de espera predeterminado es de 30 segundos para las herramientas de |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó la herramienta. |
update_time |
Solo salida. Marca de tiempo de la última actualización de la herramienta. |
etag |
Es la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
generated_summary |
Solo salida. Si el asistente de LLM genera la herramienta, este campo contiene un resumen descriptivo de la generación. |
tool_fake_config |
Es opcional. Configuración del comportamiento de la herramienta en el modo falso. |
read_only |
Solo salida. Indica si la herramienta es de solo lectura. Si es verdadero, el usuario no puede modificar la herramienta. |
Campo de unión tool_type. Es el tipo de herramienta. tool_type puede ser solo uno de los parámetros siguientes: |
|
client_function |
Es opcional. La función del cliente |
open_api_tool |
Es opcional. La herramienta de API abierta. |
google_search_tool |
Es opcional. La herramienta de Búsqueda de Google |
connector_tool |
Es opcional. La herramienta Integration Connector |
data_store_tool |
Es opcional. La herramienta de almacén de datos. |
python_function |
Es opcional. La herramienta de función de Python. |
mcp_tool |
Es opcional. La herramienta de MCP. No se puede crear ni actualizar una herramienta de MCP directamente, y se administra con el conjunto de herramientas de MCP. |
file_search_tool |
Es opcional. La herramienta de búsqueda de archivos. |
system_tool |
Es opcional. La herramienta del sistema. |
agent_tool |
Es opcional. La herramienta del agente. |
widget_tool |
Es opcional. La herramienta de widgets |
remote_agent_tool |
Es opcional. La herramienta de agente remoto. |
ToolCall
Solicitud para que el cliente o el agente ejecuten la herramienta especificada.
| Campos | |
|---|---|
id |
Es opcional. Es el identificador único de la llamada a la herramienta. Si se completa, el cliente debe devolver el resultado de la ejecución con el ID para coincidencias en |
display_name |
Solo salida. Es el nombre visible de la herramienta. |
args |
Es opcional. Son los parámetros y valores de entrada de la herramienta en formato de objeto JSON. |
parent_tool_call_id |
Solo salida. Es el ID de la llamada a la herramienta que causó esta, cuando la emitió un agente secundario que trabaja en nombre de una llamada superior. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un agente secundario en la llamada que lo inició, en lugar de renderizar cada paso como un elemento hermano. |
agent_name |
Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando lo emite el agente raíz. |
target_app |
Solo salida. La app a la que se dirige esta llamada, derivada por el asistente a partir de los argumentos de recursos de la llamada: un nombre de recurso de app, |
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutará. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: |
toolset_tool |
Es opcional. Es la herramienta del conjunto de herramientas que se ejecutará. |
ToolCalls
Solicita que el cliente ejecute las herramientas y devuelva los resultados de la ejecución antes de continuar con la sesión.
| Campos | |
|---|---|
tool_calls[] |
Es opcional. Es la lista de llamadas a herramientas que se ejecutarán. |
ToolFakeConfig
Configuración del comportamiento de la herramienta en el modo falso.
| Campos | |
|---|---|
enable_fake_mode |
Es opcional. Indica si la herramienta usa el modo falso. |
Campo de unión tool_response. La respuesta es estática o la proporciona una función de Python. tool_response puede ser solo uno de los parámetros siguientes: |
|
code_block |
Es opcional. Bloque de código que se ejecutará en lugar de una llamada a la herramienta real. |
ToolResponse
Es el resultado de la ejecución de una herramienta específica del cliente o del agente.
| Campos | |
|---|---|
id |
Es opcional. Es el ID para coincidencias del |
display_name |
Solo salida. Es el nombre visible de la herramienta. |
response |
Obligatorio. Es el resultado de la ejecución de la herramienta en formato de objeto JSON. Usa la clave "output" para especificar la respuesta de la herramienta y la clave "error" para especificar los detalles del error (si los hay). Si no se especifican las claves "output" y "error", toda la "response" se trata como el resultado de la ejecución de la herramienta. |
parent_tool_call_id |
Solo salida. Es el ID de la llamada a la herramienta que causó esta, cuando la emitió un agente secundario que trabaja en nombre de una llamada superior. Está vacío para las llamadas de nivel superior. Permite que un cliente agrupe el trabajo de un agente secundario en la llamada que lo inició, en lugar de renderizar cada paso como un elemento hermano. |
agent_name |
Solo salida. Nombre legible por humanos del agente que emitió esta llamada, p.ej., "Arquitecto de contratos". Está vacío cuando lo emite el agente raíz. |
target_app |
Solo salida. Es la app a la que se orientó la herramienta ejecutada; refleja |
Campo de unión tool_identifier. Es el identificador de la herramienta que se ejecutó. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. tool_identifier puede ser solo uno de los parámetros siguientes: |
|
tool |
Es opcional. Es el nombre de la herramienta que se ejecutará. Formato: |
toolset_tool |
Es opcional. Es la herramienta del conjunto de herramientas que se ejecutó. |
ToolResponses
Son los resultados de la ejecución de las llamadas a la herramienta solicitadas por el cliente.
| Campos | |
|---|---|
tool_responses[] |
Es opcional. Es la lista de resultados de la ejecución de la herramienta. |
Conjunto de herramientas
Un conjunto de herramientas representa un grupo de herramientas administradas de forma dinámica que el agente puede usar.
| Campos | |
|---|---|
name |
Es el identificador. Es el identificador único del conjunto de herramientas. Formato: |
display_name |
Es opcional. Es el nombre visible del conjunto de herramientas. Debe ser único dentro de la misma app. |
description |
Es opcional. Es la descripción del conjunto de herramientas. |
timeout |
Es opcional. Es el tiempo de espera para la ejecución del conjunto de herramientas. Si no se establece, el tiempo de espera predeterminado es de 30 segundos para los conjuntos de herramientas de |
create_time |
Solo salida. Es la marca de tiempo de cuando se creó el conjunto de herramientas. |
update_time |
Solo salida. Marca de tiempo de la última actualización del conjunto de herramientas. |
etag |
Es la ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, la actualización reemplazará cualquier cambio simultáneo. |
execution_type |
Es opcional. Es el tipo de ejecución de las herramientas del conjunto de herramientas. |
tool_fake_config |
Es opcional. Configuración del comportamiento de las herramientas en el modo falso. |
Campo de unión toolset_type. Es el tipo de conjunto de herramientas. toolset_type puede ser solo uno de los parámetros siguientes: |
|
mcp_toolset |
Es opcional. Es un conjunto de herramientas que contiene una lista de herramientas que ofrece el servidor de MCP. |
open_api_toolset |
Es opcional. Un conjunto de herramientas que contiene una lista de herramientas definidas por un esquema de OpenAPI. |
connector_toolset |
Es opcional. Es un conjunto de herramientas que genera herramientas a partir de una conexión de Integration Connectors. |
ToolsetTool
Es una herramienta que se crea a partir de un conjunto de herramientas.
| Campos | |
|---|---|
toolset |
Obligatorio. Es el nombre del recurso del conjunto de herramientas del que se deriva esta herramienta. Formato: |
tool_id |
Es opcional. Es el ID de la herramienta para filtrar las herramientas de las que se recuperará el esquema. |
TransferRule
Es la regla para transferir a un agente específico.
| Campos | |
|---|---|
child_agent |
Obligatorio. Es el nombre del recurso del agente secundario al que se aplica la regla. Formato: |
direction |
Obligatorio. La dirección de la transferencia. |
Campo de unión rule_type. Es el tipo de regla. rule_type puede ser solo uno de los parámetros siguientes: |
|
deterministic_transfer |
Es opcional. Es una regla que transfiere de inmediato al agente de destino cuando se cumple la condición. |
disable_planner_transfer |
Es opcional. Es la regla que impide que el planificador transfiera al agente de destino. |
DeterministicTransfer
Regla de transferencia determinística. Cuando la condición se evalúa como verdadera, se produce la transferencia.
| Campos | |
|---|---|
Campo de unión condition_type. Es la condición que se evaluará. condition_type puede ser solo uno de los parámetros siguientes: |
|
expression_condition |
Es opcional. Es una regla que evalúa una condición de estado de la sesión. Si la condición se evalúa como verdadera, se produce la transferencia. |
python_code_condition |
Es opcional. Es una regla que usa un bloque de código de Python para evaluar las condiciones. Si la condición se evalúa como verdadera, se produce la transferencia. |
Dirección
La dirección de la transferencia.
| Enums | |
|---|---|
DIRECTION_UNSPECIFIED |
Dirección sin especificar. |
PARENT_TO_CHILD |
Transferencia del agente superior al agente secundario. |
CHILD_TO_PARENT |
Transferencia del agente secundario al agente superior |
DisablePlannerTransfer
Una regla que impide que el planificador transfiera al agente de destino.
| Campos | |
|---|---|
expression_condition |
Obligatorio. Si la condición se evalúa como verdadera, el planificador no podrá transferir al agente de destino. |
TriggerAction
Es la acción que se realiza cuando se cumple una condición previa determinada.
| Campos | |
|---|---|
Campo de unión action. La acción por realizar. action puede ser solo uno de los parámetros siguientes: |
|
respond_immediately |
Es opcional. Responde de inmediato con una respuesta preconfigurada. |
transfer_agent |
Es opcional. Transferir la conversación a otro agente |
generative_answer |
Es opcional. Responder con una respuesta generativa |
GenerativeAnswer
El agente responderá de inmediato con una respuesta generativa.
| Campos | |
|---|---|
prompt |
Obligatorio. Es la instrucción que se usará para la respuesta generativa. |
RespondImmediately
El agente responderá de inmediato con una respuesta preconfigurada.
| Campos | |
|---|---|
responses[] |
Obligatorio. Son las respuestas estándares entre las que puede elegir el agente. La respuesta se elige de forma aleatoria. |
Respuesta
Representa una respuesta del agente.
| Campos | |
|---|---|
text |
Obligatorio. Es el texto con el que debe responder el agente. |
disabled |
Es opcional. Indica si la respuesta está inhabilitada. El agente no usa las respuestas inhabilitadas. |
TransferAgent
El agente transferirá la conversación a otro agente.
| Campos | |
|---|---|
agent |
Obligatorio. Es el nombre del agente al que se transferirá la conversación. El agente debe estar en la misma app que el agente actual. Formato: |
TurnCompletedEvent
Es el evento de terminal de un turno (consulta StreamChatAiAssistantResponse.turn_completed).
| Campos | |
|---|---|
turn_id |
Es el identificador del giro que finalizó. Coincide con TurnResumeSnapshot.turn_id y ActiveTurnInfo.turn_id. |
reason |
Por qué finalizó el turno |
final_sequence_number |
Es el número de secuencia del último evento que produjo el turno. Un cliente cuyo cursor esté más abajo se perdió contenido y debería volver a cargar la sesión para verlo. |
touched_apps[] |
Las apps que se modificaron o se orientaron en este turno, de modo que la consola pueda actualizar exactamente los almacenes de esas apps. Solo sesiones con permiso de proyecto. Formato: |
Motivo
Por qué finalizó el turno, de modo que un cliente que se unió tarde pueda expresar el resultado en lugar de adivinarlo a partir de una transmisión vacía.
| Enums | |
|---|---|
REASON_UNSPECIFIED |
Sin especificar. |
COMPLETED |
El turno se ejecutó hasta completarse; la sesión conserva su resultado confirmado. |
ABANDONED |
Ninguna tarea impulsaba el turno, se selló a un parcial confirmado y no se puede continuar. |
RESUME_UNAVAILABLE |
Este servidor no admite adjuntar ni reanudar la sesión, por lo que no se hizo un seguimiento de nada. En su lugar, el cliente debería volver a cargar la sesión. |
TurnHandoffEvent
Se emite antes de que esta tarea deje de entregar la transmisión a mitad del turno (p.ej., un reinicio del servidor). El estado del turno se conserva; una reconexión que lleva resume_from_sequence_number lo continúa en otra tarea.
| Campos | |
|---|---|
turn_id |
Identifica el turno que se reanudará. |
reason |
Por qué se transfiere la transmisión |
Motivo
Por qué se transfiere la transmisión
| Enums | |
|---|---|
REASON_UNSPECIFIED |
Sin especificar. |
SERVER_RESTART |
La tarea de entrega se está cerrando (envío de versión o reprogramación). |
TurnMetadata
Metadatos a nivel de turno y categorización de intents
| Campos | |
|---|---|
contract_related |
Indica si este turno del asistente estuvo relacionado con un contrato (p.ej., redacción, alineación, extracción o revisión de contratos). |
contract_finalized |
Se establece en el evento de artefacto final de un turno cuyo borrador de contrato se publicó (se activó una revisión). Terminal para el flujo de aclaración de este borrador: contract_progress es autoritativo y completo. |
contract_streaming_phase |
Se establece solo en las estimaciones de progreso en curso emitidas mientras se transmite una barrera de artefactos de contrato y en el evento de inicio de turno de revisión. No se establece en las cargas útiles autorizadas. |
contract_draft_complete |
Se establece en el evento de terminal de un borrador de contrato en el que se resuelven todos los marcadores de posición (contract_progress es 100%), independientemente de si se publicó el borrador o no. Los clientes completan y descartan la visualización del progreso del contrato en él; la publicación se informa por separado mediante contract_finalized. |
ContractStreamingPhase
Es la fase de transmisión de la carga útil del progreso del contrato.
| Enums | |
|---|---|
CONTRACT_STREAMING_PHASE_UNSPECIFIED |
La carga útil es autoritativa (se calcula a partir de un documento de contrato completo, una instantánea persistente o el estado previo al borrador). Los clientes deben reemplazar cualquier progreso recibido anteriormente por este. |
DRAFTING |
Se está transmitiendo un borrador inicial del contrato. contract_progress es una estimación en curso: no disminuye dentro de un límite de artefacto, tiene un límite inferior al rango de autoridad y pillar_breakdowns tiene total_item_count == 0 para marcar los estados estimados de los pilares. |
REVISING |
Se está transmitiendo una revisión de un contrato existente (por ejemplo, después de un envío de anotaciones). Tiene la misma semántica de estimación que DRAFTING. |
TurnResumeSnapshot
Es una repetición compactada de un turno en curso: todo lo necesario para renderizar el resultado visible del turno hasta el momento, además de la posición desde la que continúan los eventos en vivo.
| Campos | |
|---|---|
turn_id |
Identifica el turno al que se adjunta. |
resolved_sequence_number |
Es la posición que representa esta instantánea. Los eventos en vivo siguen con un sequence_number estrictamente mayor que este. Cuando es inferior al resume_from_sequence_number que solicitó el cliente, el progreso vaciado se retrasa con respecto a lo que el cliente ya renderizó: el cliente debe descartar el contenido renderizado de este turno más allá de esta posición antes de aplicar la instantánea. |
events[] |
Son eventos compactados que reconstruyen el resultado visible del turno, en orden de renderización, con las mismas formas de eventos que la transmisión en vivo. |
orphan_deadline_time |
Cuándo se cerrará el turno si no queda ningún cliente conectado. |
TypedPayload
Carga útil con un tipo. Lo usa el historial del asistente (AssistantChunk) y el evento de transmisión typed_payload. Se encuentra aquí porque tanto assistant_service.proto como session_service.proto lo necesitan.
| Campos | |
|---|---|
display_name |
Obligatorio. Es el nombre visible de la carga útil. |
type |
Obligatorio. Es el tipo de carga útil. |
value |
Obligatorio. Es el valor de la carga útil. |
metadata |
Es opcional. Son los metadatos de la carga útil. |
UiEvent
Representa una carga útil de evento de IU.
| Campos | |
|---|---|
mime_type |
Es el tipo de medio (tipo de MIME) que indica el formato de la carga útil del evento de la IU (p.ej., "application/json+a2ui"). |
json_payload |
Es la carga útil de JSON que representa la plataforma de A2UI. |
UpdateAgentRequest
Mensaje de solicitud para AgentService.UpdateAgent.
| Campos | |
|---|---|
agent |
Obligatorio. El agente que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateAppRequest
Mensaje de solicitud para AgentService.UpdateApp.
| Campos | |
|---|---|
app |
Obligatorio. Es la app que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateAppVersionRequest
Mensaje de solicitud para AgentService.UpdateAppVersion.
| Campos | |
|---|---|
app_version |
Obligatorio. Es la versión de la app que se actualizará. |
update_mask |
Es opcional. La lista de campos que se deben actualizar. Si está vacío, se actualizarán los campos |
UpdateDeploymentRequest
Mensaje de solicitud para AgentService.UpdateDeployment.
| Campos | |
|---|---|
deployment |
Obligatorio. Es la implementación que se actualizará. |
update_mask |
Es opcional. La lista de campos que se deben actualizar. |
UpdateEvaluationDatasetRequest
Mensaje de solicitud para EvaluationService.UpdateEvaluationDataset.
| Campos | |
|---|---|
evaluation_dataset |
Obligatorio. Es el conjunto de datos de evaluación que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateEvaluationExpectationRequest
Mensaje de solicitud para EvaluationService.UpdateEvaluationExpectation.
| Campos | |
|---|---|
evaluation_expectation |
Obligatorio. Es la expectativa de evaluación que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateEvaluationRequest
Mensaje de solicitud para EvaluationService.UpdateEvaluation.
| Campos | |
|---|---|
evaluation |
Obligatorio. Es la evaluación que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateExampleRequest
Mensaje de solicitud para AgentService.UpdateExample.
| Campos | |
|---|---|
example |
Obligatorio. Es el ejemplo que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateGuardrailRequest
Mensaje de solicitud para AgentService.UpdateGuardrail.
| Campos | |
|---|---|
guardrail |
Obligatorio. Es la barandilla que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateScheduledEvaluationRunRequest
Mensaje de solicitud para EvaluationService.UpdateScheduledEvaluationRun.
| Campos | |
|---|---|
scheduled_evaluation_run |
Obligatorio. Es la ejecución de evaluación programada que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateSecuritySettingsRequest
Mensaje de solicitud para AgentService.UpdateSecuritySettings.
| Campos | |
|---|---|
security_settings |
Obligatorio. Es la configuración de seguridad que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateToolRequest
Mensaje de solicitud para AgentService.UpdateTool.
| Campos | |
|---|---|
tool |
Obligatorio. Es la herramienta que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UpdateToolsetRequest
Mensaje de solicitud para AgentService.UpdateToolset.
| Campos | |
|---|---|
toolset |
Obligatorio. Es el conjunto de herramientas que se actualizará. |
update_mask |
Es opcional. La máscara de campo se usa para controlar qué campos se actualizan. Si la máscara no está presente, se actualizarán todos los campos. |
UploadEvaluationAudioRequest
Mensaje de solicitud para EvaluationService.UploadEvaluationAudio.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre del recurso de la evaluación para la que se subirá el audio de evaluación. Formato: |
audio_content |
Obligatorio. Son los bytes de audio sin procesar. El formato del audio debe ser LINEAR16 de un solo canal con una tasa de muestreo de 16 kHz (InputAudioConfig predeterminado). |
previous_audio_gcs_uri |
Es opcional. Es el URI de Google Cloud Storage del archivo de audio subido anteriormente que se borrará. Formato: |
UploadEvaluationAudioResponse
Mensaje de respuesta para EvaluationService.UploadEvaluationAudio.
| Campos | |
|---|---|
audio_gcs_uri |
Es el URI de Google Cloud Storage en el que se almacena el archivo de audio subido. Formato: |
transcript |
La transcripción del audio, generada por Cloud Speech-to-Text. |
duration |
Es la duración del audio. |
UserResponseSuggestions
Son las respuestas sugeridas del usuario del agente de asistencia.
| Campos | |
|---|---|
suggestions[] |
Obligatorio. El asistente sugirió respuestas del usuario. Estas son sugerencias para el usuario sobre cómo interactuar con el asistente. |
VpcScSettings
La configuración de VPC-SC para la app.
| Campos | |
|---|---|
allowed_origins[] |
Es opcional. Son los orígenes HTTP(S) permitidos a los que las herramientas de OpenAPI de la app pueden llamar directamente cuando los Controles del servicio de VPC están habilitados. Estas cadenas deben coincidir exactamente con el origen, incluido el puerto si se especifica. Por ejemplo, "https://example.com" o "https://example.com:443". Esta lista aún no se aplica a las herramientas de Python que pueden realizar llamadas HTTP directas. |
WebSearchQuery
Representa una sola búsqueda web y su URI de búsqueda asociada.
| Campos | |
|---|---|
query |
Es el texto de la búsqueda. |
uri |
Es el URI de la página de resultados de la Búsqueda de Google para la consulta. |
WhatsAppCredentials
Credenciales efímeras de Meta para la integración nativa de WhatsApp.
| Campos | |
|---|---|
auth_code |
Obligatorio. Es el código de autenticación de Meta que proporciona el flujo de registro incorporado. |
pin |
Obligatorio. Es el PIN de 6 dígitos que crea el usuario para la verificación en dos pasos. |
phone_number |
Obligatorio. Es el número de teléfono que se registrará en WhatsApp. |
business_account_id |
Obligatorio. Es el ID de la cuenta comercial que se usará para el número de teléfono. |
waba_id |
Obligatorio. Es el ID de la cuenta de WhatsApp Business. |
conversation_profile_id |
Es opcional. Es el ID del perfil de conversación que se usará para la implementación. |
WidgetTool
Representa una herramienta de widget que el agente puede invocar. Cuando el agente elija la herramienta, devolverá el widget al cliente. El cliente es responsable de procesar el widget y generar la siguiente consulta del usuario para continuar la interacción con el agente.
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre visible de la herramienta de widget. |
description |
Es opcional. Es la descripción de la herramienta de widget. |
widget_type |
Es opcional. Es el tipo de herramienta de widget. Si no se especifica, el tipo predeterminado será CUSTOMIZED. |
ui_config |
Es opcional. Es la configuración para renderizar el widget. |
data_mapping |
Es opcional. La asignación que define cómo se asignan los datos de una herramienta de origen a los parámetros de entrada del widget. |
text_response_config |
Es opcional. Es la configuración de las respuestas de texto que siempre se incluyen. |
Campo de unión input. La entrada de la herramienta de widget. input puede ser solo uno de los parámetros siguientes: |
|
parameters |
Es opcional. Son los parámetros de entrada de la herramienta de widget. |
DataMapping
Configuración para asignar datos de una herramienta de origen a los parámetros de entrada del widget.
| Campos | |
|---|---|
source_tool_name |
Es opcional. Es el nombre del recurso de la herramienta que proporciona los datos para el widget (p.ej., una herramienta de búsqueda o una función personalizada). Formato: |
field_mappings |
Es opcional. Es un mapa de los campos de parámetros de entrada del widget a los campos de salida correspondientes de la herramienta de origen. |
python_function |
Es opcional. Es la configuración de una función de Python que se usa para transformar el resultado de la herramienta de origen en el formato de entrada del widget. |
mode |
Es opcional. Es el modo de la asignación de datos. |
python_script |
Obsoleto: Usa |
Modo
Es la estrategia que se usa para asignar datos de la herramienta de origen al widget.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Modo sin especificar. |
FIELD_MAPPING |
Usa el mapa field_mappings para la transformación de datos. |
PYTHON_SCRIPT |
Usa python_script para la transformación de datos. |
TextResponseConfig
Es la configuración de la respuesta de texto que se devuelve con el widget.
| Campos | |
|---|---|
type |
Es opcional. Es la estrategia para proporcionar la respuesta de texto. |
static_text |
Es opcional. Es la respuesta de texto estática que se devuelve cuando el tipo es STATIC. |
text_response_instruction |
Es opcional. Es la instrucción para el LLM sobre cómo generar la respuesta de texto. Se usa como la descripción del parámetro de respuesta de texto si el tipo es LLM_GENERATED. |
Tipo
Define cómo se produce la respuesta de texto.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Indica un tipo no especificado. |
NONE |
El LLM decide de forma dinámica si genera una respuesta de texto junto con el widget según el contexto de la conversación. |
LLM_GENERATED |
Se requiere de forma explícita que el LLM genere una respuesta de texto. |
STATIC |
Siempre se usa una respuesta de texto estática predefinida. |
WidgetType
Todos los tipos de widgets disponibles. Es posible que se agreguen valores nuevos a esta enumeración en el futuro.
| Enums | |
|---|---|
WIDGET_TYPE_UNSPECIFIED |
Es un tipo de widget sin especificar. |
CUSTOM |
Tipo de widget personalizado. |
PRODUCT_CAROUSEL |
Widget de carrusel de productos. |
PRODUCT_DETAILS |
Widget de detalles del producto. |
QUICK_ACTIONS |
Widget de acciones rápidas. |
PRODUCT_COMPARISON |
Widget de comparación de productos. |
ADVANCED_PRODUCT_DETAILS |
Widget de detalles del producto avanzados. |
SHORT_FORM |
Widget de formato corto. |
OVERALL_SATISFACTION |
Widget de satisfacción general. |
ORDER_SUMMARY |
Widget de resumen del pedido. |
APPOINTMENT_DETAILS |
Widget de detalles de la cita. |
APPOINTMENT_SCHEDULER |
Widget de agenda de citas. |
CONTACT_FORM |
Widget de formulario de contacto |