## Index

- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfigService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnalyticsService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswerService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ContentExportService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ControlService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorMcpService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateBillingService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GroundedGenerationService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.MetricService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PodcastService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RequirementService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTuningService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfigService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEventService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStoreService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfigService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService` (interface)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition.CloudMarketplaceConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition.RemoteAgentcard` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenResponse.AdditionalOAuthResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireProgramsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireProgramsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationResponse.RefreshTokenInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionConfig.ScopeList` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionInvocation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddPatientFilterRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams.Origin` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdkAgentDefinition` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdkAgentDefinition.ProvisionedReasoningEngine` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.BoostSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.SuggestionType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.SuggestionTypeSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.ContentSuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.ContentSuggestion.ContentType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.PersonSuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.PersonSuggestion.PersonType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.QuerySuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.RecentSearchSuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedSiteSearchConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.DataStoreSpecs` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.Image` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.SharingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.SharingConfig.Scope` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.StarterPrompt` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentFile` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentGatewaySetting` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentGatewaySetting.AgentGatewayReference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentInvocationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentToolSettings` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.Event` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.SpanKind` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig.AlertEnrollment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig.AlertEnrollment.EnrollStates` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig.AlertEnrollment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig.AlertEnrollment.EnrollState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlloyDbSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationInsights` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationInsights.AlphaEvolveEvaluationInsight` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationScores` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationScores.AlphaEvolveEvaluationScore` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings.ParentSamplingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings.ParentSamplingConfig.ParetoSamplingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings.ModelConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings.ModelConfig.ThinkingLevel` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.RunSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentStats` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluationSubmission` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveSourceFile` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnalyticsConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.AnswerSkippedReason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment.AttributionType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment.Blob` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Citation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.CitationSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.GroundingSupport` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo.QueryClassificationInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo.QueryClassificationInfo.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.ChunkInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.ChunkInfo.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.StructuredDocumentInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.UnstructuredDocumentInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.UnstructuredDocumentInfo.ChunkContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.SnippetInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.SearchAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerGenerationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerGenerationSpec.UserDefinedClassifierSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.MultimodalSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.MultimodalSpec.ImageSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.GroundingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.GroundingSpec.FilteringLevel` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec.ModelType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.RelatedQuestionsSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec.SafetySetting` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec.SafetySetting.HarmBlockThreshold` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchParams` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.AssistSkippedReason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.BannedPhraseEnforcementResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.ModelArmorEnforcementResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.PolicyEnforcementResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.Verdict` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.ViolationSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.Reply` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistGenerationConfig` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest.AssistSkippingMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.ConnectorAuthError` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.InvokedSkill` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.SessionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistUserMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ActionInfo` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ActionList` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.HttpAgentConnectionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.Image` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.VertexAiSdkAgentConnectionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.BannedPhrase` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.BannedPhrase.BannedPhraseMatchType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.ModelArmorConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.ModelArmorConfig.FailureMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig.SystemInstruction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.MapsGroundingType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolList` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.VertexAiAgentConfig` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.VertexAiSearchToolConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.Blob` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.CodeExecutionResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.CodeExecutionResult.Outcome` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.ExecutableCode` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.File` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.ContentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.ContentMetadata.ContentKind` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox.BoundingPoly` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox.BoundingPoly.NormalizedVertex` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.Language` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.SearchEntryPoint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Segment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.VisualSegment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantMessageDroppedEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantMessageDroppedEvent.Reason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantStreamAssistResponseEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantUserMessageEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization.ServerSideOAuth2` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization.ServerSideOAuth2.PrivateNetworkConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig.ConnectorMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig.ToolspecOverride` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchCreateTargetSiteMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.FhirMatcher` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.Matcher` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.UrisMatcher` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQueryDestination` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.BigtableColumn` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.BigtableColumnFamily` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Encoding` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingMetricType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch.BranchStats` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BuildActionInvocationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BuildActionInvocationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.AssistantCapability` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.CannedQueryTexts` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.SuggestedPrompt` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryUserView` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelSubscription` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelUnsubscription` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.CheckGroundingFactChunk` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRefreshTokenRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRefreshTokenResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementResponse.MetricQueryResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.AnnotationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.PageSpan` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.StructureType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.StructuredContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Citation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CitationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CliConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CloudSqlSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig.NotebookLMState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectUserEventRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesRequest.EntityTypeFilter` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.EnableMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.QueryTerm` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.TimeRange` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun.Progress` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun.SyncType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.Trigger` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ContactDetails` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.AttributeType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.ControlPoint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.InterpolationType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.FilterAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.PromoteAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.RedirectAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.SynonymsAction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationContext` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationMessage` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAlphaEvolveExperimentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAlphaEvolveProgramRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAssistantRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateCachedContentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateCannedQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateControlRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDataStoreMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDataStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDocumentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEngineMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEvaluationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEvaluationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateIdentityMappingStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSchemaMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSchemaRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateServingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSitemapMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSitemapRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateTargetSiteMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateTargetSiteRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomTuningModel` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomTuningModel.ModelState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.BlockingReason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.ConnectorMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.ConnectorMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.EndUserConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.FederatedConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig.StreamingError` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig.StreamingError.StreamingErrorReason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.SourceEntity` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.SyncMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy.SensitiveDataProtectionPolicy` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig.NlQueryConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig.NlQueryConfig.Nl2SqlExample` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.BillingEstimation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ConfigurableBillingApproach` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbAiNaturalLanguageConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbConnectionConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbConnectionConfig.AuthMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.NotebooklmConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.ThirdPartyOauthConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ServingConfigDataStore` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DebugParams` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DedicatedCrawlRateTimeSeries` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAgentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAlphaEvolveExperimentAndProgramsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAssistantRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCachedContentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCannedQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCmekConfigMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCmekConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCollectionMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCollectionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteControlRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteDataStoreMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteDataStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteDocumentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteEngineMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteIdentityMappingStoreMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteIdentityMappingStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeletePatientFiltersRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSampleQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSampleQuerySetRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSchemaMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSchemaRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteServingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSitemapMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSitemapRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteTargetSiteMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteTargetSiteRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteUserStoreMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeployAgentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeployAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeployAgentResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeploymentInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DestinationConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DestinationConfig.Destination` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DialogflowAgentDefinition` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DistributeLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DistributeLicenseConfigResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.AclInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.AclInfo.AccessRestriction` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.Content` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.IndexStatus` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.OcrParsingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DoubleList` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DynamicTool` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EmbeddingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.AppType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig.AgentCreationConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.CommonConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ConfigurableBillingApproach` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FeatureState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.KnowledgeGraphConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.KnowledgeGraphConfig.FeatureConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MarketplaceAgentVisibility` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.TrainingState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ModelState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EntityType` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EntityTypeOperation` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.FileDataSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.WebsiteDataSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.WebsiteDataSource.EstimatorUriPattern` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec.QuerySetSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionRequest.AssistAnswerInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportMetricsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportMetricsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportMetricsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportUserLicensesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportUserLicensesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity.GroupMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity.UserMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FactChunk` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.ConversationInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.FeedbackSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.FeedbackType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.Reason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Announcements` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Announcements.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentDocuments` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentDocuments.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentEvents` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecommendedDocuments` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecommendedDocuments.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse.Result` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse.Result.DocumentType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDomainVerificationStatusRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDomainVerificationStatusResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchEntitiesTypesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchEntitiesTypesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest.Matcher` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest.UrisMatcher` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsResponse.SitemapMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FhirStoreSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableFieldImportance` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileCharacteristics` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileOriginType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileView` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FirestoreSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GenerateContentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAclConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAlphaEvolveExperimentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAlphaEvolveProgramRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAnalyticsConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAnswerRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAssistAnswerRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAssistantRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetBillingAccountLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetBranchRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCannedQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetChunkRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCmekConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCollectionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCompletionConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConnectorSecretRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConnectorSecretResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetControlRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDataConnectorRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDataStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDocumentProcessingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDocumentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetEvaluationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetIdentityMappingStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProjectRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSampleQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSampleQuerySetRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSchemaRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetServingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSiteSearchEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetTargetSiteRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUserStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWidgetConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWidgetConfigRequest.GetWidgetConfigRequestOption` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWorkspaceSettingsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GroundingFact` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GuidedSearchSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HarmCategory` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HealthcareFhirConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingEntry` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingEntryOperationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityScheduleConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig.ExternalIdpConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig.IdpType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImageCharacteristics` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImageCharacteristics.ColorSpace` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportAgentFileRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportAgentFileResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportIdentityMappingsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportIdentityMappingsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportIdentityMappingsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Interval` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.InvokeConnectorMcpRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.InvokeConnectorMcpResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LanguageInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigUsageStats` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveExperimentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveExperimentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveProgramsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveProgramsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBranchesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBranchesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCannedQueriesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCannedQueriesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCmekConfigsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCmekConfigsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCollectionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCollectionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConnectorRunsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConnectorRunsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListControlsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListControlsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConversationsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConversationsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCustomModelsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCustomModelsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEnginesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEnginesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListFilesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListFilesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingStoresRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingStoresResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsUsageStatsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsUsageStatsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSchemasRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSchemasResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListServingConfigsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListServingConfigsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataResponse.FileMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListTargetSitesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListTargetSitesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListUserLicensesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListUserLicensesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.View` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ManagedAgentDefinition` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.McpError` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.MediaInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ModelInfoView` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig.Mode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OAuth2Credential` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObservabilityConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateResponse.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OrganicCrawlRateTimeSeries` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OutputConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PageInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PanelInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PatientFilterOperationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PauseEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PredictRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Principal` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProcessedDocument` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProgramState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus.AgentSearchTokenSubscriptionStatus` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus.UpdateType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.DataProtectionPolicy` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.DataProtectionPolicy.SensitiveDataProtectionPolicy` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.ModelArmorConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.ResourceAccessControlConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectSessionDisplayNameUpdatedEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectSessionDisplayNameUpdatedEvent.Source` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProvisionProjectMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProvisionProjectRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProvisionProjectRequest.SaasParams` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeErrorConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeIdentityMappingsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeIdentityMappingsRequest.InlineSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeUserEventsMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeUserEventsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeUserEventsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsRequest.TimeRange` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse.DatedUsage` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse.MetricUsage` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.DocumentReference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.DriveDocumentReference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.PersonReference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.UserSuppliedSobiArtifactReference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RawPredictRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendQuestionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendQuestionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo.FailureReason` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo.FailureReason.CorpusType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RefreshTokenInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RejectAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateResponse.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemovePatientFilterRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveSuggestionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveSuggestionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReplacePatientFilterRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Reply` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Reply.Reference` (message) **(deprecated)**
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.ConsentChangeAction` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RequestAgentReviewRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RequiredAuthorization` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.MetricBinding` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ThresholdBinding` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ThresholdBinding.ThresholdValue` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ViolationSamplesBinding` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ResumeEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ResumeExperimentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ResumeExperimentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RetractLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RetractLicenseConfigResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating.HarmProbability` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating.HarmSeverity` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry.Target` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchAddOn` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchLinkPromotion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ExtractiveContentSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.MultiModalSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.MultiModalSpec.ImageSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec.Mode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CustomRankingParams` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DisplaySpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DisplaySpec.MatchHighlightingCondition` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceFilterSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceScoreSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAddonSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Field` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult.RefinementAttribute` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.AndExpression` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint.Comparison` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.OrExpression` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.StringConstraint` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult.OneBoxType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.QueryExpansionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RetrievalSignals` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SemanticState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SessionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment.AttributionType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment.Blob` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Citation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SafetyAttributes` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SummarySkippedReason` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SummaryWithMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTier` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchUseCase` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest.FileSelection` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.GenericConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session.Turn` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig.SessionManagementPolicy` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig.SessionTtl` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionUserInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest.CrawlType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest.Mode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateResponse.State` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUpDataConnectorMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUpDataConnectorRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SingleRegionKey` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteVerificationInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteVerificationInfo.SiteVerificationState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SpannerSource` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StartConnectorRunRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StartExperimentMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StartExperimentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StoreUserAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StoreUserAuthorizationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ActionSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.NoCodeAgentsConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec.AgentSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec.MentionMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AnswerGenerationMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AssistSkippingMode` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext.EncryptionMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext.Tab` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.GenerationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.ImageGenerationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.MapsGroundingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VideoGenerationSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.WebGroundingSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.ConnectorAuthError` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.InvokedSkill` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.SessionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.StatusUpdate` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.ToolResult` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubmitProgramsEvaluationsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubmitProgramsEvaluationsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTerm` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTier` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry.MatchOperator` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason.QuotaFailure` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.IndexingStatus` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Tenant` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TextInput` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TuneEngineMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TuneEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TuneEngineResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TurnStatusUpdateEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TurnStatusUpdateEvent.TurnStatus` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TypingIndicatorEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAclConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAnalyticsConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAssistantRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCannedQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCmekConfigMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCmekConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCollectionMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCollectionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCompletionConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateControlRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDataConnectorRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDataStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDocumentProcessingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateEngineRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateLicenseConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateProjectRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSampleQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSampleQuerySetRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSchemaMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSchemaRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateServingConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateTargetSiteMetadata` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateTargetSiteRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateUserStoreRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateWidgetConfigRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.PreciseLocation` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense.LicenseAssignmentState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserPresenceEvent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserPresenceEvent.PresenceState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ValidateUserAuthorizationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ValidateUserAuthorizationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.VideoCharacteristics` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsInternalRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsInternalResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsSetup` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsSetupComplete` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAccessTokenRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAccessTokenResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAndStoreRefreshTokenRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAndStoreRefreshTokenResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAddContextFileRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAddContextFileResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAdvancedCompleteQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAdvancedCompleteQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAssistRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAssistResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryResponse.WidgetQuerySuggestion` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AccessSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.MapsGroundingType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.WebGroundingType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.BatchAuthStatus` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CollectionComponent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ConnectorAuthState` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ConnectorAuthState.AuthState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig.ComplianceLevel` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig.CustomerType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreComponent` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreComponent.DataStoreConfigType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreUiConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.FacetField` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.HomepageSetting` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.HomepageSetting.Shortcut` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Image` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Node` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Node.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ResultDisplayType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UIComponentField` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UIComponentField.DeviceVisibility` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiBrandingSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.FeatureState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.GenerativeAnswerConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.GenerativeAnswerConfig.ImageSource` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.InteractionType` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel.AdminView` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelState` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.SearchAddonSpec` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConverseConversationRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConverseConversationResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCreateSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCreateSessionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDeleteSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDeleteSessionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDisconnectConnectorRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDisconnectConnectorResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetExecuteActionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetExecuteActionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetGetSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetGetSessionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetHomepageFetchDocumentsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetHomepageFetchDocumentsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetListSessionsRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetListSessionsResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetRemoveContextFileRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetRemoveContextFileResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSearchRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSearchResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSelectContextFilesRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSelectContextFilesResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetUpdateSessionRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetUpdateSessionResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetWriteUserEventRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetWriteUserEventResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WithdrawAgentRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig.Type` (enum)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceSettings` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteAgentTrajectoryRequest` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteAgentTrajectoryResponse` (message)
- `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteUserEventRequest` (message)

## AclConfigService

Service for managing Acl Configuration.

| GetAclConfig |
|---|
| `` rpc GetAclConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAclConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig`) `` Gets the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.aclConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAclConfig |
|---|
| `` rpc UpdateAclConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAclConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig`) `` Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.aclConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## AgentService

Service for managing agents.

| CreateAgent |
|---|
| `` rpc CreateAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Creates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.agents.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteAgent |
|---|
| `` rpc DeleteAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeployAgent |
|---|
| `` rpc DeployAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeployAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deploys an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetAgent |
|---|
| `` rpc GetAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Gets an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportAgentFile |
|---|
| `` rpc ImportAgentFile(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportAgentFileRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportAgentFileResponse`) `` Imports a file to an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Currently only No-Code agents are supported. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.agentFiles.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListAgents |
|---|
| `` rpc ListAgents(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`s under an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` which were created by the caller. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.agents.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RejectAgent |
|---|
| `` rpc RejectAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RejectAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Rejects an Agent offered to the public. The `state` of the Agent becomes `PRIVATE`. Can be called on an Agent in the state `DISABLED`, otherwise it returns an error. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.manage` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RequestAgentReview |
|---|
| `` rpc RequestAgentReview(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RequestAgentReviewRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Presents an Agent to admins by making it available for review. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `PRIVATE`, otherwise it returns an error. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.requestReview` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAgent |
|---|
| `` rpc UpdateAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Updates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| WithdrawAgent |
|---|
| `` rpc WithdrawAgent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WithdrawAgentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`) `` Withdraws an Agent offered to the public. The `state` of the Agent becomes `PRIVATE`. Can only be called by the owner of the Agent, regardless of the Agent's state, otherwise it returns an error. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.agents.requestReview` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## AlphaEvolveService

Service for managing Alpha Evolve experiments and programs.

| AcquirePrograms |
|---|
| `` rpc AcquirePrograms(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireProgramsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireProgramsResponse`) `` Acquires one or more `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram` from the generated queue of programs for evaluation. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateAlphaEvolveExperiment |
|---|
| `` rpc CreateAlphaEvolveExperiment(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAlphaEvolveExperimentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`) `` Creates a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateAlphaEvolveProgram |
|---|
| `` rpc CreateAlphaEvolveProgram(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAlphaEvolveProgramRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`) `` Creates a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteAlphaEvolveExperimentAndPrograms |
|---|
| `` rpc DeleteAlphaEvolveExperimentAndPrograms(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAlphaEvolveExperimentAndProgramsRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded). Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetAlphaEvolveExperiment |
|---|
| `` rpc GetAlphaEvolveExperiment(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAlphaEvolveExperimentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`) `` Get an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetAlphaEvolveProgram |
|---|
| `` rpc GetAlphaEvolveProgram(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAlphaEvolveProgramRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`) `` Gets an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListAlphaEvolveExperiments |
|---|
| `` rpc ListAlphaEvolveExperiments(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveExperimentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveExperimentsResponse`) `` List all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`s in a given session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListAlphaEvolvePrograms |
|---|
| `` rpc ListAlphaEvolvePrograms(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveProgramsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAlphaEvolveProgramsResponse`) `` List all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`s in a given experiment that follow the criteria provided in the request. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ResumeExperiment |
|---|
| `` rpc ResumeExperiment(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ResumeExperimentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Resumes a workflow to process the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| StartExperiment |
|---|
| `` rpc StartExperiment(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StartExperimentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Starts a workflow to process the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| SubmitProgramsEvaluations |
|---|
| `` rpc SubmitProgramsEvaluations(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubmitProgramsEvaluationsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubmitProgramsEvaluationsResponse`) `` Adds an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluation` to the experiment. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## AnalyticsService

Service for managing \& accessing Analytics.

| ExportMetrics |
|---|
| `` rpc ExportMetrics(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportMetricsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Exports metrics. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetAnalyticsConfig |
|---|
| `` rpc GetAnalyticsConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAnalyticsConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnalyticsConfig`) `` Gets the AnalyticsConfig. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateAnalyticsConfig |
|---|
| `` rpc UpdateAnalyticsConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAnalyticsConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnalyticsConfig`) `` Updates the AnalyticsConfig for analytics. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## AssistAnswerService

Service for querying `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` resources.

| GetAssistAnswer |
|---|
| `` rpc GetAssistAnswer(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAssistAnswerRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer`) `` Gets an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistAnswers.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## AssistantService

Service for managing Assistant configuration and assisting users.

| AddContextFile |
|---|
| `` rpc AddContextFile(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse`) `` Uploads a context file to use as source for the assist calls within the session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.addContextFile` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| Assist |
|---|
| `` rpc Assist(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse`) `` Assists the user with a query. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateAssistant |
|---|
| `` rpc CreateAssistant(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAssistantRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`) `` Creates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.assistants.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateCachedContent |
|---|
| `` rpc CreateCachedContent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateCachedContentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Creates an explicit context cache (Vertex `CachedContent`); its `name` is passed as `cachedContent` on subsequent GenerateContent requests. Limited to Gemini Enterprise clients (ASSISTANT_USER visibility). Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteAssistant |
|---|
| `` rpc DeleteAssistant(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAssistantRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteCachedContent |
|---|
| `` rpc DeleteCachedContent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCachedContentRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a context cache created by CreateCachedContent (releases storage before TTL). Limited to Gemini Enterprise clients (ASSISTANT_USER visibility). Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GenerateContent |
|---|
| `` rpc GenerateContent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GenerateContentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Generates content from a model on behalf of a first-party Gemini Enterprise client (unary). Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetAssistant |
|---|
| `` rpc GetAssistant(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAssistantRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`) `` Gets an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListAssistants |
|---|
| `` rpc ListAssistants(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`s under an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.assistants.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSessionFileMetadata |
|---|
| `` rpc ListSessionFileMetadata(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataResponse`) `` Lists metadata for all files in the current session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.listSessionFileMetadata` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| Predict |
|---|
| `` rpc Predict(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PredictRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Serves a unary prediction from a model on behalf of a first-party Gemini Enterprise client. This is the predict path used for text embedding models. Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RecommendQuestions |
|---|
| `` rpc RecommendQuestions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendQuestionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendQuestionsResponse`) `` Gets recommended questions for the given session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.recommendQuestions` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RemoveContextFile |
|---|
| `` rpc RemoveContextFile(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileResponse`) `` Removes a context file from a session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.removeContextFile` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SelectContextFiles |
|---|
| `` rpc SelectContextFiles(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesResponse`) `` Selects context files to be used in a session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.selectContextFiles` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamAssist |
|---|
| `` rpc StreamAssist(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse`) `` Assists the user with a query in a streaming fashion. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamGenerateContent |
|---|
| `` rpc StreamGenerateContent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GenerateContentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Server-streaming variant of GenerateContent. This is the main chat path. Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamRawPredict |
|---|
| `` rpc StreamRawPredict(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RawPredictRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Server-streaming raw prediction, for models that use a raw request/response protocol rather than the generateContent shape. Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.assist` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAssistant |
|---|
| `` rpc UpdateAssistant(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAssistantRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`) `` Updates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.assistants.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| WatchLiveEventsInternal |
|---|
| `` rpc WatchLiveEventsInternal(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsInternalRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsInternalResponse`) `` Monitors live events in a bidirectional streaming fashion. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## AuthorizationService

Service for managing authorizations.

| AcquireUserAuthorization |
|---|
| `` rpc AcquireUserAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationResponse`) `` Uses the stored refresh token for the user identified by their end-user credentials and the given resource, and returns the generated access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.authorizations.storeUserAuthorization` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateAuthorization |
|---|
| `` rpc CreateAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`) `` Creates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.authorizations.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteAuthorization |
|---|
| `` rpc DeleteAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteAuthorizationRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.authorizations.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetAuthorization |
|---|
| `` rpc GetAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`) `` Gets an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.authorizations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListAuthorizations |
|---|
| `` rpc ListAuthorizations(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`s under an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.authorizations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StoreUserAuthorization |
|---|
| `` rpc StoreUserAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StoreUserAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StoreUserAuthorizationResponse`) `` Exchanges OAuth authorization credentials for a refresh token and stores the refresh token and the scopes. The stored data will be keyed by the resource name and the user identifier from the end-user credentials. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.authorizations.storeUserAuthorization` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAuthorization |
|---|
| `` rpc UpdateAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`) `` Updates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.authorizations.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ValidateUserAuthorization |
|---|
| `` rpc ValidateUserAuthorization(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ValidateUserAuthorizationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ValidateUserAuthorizationResponse`) `` Validates an A2A 3-legged-OAuth (3LO) downstream-auth consent flow after the user returns from the third-party consent screen, and finalizes the downstream credential with Auth Manager. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## BranchService

Service for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch` Management

`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`es are automatically created when a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is created. There are fixed three branches in each data store, and may use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchService.ListBranches` method to get the details of all branches.

| GetBranch |
|---|
| `` rpc GetBranch(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetBranchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`) `` Retrieves a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.branches.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListBranches |
|---|
| `` rpc ListBranches(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBranchesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBranchesResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`s under the specified parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.branches.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## CannedQueryService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` configuration.

| CreateCannedQuery |
|---|
| `` rpc CreateCannedQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateCannedQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.cannedQueries.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteCannedQuery |
|---|
| `` rpc DeleteCannedQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCannedQueryRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cannedQueries.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetCannedQuery |
|---|
| `` rpc GetCannedQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCannedQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cannedQueries.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListActiveCannedQueryUserViews |
|---|
| `` rpc ListActiveCannedQueryUserViews(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsResponse`) `` Lists the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryUserView`s for all active `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.cannedQueries.listActiveCannedQueryUserViews` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListCannedQueries |
|---|
| `` rpc ListCannedQueries(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCannedQueriesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCannedQueriesResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`s under an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.cannedQueries.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateCannedQuery |
|---|
| `` rpc UpdateCannedQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCannedQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cannedQueries.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ChunkService

Service for displaying processed `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` information of the customer's unstructured data.

| GetChunk |
|---|
| `` rpc GetChunk(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetChunkRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListChunks |
|---|
| `` rpc ListChunks(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## CmekConfigService

Service for managing CMEK related tasks

| DeleteCmekConfig |
|---|
| `` rpc DeleteCmekConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCmekConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` De-provisions a CmekConfig. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cmekConfigs.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetCmekConfig |
|---|
| `` rpc GetCmekConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCmekConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`) `` Gets the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cmekConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListCmekConfigs |
|---|
| `` rpc ListCmekConfigs(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCmekConfigsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCmekConfigsResponse`) `` Lists all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`s with the project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.cmekConfigs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateCmekConfig |
|---|
| `` rpc UpdateCmekConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCmekConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.cmekConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## CollectionService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`s.

| DeleteCollection |
|---|
| `` rpc DeleteCollection(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteCollectionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.collections.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetCollection |
|---|
| `` rpc GetCollection(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCollectionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.collections.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetIamPolicy |
|---|
| `` rpc GetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.GetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Gets the IAM access control policy for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.collections.getIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListCollections |
|---|
| `` rpc ListCollections(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCollectionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCollectionsResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.collections.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SetIamPolicy |
|---|
| `` rpc SetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.SetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Sets the IAM access control policy for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.collections.setIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateCollection |
|---|
| `` rpc UpdateCollection(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCollectionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## CompletionService

Service for Auto-Completion.

| AdvancedCompleteQuery |
|---|
| `` rpc AdvancedCompleteQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse`) `` Completes the user input with advanced keyword suggestions. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/cloud_search.query` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.complete_query` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `completionConfig` resource: - `discoveryengine.completionConfigs.completeQuery` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CompleteExternalIdentities |
|---|
| `` rpc CompleteExternalIdentities(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesResponse`) `` This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.locations.completeExternalIdentities` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CompleteQuery |
|---|
| `` rpc CompleteQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse`) `` Completes the specified user input with keyword suggestions. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `dataStore` resource: - `discoveryengine.dataStores.completeQuery` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportCompletionSuggestions |
|---|
| `` rpc ImportCompletionSuggestions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Imports `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion`s for a DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.completionSuggestions.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportSuggestionDenyListEntries |
|---|
| `` rpc ImportSuggestionDenyListEntries(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Imports all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry` for a DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.suggestionDenyListEntries.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PurgeCompletionSuggestions |
|---|
| `` rpc PurgeCompletionSuggestions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Permanently deletes all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion`s for a DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.completionSuggestions.purge` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PurgeSuggestionDenyListEntries |
|---|
| `` rpc PurgeSuggestionDenyListEntries(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Permanently deletes all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry` for a DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.suggestionDenyListEntries.purge` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RemoveSuggestion |
|---|
| `` rpc RemoveSuggestion(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveSuggestionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveSuggestionResponse`) `` Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.RecentSearchSuggestion.google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.recent_search_suggestions` for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `completionConfig` resource: - `discoveryengine.completionConfigs.removeSuggestion` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ContentExportService

Service for exportation of Content.

## ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

| CreateControl |
|---|
| `` rpc CreateControl(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateControlRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control`) `` Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` to create already exists, an ALREADY_EXISTS error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.controls.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteControl |
|---|
| `` rpc DeleteControl(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteControlRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a Control. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` to delete does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.controls.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetControl |
|---|
| `` rpc GetControl(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetControlRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control`) `` Gets a Control. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.controls.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListControls |
|---|
| `` rpc ListControls(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListControlsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListControlsResponse`) `` Lists all Controls by their parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.controls.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateControl |
|---|
| `` rpc UpdateControl(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateControlRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control`) `` Updates a Control. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` action type cannot be changed. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` to update does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.controls.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ConversationalSearchService

Service for conversational search.

| AnswerQuery |
|---|
| `` rpc AnswerQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse`) `` Answer query method. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `servingConfig` resource: - `discoveryengine.servingConfigs.answer` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ConverseConversation |
|---|
| `` rpc ConverseConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationResponse`) `` Converses a conversation. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.conversations.converse` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateConversation |
|---|
| `` rpc CreateConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateConversationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation`) `` Creates a Conversation. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` to create already exists, an ALREADY_EXISTS error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.conversations.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateSession |
|---|
| `` rpc CreateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Creates a Session. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to create already exists, an ALREADY_EXISTS error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sessions.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteConversation |
|---|
| `` rpc DeleteConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteConversationRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a Conversation. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` to delete does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.conversations.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSession |
|---|
| `` rpc DeleteSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSessionRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a Session. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to delete does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetAnswer |
|---|
| `` rpc GetAnswer(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetAnswerRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer`) `` Gets a Answer. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.answers.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetConversation |
|---|
| `` rpc GetConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConversationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation`) `` Gets a Conversation. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.conversations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSession |
|---|
| `` rpc GetSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Gets a Session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListConversations |
|---|
| `` rpc ListConversations(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConversationsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConversationsResponse`) `` Lists all Conversations by their parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.conversations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSessions |
|---|
| `` rpc ListSessions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsResponse`) `` Lists all Sessions by their parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sessions.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamAnswerQuery |
|---|
| `` rpc StreamAnswerQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse`) `` Answer query method (streaming). It takes one `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` and returns multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse` messages in a stream. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `servingConfig` resource: - `discoveryengine.servingConfigs.answer` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateConversation |
|---|
| `` rpc UpdateConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateConversationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation`) `` Updates a Conversation. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` action type cannot be changed. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` to update does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.conversations.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateSession |
|---|
| `` rpc UpdateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Updates a Session. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` action type cannot be changed. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to update does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## CrawlRateManagementService

Service for managing crawl rate.

| ObtainCrawlRate |
|---|
| `` rpc ObtainCrawlRate(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateResponse`) `` Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| RemoveDedicatedCrawlRate |
|---|
| `` rpc RemoveDedicatedCrawlRate(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| SetDedicatedCrawlRate |
|---|
| `` rpc SetDedicatedCrawlRate(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## DataConnectorMcpService

DataConnectorMcpService is the MCP service for Data Connectors.

| ServeMcpDeleteRequest |
|---|
| `` rpc ServeMcpDeleteRequest(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` ServeMcpDeleteRequest serves a MCP DELETE request. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ServeMcpGetRequest |
|---|
| `` rpc ServeMcpGetRequest(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` ServeMcpGetRequest serves a MCP GET request. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ServeMcpPostRequest |
|---|
| `` rpc ServeMcpPostRequest(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` ServeMcpPostRequest serves a MCP POST request. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## DataConnectorService

Service for data connector management.

| AcquireAccessToken |
|---|
| `` rpc AcquireAccessToken(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenResponse`) `` Uses the per-user refresh token minted with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAndStoreRefreshToken` to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.acquireAccessToken` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| AcquireAndStoreRefreshToken |
|---|
| `` rpc AcquireAndStoreRefreshToken(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenResponse`) `` Exchanges OAuth authorization credentials for a refresh token and stores the refresh token and the scopes. The stored data will be keyed by the connector name and the user identifier from the EUC. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.acquireAndStoreRefreshToken` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| BuildActionInvocation |
|---|
| `` rpc BuildActionInvocation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BuildActionInvocationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BuildActionInvocationResponse`) `` Builds an action invocation using the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.buildActionInvocation` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CheckRefreshToken |
|---|
| > [!WARNING] > This item is deprecated! `` rpc CheckRefreshToken(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRefreshTokenRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRefreshTokenResponse`) `` Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAccessToken` instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.checkRefreshToken` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ExecuteAction |
|---|
| `` rpc ExecuteAction(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionResponse`) `` Executes a 3rd party action using the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.executeAction` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| FetchEntitiesTypes |
|---|
| `` rpc FetchEntitiesTypes(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchEntitiesTypesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchEntitiesTypesResponse`) `` Fetch the entities types for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetConnectorSecret |
|---|
| `` rpc GetConnectorSecret(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConnectorSecretRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetConnectorSecretResponse`) `` Get the secret for the associated connector. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDataConnector |
|---|
| `` rpc GetDataConnector(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDataConnectorRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`) `` Gets the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` is a singleton resource for each `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| InvokeConnectorMcp |
|---|
| `` rpc InvokeConnectorMcp(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.InvokeConnectorMcpRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.InvokeConnectorMcpResponse`) `` Makes a call to an MCP connector. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.executeAction` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListConnectorRuns |
|---|
| `` rpc ListConnectorRuns(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConnectorRunsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListConnectorRunsResponse`) `` Lists the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`s of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.connectorRuns.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SetUpDataConnector |
|---|
| `` rpc SetUpDataConnector(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUpDataConnectorRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` and sets up the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` for it. To stop a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` after setup, use the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.DeleteCollection` method. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.locations.setUpDataConnector` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StartConnectorRun |
|---|
| `` rpc StartConnectorRun(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StartConnectorRunRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`) `` Starts an immediate synchronization process for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.dataConnectors.startConnectorRun` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateDataConnector |
|---|
| `` rpc UpdateDataConnector(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDataConnectorRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataConnectors.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## DataStoreService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` configuration.

| AddPatientFilter |
|---|
| `` rpc AddPatientFilter(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddPatientFilterRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateDataStore |
|---|
| `` rpc CreateDataStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDataStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. DataStore is for storing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. To serve these documents for Search, or Recommendation use case, an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` needs to be created separately. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.dataStores.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteDataStore |
|---|
| `` rpc DeleteDataStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteDataStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataStores.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeletePatientFilters |
|---|
| `` rpc DeletePatientFilters(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeletePatientFiltersRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetCompletionConfig |
|---|
| `` rpc GetCompletionConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetCompletionConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.completionConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDataStore |
|---|
| `` rpc GetDataStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDataStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataStores.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDocumentProcessingConfig |
|---|
| `` rpc GetDocumentProcessingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDocumentProcessingConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documentProcessingConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetIamPolicy |
|---|
| `` rpc GetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.GetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Gets the IAM access control policy for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.dataStores.getIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListDataStores |
|---|
| `` rpc ListDataStores(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresResponse`) `` Lists all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s associated with the project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.dataStores.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RemovePatientFilter |
|---|
| `` rpc RemovePatientFilter(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemovePatientFilterRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ReplacePatientFilter |
|---|
| `` rpc ReplacePatientFilter(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReplacePatientFilterRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| SetIamPolicy |
|---|
| `` rpc SetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.SetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Sets the IAM access control policy for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.dataStores.setIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateCompletionConfig |
|---|
| `` rpc UpdateCompletionConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateCompletionConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig`) `` Updates the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.completionConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateDataStore |
|---|
| `` rpc UpdateDataStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDataStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.dataStores.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateDocumentProcessingConfig |
|---|
| `` rpc UpdateDocumentProcessingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDocumentProcessingConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`) `` Updates the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` is a singleton resource of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. It's empty when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is created. The first call to this method will set up `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`. The `update_mask` query parameter is not supported; if it is set the request returns an error. To update mutable fields, omit `update_mask` and send the full `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` as the request body. The entire resource is overwritten, so include all values you want to retain. For example, to update the layout parser, set `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.default_parsing_config` (or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfigOverridesEntry.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.parsing_config_overrides`) and omit `update_mask`. Some fields, such as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.chunking_config`, are immutable and return an error if changed. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documentProcessingConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## DocumentService

Service for ingesting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` information of the customer's website.

| BatchGetDocumentsMetadata |
|---|
| `` rpc BatchGetDocumentsMetadata(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse`) `` Gets index freshness metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. Supported for website search only. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.documents.batchGetDocumentsMetadata` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateDocument |
|---|
| `` rpc CreateDocument(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDocumentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.documents.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteDocument |
|---|
| `` rpc DeleteDocument(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteDocumentRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documents.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDocument |
|---|
| `` rpc GetDocument(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDocumentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documents.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetProcessedDocument |
|---|
| `` rpc GetProcessedDocument(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProcessedDocument`) `` Gets the parsed layout information for a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documents.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportDocuments |
|---|
| `` rpc ImportDocuments(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Bulk import of multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s to be successfully updated. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.documents.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListDocuments |
|---|
| `` rpc ListDocuments(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.documents.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PurgeDocuments |
|---|
| `` rpc PurgeDocuments(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Permanently deletes all selected `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s in a branch. This process is asynchronous. Depending on the number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s to be deleted, this operation can take hours to complete. Before the delete operation completes, some `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s might still be returned by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments`. To get a list of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s to be deleted, set `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force` to false. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.documents.purge` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateDocument |
|---|
| `` rpc UpdateDocument(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.documents.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## EngineService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` configuration.

| CreateEngine |
|---|
| `` rpc CreateEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.engines.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteEngine |
|---|
| `` rpc DeleteEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetEngine |
|---|
| `` rpc GetEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`) `` Gets an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetIamPolicy |
|---|
| `` rpc GetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.GetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Gets the IAM access control policy for an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.engines.getIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetWorkspaceSettings |
|---|
| `` rpc GetWorkspaceSettings(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWorkspaceSettingsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceSettings`) `` Get Workspace settings for the end user. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListEngines |
|---|
| `` rpc ListEngines(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEnginesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEnginesResponse`) `` Lists all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s associated with the project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.engines.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PauseEngine |
|---|
| `` rpc PauseEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PauseEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`) `` Pauses the training of an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.pause` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ResumeEngine |
|---|
| `` rpc ResumeEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ResumeEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`) `` Resumes the training of an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.resume` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SetIamPolicy |
|---|
| `` rpc SetIamPolicy(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.SetIamPolicyRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.iam.v1#google.iam.v1.Policy`) `` Sets the IAM access control policy for an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `resource` resource: - `discoveryengine.engines.setIamPolicy` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| TuneEngine |
|---|
| `` rpc TuneEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TuneEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Tunes an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.tune` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateEngine |
|---|
| `` rpc UpdateEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`) `` Updates an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.engines.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## EstimateBillingService

Service for managing billing estimations resources.

| EstimateDataSize |
|---|
| `` rpc EstimateDataSize(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Estimates the data size to be used by a customer. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `location` resource: - `discoveryengine.locations.estimateDataSize` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## EvaluationService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`s,

| CreateEvaluation |
|---|
| `` rpc CreateEvaluation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEvaluationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`. Upon creation, the evaluation will be automatically triggered and begin execution. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.evaluations.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetEvaluation |
|---|
| `` rpc GetEvaluation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetEvaluationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.evaluations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListEvaluationResults |
|---|
| `` rpc ListEvaluationResults(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse`) `` Gets a list of results for a given a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `evaluation` resource: - `discoveryengine.evaluations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListEvaluations |
|---|
| `` rpc ListEvaluations(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.evaluations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## GroundedGenerationService

Service for grounded generation.

| CheckGrounding |
|---|
| `` rpc CheckGrounding(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse`) `` Performs a grounding check. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `groundingConfig` resource: - `discoveryengine.groundingConfigs.check` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## IdentityMappingStoreService

Service for managing Identity Mapping Stores.

| CreateIdentityMappingStore |
|---|
| `` rpc CreateIdentityMappingStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateIdentityMappingStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore`) `` Creates a new Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.identityMappingStores.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteIdentityMappingStore |
|---|
| `` rpc DeleteIdentityMappingStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteIdentityMappingStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes the Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.identityMappingStores.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetIdentityMappingStore |
|---|
| `` rpc GetIdentityMappingStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetIdentityMappingStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore`) `` Gets the Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.identityMappingStores.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportIdentityMappings |
|---|
| `` rpc ImportIdentityMappings(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportIdentityMappingsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Imports a list of Identity Mapping Entries to an Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `identityMappingStore` resource: - `discoveryengine.identityMappingStores.importIdentityMappings` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListIdentityMappingStores |
|---|
| `` rpc ListIdentityMappingStores(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingStoresRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingStoresResponse`) `` Lists all Identity Mapping Stores. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.identityMappingStores.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListIdentityMappings |
|---|
| `` rpc ListIdentityMappings(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListIdentityMappingsResponse`) `` Lists Identity Mappings in an Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `identityMappingStore` resource: - `discoveryengine.identityMappingStores.listIdentityMappings` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PurgeIdentityMappings |
|---|
| `` rpc PurgeIdentityMappings(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeIdentityMappingsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Purges specified or all Identity Mapping Entries from an Identity Mapping Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `identityMappingStore` resource: - `discoveryengine.identityMappingStores.purgeIdentityMappings` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## LicenseConfigService

Service for managing license config related resources.

| CreateLicenseConfig |
|---|
| `` rpc CreateLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.licenseConfigs.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DistributeLicenseConfig |
|---|
| `` rpc DistributeLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DistributeLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DistributeLicenseConfigResponse`) `` Distributes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` from billing account level to project level. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `billingAccountLicenseConfig` resource: - `discoveryengine.billingAccountLicenseConfigs.distribute` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetBillingAccountLicenseConfig |
|---|
| `` rpc GetBillingAccountLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetBillingAccountLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.billingAccountLicenseConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetLicenseConfig |
|---|
| `` rpc GetLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.licenseConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListBillingAccountLicenseConfigs |
|---|
| `` rpc ListBillingAccountLicenseConfigs(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsResponse`) `` Lists all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`s for a given billing account. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.billingAccountLicenseConfigs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListLicenseConfigs |
|---|
| `` rpc ListLicenseConfigs(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsResponse`) `` Lists all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`s associated with the project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.licenseConfigs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RetractLicenseConfig |
|---|
| `` rpc RetractLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RetractLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RetractLicenseConfigResponse`) `` This method is called from the billing account side to retract the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` from the given project back to the billing account. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `billingAccountLicenseConfig` resource: - `discoveryengine.billingAccountLicenseConfigs.retract` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateLicenseConfig |
|---|
| `` rpc UpdateLicenseConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateLicenseConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`) `` Updates the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.licenseConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## MetricService

Service for metric management.

## PodcastService

Service for managing `Podcast` configuration.

## ProjectService

Service for operations on the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`.

| GetProject |
|---|
| `` rpc GetProject(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProjectRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`. Returns NOT_FOUND when the project is not yet created. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.projects.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ProvisionProject |
|---|
| `` rpc ProvisionProject(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProvisionProjectRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.projects.provision` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| QueryConfigurablePricingUsageStats |
|---|
| `` rpc QueryConfigurablePricingUsageStats(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse`) `` Queries configurable pricing usage stats for a project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `project` resource: - `discoveryengine.projects.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ReportConsentChange |
|---|
| `` rpc ReportConsentChange(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`) `` Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: - [Terms for data use](https://cloud.google.com/retail/data-use-terms) Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `project` resource: - `discoveryengine.projects.reportConsentChange` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateProject |
|---|
| `` rpc UpdateProject(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateProjectRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`) `` Updates the editable settings of a Discovery Engine Project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.projects.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## RankService

Service for ranking text records.

| Rank |
|---|
| `` rpc Rank(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankResponse`) `` Ranks a list of text records based on the given input query. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `rankingConfig` resource: - `discoveryengine.rankingConfigs.rank` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## RecommendationService

Service for making recommendations.

| Recommend |
|---|
| `` rpc Recommend(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse`) `` Makes a recommendation, which requires a contextual user event. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `servingConfig` resource: - `discoveryengine.servingConfigs.recommend` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## RequirementService

Service for requirement management.

| CheckRequirement |
|---|
| `` rpc CheckRequirement(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementResponse`) `` Check a particular requirement. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## SampleQueryService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s,

| CreateSampleQuery |
|---|
| `` rpc CreateSampleQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sampleQueries.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSampleQuery |
|---|
| `` rpc DeleteSampleQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSampleQueryRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQueries.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSampleQuery |
|---|
| `` rpc GetSampleQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSampleQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQueries.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportSampleQueries |
|---|
| `` rpc ImportSampleQueries(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Bulk import of multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s to be successfully imported. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sampleQueries.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSampleQueries |
|---|
| `` rpc ListSampleQueries(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sampleQueries.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateSampleQuery |
|---|
| `` rpc UpdateSampleQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSampleQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQueries.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SampleQuerySetService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s,

| CreateSampleQuerySet |
|---|
| `` rpc CreateSampleQuerySet(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sampleQuerySets.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSampleQuerySet |
|---|
| `` rpc DeleteSampleQuerySet(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSampleQuerySetRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQuerySets.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSampleQuerySet |
|---|
| `` rpc GetSampleQuerySet(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSampleQuerySetRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQuerySets.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSampleQuerySets |
|---|
| `` rpc ListSampleQuerySets(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sampleQuerySets.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateSampleQuerySet |
|---|
| `` rpc UpdateSampleQuerySet(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSampleQuerySetRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sampleQuerySets.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SchemaService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`s.

| CreateSchema |
|---|
| `` rpc CreateSchema(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSchemaRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.schemas.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSchema |
|---|
| `` rpc DeleteSchema(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSchemaRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.schemas.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSchema |
|---|
| `` rpc GetSchema(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSchemaRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.schemas.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSchemas |
|---|
| `` rpc ListSchemas(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSchemasRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSchemasResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.schemas.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateSchema |
|---|
| `` rpc UpdateSchema(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSchemaRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.schemas.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SearchService

Service for search.

| Search |
|---|
| `` rpc Search(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse`) `` Performs a search. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `servingConfig` resource: - `discoveryengine.servingConfigs.search` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SearchLite |
|---|
| `` rpc SearchLite(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse`) `` Performs a search. Similar to the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` instead with required OAuth and IAM checks to provide better data security. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## SearchTuningService

Service for search tuning.

| ListCustomModels |
|---|
| `` rpc ListCustomModels(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCustomModelsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCustomModelsResponse`) `` Gets a list of all the custom models. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `dataStore` resource: - `discoveryengine.dataStores.listCustomModels` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| TrainCustomModel |
|---|
| `` rpc TrainCustomModel(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Trains a custom model. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `dataStore` resource: - `discoveryengine.dataStores.trainCustomModel` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ServingConfigService

Service for operations related to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`.

| CreateServingConfig |
|---|
| `` rpc CreateServingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateServingConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`) `` Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`s are allowed in an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, otherwise a RESOURCE_EXHAUSTED error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.servingConfigs.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteServingConfig |
|---|
| `` rpc DeleteServingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteServingConfigRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.servingConfigs.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetServingConfig |
|---|
| `` rpc GetServingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetServingConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`) `` Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.servingConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListServingConfigs |
|---|
| `` rpc ListServingConfigs(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListServingConfigsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListServingConfigsResponse`) `` Lists all ServingConfigs linked to this dataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.servingConfigs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateServingConfig |
|---|
| `` rpc UpdateServingConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateServingConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`) `` Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.servingConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SessionService

Service for managing Sessions and Session-related resources.

| CreateSession |
|---|
| `` rpc CreateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Creates a Session. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to create already exists, an ALREADY_EXISTS error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sessions.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSession |
|---|
| `` rpc DeleteSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSessionRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes a Session. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to delete does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSession |
|---|
| `` rpc GetSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Gets a Session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListFiles |
|---|
| `` rpc ListFiles(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListFilesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListFilesResponse`) `` Lists metadata for all files in the current session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sessions.listSessionFileMetadata` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListSessions |
|---|
| `` rpc ListSessions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsResponse`) `` Lists all Sessions by their parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sessions.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateSession |
|---|
| `` rpc UpdateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`) `` Updates a Session. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` action type cannot be changed. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to update does not exist, a NOT_FOUND error is returned. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sessions.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SiteSearchEngineService

Service for managing site search related resources.

| BatchCreateTargetSites |
|---|
| `` rpc BatchCreateTargetSites(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` in a batch. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.targetSites.batchCreate` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| BatchVerifyTargetSites |
|---|
| `` rpc BatchVerifyTargetSites(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.siteSearchEngines.batchVerifyTargetSites` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateSitemap |
|---|
| `` rpc CreateSitemap(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSitemapRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sitemaps.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateTargetSite |
|---|
| `` rpc CreateTargetSite(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateTargetSiteRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.targetSites.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteSitemap |
|---|
| `` rpc DeleteSitemap(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSitemapRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.sitemaps.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteTargetSite |
|---|
| `` rpc DeleteTargetSite(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteTargetSiteRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.targetSites.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DisableAdvancedSiteSearch |
|---|
| `` rpc DisableAdvancedSiteSearch(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Downgrade from advanced site search to basic site search. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `siteSearchEngine` resource: - `discoveryengine.siteSearchEngines.disableAdvancedSiteSearch` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| EnableAdvancedSiteSearch |
|---|
| `` rpc EnableAdvancedSiteSearch(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Upgrade from basic site search to advanced site search. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `siteSearchEngine` resource: - `discoveryengine.siteSearchEngines.enableAdvancedSiteSearch` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| FetchDomainVerificationStatus |
|---|
| `` rpc FetchDomainVerificationStatus(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDomainVerificationStatusRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDomainVerificationStatusResponse`) `` Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `siteSearchEngine` resource: - `discoveryengine.siteSearchEngines.fetchDomainVerificationStatus` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| FetchSitemaps |
|---|
| `` rpc FetchSitemaps(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsResponse`) `` Fetch `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s in a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.sitemaps.fetch` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetSiteSearchEngine |
|---|
| `` rpc GetSiteSearchEngine(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSiteSearchEngineRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`) `` Gets the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.siteSearchEngines.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetTargetSite |
|---|
| `` rpc GetTargetSite(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetTargetSiteRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.targetSites.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetUriPatternDocumentData |
|---|
| `` rpc GetUriPatternDocumentData(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataResponse`) `` Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListTargetSites |
|---|
| `` rpc ListTargetSites(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListTargetSitesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListTargetSitesResponse`) `` Gets a list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`s. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.targetSites.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RecrawlUris |
|---|
| `` rpc RecrawlUris(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Request on-demand recrawl for a list of URIs. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `siteSearchEngine` resource: - `discoveryengine.siteSearchEngines.recrawlUris` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| SetUriPatternDocumentData |
|---|
| `` rpc SetUriPatternDocumentData(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateTargetSite |
|---|
| `` rpc UpdateTargetSite(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateTargetSiteRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.targetSites.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## UserEventService

Service for ingesting end user actions on a website to Discovery Engine API.

| CollectUserEvent |
|---|
| `` rpc CollectUserEvent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectUserEventRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody`) `` Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ImportUserEvents |
|---|
| `` rpc ImportUserEvents(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userEvents.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| PurgeUserEvents |
|---|
| `` rpc PurgeUserEvents(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeUserEventsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userEvents.purge` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| WriteAgentTrajectory |
|---|
| `` rpc WriteAgentTrajectory(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteAgentTrajectoryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteAgentTrajectoryResponse`) `` Writes the execution trajectory of a single agent turn for internal observability logging. This method is used by first-party agent clients (for example, the Gemini Enterprise desktop Cowork agent). Logging is gated on the engine's ObservabilityConfig; content-bearing attributes are redacted unless sensitive-content logging is enabled, and the trajectory is written as a JSON object to a fixed Google-internal GCS bucket for debugging (never to a customer project). It is NOT persisted to the user event or recommendation store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.engines.createEngineUserData` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| WriteUserEvent |
|---|
| `` rpc WriteUserEvent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteUserEventRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent`) `` Writes a single user event. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userEvents.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## UserLicenseService

Service for managing User Licenses.

| BatchUpdateUserLicenses |
|---|
| `` rpc BatchUpdateUserLicenses(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates the User License. This method is used for batch assign/unassign licenses to users. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userStores.batchUpdateUserLicenses` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ExportUserLicenses |
|---|
| `` rpc ExportUserLicenses(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportUserLicensesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportUserLicensesResponse`) `` Exports all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense`s under the parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListUserLicenses` read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExportUserLicensesResponse.FIELDS.bytes.google.cloud.discoveryengine.v1alpha.ExportUserLicensesResponse.csv_data`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userStores.listUserLicenses` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListLicenseConfigsUsageStats |
|---|
| `` rpc ListLicenseConfigsUsageStats(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsUsageStatsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListLicenseConfigsUsageStatsResponse`) `` Lists all the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigUsageStats`s associated with the project. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userStores.listUserLicenses` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListUserLicenses |
|---|
| `` rpc ListUserLicenses(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListUserLicensesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListUserLicensesResponse`) `` Lists the User Licenses. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `discoveryengine.userStores.listUserLicenses` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## UserStoreService

Service for managing User Stores.

| GetUserStore |
|---|
| `` rpc GetUserStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetUserStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore`) `` Gets the User Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.userStores.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateUserStore |
|---|
| `` rpc UpdateUserStore(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateUserStoreRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore`) `` Updates the User Store. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.userStores.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## WidgetConfigService

Service for managing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` configuration.

| GetWidgetConfig |
|---|
| `` rpc GetWidgetConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWidgetConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig`) `` Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig`. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.widgetConfigs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateWidgetConfig |
|---|
| `` rpc UpdateWidgetConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateWidgetConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig`) `` Update a WidgetConfig. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `discoveryengine.widgetConfigs.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## WidgetService

Service for Widget.

| LookupWidgetConfig |
|---|
| `` rpc LookupWidgetConfig(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAcquireAccessToken |
|---|
| > [!WARNING] > This item is deprecated! `` rpc WidgetAcquireAccessToken(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAccessTokenRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAccessTokenResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAcquireAndStoreRefreshToken |
|---|
| `` rpc WidgetAcquireAndStoreRefreshToken(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAndStoreRefreshTokenRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAcquireAndStoreRefreshTokenResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAddContextFile |
|---|
| `` rpc WidgetAddContextFile(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAddContextFileRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAddContextFileResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAdvancedCompleteQuery |
|---|
| `` rpc WidgetAdvancedCompleteQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAdvancedCompleteQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAdvancedCompleteQueryResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAnswerQuery |
|---|
| `` rpc WidgetAnswerQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetAssist |
|---|
| `` rpc WidgetAssist(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAssistRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAssistResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetCompleteQuery |
|---|
| `` rpc WidgetCompleteQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetConverseConversation |
|---|
| `` rpc WidgetConverseConversation(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConverseConversationRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConverseConversationResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetCreateSession |
|---|
| `` rpc WidgetCreateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCreateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCreateSessionResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetDeleteSession |
|---|
| `` rpc WidgetDeleteSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDeleteSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDeleteSessionResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetDisconnectConnector |
|---|
| `` rpc WidgetDisconnectConnector(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDisconnectConnectorRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetDisconnectConnectorResponse`) `` Disconnects the calling end user from a connector: hard-deletes the user's stored credential (OAuth connectors) and clears the per-user connected status. It does not detach data stores from the Engine (admin-only). For public / NO_AUTH connectors there is no credential to delete; only the per-user status is cleared. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetExecuteAction |
|---|
| `` rpc WidgetExecuteAction(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetExecuteActionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetExecuteActionResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetGetSession |
|---|
| `` rpc WidgetGetSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetGetSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetGetSessionResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetHomepageFetchDocuments |
|---|
| `` rpc WidgetHomepageFetchDocuments(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetHomepageFetchDocumentsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetHomepageFetchDocumentsResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetListSessions |
|---|
| `` rpc WidgetListSessions(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetListSessionsRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetListSessionsResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetRemoveContextFile |
|---|
| `` rpc WidgetRemoveContextFile(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetRemoveContextFileRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetRemoveContextFileResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetSearch |
|---|
| `` rpc WidgetSearch(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSearchRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSearchResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetSelectContextFiles |
|---|
| `` rpc WidgetSelectContextFiles(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSelectContextFilesRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetSelectContextFilesResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetStreamAnswerQuery |
|---|
| `` rpc WidgetStreamAnswerQuery(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetAnswerQueryResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetUpdateSession |
|---|
| `` rpc WidgetUpdateSession(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetUpdateSessionRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetUpdateSessionResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| WidgetWriteUserEvent |
|---|
| `` rpc WidgetWriteUserEvent(`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetWriteUserEventRequest`) returns (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetWriteUserEventResponse`) `` Do not call this API directly. It is for internal use only and is subject to breaking changes. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - `https://www.googleapis.com/auth/discoveryengine.assist.readwrite` - `https://www.googleapis.com/auth/discoveryengine.readwrite` - `https://www.googleapis.com/auth/discoveryengine.serving.readwrite` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## A2AAgentDefinition

Stored definition of an agent that uses A2A.

| Fields ||
|---|---|
| `cloud_marketplace_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition.CloudMarketplaceConfig` Optional. Configuration specific to agents that are deployed from Cloud Marketplace. |
| Union field `agent_card`. Stores agent's name, capabilities, auth info, etc. `agent_card` can be only one of the following: ||
| `json_agent_card` | `string` Optional. The agent card is a JSON string. |
| `remote_agent_card (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition.RemoteAgentcard` > [!WARNING] > This item is deprecated! Optional. Deprecated: do not use for new integrations. Use `json_agent_card` instead. A remote agent card (third-party). |

## CloudMarketplaceConfig

Configuration specific to agents that are deployed from Cloud Marketplace.

| Fields ||
|---|---|
| `entitlement` | `string` Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`. |
| `order` | `string` Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}` |

## RemoteAgentcard

> [!WARNING]
> This item is deprecated!

Deprecated: Definition of an agent card hosted remotely. Do not use for new integrations. Use `json_agent_card` instead; the URI of a remote agent card can be embedded inside the JSON payload. Retained for backwards compatibility with existing Agent Registry imports.

| Fields ||
|---|---|
| `uri (deprecated)` | `string` > [!WARNING] > This item is deprecated! Required. Deprecated: see the enclosing message. The URI of the agent card. |

## AclConfig

Access Control Configuration.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `idp_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig` Identity provider config. |

## AcquireAccessTokenRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAccessToken` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the connector for which a token is queried. |
| `scope` | `string` Optional. The scope to request for the access token. Scope will override default scope if specified. |
| `action` | `string` Optional. The tool/action name being executed. If provided, the server will check the required scopes of the action and dynamically trigger incremental authorization if they are missing. |

## AcquireAccessTokenResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAccessToken` method.

| Fields ||
|---|---|
| `refresh_token_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RefreshTokenInfo` Info about the stored refresh token used to create the access token. |
| `access_token` | `string` The created access token. |

## AcquireAndStoreRefreshTokenRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAndStoreRefreshToken` method.

| Fields ||
|---|---|
| `name` | `string` Required. Connector resource. The connector name identifies the 3rd party system to use for authorization. It is also used as a key to store the refresh token. |
| `scopes[]` | `string` The scopes of the authorization code and the refresh token. |
| `full_redirect_uri` | `string` Required. The URI the user is redirected to after authorization, including all parameters. E.g., `https://example.com/redir?code=5` |
| `instance_uri` | `string` Optional. The instance URI for the connector, if provided, supported connectors will use this instance URI to construct the token exchange URL. For example, Shopify instance URI is the shop URL. |

## AcquireAndStoreRefreshTokenResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.AcquireAndStoreRefreshToken` method.

| Fields ||
|---|---|
| `additional_oauth_responses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenResponse.AdditionalOAuthResponse` Optional. Additional OAuth responses from the authorization response. This field is optional and will not always be populated. It depends on the connector's type and the authorization response. |

## AdditionalOAuthResponse

Additional OAuth responses from the authorization response.

| Fields ||
|---|---|
| `key` | `string` The key of the additional OAuth response. |
| Union field `value`. The value of the additional OAuth response. `value` can be only one of the following: ||
| `string_value` | `string` The string value of the additional OAuth response. |
| `int_value` | `int64` The integer value of the additional OAuth response. |
| `bool_value` | `bool` The boolean value of the additional OAuth response. |

## AcquireProgramsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.AcquirePrograms`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (AlphaEvolveExperiment) of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |
| `desired_programs_count` | `int32` Optional. Number of evolved programs to acquire. If not set, the default value is 1. |

## AcquireProgramsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.AcquirePrograms`.

| Fields ||
|---|---|
| `programs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram` Output only. List of acquired program candidates to be evaluated. Note: The number of programs acquired might be lower than requested. |

## AcquireUserAuthorizationRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.AcquireUserAuthorization` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |

## AcquireUserAuthorizationResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.AcquireUserAuthorization` method.

| Fields ||
|---|---|
| `refresh_token_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireUserAuthorizationResponse.RefreshTokenInfo` Info about the stored refresh token used to create the access token. |
| `access_token` | `string` The created access token. |
| `authorization_uri` | `string` A URI, that triggers the authorization flow. Set when the user needs to be (re)authorized. |

## RefreshTokenInfo

Describes a refresh token.

| Fields ||
|---|---|
| `scopes[]` | `string` The list of scopes for this token. |

## ActionConfig

Informations to support actions on the connector.

| Fields ||
|---|---|
| `is_action_configured` | `bool` Output only. The connector contains the necessary parameters and is configured to support actions. |
| `service_name` | `string` Optional. The Service Directory resource name (projects/\*/locations/\*/namespaces/\*/services/\*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.FIELDS.google.protobuf.Struct.google.cloud.discoveryengine.v1alpha.DataConnector.params`. Required when VPC Service Controls are enabled. |
| `use_static_secrets` | `bool` Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. |
| `create_bap_connection` | `bool` Optional. Whether to create a BAP connection for the connector. |
| `user_defined_scopes_mapping` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionConfig.ScopeList`>`` Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. |
| Union field `action_config_params`. Params needed to support actions in the format of (Key, Value) pairs. String values with the format `projects/*/[locations/*/]secrets/*/versions/*` will be read from Secret Manager. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: - Key: `client_id` - Value: type STRING. The client ID for the service provider to identify your application. - Key: `client_secret` - Value:type STRING. The client secret generated by the application's authorization server. `action_config_params` can be only one of the following: ||
| `action_params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Action parameters in structured json format. |
| `json_action_params` | `string` Optional. Action parameters in json string format. |

## ScopeList

Stores a list of scopes.

| Fields ||
|---|---|
| `scopes[]` | `string` Optional. The list of scopes. |

## ActionInvocation

Represents an action invocation.

| Fields ||
|---|---|
| `agent_name` | `string` Optional. Name of the agent that is performing the action. |
| `action_name` | `string` Name of the action. For example: "send_email" |
| `args` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Named arguments of the action. For example: `{"recipient": "tom@...", "subject": ... }` When offered to a user, this part might be editable. If there are multiple options for the action arguments (e.g., multiple possible time slots for a calendar event), then this field describes the first option. |
| `data_connector` | `string` `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` resource. The data connector used for performing the action. |
| `data_source` | `string` Output only. The name of the data source. |
| `invocation_id` | `string` Output only. The action invocation ID. |
| `action_display_name` | `string` Output only. Human-readable name of the action that is displayed to the user. |
| `user_confirmation_message` | `string` Output only. Human-readable message shown to the user along with the confirmation dialog. |
| `authorization_url` | `string` Output only. Authorization URL. |
| `resend_query_on_user_authorization` | `bool` Output only. If true, caller must resend query upon user authorization. |
| `parameter_declaration` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. Description of the parameters of the action including rendering/validation information. Its format is based on the OpenAPI's parameters specification. Based on: <https://swagger.io/docs/specification/describing-parameters/> **Example:** { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the event", }, "start_time": { "type": "string", "format": "date-time", "description": ( "Start time of the meeting, e.g. 2024-07-12T23:30" ), }, "attendees": { "type": "array", "items": {"type": "string", "format": "email"}, "description": "List of email addresses of attendees", }, "duration": { "type": "integer", "format": "int32", "minimum": 5, "maximum": 240, "default": { "number_value": 30 }, "description": ( "Duration of the meeting in minutes. Defaults to 30" " minutes." ), }, "timezone": { "type": "string", "description": ( 'IANA Time Zone Database name, e.g. "Europe/Zurich". If' " omitted, timezone of the user will be used" ), }, "event_type": { "type": "string", "enum": ["meeting", "focus_time", "out_of_office", "task"], "description": "Type of the event", }, }, "required": ["start_time", "title", "attendees"] } |
| `arg_set_candidates[]` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. If there are multiple options for the action arguments (e.g., multiple possible time slots for a calendar event), these additional argument candidates are listed in this field. Contains a list of argument sets, each of which is formatted similarly as the args field. The argument sets only contain the arguments that differ from the args field. When offered to a user, these values might be editable. For example: `args` contains the first option with all the arguments: {"title": "Meeting with John", "start_time": "2024-08-01T13:30", ... } `arg_set_candidates` contains the rest of the options, but only the differing arguments are populated: ` [{ "start_time": "2024-08-01T14:00" }, { "start_time": "2024-08-01T14:30" }, { "start_time": "2024-08-01T15:30" }] ` |
| `executed_args` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. Represents the arguments that were actually used for execution, potentially modified by the user from the initial args. |

## AddContextFileRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.AddContextFile` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` If `-` is specified as the session ID, a new session is created with an automatically generated ID. |
| `file_name` | `string` Required. The name of the file. |
| `mime_type` | `string` Optional. The content type of the file, see <https://www.iana.org/assignments/media-types/media-types.xhtml>. This field is required when the data source does not provide the content type. |
| Union field `file`. The contents of the file. `file` can be only one of the following: ||
| `file_contents` | `bytes` File contents provided inline. |
| `document` | `string` Resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. The caller needs to have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, otherwise a PERMISSION_DENIED error is returned. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}` |

## AddContextFileResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.AddContextFile` method.

| Fields ||
|---|---|
| `session` | `string` The name of the session, either the provided one, or the newly created one. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `file_id` | `string` The ID of the uploaded file. |
| `token_count (deprecated)` | `int64` > [!WARNING] > This item is deprecated! Deprecated: This field will not be set for all file types, and will eventually be removed. The length of the file measured in tokens. |
| `mime_type` | `string` Output only. The resolved content type of the uploaded file, see <https://www.iana.org/assignments/media-types/media-types.xhtml>. Unlike the optional, caller-supplied `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileRequest.mime_type`, this is the content type the service actually resolved for the file. |
| `byte_count` | `int64` Output only. The size of the uploaded file in bytes. |
| `file_name` | `string` Output only. The resolved name of the uploaded file, including its file extension. Unlike the caller-supplied `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileRequest.file_name`, the service appends the extension that matches the resolved `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileResponse.mime_type` when the caller-supplied name has none, so usage audit logs capture the file type even for generically named AI-generated files. |

## AddPatientFilterRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.AddPatientFilter` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not exist, a NOT_FOUND error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` already has a patient filter, an ALREADY_EXISTS error will be returned. |
| `filter_groups[]` | `string` Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. |

## AdditionalParams

AdditionalParams message for WidgetService methods for security and privacy enhancement.

| Fields ||
|---|---|
| `token` | `string` Required. Token that used for non-human user check. |
| `origin` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams.Origin` Optional. The origin of the request. |

## Origin

The origin of the request.

| Enums ||
|---|---|
| `ORIGIN_UNSPECIFIED` | Origin unspecified. |
| `AGENT_DESIGNER` | Request is from agent designer. |
| `LOW_CODE_AGENT` | Request is from low code agent. |
| `CHAT_AGENT` | Request is from chat agent. |

## AdkAgentDefinition

Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).

| Fields ||
|---|---|
| `tool_settings (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentToolSettings` > [!WARNING] > This item is deprecated! Optional. The parameters that define how the agent is presented to the planner LLM. DEPRECATED: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.google.cloud.discoveryengine.v1alpha.AgentInvocationSpec.google.cloud.discoveryengine.v1alpha.Agent.agent_invocation_spec` instead. |
| `provisioned_reasoning_engine` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdkAgentDefinition.ProvisionedReasoningEngine` Optional. The reasoning engine that the agent is connected to. |
| `authorizations[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. DEPRECATED: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.repeated.string.google.cloud.discoveryengine.v1alpha.Agent.authorizations` instead. Resource names of the required authorizations. If the user is not authorized, the service will return a number of authorization URIs that the user must open in a browser and authorize. Once all authorizations are granted, the user can retry the query, and the authorizations will be forwarded to the agent. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |

## ProvisionedReasoningEngine

Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.

| Fields ||
|---|---|
| `reasoning_engine` | `string` Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` |

## AdvancedCompleteQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.AdvancedCompleteQuery` method. .

| Fields ||
|---|---|
| `completion_config` | `string` Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. |
| `query` | `string` Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. |
| `query_model` | `string` Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: - `document` - Using suggestions generated from user-imported documents. - `search-history` - Using suggestions generated from the past history of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API calls. Do not use it when there is no traffic for Search API. - `user-event` - Using suggestions generated from user-imported search events. - `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: - `document` is the default model for regular dataStores. - `search-history` is the default model for site search dataStores. |
| `user_pseudo_id` | `string` Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id`. The field must be a UTF-8 encoded string with a length limit of 128 |
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo` Optional. Information about the end user. This should be the same identifier information as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.google.cloud.discoveryengine.v1alpha.UserInfo.google.cloud.discoveryengine.v1alpha.UserEvent.user_info` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.UserInfo.google.cloud.discoveryengine.v1alpha.SearchRequest.user_info`. |
| `include_tail_suggestions` | `bool` Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. |
| `boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.BoostSpec` Optional. Specification to boost suggestions matching the condition. |
| `suggestion_types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.SuggestionType` Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. |
| `suggestion_type_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.SuggestionTypeSpec` Optional. Specification of each suggestion type. |
| `experiment_ids[]` | `string` Optional. Experiment ids for this request. |

## BoostSpec

Specification to boost suggestions based on the condition of the suggestion.

| Fields ||
|---|---|
| `condition_boost_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec` Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. |

## ConditionBoostSpec

Boost applies to suggestions which match a condition.

| Fields ||
|---|---|
| `condition` | `string` An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: - To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` |
| `boost` | `float` Strength of the boost, which should be in \[-1, 1\]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. |

## SuggestionType

Suggestion type to return.

| Enums ||
|---|---|
| `SUGGESTION_TYPE_UNSPECIFIED` | Default value. |
| `QUERY` | Returns query suggestions. |
| `PEOPLE` | Returns people suggestions. |
| `CONTENT` | Returns content suggestions. |
| `RECENT_SEARCH` | Returns recent search suggestions. |
| `GOOGLE_WORKSPACE` | Returns Google Workspace suggestions. |

## SuggestionTypeSpec

Specification of each suggestion type.

| Fields ||
|---|---|
| `suggestion_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest.SuggestionType` Optional. Suggestion type. |
| `max_suggestions` | `int32` Optional. Maximum number of suggestions to return for each suggestion type. |

## AdvancedCompleteQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.AdvancedCompleteQuery` method.

| Fields ||
|---|---|
| `query_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.QuerySuggestion` Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. |
| `tail_match_triggered` | `bool` True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. |
| `people_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.PersonSuggestion` Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. |
| `content_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.ContentSuggestion` Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. |
| `recent_search_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.RecentSearchSuggestion` Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. |

## ContentSuggestion

Suggestions as content.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |
| `content_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.ContentSuggestion.ContentType` The type of the content suggestion. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` The document data snippet in the suggestion. Only a subset of fields will be populated. |
| `data_store` | `string` The name of the dataStore that this suggestion belongs to. |
| `score` | `double` The score of each suggestion. The score is in the range of \[0, 1\]. |
| `icon_uri` | `string` The icon uri of the content suggestion. |
| `destination_uri` | `string` The destination uri of the content suggestion. |

## ContentType

The type of the content returned for content suggestions.

| Enums ||
|---|---|
| `CONTENT_TYPE_UNSPECIFIED` | Default value. |
| `GOOGLE_WORKSPACE` | The suggestion is from a Google Workspace source. |
| `THIRD_PARTY` | The suggestion is from a third party source. |

## PersonSuggestion

Suggestions as people.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |
| `person_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse.PersonSuggestion.PersonType` The type of the person. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` The document data snippet in the suggestion. Only a subset of fields is populated. |
| `data_store` | `string` The name of the dataStore that this suggestion belongs to. |
| `score` | `double` The score of each suggestion. The score is in the range of \[0, 1\]. |
| `display_photo_uri` | `string` The photo uri of the person suggestion. |
| `destination_uri` | `string` The destination uri of the person suggestion. |

## PersonType

Classifies the person by identity source and entity kind; GOOGLE_GROUP takes precedence for groups regardless of their identity source.

| Enums ||
|---|---|
| `PERSON_TYPE_UNSPECIFIED` | Default value. |
| `CLOUD_IDENTITY` | The suggestion is from a GOOGLE_IDENTITY source. |
| `THIRD_PARTY_IDENTITY` | The suggestion is from a THIRD_PARTY_IDENTITY source. |
| `GOOGLE_GROUP` | The suggestion is a group (e.g. a Google Group), not an individual. |

## QuerySuggestion

Suggestions as search queries.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |
| `completable_field_paths[]` | `string` The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. |
| `data_store[]` | `string` The name of the dataStore that this suggestion belongs to. |
| `score` | `double` The score of each suggestion. The score is in the range of \[0, 1\]. |

## RecentSearchSuggestion

Suggestions from recent search history.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |
| `recent_search_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time when this recent rearch happened. |
| `score` | `double` The score of each suggestion. The score is in the range of \[0, 1\]. |

## AdvancedSiteSearchConfig

Configuration data for advance site search.

| Fields ||
|---|---|
| `disable_initial_index` | `bool` If set true, initial indexing is disabled for the DataStore. |
| `disable_automatic_refresh` | `bool` If set true, automatic refresh is disabled for the DataStore. |

## Agent

Performs a predefined, specific task.

| Fields ||
|---|---|
| `name` | `string` Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `display_name` | `string` Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. |
| `description` | `string` Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query. |
| `icon` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.Image` Optional. The icon that represents the agent on the UI. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when this Agent was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when this Agent was most recently updated. |
| `authorizations[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. Deprecated: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.google.cloud.discoveryengine.v1alpha.AuthorizationConfig.google.cloud.discoveryengine.v1alpha.Agent.authorization_config` instead. List of required authorizations for this agent. |
| `authorization_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationConfig` Optional. The authorizations that are required by the agent. |
| `data_store_specs` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.DataStoreSpecs` Optional. DataStoreSpecs associated with the agent. Not setting this field will result in using all data stores in the engine. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.State` Output only. The lifecycle state of the agent. |
| `tool_settings (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentToolSettings` > [!WARNING] > This item is deprecated! Optional. DEPRECATED: Please use agent_invocation_spec instead. |
| `agent_invocation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentInvocationSpec` Optional. The invocation spec of the agent, used by the LLM to decide when to use the agent. |
| `language_code` | `string` Optional. The code of the language of the text in the description, display_name and starter_prompts fields. |
| `starter_prompts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.StarterPrompt` Optional. The starter prompt suggestions to show the user on the landing page of the agent. |
| `custom_placeholder_text` | `string` Optional. The custom placeholder text that appears in the text box before the user enters any text. |
| `sharing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.SharingConfig` Optional. The sharing config of the agent. |
| `observability_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObservabilityConfig` Optional. Observability config for the agent. |
| Union field `definition`. The definition of the agent. LINT.IfChange(definition) `definition` can be only one of the following: ||
| `adk_agent_definition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdkAgentDefinition` Optional. The behavior of the agent is defined as an ADK agent. |
| `managed_agent_definition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ManagedAgentDefinition` Optional. The behavior of the Google managed agent. |
| `a2a_agent_definition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.A2AAgentDefinition` Optional. The behavior of the agent is defined as an A2A agent. |
| `dialogflow_agent_definition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DialogflowAgentDefinition` Optional. The behavior of the agent is defined as a Dialogflow agent. |
| Union field `agent_state_reason`. The reason why the agent is in its current state. `agent_state_reason` can be only one of the following: ||
| `suspension_reason` | `string` Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED. |
| `rejection_reason` | `string` Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection. |
| `deployment_failure_reason` | `string` Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED. |
| `creation_failure_reason` | `string` Output only. The reason why the agent creation (provisioning) failed. Only set if the state is CREATION_FAILED. |

## DataStoreSpecs

Represents a set of data store specs.

| Fields ||
|---|---|
| `specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` Optional. Specs defining `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to filter on in a search call and configurations for those data stores. This is only considered for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s with multiple data stores. |

## Image

Represents an image.

| Fields ||
|---|---|
| Union field `storage_method`. Can be either a URI or the content encoded as a base64 string. `storage_method` can be only one of the following: ||
| `uri` | `string` Image URI. |
| `content` | `string` Base64-encoded image file contents. |

## SharingConfig

Sharing related configuration.

| Fields ||
|---|---|
| `scope` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.SharingConfig.Scope` Optional. The sharing scope of the agent. |

## Scope

The sharing scope of the agent.

| Enums ||
|---|---|
| `SCOPE_UNSPECIFIED` | Default value. Behaves as `RESTRICTED`. |
| `RESTRICTED` | The agent is shared with specific users based on the IAM policy. |
| `ALL_USERS` | The agent is shared with all users. |
| `PRIVATE` | The agent is not shared: it is only accessible to its creator and to administrators. |

## StarterPrompt

The starter prompt suggestion to show the user on the landing page of the agent.

| Fields ||
|---|---|
| `text` | `string` Required. The text of the starter prompt. |

## State

Possible values for the lifecycle state of the agent.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `CONFIGURED` | The agent is configured, but no deployment triggered yet. |
| `DEPLOYING` | The agent is being deployed. |
| `DISABLED` | The agent is available for admins only. |
| `DEPLOYMENT_FAILED` | The agent deployment failed. |
| `PRIVATE` | Agent is available only to its creator.. |
| `ENABLED` | Agent is available for users who have access. |
| `SUSPENDED` | Agent is temporarily unavailable, though visible to users who have access. |
| `CREATING` | Agent is being created. |
| `CREATION_FAILED` | Agent creation (provisioning) failed. Terminal. To retry, the caller must `DeleteAgent` to clear the failed resource and then create again; there is no in-place overwrite of a failed agent. Only set for asynchronously-provisioned agents. |

## AgentFile

Describes a file used internally by an agent as a context on each invocation.

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the file. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}/files/{file}` |
| `file_name` | `string` Required. The name of the file. |
| `mime_type` | `string` Immutable. The content type of the file. |

## AgentGatewaySetting

Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise.

| Fields ||
|---|---|
| `default_egress_agent_gateway` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentGatewaySetting.AgentGatewayReference` Optional. The default egress agent gateway to use, when this setting is applied to a Gemini Enterprise resource. The deployment mode must be GOOGLE_MANAGED, and the governed access path must be AGENT_TO_ANYWHERE. |

## AgentGatewayReference

Reference to an Agent Gateway resource.

| Fields ||
|---|---|
| `name` | `string` Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. |

## AgentInvocationSpec

Invocation spec for the agent, used by the LLM to decide when to invoke the agent.

| Fields ||
|---|---|
| `description` | `string` Required. Description that guides the LLM on when to invoke the agent. A good description clearly and concisely explains the agent's capabilities, for example: "This agent can book flights and check flight statuses." |

## AgentToolSettings

> [!WARNING]
> This item is deprecated!

DEPRECATED: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentInvocationSpec` instead. Settings for the tool that represents the agent to the Agentspace planner LLM.

| Fields ||
|---|---|
| `tool_description` | `string` Required. This might be used by an LLM to describe when the agent should be used. |
| `input_parameter_name` | `string` Optional. Parameter name for the function call. This parameter name will hint the LLM what type of content the parameter is expected to contain, e.g. a "question", a "command", a "search_query", etc. |
| `input_parameter_description` | `string` Optional. Parameter description for the function call. This description will give the LLM more information about the parameter, e.g. what kind of content is expected to be passed in and what actions should be performed on it. |

## AgentTrajectory

AgentTrajectory captures the execution trace of a single agent turn, modeled on OpenTelemetry GenAI semantic conventions. It is reported by first-party clients (e.g. the Gemini Enterprise desktop Cowork agent) for internal observability logging only; it is not persisted to the user event / recommendation store.

The server gates logging on the engine's ObservabilityConfig, redacts content-bearing attributes unless sensitive-content logging is enabled, and writes the trajectory as a JSON object to a fixed Google-internal GCS bucket for debugging (never to a customer project).

| Fields ||
|---|---|
| `spans[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span` Required. The spans that make up this agent turn. All spans MUST share the same `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.FIELDS.string.google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.trace_id`. |
| `session_id` | `string` Optional. A unique identifier for the agent session this turn belongs to. |
| `resource_attributes` | `map<string, string>` Optional. Resource-level attributes shared by all spans, following OpenTelemetry resource semantic conventions (e.g. `service.name`, `gen_ai.agent.name`, `gen_ai.agent.id`). These are opted in to observability logging by default. |

## Span

A single span within the agent trajectory, aligned with the OpenTelemetry span data model.

| Fields ||
|---|---|
| `trace_id` | `string` Required. A 32 hex-character (16-byte) trace ID shared by all spans of the turn. |
| `span_id` | `string` Required. A 16 hex-character (8-byte) span ID that uniquely identifies this span within the trace. |
| `parent_span_id` | `string` Optional. The span ID of this span's parent, if any. Empty for the root span. |
| `display_name` | `string` Required. A human-readable name for the span (e.g. `invoke_agent`, `generate_content`, `execute_tool <tool_name>`). |
| `span_kind` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.SpanKind` Optional. The kind of the span. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Required. The start time of the span. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Required. The end time of the span. |
| `attributes` | `map<string, string>` Optional. Non-content span attributes following OpenTelemetry GenAI semantic conventions (e.g. `gen_ai.system`, `gen_ai.operation.name`, `gen_ai.request.model`, `gen_ai.usage.input_tokens`). Numeric values are string-encoded. These are opted in to observability logging by default. |
| `content_attributes` | `map<string, string>` Optional. Content-bearing attributes (e.g. prompts, responses, tool arguments and results). These are opted OUT of observability logging by default and are only logged when the customer has enabled sensitive-content logging. |
| `status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Optional. The status of the span. `code` is a `google.rpc.Code`; `OK` (0) indicates success and any non-zero code indicates an error. |
| `events[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory.Span.Event` Optional. Timed events that occurred during the span. |

## Event

A timed event that occurred during the span (e.g. a streamed chunk).

| Fields ||
|---|---|
| `display_name` | `string` Required. A human-readable name for the event. |
| `event_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Required. The wall-clock time the event occurred. |
| `attributes` | `map<string, string>` Optional. Non-content attributes describing the event. |

## SpanKind

The kind of the span, aligned with OpenTelemetry SpanKind.

| Enums ||
|---|---|
| `SPAN_KIND_UNSPECIFIED` | Unspecified. Treated as INTERNAL. |
| `INTERNAL` | An internal operation within the agent (e.g. invoke_agent). |
| `SERVER` | A synchronous incoming request handler. |
| `CLIENT` | A synchronous outgoing request (e.g. a model or tool call). |
| `PRODUCER` | An asynchronous producer of a message. |
| `CONSUMER` | An asynchronous consumer of a message. |

## AlertPolicyConfig

The connector level alert config.

| Fields ||
|---|---|
| `alert_policy_name` | `string` Immutable. The fully qualified resource name of the AlertPolicy. |
| `alert_enrollments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig.AlertEnrollment` Optional. The enrollment states of each alert. |

## AlertEnrollment

The alert enrollment status.

| Fields ||
|---|---|
| `alert_id` | `string` Immutable. The ID of an alert. |
| `enroll_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig.AlertEnrollment.EnrollStates` Required. The enrollment status of a customer. |

## EnrollStates

The enrollment status enum for the alert.

| Enums ||
|---|---|
| `ENROLL_STATES_UNSPECIFIED` | Default value. Used for customers who have not responded to the alert policy. |
| `ENROLLED` | Customer is enrolled in this policy. |
| `DECLINED` | Customer declined this policy. |

## AlertPolicyResourceConfig

The resource level alert config. Used in: \* UserLicense \* EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.

| Fields ||
|---|---|
| `alert_policy` | `string` Immutable. The fully qualified resource name of the AlertPolicy. |
| `alert_enrollments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig.AlertEnrollment` Optional. The enrollment state of each alert. |
| `contact_details[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ContactDetails` Optional. The contact details for each alert policy. |
| `language_code` | `string` Optional. The language code used for notifications |
| `region_code` | `string` Optional. The region code used of the user that subscribed to the alert policy. |

## AlertEnrollment

The alert enrollment status.

| Fields ||
|---|---|
| `alert_id` | `string` Immutable. The ID of an alert. |
| `enroll_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig.AlertEnrollment.EnrollState` Required. The enrollment status of a customer. |
| `notification_params` | `map<string, string>` Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. \* Gemini Business welcome emails. \* Gemini Business user invitation emails. |

## EnrollState

The enrollment status enum for the alert.

| Enums ||
|---|---|
| `ENROLL_STATE_UNSPECIFIED` | Default value. Used for customers who have not responded to the alert policy. |
| `ENROLLED` | Customer is enrolled in this policy. |
| `DECLINED` | Customer declined this policy. |

## AlloyDbSource

AlloyDB source import data from.

| Fields ||
|---|---|
| `project_id` | `string` The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `location_id` | `string` Required. The AlloyDB location to copy the data from with a length limit of 256 characters. |
| `cluster_id` | `string` Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. |
| `database_id` | `string` Required. The AlloyDB database to copy the data from with a length limit of 256 characters. |
| `table_id` | `string` Required. The AlloyDB table to copy the data from with a length limit of 256 characters. |
| `gcs_staging_dir` | `string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |

## AlphaEvolveEvaluationInsights

Evaluation insights for a program.

| Fields ||
|---|---|
| `insights[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationInsights.AlphaEvolveEvaluationInsight` Optional. List of evaluation insights. |

## AlphaEvolveEvaluationInsight

A single evaluation insight.

| Fields ||
|---|---|
| `label` | `string` Optional. Label of the insight. |
| `text` | `string` Optional. Text of the insight. |

## AlphaEvolveEvaluationScores

Contains the evaluation scores for the target metrics to optimize.

| Fields ||
|---|---|
| `scores[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationScores.AlphaEvolveEvaluationScore` Required. List of evaluation scores. |

## AlphaEvolveEvaluationScore

Score for a single metric.

| Fields ||
|---|---|
| `metric` | `string` Required. Name of the metric. |
| `score` | `float` Required. Score of a program for this metric. |

## AlphaEvolveExperiment

An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Time when the experiment was created. |
| `config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig` Required. Experiment configuration. |
| `stats` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentStats` Output only. Experiment stats. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment.State` Output only. The state of the experiment. |
| `initial_alpha_evolve_program` | `string` Output only. Specifies the name of the seed program used to start the experiment. |

## State

Experiment state values.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. This value is unused. |
| `CREATED` | The experiment is created. |
| `RUNNING` | The experiment is running. |
| `PAUSED` | The experiment is paused. |
| `COMPLETED` | The experiment is completed. |
| `FAILED` | The experiment has failed. |

## AlphaEvolveExperimentConfig

Configuration of an experiment.

| Fields ||
|---|---|
| `title` | `string` Required. Title of the experiment. |
| `problem_description` | `string` Required. Description of the problem to be solved by the experiment. |
| `program_language` | `string` Required. Primary programming language of the code being optimized. |
| `run_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.RunSettings` Required. Run settings for the experiment, controlling the overall behavior of the experiment run. |
| `generation_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings` Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts. |
| `evolution_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings` Optional. Evolution settings for the experiment. |

## EvolutionSettings

Evolution settings for the experiment.

| Fields ||
|---|---|
| `parent_sampling_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings.ParentSamplingConfig` Optional. Parent sampling configuration. |

## ParentSamplingConfig

Configuration for parent sampling.

| Fields ||
|---|---|
| `pareto_sampling_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.EvolutionSettings.ParentSamplingConfig.ParetoSamplingConfig` Optional. Pareto sampling configuration. |

## ParetoSamplingConfig

Configuration for Pareto sampling.

| Fields ||
|---|---|
| `pareto_sampling_probability` | `float` Optional. Probability \[0.0, 1.0\] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize. |

## GenerationSettings

Generation settings for the experiment.

| Fields ||
|---|---|
| `context` | `string` Optional. Additional user-provided context to be used during generation. |
| `include_full_program_in_prompt` | `bool` Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window. |
| `models[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings.ModelConfig` Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model. |

## ModelConfig

Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset.

The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.

| Fields ||
|---|---|
| `name` | `string` Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. |
| `thinking_level` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperimentConfig.GenerationSettings.ModelConfig.ThinkingLevel` Optional. Sent as Vertex `ThinkingConfig.thinking_level`. |
| `weight` | `float` Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. |

## ThinkingLevel

How hard the model should think, as a portable level rather than a token budget. Levels need a Gemini 3 model: Gemini 2.5 and earlier budget thinking in tokens and reject a level outright.

Which levels a given model accepts, and which it uses when this is unset, are per-model and documented with the model rather than here.

| Enums ||
|---|---|
| `THINKING_LEVEL_UNSPECIFIED` | Unset. The model applies its own default, which is not the same level for every model. |
| `MINIMAL` | Least thinking. Not offered by every model. |
| `LOW` | Vertex `LOW`. |
| `MEDIUM` | Vertex `MEDIUM`. |
| `HIGH` | Vertex `HIGH`. |

## RunSettings

Run settings for the experiment.

| Fields ||
|---|---|
| `max_programs` | `int32` Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1. |
| `concurrency` | `int32` Required. Maximum number of programs that can be generated in parallel. Must be positive. |
| `max_duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. Maximum duration of the experiment. If unset, defaults to 24 hours. |

## AlphaEvolveExperimentStats

Stats about the experiment.

| Fields ||
|---|---|
| `candidates_count` | `int32` Output only. Number of candidates generated. |
| `evaluated_candidates_count` | `int32` Output only. Number of candidates evaluated. |
| `input_token_count` | `int64` Output only. Number of billed input tokens consumed by the experiment. |
| `output_token_count` | `int64` Output only. Number of billed output tokens consumed by the experiment. |

## AlphaEvolveProgram

Represents a single program to be used within the context of an AlphaEvolve experiment.

| Fields ||
|---|---|
| `name` | `string` Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}` |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Time when the program was created. |
| `content` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramContent` Optional. Content of the program. |
| `evaluation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluation` Optional. Evaluation results for the program. |
| `parent_programs[]` | `string` Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}` |
| `lock_token` | `string` Optional. Lock token for the program. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProgramState` Output only. State of the program. |

## AlphaEvolveProgramContent

A self-contained message containing the content of a program. Can represent a collection of files.

| Fields ||
|---|---|
| `description` | `string` Optional. Description of the program. |
| `files[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveSourceFile` Required. A list of source files that make up the overall program. |

## AlphaEvolveProgramEvaluation

Evaluation results for a program candidate.

| Fields ||
|---|---|
| `scores` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationScores` Optional. Contains the evaluation scores for the target metrics to optimize. |
| `insights` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveEvaluationInsights` Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt. |

## AlphaEvolveProgramEvaluationSubmission

Evaluation submission for a program candidate.

| Fields ||
|---|---|
| `program` | `string` Required. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}` |
| `evaluation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluation` Required. Evaluation results for the program candidate. |
| `lock_token` | `string` Required. Lock token for the program obtained in the AcquireAlphaEvolvePrograms call. |

## AlphaEvolveSourceFile

A single source file with its path, content and metadata.

| Fields ||
|---|---|
| `path` | `string` Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md" |
| `content` | `string` Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text. |
| `program_language` | `string` Optional. The programming language of the file. |
| `description` | `string` Optional. Additional description of the file. |

## AnalyticsConfig

The customer controllable config for Analytics.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the analytics customer config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/analytics/config` |
| `user_level_metrics_enabled` | `bool` Whether user-level metrics are enabled. |

## Answer

Defines an answer.

| Fields ||
|---|---|
| `name` | `string` Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.State` The state of the answer generation. |
| `answer_text` | `string` The textual answer. |
| `citations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Citation` Citations. |
| `grounding_supports[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.GroundingSupport` Optional. Grounding supports. |
| `references[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference` References. |
| `blob_attachments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment` Output only. List of blob attachments in the answer. |
| `related_questions[]` | `string` Suggested related questions. |
| `steps[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step` Answer generation steps. |
| `query_understanding_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo` Query understanding information. |
| `answer_skipped_reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.AnswerSkippedReason` Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Answer creation timestamp. |
| `complete_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Answer completed timestamp. |
| `safety_ratings[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating` Optional. Safety ratings. |
| `grounding_score` | `double` A score in the range of \[0, 1\] describing how grounded the answer is by the reference chunks. |

## AnswerSkippedReason

An enum for answer skipped reasons.

| Enums ||
|---|---|
| `ANSWER_SKIPPED_REASON_UNSPECIFIED` | Default value. The answer skipped reason is not specified. |
| `ADVERSARIAL_QUERY_IGNORED` | The adversarial query ignored case. |
| `NON_ANSWER_SEEKING_QUERY_IGNORED` | The non-answer seeking query ignored case Google skips the answer if the query is chit chat. |
| `OUT_OF_DOMAIN_QUERY_IGNORED` | The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results. |
| `POTENTIAL_POLICY_VIOLATION` | The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic. |
| `NO_RELEVANT_CONTENT` | The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results. |
| `JAIL_BREAKING_QUERY_IGNORED` | The jail-breaking query ignored case. For example, "Reply in the tone of a competing company's CEO". Google skips the answer if the query is classified as a jail-breaking query. |
| `CUSTOMER_POLICY_VIOLATION` | The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer. |
| `NON_ANSWER_SEEKING_QUERY_IGNORED_V2` | The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent. |
| `LOW_GROUNDED_ANSWER` | The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated. |
| `USER_DEFINED_CLASSIFICATION_QUERY_IGNORED` | The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification. |
| `UNHELPFUL_ANSWER` | The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted. |

## BlobAttachment

Stores binarydata attached to text answer, e.g. image, video, audio, etc.

| Fields ||
|---|---|
| `data` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment.Blob` Output only. The mime type and data of the blob. |
| `attribution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.BlobAttachment.AttributionType` Output only. The attribution type of the blob. |

## AttributionType

The source of the blob.

| Enums ||
|---|---|
| `ATTRIBUTION_TYPE_UNSPECIFIED` | Unspecified attribution type. |
| `CORPUS` | The attachment data is from the corpus. |
| `GENERATED` | The attachment data is generated by the model through code generation. |

## Blob

The media type and data of the blob.

| Fields ||
|---|---|
| `mime_type` | `string` Output only. The media type (MIME type) of the generated or retrieved data. |
| `data` | `bytes` Output only. Raw bytes. |

## Citation

Citation info for a segment.

| Fields ||
|---|---|
| `start_index` | `int64` Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. |
| `end_index` | `int64` End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length. |
| `sources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.CitationSource` Citation sources for the attributed segment. |

## CitationSource

Citation source.

| Fields ||
|---|---|
| `reference_id` | `string` ID of the citation source. |

## GroundingSupport

Grounding support for a claim in `answer_text`.

| Fields ||
|---|---|
| `start_index` | `int64` Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). |
| `end_index` | `int64` Required. End of the claim, exclusive. |
| `sources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.CitationSource` Optional. Citation sources for the claim. |
| `grounding_score` | `double` A score in the range of \[0, 1\] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. |
| `grounding_check_required` | `bool` Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. |

## QueryUnderstandingInfo

Query understanding information.

| Fields ||
|---|---|
| `query_classification_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo.QueryClassificationInfo` Query classification information. |

## QueryClassificationInfo

Query classification information.

| Fields ||
|---|---|
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.QueryUnderstandingInfo.QueryClassificationInfo.Type` Query classification type. |
| `positive` | `bool` Classification output. |

## Type

Query classification types.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified query classification type. |
| `ADVERSARIAL_QUERY` | Adversarial query classification type. |
| `NON_ANSWER_SEEKING_QUERY` | Non-answer-seeking query classification type, for chit chat. |
| `JAIL_BREAKING_QUERY` | Jail-breaking query classification type. |
| `NON_ANSWER_SEEKING_QUERY_V2` | Non-answer-seeking query classification type, for no clear intent. |
| `USER_DEFINED_CLASSIFICATION_QUERY` | User defined query classification type. |

## Reference

Reference.

| Fields ||
|---|---|
| Union field `content`. Search result content. `content` can be only one of the following: ||
| `unstructured_document_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.UnstructuredDocumentInfo` Unstructured document information. |
| `chunk_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.ChunkInfo` Chunk information. |
| `structured_document_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.StructuredDocumentInfo` Structured document information. |

## ChunkInfo

Chunk information.

| Fields ||
|---|---|
| `chunk` | `string` Chunk resource name. |
| `content` | `string` Chunk textual content. |
| `document_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.ChunkInfo.DocumentMetadata` Document metadata. |
| `blob_attachment_indexes[]` | `int64` Output only. Stores indexes of blobattachments linked to this chunk. |
| `relevance_score` | `float` The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |

## DocumentMetadata

Document metadata.

| Fields ||
|---|---|
| `document` | `string` Document resource name. |
| `uri` | `string` URI for the document. |
| `title` | `string` Title. |
| `page_identifier` | `string` Page identifier. |
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. |

## StructuredDocumentInfo

Structured search information.

| Fields ||
|---|---|
| `document` | `string` Document resource name. |
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Structured search data. |
| `title` | `string` Output only. The title of the document. |
| `uri` | `string` Output only. The URI of the document. |

## UnstructuredDocumentInfo

Unstructured document information.

| Fields ||
|---|---|
| `document` | `string` Document resource name. |
| `uri` | `string` URI for the document. |
| `title` | `string` Title. |
| `chunk_contents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Reference.UnstructuredDocumentInfo.ChunkContent` List of cited chunk contents derived from document content. |
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. |

## ChunkContent

Chunk content.

| Fields ||
|---|---|
| `content` | `string` Chunk textual content. |
| `page_identifier` | `string` Page identifier. |
| `blob_attachment_indexes[]` | `int64` Output only. Stores indexes of blobattachments linked to this chunk. |
| `relevance_score` | `float` The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |

## State

Enumeration of the state of the answer generation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unknown. |
| `IN_PROGRESS` | Answer generation is currently in progress. |
| `FAILED` | Answer generation currently failed. |
| `SUCCEEDED` | Answer generation has succeeded. |
| `STREAMING` | Answer generation is currently in progress. |

## Step

Step information.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.State` The state of the step. |
| `description` | `string` The description of the step. |
| `thought` | `string` The thought of the step. |
| `actions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action` Actions. |

## Action

Action.

| Fields ||
|---|---|
| `observation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation` Observation. |
| Union field `action`. The action. `action` can be only one of the following: ||
| `search_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.SearchAction` Search action. |

## Observation

Observation.

| Fields ||
|---|---|
| `search_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult` Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. |

## SearchResult

| Fields ||
|---|---|
| `document` | `string` Document resource name. |
| `uri` | `string` URI for the document. |
| `title` | `string` Title. |
| `snippet_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.SnippetInfo` If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. |
| `chunk_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo` If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. |
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. |

## ChunkInfo

Chunk information.

| Fields ||
|---|---|
| `chunk` | `string` Chunk resource name. |
| `content` | `string` Chunk textual content. |
| `relevance_score` | `float` The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |

## SnippetInfo

Snippet information.

| Fields ||
|---|---|
| `snippet` | `string` Snippet content. |
| `snippet_status` | `string` Status of the snippet defined by the search team. |

## SearchAction

Search action.

| Fields ||
|---|---|
| `query` | `string` The query to search. |

## State

Enumeration of the state of the step.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unknown. |
| `IN_PROGRESS` | Step is currently in progress. |
| `FAILED` | Step currently failed. |
| `SUCCEEDED` | Step has succeeded. |

## AnswerGenerationSpec

The specification for answer generation.

| Fields ||
|---|---|
| `user_defined_classifier_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerGenerationSpec.UserDefinedClassifierSpec` Optional. The specification for user specified classifier spec. |

## UserDefinedClassifierSpec

The specification for user defined classifier.

| Fields ||
|---|---|
| `enable_user_defined_classifier` | `bool` Optional. Whether or not to enable and include user defined classifier. |
| `preamble` | `string` Optional. The preamble to be used for the user defined classifier. |
| `model_id` | `string` Optional. The model ID to be used for the user defined classifier. |
| `task_marker` | `string` Optional. The task marker to be used for the user defined classifier. |
| `top_p` | `double` Optional. The top-p value to be used for the user defined classifier. |
| `top_k` | `int64` Optional. The top-k value to be used for the user defined classifier. |
| `temperature` | `double` Optional. The temperature value to be used for the user defined classifier. |
| `seed` | `int32` Optional. The seed value to be used for the user defined classifier. |

## AnswerQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery` method.

| Fields ||
|---|---|
| `serving_config` | `string` Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Required. Current user query. |
| `session` | `string` The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. |
| `safety_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec` Model specification. |
| `related_questions_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.RelatedQuestionsSpec` Related questions specification. |
| `grounding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.GroundingSpec` Optional. Grounding specification. |
| `answer_generation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec` Answer generation specification. |
| `search_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec` Search specification. |
| `query_understanding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec` Query understanding specification. |
| `asynchronous_mode (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession` method. |
| `user_pseudo_id` | `string` A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |
| `end_user_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec` Optional. End user specification. |

## AnswerGenerationSpec

Answer generation specification.

| Fields ||
|---|---|
| `model_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec` Answer generation model specification. |
| `prompt_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec` Answer generation prompt specification. |
| `include_citations` | `bool` Specifies whether to include citation metadata in the answer. The default value is `false`. |
| `answer_language_code` | `string` Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. |
| `ignore_adversarial_query` | `bool` Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. |
| `ignore_non_answer_seeking_query` | `bool` Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. |
| `ignore_jail_breaking_query` | `bool` Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. |
| `multimodal_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.MultimodalSpec` Optional. Multimodal specification. |
| `ignore_low_relevant_content` | `bool` Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. |

## ModelSpec

Answer Generation Model specification.

| Fields ||
|---|---|
| `model_version` | `string` Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. |

## MultimodalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.

| Fields ||
|---|---|
| `image_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.MultimodalSpec.ImageSource` Optional. Source of image returned in the answer. |

## ImageSource

Specifies the image source.

| Enums ||
|---|---|
| `IMAGE_SOURCE_UNSPECIFIED` | Unspecified image source (multimodal feature is disabled by default). |
| `ALL_AVAILABLE_SOURCES` | Behavior when service determines the pick from all available sources. |
| `CORPUS_IMAGE_ONLY` | Includes image from corpus in the answer. |
| `FIGURE_GENERATION_ONLY` | Triggers figure generation in the answer. |

## PromptSpec

Answer generation prompt specification.

| Fields ||
|---|---|
| `preamble` | `string` Customized preamble. |

## EndUserSpec

End user specification.

| Fields ||
|---|---|
| `end_user_metadata[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData` Optional. End user metadata. |

## EndUserMetaData

End user metadata.

| Fields ||
|---|---|
| Union field `content`. Search result content. `content` can be only one of the following: ||
| `chunk_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo` Chunk information. |

## ChunkInfo

Chunk information.

| Fields ||
|---|---|
| `content` | `string` Chunk textual content. It is limited to 8000 characters. |
| `document_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo.DocumentMetadata` Metadata of the document from the current chunk. |

## DocumentMetadata

Document metadata contains the information of the document of the current chunk.

| Fields ||
|---|---|
| `title` | `string` Title of the document. |

## GroundingSpec

Grounding specification.

| Fields ||
|---|---|
| `include_grounding_supports` | `bool` Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. |
| `filtering_level` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.GroundingSpec.FilteringLevel` Optional. Specifies whether to enable the filtering based on grounding score and at what level. |

## FilteringLevel

Level to filter based on answer grounding.

| Enums ||
|---|---|
| `FILTERING_LEVEL_UNSPECIFIED` | Default is no filter |
| `FILTERING_LEVEL_LOW` | Filter answers based on a low threshold. |
| `FILTERING_LEVEL_HIGH` | Filter answers based on a high threshold. |

## QueryUnderstandingSpec

Query understanding specification.

| Fields ||
|---|---|
| `query_classification_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec` Query classification specification. |
| `query_rephraser_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec` Query rephraser specification. |
| `disable_spell_correction` | `bool` Optional. Whether to disable spell correction. The default value is `false`. |

## QueryClassificationSpec

Query classification specification.

| Fields ||
|---|---|
| `types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec.Type` Enabled query classification types. |

## Type

Query classification types.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified query classification type. |
| `ADVERSARIAL_QUERY` | Adversarial query classification type. |
| `NON_ANSWER_SEEKING_QUERY` | Non-answer-seeking query classification type, for chit chat. |
| `JAIL_BREAKING_QUERY` | Jail-breaking query classification type. |
| `NON_ANSWER_SEEKING_QUERY_V2` | Non-answer-seeking query classification type, for no clear intent. |
| `USER_DEFINED_CLASSIFICATION_QUERY` | User defined query classification type. |

## QueryRephraserSpec

Query rephraser specification.

| Fields ||
|---|---|
| `disable` | `bool` Disable query rephraser. |
| `max_rephrase_steps` | `int32` Max rephrase steps. The max number is 5 steps. If not set or set to \< 1, it will be set to 1 by default. |
| `model_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec` Optional. Query Rephraser Model specification. |

## ModelSpec

Query Rephraser Model specification.

| Fields ||
|---|---|
| `model_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec.ModelType` Optional. Enabled query rephraser model type. If not set, it will use LARGE by default. |

## ModelType

Query rephraser types. Currently only supports single-hop (max_rephrase_steps = 1) model selections. For multi-hop (max_rephrase_steps \> 1), there is only one default model.

| Enums ||
|---|---|
| `MODEL_TYPE_UNSPECIFIED` | Unspecified model type. |
| `SMALL` | Small query rephraser model. Gemini 1.0 XS model. |
| `LARGE` | Large query rephraser model. Gemini 1.0 Pro model. |

## RelatedQuestionsSpec

Related questions specification.

| Fields ||
|---|---|
| `enable` | `bool` Enable related questions feature if true. |

## SafetySpec

Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

| Fields ||
|---|---|
| `enable` | `bool` Enable the safety filtering on the answer response. It is false by default. |
| `safety_settings[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec.SafetySetting` Optional. Safety settings. This settings are effective only when the safety_spec.enable is true. |

## SafetySetting

Safety settings.

| Fields ||
|---|---|
| `category` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HarmCategory` Required. Harm category. |
| `threshold` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec.SafetySetting.HarmBlockThreshold` Required. The harm block threshold. |

## HarmBlockThreshold

Probability based thresholds levels for blocking.

| Enums ||
|---|---|
| `HARM_BLOCK_THRESHOLD_UNSPECIFIED` | Unspecified harm block threshold. |
| `BLOCK_LOW_AND_ABOVE` | Block low threshold and above (i.e. block more). |
| `BLOCK_MEDIUM_AND_ABOVE` | Block medium threshold and above. |
| `BLOCK_ONLY_HIGH` | Block only high threshold (i.e. block less). |
| `BLOCK_NONE` | Block none. |
| `OFF` | Turn off the safety filter. |

## SearchSpec

Search specification.

| Fields ||
|---|---|
| Union field `input`. Search parameters to control the search behavior. Or provide search result list to generate answer. `input` can be only one of the following: ||
| `search_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchParams` Search parameters. |
| `search_result_list` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList` Search result list. |

## SearchParams

Search parameters.

| Fields ||
|---|---|
| `max_return_results` | `int32` Number of search results to return. The default value is 10. |
| `filter` | `string` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |
| `boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec` Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) |
| `order_by` | `string` The order in which documents are returned. Documents can be ordered by a field in an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. |
| `search_result_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode` Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) |
| `custom_fine_tuning_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec` Optional. Custom fine tuning configs. |
| `data_store_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. |
| `natural_language_query_understanding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec` Optional. Specification to enable natural language understanding capabilities for search requests. |

## SearchResultList

Search result list.

| Fields ||
|---|---|
| `search_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult` Search results. |

## SearchResult

Search result.

| Fields ||
|---|---|
| Union field `content`. Search result content. `content` can be only one of the following: ||
| `unstructured_document_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo` Unstructured document information. |
| `chunk_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo` Chunk information. |

## ChunkInfo

Chunk information.

| Fields ||
|---|---|
| `chunk` | `string` Chunk resource name. |
| `content` | `string` Chunk textual content. |
| `document_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata` Metadata of the document from the current chunk. |

## DocumentMetadata

Document metadata contains the information of the document of the current chunk.

| Fields ||
|---|---|
| `uri` | `string` Uri of the document. |
| `title` | `string` Title of the document. |

## UnstructuredDocumentInfo

Unstructured document information.

| Fields ||
|---|---|
| `document` | `string` Document resource name. |
| `uri` | `string` URI for the document. |
| `title` | `string` Title. |
| `document_contexts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext` List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive. |
| `extractive_segments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment` List of extractive segments. |
| `extractive_answers[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer` > [!WARNING] > This item is deprecated! Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers. |

## DocumentContext

Document context.

| Fields ||
|---|---|
| `page_identifier` | `string` Page identifier. |
| `content` | `string` Document content to be used for answer generation. |

## ExtractiveAnswer

Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)

| Fields ||
|---|---|
| `page_identifier` | `string` Page identifier. |
| `content` | `string` Extractive answer content. |

## ExtractiveSegment

Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.

| Fields ||
|---|---|
| `page_identifier` | `string` Page identifier. |
| `content` | `string` Extractive segment content. |

## AnswerQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery` method.

| Fields ||
|---|---|
| `answer` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer` Answer resource object. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.FIELDS.int32.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps` is greater than 1, use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer.FIELDS.string.google.cloud.discoveryengine.v1alpha.Answer.name` to fetch answer information using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer` API. |
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` Session resource object. It will be only available when session field is set and valid in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` request. |
| `answer_query_token` | `string` A global unique ID used for logging. |

## AssistAnswer

AssistAnswer resource, main part of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse`.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.State` State of the answer generation. |
| `connector_display_names` | `map<string, string>` Output only. Maps an internal connector agent name (the machine identifier embedded in tool names, e.g. `custom_mcp_<fingerprint>_agent`) to the connector's human-readable display name. Populated at serving time for custom MCP / agent gateway connectors so user-facing surfaces (e.g. the tool-call chip) can show the connector name instead of its internal identifier. Empty when there are no such connectors. |
| `replies[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.Reply` Replies of the assistant. |
| `diagnostic_info` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Diagnostic information collected while processing the request. This is meant for human readers only, mainly to help with debugging. The structure of the data is subject to change without notice. |
| `assist_skipped_reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.AssistSkippedReason` Reasons for not answering the assist call. |
| `required_authorizations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RequiredAuthorization` Output only. The list of required authorizations. Only populated when the user is not authorized for a particular `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`, but the invoked agent requires it. |
| `customer_policy_enforcement_result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult` Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation. |

## AssistSkippedReason

Possible reasons for not answering an assist call.

| Enums ||
|---|---|
| `ASSIST_SKIPPED_REASON_UNSPECIFIED` | Default value. Skip reason is not specified. |
| `NON_ASSIST_SEEKING_QUERY_IGNORED` | The assistant ignored the query, because it did not appear to be answer-seeking. |
| `CUSTOMER_POLICY_VIOLATION` | The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase). |

## CustomerPolicyEnforcementResult

Customer policy enforcement results. Contains the results of the various policy checks, like the banned phrases or the Model Armor checks.

| Fields ||
|---|---|
| `verdict` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.Verdict` Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK. |
| `policy_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.PolicyEnforcementResult` Customer policy enforcement results. Populated only if the assist call was skipped due to a policy violation. It contains results from those filters that blocked the processing of the query. |
| `violation_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.ViolationSource` Output only. The source of the violation. |

## BannedPhraseEnforcementResult

Customer policy enforcement result for the banned phrase policy.

| Fields ||
|---|---|
| `banned_phrases[]` | `string` The banned phrases that were found in the query or the answer. |

## ModelArmorEnforcementResult

Customer policy enforcement result for the Model Armor policy.

| Fields ||
|---|---|
| Union field `result`. The Model Armor policy result. `result` can be only one of the following: ||
| `model_armor_violation` | `string` The Model Armor violation that was found. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` The error returned by Model Armor if the policy enforcement failed for some reason. |

## PolicyEnforcementResult

Customer policy enforcement result for a single policy type.

| Fields ||
|---|---|
| Union field `enforcement_result`. The policy type specific result. It can be either an error or a detailed information about the policy enforcement result. `enforcement_result` can be only one of the following: ||
| `banned_phrase_enforcement_result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.BannedPhraseEnforcementResult` The policy enforcement result for the banned phrase policy. |
| `model_armor_enforcement_result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.CustomerPolicyEnforcementResult.ModelArmorEnforcementResult` The policy enforcement result for the Model Armor policy. |

## Verdict

The verdict of the customer policy enforcement.

| Enums ||
|---|---|
| `UNSPECIFIED` | Unknown value. |
| `ALLOW` | There was no policy violation. |
| `BLOCK` | Processing was blocked by the customer policy. |

## ViolationSource

If the assist call was skipped due to a policy violation, this contains the source of the violation.

| Enums ||
|---|---|
| `VIOLATION_SOURCE_UNSPECIFIED` | Unknown value. |
| `SYSTEM` | Violation found in the system response. |
| `PROMPT` | Violation found in the user prompt. |
| `ATTACHMENT` | Violation found in the user attachment. |

## Reply

One part of the multi-part response of the assist call.

| Fields ||
|---|---|
| `reply_id` | `string` Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.StreamAssist` call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse` messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time when the reply was created. |
| Union field `reply`. Alternatives for the assistant reply. `reply` can be only one of the following: ||
| `grounded_content` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent` Possibly grounded response text or media from the assistant. |

## State

State of the answer generation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unknown. |
| `IN_PROGRESS` | Assist operation is currently in progress. |
| `FAILED` | Assist operation has failed. |
| `SUCCEEDED` | Assist operation has succeeded. |
| `SKIPPED` | Assist operation has been skipped. |
| `CANCELLED` | Assist operation has been cancelled (e.g. client closed the stream). May contain a partial response. |

## AssistGenerationConfig

> [!WARNING]
> This item is deprecated!

Assistant generation configuration to be used for the request.

| Fields ||
|---|---|
| `model_id` | `string` Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. |

## AssistRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.Assist` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. |
| `session` | `string` Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `assist_skipping_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest.AssistSkippingMode` Optional. Determines the cases in which the assistant will not answer the query. If the answer is skipped, the reasons will be listed in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.AssistAnswer.AssistSkippedReason.google.cloud.discoveryengine.v1alpha.AssistAnswer.assist_skipped_reasons` within `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.FIELDS.google.cloud.discoveryengine.v1alpha.AssistAnswer.google.cloud.discoveryengine.v1alpha.AssistResponse.answer`. |
| `file_ids[]` | `string` Optional. The IDs of the files to be used for answering the request. When uploading a file, its ID is returned in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileResponse.file_id`. |
| `user_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistUserMetadata` Optional. Information about the user initiating the query. |
| `language_code` | `string` Optional. Language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. |
| `web_grounding_enabled` | `bool` Optional. If set to true, enables grounding with web search. Works only if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.google.cloud.discoveryengine.v1alpha.Assistant.web_grounding_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. |
| `data_store_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` Optional. Specs defining `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to filter on in a search call and configurations for those data stores. This is only considered for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s with multiple data stores. Not setting this field will result in using all data stores in the engine, except when `ignore_data_stores` is set to true. |
| `assist_generation_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistGenerationConfig` Optional. Request level generation configuration. This is used to override the default generation configuration at the engine level. |
| `maps_grounding_enabled` | `bool` Optional. If set to `true`, enables grounding with Google Maps. Works only if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.google.cloud.discoveryengine.v1alpha.Assistant.MapsGroundingType.google.cloud.discoveryengine.v1alpha.Assistant.maps_grounding_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.MapsGroundingType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.Assistant.MapsGroundingType.MAPS_GROUNDING_TYPE_GOOGLE_MAPS`. |
| `google_search_grounding_enabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.AssistRequest.web_grounding_enabled` instead. |

## AssistSkippingMode

Available skipping behaviors for assist requests.

| Enums ||
|---|---|
| `ASSIST_SKIPPING_MODE_UNSPECIFIED` | Default value. The answer can be skipped if the query isn't seeking assistance. |
| `REQUEST_ASSIST` | Request Assistant answer. The answer may still be skipped if the query fails policy checks. |

## AssistResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.Assist` method.

| Fields ||
|---|---|
| `answer` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` resource generated in response to the query. |
| `session_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.SessionInfo` Session information. |
| `assist_token` | `string` A global unique ID that identifies the current request-response pair. Used for feedback and support. |
| `invocation_tools[]` | `string` The tool names of the tools that were invoked. |
| `invoked_skills[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.InvokedSkill` The skills executed during the turn. |
| `connector_auth_errors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.ConnectorAuthError` Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors. |

## ConnectorAuthError

Describes an authentication error for a specific data connector.

| Fields ||
|---|---|
| `data_connector` | `string` Resource name of the data connector that failed authentication. |
| `error_message` | `string` Human-readable error message describing the auth failure. |

## InvokedSkill

Represents a skill used during the assist call.

| Fields ||
|---|---|
| `name` | `string` The resource name of the skill. |
| `display_name` | `string` The display name of the skill. |

## SessionInfo

Information about the session.

| Fields ||
|---|---|
| `session` | `string` Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `query_id` | `string` Query ID that corresponds to this assist API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Assist API call, the assist request happens in the context of the search results from this search call. |

## AssistUserMetadata

User metadata of the request.

| Fields ||
|---|---|
| `time_zone` | `string` Optional. IANA time zone, e.g. Europe/Budapest. |
| `preferred_language_code` | `string` Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. |

## Assistant

Discovery Engine Assistant resource.

| Fields ||
|---|---|
| `name` | `string` Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. |
| `description` | `string` Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. |
| `generation_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig` Optional. Configuration for the generation of the assistant response. |
| `google_search_grounding_enabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.google.cloud.discoveryengine.v1alpha.Assistant.web_grounding_type` instead. |
| `web_grounding_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType` Optional. The type of web grounding to use. |
| `default_web_grounding_toggle_off` | `bool` Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| `maps_grounding_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.MapsGroundingType` Optional. The type of Google Maps grounding to use. |
| `default_maps_grounding_toggle_off` | `bool` Optional. This field controls the default maps grounding toggle for end users if `maps_grounding_type` is set to `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`. By default, this field is set to false. If `maps_grounding_type` is `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`, end users will have maps grounding enabled by default on UI. If true, the grounding toggle will default to the OFF position in the UI. End users can still enable maps grounding in the UI if maps grounding is enabled. |
| `vertex_ai_agent_configs[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.VertexAiAgentConfig` > [!WARNING] > This item is deprecated! Optional. Deprecated: Will be replaced by Dialogflow agents in AgentService. List of Vertex AI Agents that can be reached through the assistant. |
| `enabled_actions (deprecated)` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ActionList`>`` > [!WARNING] > This item is deprecated! Optional. Deprecated: will be replaced by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Assistant.EnabledToolsEntry.google.cloud.discoveryengine.v1alpha.Assistant.enabled_tools` instead. The enabled actions on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled actions towards the connector instance. Admin can selectively enable multiple actions on any of the connector instances that they created in the project. For example {"jira1ConnectorName": \[(actionId1, "createTicket"), (actionId2, "transferTicket")\], "gmail1ConnectorName": \[(actionId3, "sendEmail"),..\] } |
| `enabled_tools` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolList`>`` Optional. Note: not implemented yet. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Assistant.EnabledActionsEntry.google.cloud.discoveryengine.v1alpha.Assistant.enabled_actions` instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": \[(toolId1, "createTicket"), (toolId2, "transferTicket")\], "gmail1ConnectorName": \[(toolId3, "sendEmail"),..\] } |
| `customer_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy` Optional. Customer policy for the assistant. |
| `vertex_ai_search_tool_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.VertexAiSearchToolConfig` Optional. Configuration options for the Vertex AI Search tool. |
| `style_and_formatting_instructions (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. Deprecated: Please use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig.SystemInstruction.FIELDS.string.google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig.SystemInstruction.additional_system_instruction` instead. Common system instruction snippet for setting conversation style, tone and formatting. Added to all LLM prompts via the placeholder `[STYLE_AND_FORMATTING_INSTRUCTIONS]`. |
| `agent_configs[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig` > [!WARNING] > This item is deprecated! Optional. Deprecated: Please use AgentService instead. List of Agents that can be reached through the assistant. |
| `enable_end_user_agent_creation` | `bool` Optional. Indicates whether end users are allowed to create agents in the Agentspace. |
| `disable_location_context` | `bool` Optional. Indicates whether to disable user location context. By default, user location context is enabled. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Represents the time when this Assistant was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Represents the time when this Assistant was most recently updated. |
| `knowledge_catalog_enabled` | `bool` Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. If unspecified, defaults to true. |

## ActionInfo

> [!WARNING]
> This item is deprecated!

Deprecated: Will be replaced by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolInfo` instead. Information to identify an action.

| Fields ||
|---|---|
| `action_name` | `string` The name of the action as defined by DataConnectorService.QueryAvailableActions. |
| `action_display_name` | `string` The display name of the action. |

## ActionList

> [!WARNING]
> This item is deprecated!

Deprecated: Will be replaced by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolList` instead. The enabled actions on a connector

| Fields ||
|---|---|
| `action_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ActionInfo` The list of actions with corresponding action information. |

## AgentConfig

> [!WARNING]
> This item is deprecated!

Deprecated: Please use AgentService instead. Configuration options for the agents that the assistant may call when processing queries.

| Fields ||
|---|---|
| `id` | `string` Required. A unique, human-readable ID for the agent. Must match the following regular expression: `[a-z][a-zA-Z0-9_-]*`. |
| `display_name` | `string` Required. Display name of the agent used for reference in the assistant. |
| `tool_description` | `string` Required. The tool description of the agent. This description will be used by the LLM to decide whether the agent is relevant to the user question and the question should be routed to the agent. |
| `icon` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.Image` Required. The icon that represents the agent on the UI. |
| `authorizations[]` | `string` Optional. Resource names of the required authorizations. If the user is not authorized, the service will return a number of authorization URIs that the user must open in a browser and authorize. Once all authorizations are granted, the user can retry the query, and the authorizations will be forwarded to the agent. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |
| Union field `connection_info`. The connection configuration of the agent. `connection_info` can be only one of the following: ||
| `vertex_ai_sdk_agent_connection_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.VertexAiSdkAgentConnectionInfo` Required. Connection information for a Vertex AI SDK agent |
| `http_agent_connection_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.HttpAgentConnectionInfo` Required. Connection info for an HTTP agent. |

## HttpAgentConnectionInfo

A agent that is reachable by the assistant via HTTP.

| Fields ||
|---|---|
| `http_uri` | `string` Required. The HTTP address of the agent, e.g. "https://example.com/agent1". |

## Image

Represents an image.

| Fields ||
|---|---|
| Union field `storage_method`. Can be either a URI or the content encoded as a base64 string. `storage_method` can be only one of the following: ||
| `uri` | `string` Required. Image URI. |
| `content` | `string` Required. Base64-encoded image file contents. |

## VertexAiSdkAgentConnectionInfo

Connection information for a Vertex AI SDK agent - currently only agents exposed through Reasoning Engines are supported.

| Fields ||
|---|---|
| `reasoning_engine` | `string` Resource name of the reasoning engine exposing the agent. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` |

## CustomerPolicy

Customer-defined policy for the assistant.

| Fields ||
|---|---|
| `banned_phrases[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.BannedPhrase` Optional. List of banned phrases. |
| `model_armor_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.ModelArmorConfig` Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. |
| `data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy` Optional. Data protection policy to be used for sanitizing file uploads. |

## BannedPhrase

Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused.

| Fields ||
|---|---|
| `phrase` | `string` Required. The raw string content to be banned. |
| `match_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.BannedPhrase.BannedPhraseMatchType` Optional. Match type for the banned phrase. |
| `ignore_diacritics` | `bool` Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, "cafe" would match "café". |

## BannedPhraseMatchType

The matching method for the banned phrase.

| Enums ||
|---|---|
| `BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED` | Defaults to SIMPLE_STRING_MATCH. |
| `SIMPLE_STRING_MATCH` | The banned phrase matches if it is found anywhere in the text as an exact substring. |
| `WORD_BOUNDARY_STRING_MATCH` | Banned phrase only matches if the pattern found in the text is surrounded by word delimiters. The phrase itself may still contain word delimiters. |

## ModelArmorConfig

Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and assistant responses.

| Fields ||
|---|---|
| `user_prompt_template` | `string` Optional. The resource name of the Model Armor template for sanitizing user prompts. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the user prompt. |
| `response_template` | `string` Optional. The resource name of the Model Armor template for sanitizing assistant responses. Format: `projects/{project}/locations/{location}/templates/{template_id}` If not specified, no sanitization will be applied to the assistant response. |
| `failure_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.CustomerPolicy.ModelArmorConfig.FailureMode` Optional. Defines the failure mode for Model Armor sanitization. |

## FailureMode

Determines the behavior when Model Armor fails to process a request.

| Enums ||
|---|---|
| `FAILURE_MODE_UNSPECIFIED` | Unspecified failure mode, default behavior is `FAIL_CLOSED`. |
| `FAIL_OPEN` | In case of a Model Armor processing failure, the request is allowed to proceed without any changes. |
| `FAIL_CLOSED` | In case of a Model Armor processing failure, the request is rejected. |

## GenerationConfig

Configuration for the generation of the assistant response.

| Fields ||
|---|---|
| `default_model_id` | `string` Optional. The default model to use for assistant. |
| `allowed_model_ids[]` | `string` Optional. The list of models that are allowed to be used for assistant. |
| `system_instruction` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.GenerationConfig.SystemInstruction` System instruction, also known as the prompt preamble for LLM calls. See also <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions> |
| `default_language` | `string` The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected. |

## SystemInstruction

System instruction, also known as the prompt preamble for LLM calls.

| Fields ||
|---|---|
| `additional_system_instruction` | `string` Optional. Additional system instruction that will be added to the default system instruction. |

## MapsGroundingType

The type of Google Maps grounding to use.

| Enums ||
|---|---|
| `MAPS_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `MAPS_GROUNDING_TYPE_DISABLED` | Maps grounding is disabled. |
| `MAPS_GROUNDING_TYPE_GOOGLE_MAPS` | Grounding with Google Maps is enabled. |

## ToolInfo

Information to identify a tool.

| Fields ||
|---|---|
| `tool_name` | `string` The name of the tool as defined by DataConnectorService.QueryAvailableActions. Note: it's using `action` in the DataConnectorService apis, but they are the same as the `tool` here. |
| `tool_display_name` | `string` The display name of the tool. |

## ToolList

The enabled tools on a connector

| Fields ||
|---|---|
| `tool_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.ToolInfo` The list of tools with corresponding tool information. |

## VertexAiAgentConfig

> [!WARNING]
> This item is deprecated!

Deprecated: Use Dialogflow agents in AgentService instead. Represents an external Vertex AI Agent that can be reached through the assistant.

| Fields ||
|---|---|
| `display_name` | `string` Required. Display name of the Vertex AI Agent used for reference in the assistant. |
| `name` | `string` Required. Resource name of the Vertex AI Agent. Format: `projects/{project}/locations/{location}/agents/{agent}` |
| `tool_description` | `string` Required. The tool description of the Vertex AI Agent. This description will be used by the LLM to decide whether the agent is relevant to the user question and the question should be routed to the agent. |

## VertexAiSearchToolConfig

Configuration options for the Vertex AI Search tool that the assistant may use when processing queries.

| Fields ||
|---|---|
| `llm_system_instructions (deprecated)` | `string` > [!WARNING] > This item is deprecated! Deprecated: Please refrain from using this field. System instructions for answering based on the search results of Vertex AI Search. Note that the answer produced by the search tool may differ from the final answer of the assistant. In general, system instructions are a set of natural language instructions that the model processes before it processes prompts. It tells the model how it should behave and respond to prompts. See <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions> Example: "Use information only from the sources to answer. Also, make sure to nicely format the answer with Markdown." If not specified, the internal default will be used. |

## WebGroundingType

The type of web grounding to use.

| Enums ||
|---|---|
| `WEB_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `WEB_GROUNDING_TYPE_DISABLED` | Web grounding is disabled. |
| `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` | Grounding with Google Search is enabled. |
| `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH` | Grounding with Enterprise Web Search is enabled. |

## AssistantContent

Multi-modal content.

| Fields ||
|---|---|
| `role` | `string` The producer of the content. Can be "model" or "user". |
| `thought` | `bool` Optional. Indicates if the part is thought from the model. |
| Union field `data`. Contained data. `data` can be only one of the following: ||
| `text` | `string` Inline text. |
| `inline_data` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.Blob` Inline binary data. |
| `file` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.File` A file, e.g., an audio summary. |
| `executable_code` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.ExecutableCode` Code generated by the model that is meant to be executed. |
| `code_execution_result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.CodeExecutionResult` Result of executing an ExecutableCode. |

## Blob

Inline blob.

| Fields ||
|---|---|
| `mime_type` | `string` Required. The media type (MIME type) of the generated data. |
| `data` | `bytes` Required. Raw bytes. |

## CodeExecutionResult

Result of executing ExecutableCode.

| Fields ||
|---|---|
| `outcome` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent.CodeExecutionResult.Outcome` Required. Outcome of the code execution. |
| `output` | `string` Optional. Contains stdout when code execution is successful, stderr or other description otherwise. |

## Outcome

Enumeration of possible outcomes of the code execution.

| Enums ||
|---|---|
| `OUTCOME_UNSPECIFIED` | Unspecified status. This value should not be used. |
| `OUTCOME_OK` | Code execution completed successfully. |
| `OUTCOME_FAILED` | Code execution finished but with a failure. `stderr` should contain the reason. |
| `OUTCOME_DEADLINE_EXCEEDED` | Code execution ran for too long, and was cancelled. There may or may not be a partial output present. |

## ExecutableCode

Code generated by the model that is meant to be executed by the model.

| Fields ||
|---|---|
| `code` | `string` Required. The code content. Currently only supports Python. |

## File

A file, e.g., an audio summary.

| Fields ||
|---|---|
| `mime_type` | `string` Required. The media type (MIME type) of the file. |
| `file_id` | `string` Required. The file ID. |

## AssistantGroundedContent

A piece of content and possibly its grounding information.

Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.

| Fields ||
|---|---|
| `content` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantContent` The content. |
| `citation_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CitationMetadata` Source attribution of the generated content. See also <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check> |
| `content_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.ContentMetadata` Optional. Metadata for the content. Currently only used for answers of research assistants. |
| Union field `metadata`. Grounding metadata for various modals. It only supports text for now. `metadata` can be only one of the following: ||
| `text_grounding_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata` Metadata for grounding based on text sources. |

## ContentMetadata

Metadata for the content.

| Fields ||
|---|---|
| `content_kind` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.ContentMetadata.ContentKind` Type of the content. Shows which part of the answer of the research assistant this content belongs to. |
| `content_id` | `string` ID of the content. It is used to connect research questions with answers to them. For example, the parts of the answer to a research question will have the same `content_id` as the question. |

## ContentKind

Possible content kinds. Currently only used for differentiating sections in the full answer of a research assistant.

| Enums ||
|---|---|
| `CONTENT_KIND_UNSPECIFIED` | Unknown. |
| `RESEARCH_PLAN` | Research plan. |
| `RESEARCH_QUESTION` | Research question. |
| `RESEARCH_ANSWER` | Research answer. |
| `RESEARCH_REPORT` | Research report. |
| `RESEARCH_AUDIO_SUMMARY` | Research audio summary. |

## TextGroundingMetadata

Grounding details for text sources.

| Fields ||
|---|---|
| `segments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Segment` Grounding information for parts of the text. |
| `visual_segments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.VisualSegment` Grounding information for parts of the visual content. |
| `references[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference` References for the grounded text. |
| `search_entry_points[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.SearchEntryPoint` Optional. Google Search entry points for the web searches used for grounding. |

## Reference

Referenced content and related document metadata.

| Fields ||
|---|---|
| `content` | `string` Referenced text content. |
| `code_snippet` | `string` Chunk of code snippet from the referenced document. |
| `document_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata` Document metadata. |
| `chunk_metadata` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. Generic structured chunk metadata from upstream data source connectors. |

## DocumentMetadata

Document metadata.

| Fields ||
|---|---|
| `language` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.Language` |
| `bounding_boxes[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox` Optional. Bounding boxes for this reference. Repeated to support references spawning multiple pages. |
| `document` | `string` Document resource name. |
| `uri` | `string` URI for the document. It may contain a URL that redirects to the actual website. |
| `title` | `string` Title. |
| `page_identifier` | `string` Page identifier. |
| `domain` | `string` Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. |
| `mime_type` | `string` The mime type of the document. <https://www.iana.org/assignments/media-types/media-types.xhtml>. |

## BoundingBox

A bounding box that spawns a single page.

| Fields ||
|---|---|
| `page_number` | `string` |
| `bounding_poly` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox.BoundingPoly` Bounding poly for the text content in the document. |

## BoundingPoly

Bounding poly for the text content in the document.

| Fields ||
|---|---|
| `normalized_vertices[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata.BoundingBox.BoundingPoly.NormalizedVertex` |

## NormalizedVertex

A vertex represents a 2D point in the image.

NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

| Fields ||
|---|---|
| `x` | `float` X coordinate. |
| `y` | `float` Y coordinate (starts from the top of the image). |

## Language

Language of the referenced content. For now, it is only used for code.

| Enums ||
|---|---|
| `LANGUAGE_UNSPECIFIED` |   |
| `PYTHON` |   |
| `SQL` |   |

## SearchEntryPoint

Google Search entry point.

| Fields ||
|---|---|
| `rendered_content` | `string` Web content snippet that can be embedded in a web page or an app webview. |

## Segment

Grounding information for a segment of the text.

| Fields ||
|---|---|
| `start_index` | `int64` Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). |
| `end_index` | `int64` End of the segment, exclusive. |
| `reference_indices[]` | `int32` References for the segment. |
| `grounding_score` | `float` Score for the segment. |
| `text` | `string` The text segment itself. |

## VisualSegment

Grounding information for a visual segment.

| Fields ||
|---|---|
| `reference_indices[]` | `int32` References for the visual segment. |
| `content_id` | `string` The content ID of the visual segment. In order to display the citation of the visual element, this content_id needs to match with the `grounded_content.content_metadata.content_id` field. |

## AssistantMessageDroppedEvent

Event indicating that a message payload could not be delivered through the real-time channel, e.g., due to size limits or compliance requirements. The message must be fetched through separate RPC instead.

| Fields ||
|---|---|
| `reason` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantMessageDroppedEvent.Reason` Output only. The reason why the message was dropped. |

## Reason

The reason why the message was dropped.

| Enums ||
|---|---|
| `REASON_UNSPECIFIED` | Default value. |
| `SIZE_EXCEEDED` | The message payload exceeded the size limit for the channel. |

## AssistantStreamAssistResponseEvent

Event for a part of an LLM response in a collaborative session.

| Fields ||
|---|---|
| `turn_id` | `string` Output only. The turn ID of the response. |
| `chunk_id_start` | `int64` Output only. The start chunk ID of the response. This is inclusive. |
| `chunk_id_end` | `int64` Output only. The chunk ID when the next AssistantStreamAssistResponseEvent should start. This is exclusive. |
| `stream_assist_responses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse` Output only. The stream assist response for the event. There should be exactly (chunk_id_end - chunk_id_start) responses, one for each chunk. |

## AssistantUserMessageEvent

Event for a user sending a message in a collaborative session.

| Fields ||
|---|---|
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionUserInfo` Output only. Information about the user sending the message. |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Output only. The query sent by the user. |

## AuthConfig

Configuration for third-party authorization.

| Fields ||
|---|---|
| Union field `credential`. Configuration for the credential. `credential` can be only one of the following: ||
| `oauth2` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OAuth2Credential` OAuth2 credential configuration. |

## Authorization

Discovery Engine Authorization resource.

| Fields ||
|---|---|
| `name` | `string` Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. |
| Union field `authorization_config`. The authorization configuration. `authorization_config` can be only one of the following: ||
| `server_side_oauth2` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization.ServerSideOAuth2` Server-side OAuth2 configuration. |

## ServerSideOAuth2

OAuth2 configuration.

| Fields ||
|---|---|
| `client_id` | `string` Required. The OAuth2 client ID. |
| `client_secret` | `string` Required. The OAuth2 client secret. Encrypted at rest. |
| `token_uri` | `string` Required. The HTTP endpoint that exchanges a client authorization for an access token. |
| `authorization_uri` | `string` Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. |
| `scopes[]` | `string` Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. |
| `pkce_verification_enabled` | `bool` Optional. Whether to enable PKCE verification. <https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/> |
| `basic_authentication_enabled` | `bool` Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used. |
| `private_network_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization.ServerSideOAuth2.PrivateNetworkConfig` Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress. |

## PrivateNetworkConfig

Identifies the instance hosting an OAuth provider that is reachable only over a private network.

| Fields ||
|---|---|
| `instance_resource` | `string` Required. Resource name of the instance hosting the OAuth provider. For Looker, the Looker instance, in the form `projects/{project}/locations/{location}/instances/{instance}`. |

## AuthorizationConfig

Describes the authorizations required.

| Fields ||
|---|---|
| `tool_authorizations[]` | `string` Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body. |
| `agent_authorization` | `string` Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header. |

## BAPConfig

The configuration for the BAP connector.

| Fields ||
|---|---|
| `supported_connector_modes[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig.ConnectorMode` Required. The supported connector modes for the associated BAP connection. |
| `enabled_actions[]` | `string` Optional. The actions enabled on the associated BAP connection. |
| `toolspec_override` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig.ToolspecOverride` Optional. Custom toolspec overrides for this connection. For Enterprise BAP connectors that support admin-curated tool definitions, this holds the (simplified) per-tool overrides. On Get, populated by the server by merging persisted overrides with live runtime tool definitions and trimming the result for UI consumption. On Update, the supplied value replaces the persisted overrides after server-side validation and merging: the `base_version` field MUST match the server's current base toolspec version (otherwise the request is rejected with a user-facing error directing the admin to re-download the latest tools first). |

## ConnectorMode

Use cases supported by this BAP connector.

| Enums ||
|---|---|
| `CONNECTOR_MODE_UNSPECIFIED` | Connector mode unspecified. |
| `DATA_INGESTION` | Connector utilized for data ingestion. |
| `ACTIONS` | Connector utilized for Actions |
| `END_USER_AUTHENTICATION` | Connector utilized for End User Authentication. |

## ToolspecOverride

Customer-facing view of the admin-curated toolspec for a BAP connection. Holds the (simplified) per-tool definitions surfaced to and editable by the admin in the Discovery Engine UI.

Mirrors the shape of the backend `google.cloud.connectorexecution.v1.ToolspecOverride` message, but is intentionally kept as a separate public type so the Discovery Engine API surface can evolve independently of the fed-API surface (AIP-215). Handlers convert between the two via helpers in //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.

| Fields ||
|---|---|
| `tools[]` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Required. Tool definitions (one Struct per tool) that the admin has customised on top of the base toolspec returned by the fed API. REQUIRED because it is the only user-editable field in the modify API; the request must carry at least one tool. |
| `base_version` | `string` Required. Base toolspec version against which `tools` were authored. On Update, MUST match the server's current stable toolspec version for the connection; mismatch is rejected with a user-facing error directing the admin to re-download the latest tools first. |

## BatchCreateTargetSiteMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## BatchCreateTargetSitesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. |
| `requests[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateTargetSiteRequest` Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. |

## BatchCreateTargetSitesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchCreateTargetSites` method.

| Fields ||
|---|---|
| `target_sites[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` TargetSites created. |

## BatchGetDocumentsMetadataRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. |
| `matcher` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.Matcher` Required. Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. |

## FhirMatcher

Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s by FHIR resource names.

| Fields ||
|---|---|
| `fhir_resources[]` | `string` Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |

## Matcher

Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. Currently supports matching by exact URIs.

| Fields ||
|---|---|
| Union field `matcher`. Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. `matcher` can be only one of the following: ||
| `uris_matcher` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.UrisMatcher` Matcher by exact URIs. |
| `fhir_matcher` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.FhirMatcher` Matcher by FHIR resource names. |

## UrisMatcher

Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s by exact uris.

| Fields ||
|---|---|
| `uris[]` | `string` The exact URIs to match by. |

## BatchGetDocumentsMetadataResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.BatchGetDocumentsMetadata` method.

| Fields ||
|---|---|
| `documents_metadata[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.DocumentMetadata` The metadata of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. |

## DocumentMetadata

The metadata of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`.

| Fields ||
|---|---|
| `matcher_value` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue` The value of the matcher that was used to match the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse.State` The state of the document. |
| `last_refreshed_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The timestamp of the last time the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` was last indexed. |
| `data_ingestion_source` | `string` The data ingestion source of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. Allowed values are: - `batch`: Data ingested via Batch API, e.g., ImportDocuments. - `streaming` Data ingested via Streaming API, e.g., FHIR streaming. |

## MatcherValue

The value of the matcher that was used to match the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`.

| Fields ||
|---|---|
| Union field `matcher_value`. The value of the matcher that was used to match the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. `matcher_value` can be only one of the following: ||
| `uri` | `string` If match by URI, the URI of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. |
| `fhir_resource` | `string` Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |

## State

The state of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Should never be set. |
| `INDEXED` | The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` is indexed. |
| `NOT_IN_TARGET_SITE` | The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` is not indexed because its URI is not in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`. |
| `NOT_IN_INDEX` | The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` is not indexed. |

## BatchUpdateUserLicensesMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.BatchUpdateUserLicenses` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of user licenses successfully updated. |
| `failure_count` | `int64` Count of user licenses that failed to be updated. |

## BatchUpdateUserLicensesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.BatchUpdateUserLicenses` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. |
| `delete_unassigned_user_licenses` | `bool` Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. |
| Union field `source`. Required. The source of the input. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BatchUpdateUserLicensesRequest.InlineSource` The inline source for the input content for license assignment. |

## InlineSource

The inline source for the input config for BatchUpdateUserLicenses method.

| Fields ||
|---|---|
| `user_licenses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense` Required. A list of user licenses to update. Each user license must have a valid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserLicense.user_principal`. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. |

## BatchUpdateUserLicensesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.BatchUpdateUserLicenses` method.

| Fields ||
|---|---|
| `user_licenses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense` UserLicenses successfully updated. |
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |

## BatchVerifyTargetSitesMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## BatchVerifyTargetSitesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. |

## BatchVerifyTargetSitesResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.BatchVerifyTargetSites` method.

## BigQueryDestination

The BigQuery output destination configuration.

| Fields ||
|---|---|
| `dataset_id` | `string` Required. The ID of a BigQuery Dataset. |
| `table_id` | `string` Required. The table_id of exported BigQuery table. |

## BigQuerySource

BigQuery source import data from.

| Fields ||
|---|---|
| `project_id` | `string` The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `dataset_id` | `string` Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. |
| `table_id` | `string` Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. |
| `gcs_staging_dir` | `string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. |
| `data_schema` | `string` The schema to use when parsing the data from the source. Supported values for user event imports: - `user_event` (default): One `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` per row. Supported values for document imports: - `document` (default): One `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` format per row. Each document must have a valid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id` and one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.json_data` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.google.protobuf.Struct.google.cloud.discoveryengine.v1alpha.Document.struct_data`. - `custom`: One custom data per row in arbitrary format that conforms to the defined `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` of the data store. This can only be used by the GENERIC Data Store vertical. |
| Union field `partition`. BigQuery table partition info. Leave this empty if the BigQuery table is not partitioned. `partition` can be only one of the following: ||
| `partition_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. |

## BigtableOptions

The Bigtable Options object that contains information to support the import.

| Fields ||
|---|---|
| `key_field_name` | `string` The field name used for saving row key value in the document. The name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. |
| `families` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.BigtableColumnFamily`>`` The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. |

## BigtableColumn

The column of the Bigtable.

| Fields ||
|---|---|
| `qualifier` | `bytes` Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. |
| `field_name` | `string` The field name to use for this column in the document. The name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. |
| `encoding` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Encoding` The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: - `TEXT`: indicates values are alphanumeric text strings. - `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. |
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Type` The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. |

## BigtableColumnFamily

The column family of the Bigtable.

| Fields ||
|---|---|
| `field_name` | `string` The field name to use for this column family in the document. The name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. |
| `encoding` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Encoding` The encoding mode of the values when the type is not STRING. Acceptable encoding values are: - `TEXT`: indicates values are alphanumeric text strings. - `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. |
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.Type` The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. |
| `columns[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions.BigtableColumn` The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. |

## Encoding

The encoding mode of a Bigtable column or column family.

| Enums ||
|---|---|
| `ENCODING_UNSPECIFIED` | The encoding is unspecified. |
| `TEXT` | Text encoding. |
| `BINARY` | Binary encoding. |

## Type

The type of values in a Bigtable column or column family. The values are expected to be encoded using [HBase Bytes.toBytes](https://hbase.apache.org/1.4/apidocs/org/apache/hadoop/hbase/util/Bytes.html) function when the encoding value is set to `BINARY`.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | The type is unspecified. |
| `STRING` | String type. |
| `NUMBER` | Numerical type. |
| `INTEGER` | Integer type. |
| `VAR_INTEGER` | Variable length integer type. |
| `BIG_NUMERIC` | BigDecimal type. |
| `BOOLEAN` | Boolean type. |
| `JSON` | JSON type. |

## BigtableSource

The Cloud Bigtable source for importing data.

| Fields ||
|---|---|
| `project_id` | `string` The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `instance_id` | `string` Required. The instance ID of the Cloud Bigtable that needs to be imported. |
| `table_id` | `string` Required. The table ID of the Cloud Bigtable that needs to be imported. |
| `bigtable_options` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableOptions` Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. |

## BillingAccountLicenseConfig

Information about license configs at billing account level.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`. |
| `license_count` | `int64` Required. The number of licenses purchased under this billing account license config. |
| `license_config_distributions` | `map<string, int64>` A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it. |
| `subscription_name` | `string` Output only. The corresponding SubV3 subscription name. |
| `subscription_tier` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTier` Required. The subscription tier. |
| `subscription_term` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTerm` Required. The subscription term. |
| `start_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Required. The subscription start date. |
| `end_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Optional. The planed subscription end date. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig.State` Output only. The state of the BillingAccountLicenseConfig. |
| `auto_renew` | `bool` Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date. |
| `procurement_entitlement_id` | `string` The procurement entitlement ID of the subscription. |
| `subscription_display_name` | `string` The subscription display name. |
| `gemini_bundle` | `bool` Whether the license config is for Gemini bundle. |
| `early_terminated` | `bool` Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. |
| `early_termination_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` The date when the subscription is terminated earlier than the expiration date. |

## State

BillingAccountLicenseConfig state enumeration.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The BillingAccountLicenseConfig does not exist. Default value. Do not use. |
| `ACTIVE` | The BillingAccountLicenseConfig is active and being used. |
| `EXPIRED` | The BillingAccountLicenseConfig has expired. |
| `NOT_STARTED` | The BillingAccountLicenseConfig has not started yet, and its start date is in the future. |
| `DEACTIVATING` | The BillingAccountLicenseConfig is in a grace period. Its subscription has ended, either through early termination or by reaching its end date, but the customer keeps access for a limited time. It becomes EXPIRED when the grace period ends. |

## BillingMetricType

Type of billing metric for usage stats.

| Enums ||
|---|---|
| `BILLING_METRIC_TYPE_UNSPECIFIED` | Default value. |
| `DAILY_MDN_QPM` | Daily median search request QPM. |
| `DAILY_MIN_QPM` | Daily min search request QPM. |
| `DAILY_MAX_QPM` | Daily max search request QPM. |
| `DAILY_SEARCH_REQUEST` | Daily search request total. |
| `TOTAL_STORAGE` | Total storage bytes for indexing core. |

## Branch

A data branch that stores `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s.

| Fields ||
|---|---|
| `name` | `string` Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`. |
| `display_name` | `string` Output only. Human readable name of the branch to display in the UI. |
| `is_default` | `bool` Output only. Indicates whether this branch is set as the default branch of its parent data store. |
| `last_document_import_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp of last import through `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments`. Empty value means no import has been made to this branch. |
| `branch_stats` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch.BranchStats` Output only. Statistics describing a branch. This field is not populated in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.BranchView.BRANCH_VIEW_BASIC` view. |

## BranchStats

Statistics describing a branch.

| Fields ||
|---|---|
| `document_counts` | `map<string, int64>` The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: \['all'\]. |

## BranchView

A view that specifies different level of fields of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch` to show in responses.

| Enums ||
|---|---|
| `BRANCH_VIEW_UNSPECIFIED` | The value when it's unspecified. This defaults to the BASIC view. |
| `BRANCH_VIEW_BASIC` | Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch` to know what is excluded. |
| `BRANCH_VIEW_FULL` | Includes all fields of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`. |

## BuildActionInvocationRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.BuildActionInvocation` method.

| Fields ||
|---|---|
| `name` | `string` Required. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` resource. The data connector used for building the action invocation. |
| `action_name` | `string` Required. Name of the action. For example: `"send_email"` |
| `language_code` | `string` Optional. Language to be used for status and error messages. |

## BuildActionInvocationResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.BuildActionInvocation` method.

| Fields ||
|---|---|
| `action_invocation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionInvocation` The action invocation. |

## CannedQuery

Canned query resource of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. It represents a short-cut to a predefined conversation start.

| Fields ||
|---|---|
| `name` | `string` Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters. |
| `default_texts` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.CannedQueryTexts` Required. The default (non-localized) values for the text attributes. |
| `localized_texts` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.CannedQueryTexts`>`` Optional. The translations of the text attributes. The keys should be BCP-47 language codes. |
| `required_capabilities[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.AssistantCapability` Optional. The capabilities the Assistant needs to have to use this canned query. |
| `enabled` | `bool` Whether this canned query is enabled. |
| `google_defined` | `bool` Output only. Whether this is a Google-defined, read-only canned query. |

## AssistantCapability

Capability of an assistant needed to use this canned query.

| Fields ||
|---|---|
| Union field `capability`. Capability of an assistant, either an action or a tool. `capability` can be only one of the following: ||
| `action_name` | `string` The name of the action that the Assistant needs to have set up to use this canned query. |

## CannedQueryTexts

The text pieces for the canned query, which can be localized.

| Fields ||
|---|---|
| `title` | `string` Required. The title that is for the end user. |
| `prefix` | `string` Optional. The prefix that `suggested_prompts` should start with. |
| `suggested_prompts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.SuggestedPrompt` Required. The prompts the canned query will offer to the user. |

## SuggestedPrompt

A suggested prompt for the canned query.

| Fields ||
|---|---|
| `prompt_text` | `string` Required. The text of the suggested prompt. |

## CannedQueryUserView

Limited information about a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` that is sufficient for the end users.

| Fields ||
|---|---|
| `canned_query` | `string` The resource name of the `CannedQuery` this view is for. This identifies the canned query in the assist request. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` |
| `localized_texts` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery.CannedQueryTexts` The localized texts for the canned query. |

## ChannelResponse

Response from the channel subscription.

| Fields ||
|---|---|
| `target_resource` | `string` Output only. Cloud resource name of the entity that the events are associated with, e.g., session name, collaborative project name, etc. |
| `event_id` | `string` Output only. ID of the event, unique across all events for the resource. E.g.: - user message: assistantUserMessageEvents/{message_id} - user typing: typingIndicatorEvents/{user_principal} - user presence: userPresenceEvents/{user_principal} - session display name: projectSessionDisplayNameUpdatedEvents/{session_id} ... |
| `event_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when the event was created or committed on the server. |
| Union field `Event`. One of the events. `Event` can be only one of the following: ||
| `message_dropped_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantMessageDroppedEvent` Output only. Event indicating that an assistant message was dropped. |
| `user_message_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantUserMessageEvent` Output only. Event indicating a user message. |
| `stream_assist_response_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantStreamAssistResponseEvent` Output only. Event containing a stream assist response. |
| `typing_indicator_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TypingIndicatorEvent` Output only. Event indicating a typing indicator change. |
| `user_presence_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserPresenceEvent` Output only. Event indicating a user's presence on the target resource changed. |
| `turn_status_update_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TurnStatusUpdateEvent` Output only. Event indicating a turn status update. |
| `project_session_display_name_updated_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectSessionDisplayNameUpdatedEvent` Output only. Event indicating a collaborative-project session's display name changed. |

## ChannelSubscription

Message to subscribe to live events.

| Fields ||
|---|---|
| `target_resource` | `string` Required. The full resource name of the Cloud Resource to subscribe to. The Bridge Server will use this to perform IAM checks and determine the Punctual Object ID prefix to watch. Example: "//discoveryengine.googleapis.com/projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}" |

## ChannelUnsubscription

Message to unsubscribe from live events.

| Fields ||
|---|---|
| `target_resource` | `string` Required. The full resource name of the Cloud Resource to unsubscribe from. The Bridge Server will use this to perform IAM checks and determine the Punctual Object ID prefix to stop watching. Example: "//discoveryengine.googleapis.com/projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}" |

## CheckGroundingRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding` method.

| Fields ||
|---|---|
| `grounding_config` | `string` Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. |
| `answer_candidate` | `string` Answer candidate to check. It can have a maximum length of 4096 tokens. |
| `facts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GroundingFact` List of facts for the grounding check. We support up to 200 facts. |
| `grounding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingSpec` Configuration of the grounding check. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |

## CheckGroundingResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GroundedGenerationService.CheckGrounding` method.

| Fields ||
|---|---|
| `cited_chunks[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FactChunk` List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. |
| `cited_facts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.CheckGroundingFactChunk` List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. |
| `claims[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim` Claim texts and citation info across all claims in the answer candidate. |
| `support_score` | `float` The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. |

## CheckGroundingFactChunk

Fact chunk for grounding check.

| Fields ||
|---|---|
| `chunk_text` | `string` Text content of the fact chunk. Can be at most 10K characters long. |

## Claim

Text and citation info for a claim in the answer candidate.

| Fields ||
|---|---|
| `claim_text` | `string` Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. |
| `citation_indices[]` | `int32` A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance \[1,3,4\] means that cited_chunks\[1\], cited_chunks\[3\], cited_chunks\[4\] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. |
| `start_pos` | `int32` Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). |
| `end_pos` | `int32` Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). |
| `grounding_check_required` | `bool` Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.FIELDS.repeated.int32.google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices` should not be returned. |
| `score` | `double` Confidence score for the claim in the answer candidate, in the range of \[0, 1\]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. |

## CheckGroundingSpec

Specification for the grounding check.

| Fields ||
|---|---|
| `citation_threshold` | `double` The threshold (in \[0,1\]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. |
| `enable_claim_level_score` | `bool` The control flag that enables claim-level grounding score in the response. |

## CheckRefreshTokenRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.CheckRefreshToken` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the connector for which a token is queried. |

## CheckRefreshTokenResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.CheckRefreshToken` method.

| Fields ||
|---|---|
| `refresh_token_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RefreshTokenInfo` Info about the stored refresh token. |

## CheckRequirementRequest

Request for CheckRequirement method.

| Fields ||
|---|---|
| `location` | `string` Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` |
| `requirement_type` | `string` The type specifying the requirement to check. The supported types are: - `discoveryengine.googleapis.com/media_recs/general/all/warning` - `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` - `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` - `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` - `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` - `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` - `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` - `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning` |
| `resources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.MonitoredResource` The resources to be checked for this requirement. The type needed for the monitored resources: - `discoveryengine.googleapis.com/Branch`. - The labels needed for this resource: - `project_number` - `location_id` - `collection_id` - `datastore_id` - `branch_id` - `discoveryengine.googleapis.com/DataStore` - The labels needed for this resource: - `project_number` - `location_id` - `collection_id` - `datastore_id` |

## CheckRequirementResponse

Response for the CheckRequirement method.

| Fields ||
|---|---|
| `requirement` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement` Requirement definition. |
| `requirement_condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Expr` The condition for evaluating the requirement result. |
| `metric_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CheckRequirementResponse.MetricQueryResult` Metric results. |
| `oldest_metric_timestamp` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time. |
| `result` | `string` The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`. |

## MetricQueryResult

Metric result. The metric are in the requirement_condition.

| Fields ||
|---|---|
| `name` | `string` This metric query name is mapping to variables in the requirement_condition. |
| `value` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.monitoring.v3#google.monitoring.v3.TypedValue` Value of the metric query. |
| `timestamp` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Time corresponding to when this metric value was calculated. |
| `unit` | `string` The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. |
| `metric_type` | `string` Type identifier of the metric corresponding to this query result. |

## Chunk

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

| Fields ||
|---|---|
| `name` | `string` The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `id` | `string` Unique chunk ID of the current chunk. |
| `content` | `string` Content is a string from a document (parsed content). |
| `document_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata` Metadata of the document from the current chunk. |
| `derived_struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. |
| `page_span` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.PageSpan` Page span of the chunk. |
| `chunk_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata` Output only. Metadata of the current chunk. |
| `data_urls[]` | `string` Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:\[\]\[;base64\], |
| `annotation_contents[]` | `string` Output only. Annotation contents if the current chunk contains annotations. |
| `annotation_metadata[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.AnnotationMetadata` Output only. The annotation metadata includes structured content in the current chunk. |
| `relevance_score` | `double` Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range \[-1.0, 1.0\]. Only populated on `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse`. |

## AnnotationMetadata

The annotation metadata includes structured content in the current chunk.

| Fields ||
|---|---|
| `structured_content` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.StructuredContent` Output only. The structured content information. |
| `image_id` | `string` Output only. Image ID is provided if the structured content is based on an image. |

## ChunkMetadata

Metadata of the current chunk. This field is only populated on `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API.

| Fields ||
|---|---|
| `previous_chunks[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` The previous chunks of the current chunk. The number is controlled by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks`. This field is only populated on `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API. |
| `next_chunks[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` The next chunks of the current chunk. The number is controlled by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks`. This field is only populated on `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API. |

## DocumentMetadata

Document metadata contains the information of the document of the current chunk.

| Fields ||
|---|---|
| `uri` | `string` Uri of the document. |
| `title` | `string` Title of the document. |
| `mime_type` | `string` The mime type of the document. <https://www.iana.org/assignments/media-types/media-types.xhtml>. |
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Data representation. The structured JSON data for the document. It should conform to the registered `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` or an `INVALID_ARGUMENT` error is thrown. |

## PageSpan

Page span of the chunk.

| Fields ||
|---|---|
| `page_start` | `int32` The start page of the chunk. |
| `page_end` | `int32` The end page of the chunk. |

## StructureType

Defines the types of the structured content that can be extracted.

| Enums ||
|---|---|
| `STRUCTURE_TYPE_UNSPECIFIED` | Default value. |
| `SHAREHOLDER_STRUCTURE` | Shareholder structure. |
| `SIGNATURE_STRUCTURE` | Signature structure. |
| `CHECKBOX_STRUCTURE` | Checkbox structure. |

## StructuredContent

The structured content information.

| Fields ||
|---|---|
| `structure_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk.StructureType` Output only. The structure type of the structured content. |
| `content` | `string` Output only. The content of the structured content. |

## Citation

Source attributions for content.

| Fields ||
|---|---|
| `start_index` | `int32` Output only. Start index into the content. |
| `end_index` | `int32` Output only. End index into the content. |
| `uri` | `string` Output only. Url reference of the attribution. |
| `title` | `string` Output only. Title of the attribution. |
| `license` | `string` Output only. License of the attribution. |
| `publication_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Output only. Publication date of the attribution. |

## CitationMetadata

A collection of source attributions for a piece of content.

| Fields ||
|---|---|
| `citations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Citation` Output only. List of citations. |

## CliConfig

The configuration for the CLI execution based connectors.

| Fields ||
|---|---|
| `enabled_actions[]` | `string` Optional. The actions enabled on the associated CLI connection. |

## CloudSqlSource

Cloud SQL source import data from.

| Fields ||
|---|---|
| `project_id` | `string` The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `instance_id` | `string` Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. |
| `database_id` | `string` Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. |
| `table_id` | `string` Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. |
| `gcs_staging_dir` | `string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |
| `offload` | `bool` Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). |

## CmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. |
| `kms_key` | `string` Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. |
| `kms_key_version` | `string` Output only. KMS key version resource name which will be used to encrypt resources `<kms_key>/cryptoKeyVersions/{keyVersion}`. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig.State` Output only. The states of the CmekConfig. |
| `is_default` | `bool` Output only. The default CmekConfig for the Customer. |
| `last_rotation_timestamp_micros` | `int64` Output only. The timestamp of the last key rotation. |
| `single_region_keys[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SingleRegionKey` Optional. Single-regional CMEKs that are required for some VAIS features. |
| `notebooklm_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig.NotebookLMState` Output only. Whether the NotebookLM Corpus is ready to be used. |

## NotebookLMState

States of NotebookLM.

| Enums ||
|---|---|
| `NOTEBOOK_LM_STATE_UNSPECIFIED` | The NotebookLM state is unknown. |
| `NOTEBOOK_LM_NOT_READY` | The NotebookLM is not ready. |
| `NOTEBOOK_LM_READY` | The NotebookLM is ready to be used. |
| `NOTEBOOK_LM_NOT_ENABLED` | The NotebookLM is not enabled. |

## State

States of the CmekConfig.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The CmekConfig state is unknown. |
| `CREATING` | The CmekConfig is creating. |
| `ACTIVE` | The CmekConfig can be used with DataStores. |
| `KEY_ISSUE` | The CmekConfig is unavailable, most likely due to the KMS Key being revoked. |
| `DELETING` | The CmekConfig is deleting. |
| `DELETE_FAILED` | The CmekConfig deletion process failed. |
| `UNUSABLE` | The CmekConfig is not usable, most likely due to some internal issue. |
| `ACTIVE_ROTATING` | The KMS key version is being rotated. |
| `DELETED` | The KMS key is soft deleted. Some cleanup policy will eventually be applied. |
| `EXPIRED` | The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED. |

## CollectUserEventRequest

Request message for CollectUserEvent method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. If the collect user event action is applied in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in `Location` level, for example, the event with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` across multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, the format is: `projects/{project}/locations/{location}`. |
| `user_event` | `string` Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. |
| `uri` | `string` The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. |
| `ets` | `int64` The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. |

## Collection

Collection is a container for configuring resources and access to a set of DataStores.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `data_connector` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` method, which creates a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` while setting up the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` singleton resource. Setting up connector on an existing `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` is not supported. This output only field contains a subset of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.GetDataConnector` method. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` was created at. |

## CompleteExternalIdentitiesRequest

Request message for completing external identities (users and groups) from an external identity provider (IdP).

| Fields ||
|---|---|
| `parent` | `string` Required. The parent location resource name, such as `projects/*/locations/global`. |
| `prefix_query` | `string` Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive. |
| `max_suggestions` | `int32` Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit. |
| `entity_type_filter` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteExternalIdentitiesRequest.EntityTypeFilter` Optional. The type of entities to fetch. If not set, all entity types will be returned. |
| `use_scim_identities` | `bool` Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities. |

## EntityTypeFilter

The type of entities to fetch.

| Enums ||
|---|---|
| `ENTITY_TYPE_FILTER_UNSPECIFIED` | Unspecified entity type filter. |
| `USERS` | Fetch only users. |
| `GROUPS` | Fetch only groups. |

## CompleteExternalIdentitiesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteExternalIdentities`.

| Fields ||
|---|---|
| `external_identities[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity` The list of external identities that match the query. |

## CompleteQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. |
| `query` | `string` Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. |
| `query_model` | `string` Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: - `document` - Using suggestions generated from user-imported documents. - `search-history` - Using suggestions generated from the past history of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API calls. Do not use it when there is no traffic for Search API. - `user-event` - Using suggestions generated from user-imported search events. - `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: - `document` is the default model for regular dataStores. - `search-history` is the default model for site search dataStores. |
| `user_pseudo_id` | `string` Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `include_tail_suggestions` | `bool` Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. |

## CompleteQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery` method.

| Fields ||
|---|---|
| `query_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion` Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. |
| `tail_match_triggered` | `bool` True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. |

## QuerySuggestion

Suggestions as search queries.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |
| `completable_field_paths[]` | `string` The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. |

## CompletionConfig

Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them.

| Fields ||
|---|---|
| `name` | `string` Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` |
| `matching_order` | `string` The matching order for autocomplete suggestions, e.g., a query consisting of `sh` with `out-of-order` specified would suggest `women's shoes`, whereas a query of `red s` with `exact-prefix` specified would suggest `red shoes`. Currently supported values: - `out-of-order` - `exact-prefix` Default value: `exact-prefix`. |
| `max_suggestions` | `int32` The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of \[1, 20\]. If not set or set to 0, it will be set to the default of 20 suggestions. |
| `min_prefix_length` | `int32` The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of \[1, 20\]. If not set or set to 0, it will be set to the default of 1 character. |
| `query_model` | `string` The data model of query suggestions for serving. Currently supported values: - `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. - `document` - Using suggestions generated from user-imported documents. - `search-history` - Using suggestions generated from the past history of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` API calls. Do not use it when there is no traffic for Search API. - `user-event` - Using suggestions generated from user-imported search events. - `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. |
| `query_frequency_threshold` | `int32` This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. |
| `num_unique_users_threshold` | `int32` This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. |
| `should_serve_content_suggestions` | `bool` Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. |
| `filter_pii_suggestions_using_dlp (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Deprecated: this field has no effect. As of May 2025, PII suggestion filtering using [DLP](https://cloud.google.com/security/products/dlp) is always on for all data stores and can't be configured per data store. |
| `enable_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.EnableMode` The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.EnableMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.CompletionConfig.EnableMode.AUTOMATIC`. Applies to DataStore only. Ignored for Engine. |

## EnableMode

Specifies the enable mode of autocomplete generation pipelines.

| Enums ||
|---|---|
| `ENABLE_MODE_UNSPECIFIED` | When AutoComplete enable mode unspecified, it defaults to AUTOMATIC mode. |
| `AUTOMATIC` | AutoComplete will be enabled when the data store meets criteria. |
| `MANUAL` | AutoComplete will be enabled regardless of UCS data requirements. |

## CompletionInfo

Detailed completion information including completion attribution token and clicked completion info.

| Fields ||
|---|---|
| `selected_suggestion` | `string` Optional. End user selected `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.FIELDS.string.google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion`. |
| `selected_position` | `int32` End user selected `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.FIELDS.string.google.cloud.discoveryengine.v1alpha.CompleteQueryResponse.QuerySuggestion.suggestion` position, starting from 0. |

## CompletionSuggestion

Autocomplete suggestions that are imported from Customer.

| Fields ||
|---|---|
| `suggestion` | `string` Required. The suggestion text. |
| `language_code` | `string` BCP-47 language code of this suggestion. |
| `group_id` | `string` If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. |
| `group_score` | `double` The score of this suggestion within its group. |
| `alternative_phrases[]` | `string` Alternative matching phrases for this suggestion. |
| Union field `ranking_info`. Ranking metrics of this suggestion. `ranking_info` can be only one of the following: ||
| `global_score` | `double` Global score of this suggestion. Control how this suggestion would be scored / ranked. |
| `frequency` | `int64` Frequency of this suggestion. Will be used to rank suggestions when score is not available. |

## Condition

Defines circumstances to be checked before allowing a behavior

| Fields ||
|---|---|
| `query_terms[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.QueryTerm` Search only A list of terms to match the query on. Cannot be set when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.FIELDS.string.google.cloud.discoveryengine.v1alpha.Condition.query_regex` is set. Maximum of 10 query terms. |
| `active_time_range[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.TimeRange` Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| `query_regex` | `string` Optional. Query regex to match the whole search query. Cannot be set when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Condition.QueryTerm.google.cloud.discoveryengine.v1alpha.Condition.query_terms` is set. Only supported for Basic Site Search promotion serving controls. |

## QueryTerm

Matcher for search request query

| Fields ||
|---|---|
| `value` | `string` The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| `full_match` | `bool` Whether the search query needs to exactly match the query term. |

## TimeRange

Used for time-dependent conditions.

| Fields ||
|---|---|
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Start of time range. Range is inclusive. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` End of time range. Range is inclusive. Must be in the future. |

## ConnectorRun

A data sync run of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`. After `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` is successfully initialized, data syncs are scheduled at `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.FIELDS.google.protobuf.Duration.google.cloud.discoveryengine.v1alpha.DataConnector.refresh_interval`. A `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun` represents a data sync either in the past or onging that the moment. //

| Fields ||
|---|---|
| `name` | `string` Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the connector run started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the connector run ended. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.State` Output only. The state of the sync run. |
| `errors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field. |
| `state_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp at which the connector run sync state was last updated. |
| `latest_pause_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the connector run was most recently paused. |
| `entity_runs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun` Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities. |
| `trigger` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.Trigger` Output only. The trigger for this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`. |

## EntityRun

Represents an entity that was synced in this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`.

| Fields ||
|---|---|
| `entity_name` | `string` The name of the source entity. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.State` The state of the entity's sync run. |
| `errors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message. |
| `state_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp at which the entity sync state was last updated. |
| `progress` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun.Progress` Metadata to generate the progress bar. |
| `stats_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated. |
| `sync_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun.EntityRun.SyncType` Sync type of this run. |
| `scheduled_record_count` | `int64` Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors. |
| `extracted_record_count` | `int64` Optional. The number of documents extracted from connector source, ready to be ingested to VAIS. |
| `indexed_record_count` | `int64` Optional. The number of documents indexed. |
| `error_record_count` | `int64` Optional. The total number of documents failed at sync at indexing stage. |
| `source_api_request_count` | `int64` Optional. The number of requests sent to 3p API. |
| `deleted_record_count` | `int64` Optional. The number of documents deleted. |

## Progress

Represents the progress of a sync run.

| Fields ||
|---|---|
| `current_count` | `int64` The current progress. |
| `total_count` | `int64` The total. |
| `percentile` | `float` Derived. The percentile of the progress.current_count / total_count. The value is between \[0, 1.0\] inclusive. |

## SyncType

Data synchronization type of the connector.

| Enums ||
|---|---|
| `SYNC_TYPE_UNSPECIFIED` | Sync type unspecified. |
| `FULL` | Sync triggers full sync of all documents. |
| `INCREMENTAL` | Incremental sync of updated documents. |
| `REALTIME` | Realtime sync. |
| `SCALA_SYNC` | Scala sync. |

## State

The state of run.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. |
| `RUNNING` | The data sync is ongoing. |
| `SUCCEEDED` | The data sync is finished. |
| `FAILED` | The data sync is failed. |
| `OVERRUN` | Data sync has been running longer than expected and is still running at the time the next run is supposed to start. |
| `CANCELLED` | Data sync was scheduled but has been cancelled. |
| `PENDING` | Data sync is about to start. |
| `WARNING` | The data sync completed with non-fatal errors. |
| `SKIPPED` | An ongoing connector run has been running longer than expected, causing this run to be skipped. |

## Trigger

Triggering reasons for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`.

| Enums ||
|---|---|
| `TRIGGER_UNSPECIFIED` | Default value. |
| `SCHEDULER` | ConnectorRun triggered by scheduler if connector has PERIODIC sync mode. |
| `INITIALIZATION` | ConnectorRun auto triggered by connector initialization. |
| `RESUME` | ConnectorRun auto triggered by resuming connector. |
| `MANUAL` | ConnectorRun triggered by user manually. |

## ConnectorType

The type of connector. New values may be added to this enum in the future.

| Enums ||
|---|---|
| `CONNECTOR_TYPE_UNSPECIFIED` | Default value. |
| `THIRD_PARTY` | Third party connector to connector to third party application. |
| `GCP_FHIR` | Data connector connects between FHIR store and VAIS datastore. |
| `BIG_QUERY` | Big query connector. |
| `GCS` | Google Cloud Storage connector. |
| `GOOGLE_MAIL` | Gmail connector. |
| `GOOGLE_CALENDAR` | Google Calendar connector. |
| `GOOGLE_DRIVE` | Google Drive connector. |
| `NATIVE_CLOUD_IDENTITY` | Native Cloud Identity connector for people search powered by People API. |
| `THIRD_PARTY_FEDERATED` | Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API. |
| `THIRD_PARTY_EUA` | Connector utilized for End User Authentication features. |
| `GCNV` | Google Cloud NetApp Volumes connector. |
| `GOOGLE_CHAT` | Google Chat connector. |
| `GOOGLE_SITES` | Google Sites connector. |
| `REMOTE_MCP` | Remote MCP based connector. |
| `GOOGLE_WORKSPACE` | Google Workspace connector. |

## ContactDetails

The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.

| Fields ||
|---|---|
| `email_address` | `string` Optional. The email address of the contact. |

## Control

Defines a conditioned behavior to employ during serving. Must be attached to a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` to be considered at serving time. Permitted actions dependent on `SolutionType`.

| Fields ||
|---|---|
| `name` | `string` Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| `display_name` | `string` Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| `associated_serving_config_ids[]` | `string` Output only. List of all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` IDs this control is attached to. May take up to 10 minutes to update after changes. |
| `solution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| `use_cases[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchUseCase` Specifies the use case for the control. Affects what condition fields can be set. Only applies to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. Currently only allow one use case per control. Must be set when solution_type is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `conditions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Condition` Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| Union field `action`. `action` can be only one of the following: ||
| `boost_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction` Defines a boost-type control |
| `filter_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.FilterAction` Defines a filter-type control Currently not supported by Recommendation |
| `redirect_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.RedirectAction` Defines a redirect-type control. |
| `synonyms_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.SynonymsAction` Treats a group of terms as synonyms of one another. |
| `promote_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.PromoteAction` Promote certain links based on predefined trigger queries. |

## BoostAction

Adjusts order of products in returned list.

| Fields ||
|---|---|
| `boost (deprecated)` | `float` > [!WARNING] > This item is deprecated! Strength of the boost, which should be in \[-1, 1\]. Negative boost means demotion. Default is 0.0 (No-op). |
| `filter` | `string` Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: <https://cloud.google.com/retail/docs/filter-and-order> Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| `data_store` | `string` Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| Union field `boost_spec`. Constant value boost or custom ranking based boost specifications. `boost_spec` can be only one of the following: ||
| `fixed_boost` | `float` Optional. Strength of the boost, which should be in \[-1, 1\]. Negative boost means demotion. Default is 0.0 (No-op). |
| `interpolation_boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec` Optional. Complex specification for custom ranking based on customer defined attribute value. |

## InterpolationBoostSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

| Fields ||
|---|---|
| `field_name` | `string` Optional. The name of the field whose value will be used to determine the boost amount. |
| `attribute_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.AttributeType` Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
| `interpolation_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.InterpolationType` Optional. The interpolation type to be applied to connect the control points listed below. |
| `control_points[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.BoostAction.InterpolationBoostSpec.ControlPoint` Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |

## AttributeType

The attribute(or function) for which the custom ranking is to be applied.

| Enums ||
|---|---|
| `ATTRIBUTE_TYPE_UNSPECIFIED` | Unspecified AttributeType. |
| `NUMERICAL` | The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
| `FRESHNESS` | For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. For example, `5D`, `3DT12H30M`, `T24H`. |

## ControlPoint

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

| Fields ||
|---|---|
| `attribute_value` | `string` Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. |
| `boost_amount` | `float` Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |

## InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

| Enums ||
|---|---|
| `INTERPOLATION_TYPE_UNSPECIFIED` | Interpolation type is unspecified. In this case, it defaults to Linear. |
| `LINEAR` | Piecewise linear interpolation will be applied. |

## FilterAction

Specified which products may be included in results. Uses same filter as boost.

| Fields ||
|---|---|
| `filter` | `string` Required. A filter to apply on the matching condition results. Required Syntax documentation: <https://cloud.google.com/retail/docs/filter-and-order> Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| `data_store` | `string` Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |

## PromoteAction

Promote certain links based on some trigger queries.

Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.

| Fields ||
|---|---|
| `data_store` | `string` Required. Data store with which this promotion is attached to. |
| `search_link_promotion` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchLinkPromotion` Required. Promotion attached to this action. |

## RedirectAction

Redirects a shopper to the provided URI.

| Fields ||
|---|---|
| `redirect_uri` | `string` Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |

## SynonymsAction

Creates a set of terms that will act as synonyms of one another.

Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".

| Fields ||
|---|---|
| `synonyms[]` | `string` Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |

## Conversation

External conversation proto definition.

| Fields ||
|---|---|
| `name` | `string` Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation.State` The state of the Conversation. |
| `user_pseudo_id` | `string` A unique identifier for tracking users. |
| `messages[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationMessage` Conversation messages. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the conversation started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the conversation finished. |

## State

Enumeration of the state of the conversation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unknown. |
| `IN_PROGRESS` | Conversation is currently open. |
| `COMPLETED` | Conversation has been completed. |

## ConversationContext

Defines context of the conversation

| Fields ||
|---|---|
| `context_documents[]` | `string` The current list of documents the user is seeing. It contains the document resource references. |
| `active_document` | `string` The current active document the user opened. It contains the document resource reference. |

## ConversationMessage

Defines a conversation message.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Message creation timestamp. |
| Union field `message`. `message` can be only one of the following: ||
| `user_input` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TextInput` User text input. |
| `reply` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Reply` Search reply. |

## ConverseConversationRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TextInput` Required. Current user input. |
| `serving_config` | `string` The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used. |
| `conversation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. |
| `safe_search` | `bool` Whether to turn on safe search. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |
| `summary_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec` A specification for configuring the summary returned in the response. |
| `filter` | `string` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |
| `boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec` Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) |

## ConverseConversationResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation` method.

| Fields ||
|---|---|
| `reply` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Reply` Answer to the current query. |
| `conversation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` Updated conversation including the answer. |
| `related_questions[]` | `string` Suggested related questions. |
| `search_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult` Search Results. |

## CrawlRateTimeSeries

The historical crawl rate timeseries data, used for monitoring.

| Fields ||
|---|---|
| `qps_time_series` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.monitoring.v3#google.monitoring.v3.TimeSeries` The QPS of the crawl rate. |

## CreateAgentRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.CreateAgent` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `agent` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` to create. |

## CreateAlphaEvolveExperimentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.CreateAlphaEvolveExperiment`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (Session) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `alpha_evolve_experiment` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment` Required. AlphaEvolveExperiment to create. Typically, only the config field should be set. |

## CreateAlphaEvolveProgramRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.CreateAlphaEvolveProgram`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (AlphaEvolveExperiment) of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |
| `alpha_evolve_program` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram` Required. The program to create. |

## CreateAssistantRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.CreateAssistant` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `assistant` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` to create. |
| `assistant_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`'s resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. |

## CreateAuthorizationRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.CreateAuthorization` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}` |
| `authorization` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` to create. |
| `authorization_id` | `string` Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. |

## CreateCachedContentRequest

Request for `AssistantService.CreateCachedContent`.

Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` serving the request. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `model` | `string` Required. Opaque model ID the cache is used with; must match the model on the GenerateContent requests that reference it. |
| `http_body` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody` Required. The Vertex `CachedContent` to create, as JSON. |

## CreateCannedQueryRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.CreateCannedQuery` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `canned_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` to create. |
| `canned_query_id` | `string` Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. |

## CreateControlRequest

Request for CreateControl method.

| Fields ||
|---|---|
| `parent` | `string` Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. |
| `control` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` Required. The Control to create. |
| `control_id` | `string` Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /\[a-z\]\[0-9\]-_/. |

## CreateConversationRequest

Request for CreateConversation method.

| Fields ||
|---|---|
| `parent` | `string` Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` |
| `conversation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` Required. The conversation to create. |

## CreateDataStoreMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## CreateDataStoreRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. |
| `data_store` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` to create. |
| `data_store_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`'s resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `create_advanced_site_search` | `bool` A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. |
| `skip_default_schema_creation` | `bool` A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. |
| Union field `cmek_options`. CMEK options for the DataStore. Setting this field will override the default CmekConfig if one is set for the project. `cmek_options` can be only one of the following: ||
| `cmek_config_name` | `string` Resource name of the CmekConfig to use for protecting this DataStore. |
| `disable_cmek` | `bool` DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |

## CreateDocumentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocument` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` to create. |
| `document_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, which becomes the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.name`. If the caller does not have permission to create the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s with the same `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent`. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## CreateEngineMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## CreateEngineRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. |
| `engine` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` to create. |
| `engine_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`'s resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |

## CreateEvaluationMetadata

This type has no fields.
Metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation` method.

## CreateEvaluationRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.CreateEvaluation` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}`. |
| `evaluation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` to create. |

## CreateIdentityMappingStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.CreateIdentityMappingStore`

| Fields ||
|---|---|
| `parent` | `string` Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. |
| `identity_mapping_store_id` | `string` Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. |
| `identity_mapping_store` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore` Required. The Identity Mapping Store to create. |
| Union field `cmek_options`. CMEK options for the Identity Mapping Store. Setting this field will override the default CmekConfig if one is set for the project. `cmek_options` can be only one of the following: ||
| `cmek_config_name` | `string` Resource name of the CmekConfig to use for protecting this Identity Mapping Store. |
| `disable_cmek` | `bool` Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |

## CreateLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.CreateLicenseConfig` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}`. |
| `license_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` to create. |
| `license_config_id` | `string` Optional. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`'s resource name. We are using the tier (product edition) name as the license config ID such as `search` or `search_and_assistant`. |

## CreateSampleQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.CreateSampleQuery` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. |
| `sample_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` to create. |
| `sample_query_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery.FIELDS.string.google.cloud.discoveryengine.v1alpha.SampleQuery.name`. If the caller does not have permission to create the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s with the same `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest.parent`. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## CreateSampleQuerySetRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}`. |
| `sample_query_set` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` to create. |
| `sample_query_set_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet.FIELDS.string.google.cloud.discoveryengine.v1alpha.SampleQuerySet.name`. If the caller does not have permission to create the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s with the same `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent`. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## CreateSchemaMetadata

Metadata for Create Schema LRO.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## CreateSchemaRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.CreateSchema` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. |
| `schema` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` to create. |
| `schema_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`, which becomes the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema.FIELDS.string.google.cloud.discoveryengine.v1alpha.Schema.name`. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |

## CreateServingConfigRequest

Request for CreateServingConfig method.

| Fields ||
|---|---|
| `parent` | `string` Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `serving_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` Required. The ServingConfig to create. |
| `serving_config_id` | `string` Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /\[a-zA-Z0-9\]\[a-zA-Z0-9_-\]+/. |

## CreateSessionRequest

Request for CreateSession method.

| Fields ||
|---|---|
| `parent` | `string` Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` |
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` Required. The session to create. |
| `session_id` | `string` Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /\[a-z0-9\]\[a-z0-9-\]{0,61}\[a-z0-9\]/. If not specified, a unique ID will be generated. |

## CreateSitemapMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateSitemap` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## CreateSitemapRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateSitemap` method.

| Fields ||
|---|---|
| `parent` | `string` Required. Parent resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. |
| `sitemap` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` to create. |

## CreateTargetSiteMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## CreateTargetSiteRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.CreateTargetSite` method.

| Fields ||
|---|---|
| `parent` | `string` Required. Parent resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. |
| `target_site` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` to create. |

## CustomAttribute

A custom attribute that is not explicitly modeled in a resource, e.g. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent`.

| Fields ||
|---|---|
| `text[]` | `string` The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute.FIELDS.repeated.string.google.cloud.discoveryengine.v1alpha.CustomAttribute.text` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute.FIELDS.repeated.double.google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers` should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `numbers[]` | `double` The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute.FIELDS.repeated.string.google.cloud.discoveryengine.v1alpha.CustomAttribute.text` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute.FIELDS.repeated.double.google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers` should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## CustomFineTuningSpec

Defines custom fine tuning spec.

| Fields ||
|---|---|
| `enable_search_adaptor` | `bool` Whether or not to enable and include custom fine tuned search adaptor model. |

## CustomTuningModel

Metadata that describes a custom tuned model.

| Fields ||
|---|---|
| `name` | `string` Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters. |
| `display_name` | `string` The display name of the model. |
| `model_version` | `int64` The version of the model. |
| `model_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomTuningModel.ModelState` The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). |
| `create_time (deprecated)` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` > [!WARNING] > This item is deprecated! Deprecated: Timestamp the Model was created at. |
| `training_start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp the model training was initiated. |
| `metrics` | `map<string, double>` The metrics of the trained model. |
| `error_message` | `string` Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. |

## ModelState

The state of the model.

| Enums ||
|---|---|
| `MODEL_STATE_UNSPECIFIED` | Default value. |
| `TRAINING_PAUSED` | The model is in a paused training state. |
| `TRAINING` | The model is currently training. |
| `TRAINING_COMPLETE` | The model has successfully completed training. |
| `READY_FOR_SERVING` | The model is ready for serving. |
| `TRAINING_FAILED` | The model training failed. |
| `NO_IMPROVEMENT` | The model training finished successfully but metrics did not improve. |
| `INPUT_VALIDATION_FAILED` | Input data validation failed. Model training didn't start. |

## DataConnector

Manages the connection to external data sources for all data stores grouped under a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. It's a singleton resource of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. The initialization is only supported through `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` method, which will create a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` and initialize its `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`.

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.State` Output only. State of the connector. |
| `data_source` | `string` Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). |
| `remove_param_keys[]` | `string` Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request. |
| `refresh_interval` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. |
| `next_sync_time` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.DateTime` Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity. |
| `entities[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.SourceEntity` List of entities from the connected data source to ingest. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` was created at. |
| `latest_pause_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The most recent timestamp when this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. |
| `last_sync_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. For periodic connectors only, the last time a data sync was completed. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` was last updated. |
| `errors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Output only. The errors from initialization or from the latest connector run. |
| `sync_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.SyncMode` The data synchronization mode supported by the data connector. |
| `kms_key_name` | `string` Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. |
| `destination_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DestinationConfig` Optional. Any target destinations used to connect to third-party services. |
| `action_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.State` Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. |
| `action_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ActionConfig` Optional. Action configurations to make the connector support actions. |
| `end_user_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.EndUserConfig` Optional. Any params and credentials used specifically for EUA connectors. |
| `federated_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.FederatedConfig` Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode. |
| `connector_modes[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.ConnectorMode` Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. |
| `static_ip_enabled` | `bool` Optional. Whether customer has enabled static IP addresses for this connector. |
| `static_ip_addresses[]` | `string` Output only. The static IP addresses used by this connector. |
| `oauth_static_ip_addresses[]` | `string` Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. |
| `blocking_reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.BlockingReason` Output only. User actions that must be completed before the connector can start syncing data. |
| `identity_refresh_interval (deprecated)` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` > [!WARNING] > This item is deprecated! The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. |
| `identity_schedule_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityScheduleConfig` The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. |
| `private_connectivity_project_id` | `string` Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. |
| `bap_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BAPConfig` Optional. The configuration for establishing a BAP connection. |
| `connector_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorType` Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. |
| `realtime_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.State` Output only. real-time sync state |
| `alert_policy_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyConfig` Optional. The connector level alert config. |
| `realtime_sync_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig` Optional. The configuration for realtime sync. |
| `acl_enabled` | `bool` Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. |
| `create_eua_saas` | `bool` Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. |
| `auto_run_disabled` | `bool` Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs |
| `incremental_sync_disabled` | `bool` Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true. |
| `incremental_refresh_interval` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled. |
| `hybrid_ingestion_disabled` | `bool` Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. |
| `data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy` Optional. Specifies the data protection policy for the connector. |
| `egress_fqdns[]` | `string` Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. |
| `vpcsc_enabled` | `bool` Output only. Whether the connector is created with VPC-SC enabled. |
| `dynamic_tools[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DynamicTool` Output only. The dynamic tools fetched for this connector. |
| `cli_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CliConfig` Optional. The configuration for establishing a CLI connection. |
| `connector_source_id` | `string` Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source. |
| `tag` | `string` Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-<micros>` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill. |
| `metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.ConnectorMetadata` Optional. User-facing metadata for the connector. Populated from the connector's generated metadata / registry `ConnectorSource`. |
| Union field `data_connector_params`. Params needed to access the source in the format of (Key, Value) pairs. String values with the format `projects/*/[locations/*/]secrets/*/versions/*` will be read from Secret Manager. Required parameters for all data sources: - Key: `instance_uri` - Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: - Key: `client_id` - Value: type STRING. The client ID for the third party service provider to identify your application. - Key: `client_secret` - Value:type STRING. The client secret generated by the third party authorization server. - Key: `access_token` - Value: type STRING. OAuth token for UCS to access to the protected resource. - Key: `refresh_token` - Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: - Key: `user_account` - Value: type STRING. The username or email with the source. - Key: `api_token` - Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } Optional parameter to specify the authorization type to use for multiple authorization types support: - Key: `auth_type` - Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`, `NO_AUTH`. `data_connector_params` can be only one of the following: ||
| `params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Required data connector parameters in structured json format. |
| `json_params` | `string` Required data connector parameters in json string format. |

## BlockingReason

User actions that must be completed before the connector can start syncing data.

| Enums ||
|---|---|
| `BLOCKING_REASON_UNSPECIFIED` | Default value. |
| `ALLOWLIST_STATIC_IP` | Connector requires customer to allowlist static IPs. |
| `ALLOWLIST_IN_SERVICE_ATTACHMENT` | Connector requires customer to allowlist our project in their service attachment. |
| `ALLOWLIST_SERVICE_ACCOUNT` | Connector requires customer to allowlist service account in their project. |

## ConnectorMetadata

User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).

| Fields ||
|---|---|
| `title` | `string` Optional. Display title of the connector. |
| `description` | `string` Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. |
| `short_description` | `string` Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). |
| `author` | `string` Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). |
| `note` | `string` Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. |

## ConnectorMode

The modes enabled for this connector. INGESTION, ACTIONS, FEDERATED, OR EUA

| Enums ||
|---|---|
| `CONNECTOR_MODE_UNSPECIFIED` | Connector mode unspecified. |
| `DATA_INGESTION` | Connector utilized for data ingestion. |
| `ACTIONS` | Connector utilized for actions. |
| `FEDERATED` | Connector utilized for federated search. |
| `EUA` | Connector utilized for End User Authentication. |
| `FEDERATED_AND_EUA` | Hybrid connector utilized for federated search and End User Authentication. |

## EndUserConfig

Any params and credentials used specifically for EUA connectors.

| Fields ||
|---|---|
| `additional_params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Any additional parameters needed for EUA. |
| `tenant` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Tenant` Optional. The tenant project the connector is connected to. |
| Union field `auth_config`. Authentication configuration for EUA connectors. Both arms hold customer-supplied auth parameters, including PEM private keys. Without a redacting semantic type, `DebugString()` prints the key material in full. `auth_config` can be only one of the following: ||
| `auth_params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Any authentication parameters specific to EUA connectors. |
| `json_auth_params` | `string` Optional. Any authentication parameters specific to EUA connectors in json string format. |

## FederatedConfig

Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.

| Fields ||
|---|---|
| `additional_params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Any additional parameters needed for FEDERATED. |
| Union field `auth_config`. Authentication configuration for FEDERATED connectors. `auth_config` can be only one of the following: ||
| `auth_params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Any authentication parameters specific to FEDERATED connectors. |
| `json_auth_params` | `string` Optional. Any authentication parameters specific to FEDERATED connectors in json string format. |

## RealtimeSyncConfig

The configuration for realtime sync to store additional params for realtime sync.

| Fields ||
|---|---|
| `webhook_uri` | `string` Optional. Webhook url for the connector to specify additional params for realtime sync. |
| `realtime_sync_secret` | `string` Optional. The ID of the Secret Manager secret used for webhook secret. |
| `streaming_error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig.StreamingError` Optional. Streaming error details. |

## StreamingError

Streaming error details.

| Fields ||
|---|---|
| `streaming_error_reason` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.RealtimeSyncConfig.StreamingError.StreamingErrorReason` Optional. Streaming error. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Optional. Error details. |

## StreamingErrorReason

Broad types of streaming errors.

| Enums ||
|---|---|
| `STREAMING_ERROR_REASON_UNSPECIFIED` | Streaming error reason unspecified. |
| `STREAMING_SETUP_ERROR` | Some error occurred while setting up resources for realtime sync. |
| `STREAMING_SYNC_ERROR` | Some error was encountered while running realtime sync for the connector. |
| `INGRESS_ENDPOINT_REQUIRED` | Ingress endpoint is required when setting up realtime sync in private connectivity. |

## SourceEntity

Represents an entity in the data source. For example, the `Account` object in Salesforce.

| Fields ||
|---|---|
| `entity_name` | `string` The name of the entity. Supported values by data source: - Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` - Jira: `Issue` - Confluence: `Content`, `Space` |
| `key_property_mappings` | `map<string, string>` Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: - `title`: The title for data record. This would be displayed on search results. - `description`: The description for data record. This would be displayed on search results. |
| `data_store` | `string` Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` method, a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is automatically created for each source entity. |
| `starting_schema` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` Optional. The start schema to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` API, and will be ignored if used in other APIs. This field will be omitted from all API responses including `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.GetDataConnector` API. To retrieve a schema of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema` API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). |
| `healthcare_fhir_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HealthcareFhirConfig` Optional. Configuration for `HEALTHCARE_FHIR` vertical. |
| Union field `entity_params`. The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: - Key: `document_id_column` - Value: type STRING. The value of the column ID. `entity_params` can be only one of the following: ||
| `params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The parameters for the entity to facilitate data ingestion in structured json format. |
| `json_params` | `string` The parameters for the entity to facilitate data ingestion in json string format. |

## State

The state of connector.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. |
| `CREATING` | The connector is being set up. |
| `ACTIVE` | The connector is successfully set up and awaiting next sync run. |
| `FAILED` | The connector is in error. The error details can be found in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.FIELDS.repeated.google.rpc.Status.google.cloud.discoveryengine.v1alpha.DataConnector.errors`. If the error is unfixable, the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` can be deleted by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.DeleteCollection` API. |
| `RUNNING` | The connector is actively syncing records from the data source. |
| `WARNING` | The connector has completed a sync run, but encountered non-fatal errors. |
| `INITIALIZATION_FAILED` | Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types). |
| `UPDATING` | Connector is in the process of an update. |

## SyncMode

Defines the data synchronization mode supported by the data connector.

| Enums ||
|---|---|
| `PERIODIC` | The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync. |
| `STREAMING` | The data will be synced in real time. |
| `UNSPECIFIED` | Connector that doesn't ingest data will have this value |

## DataProtectionPolicy

Contains the data protection policy config for a DataStore or a connector.

| Fields ||
|---|---|
| `sensitive_data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy.SensitiveDataProtectionPolicy` Optional. Specifies the sensitive data protection policy for the connector source. |

## SensitiveDataProtectionPolicy

Specifies a Sensitive Data Protection (<https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview>) policy.

| Fields ||
|---|---|
| `policy` | `string` Optional. Specifies the resource name of the Sensitive Data Protection content policy. |

## DataScienceAgentConfig

Configuration specific to Google premade data science agents. This data structure is intended to store deployment and request time configuration for the agent.

| Fields ||
|---|---|
| `bq_project_id` | `string` Required. The BigQuery project ID where the dataset is located. |
| `bq_dataset_id` | `string` Required. The BigQuery dataset ID to use for the agent. The dataset must be in the project specified by `bq_project_id`. |
| `blocklist_tables[]` | `string` Optional. The BigQuery tables to block from being used by the agent. |
| `allowlist_tables[]` | `string` Optional. The BigQuery tables to allow to be used by the agent. |
| `nl_query_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig.NlQueryConfig` Optional. Customer provided configuration. |

## NlQueryConfig

Define the customer provided configurations specific to natural language translation to SQL/Python code.

| Fields ||
|---|---|
| `nl2sql_prompt` | `string` Optional. The customer provided NL2SQL instructions |
| `nl2py_prompt` | `string` Optional. The customer provided instructions for LLM to write python code for data analysis. |
| `nl2sql_examples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig.NlQueryConfig.Nl2SqlExample` Optional. The customer provided NL2SQL examples, including both input and expected sql. |
| `schema_description` | `string` Optional. The natural language description of the schema of the BigQuery dataset. |
| `bq_sql_gen_use_custom_prompt` | `bool` Optional. Whether to use the custom prompt for the BigQuery SQL Gen service. |

## Nl2SqlExample

A single NL2SQL example.

| Fields ||
|---|---|
| `query` | `string` Optional. The natural language query to be answered. |
| `expected_sql` | `string` Optional. The expected SQL output. |
| `expected_response` | `string` Optional. The expected response to the query. |

## DataStore

DataStore captures global settings and configs at the DataStore level.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `industry_vertical` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical` Immutable. The industry vertical that the data store registers. |
| `solution_types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` The solutions that the data store enrolls. Available solutions for each `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.google.cloud.discoveryengine.v1alpha.IndustryVertical.google.cloud.discoveryengine.v1alpha.DataStore.industry_vertical`: - `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. - `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. |
| `default_schema_id` | `string` Output only. The ID of the default `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` associated to this data store. |
| `content_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig` Immutable. The content config of the data store. If this field is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.NO_CONTENT`. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` was created at. |
| `advanced_site_search_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedSiteSearchConfig` Optional. Configuration for advanced site search. |
| `language_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LanguageInfo` Language info for DataStore. |
| `natural_language_query_understanding_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig` Optional. Configuration for Natural Language Query Understanding. |
| `kms_key_name` | `string` Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. |
| `cmek_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` Output only. CMEK-related information for the DataStore. |
| `idp_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig` Output only. Data store level identity provider config. |
| `billing_estimation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.BillingEstimation` Output only. Data size estimation for billing. |
| `acl_enabled` | `bool` Immutable. Whether data in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` methods. When ACL is enabled for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` can't be accessed by calling `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments`. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. |
| `workspace_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig` Config to store data store type configuration for workspace data. This must be set when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.google.cloud.discoveryengine.v1alpha.DataStore.content_config` is set as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.GOOGLE_WORKSPACE`. |
| `document_processing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` Configuration for Document understanding and enrichment. |
| `starting_schema` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` The start schema to use for this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore` API, and will be ignored if used in other APIs. This field will be omitted from all API responses including `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.CreateDataStore` API. To retrieve a schema of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema` API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). |
| `healthcare_fhir_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HealthcareFhirConfig` Optional. Configuration for `HEALTHCARE_FHIR` vertical. |
| `serving_config_data_store` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ServingConfigDataStore` Optional. Stores serving config at DataStore level. |
| `identity_mapping_store` | `string` Immutable. The fully qualified resource name of the associated `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore`. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. |
| `is_infobot_faq_data_store` | `bool` Optional. If set, this DataStore is an Infobot FAQ DataStore. |
| `federated_search_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig` Optional. If set, this DataStore is a federated search DataStore. |
| `configurable_billing_approach` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ConfigurableBillingApproach` Optional. Configuration for configurable billing approach. See |
| `configurable_billing_approach_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when configurable_billing_approach was last updated. |
| `data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataProtectionPolicy` Optional. Specifies the data protection policy for the data store. |
| `icon_uri` | `string` Output only. Provides the icon URI of the data store's connector source, if this is a connector-backed data store. Empty for data stores without an associated connector source. In `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore`, this is only populated when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_FULL` is requested via `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.FIELDS.google.cloud.discoveryengine.v1alpha.DataStoreView.google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.view` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetDataStoreRequest.FIELDS.google.cloud.discoveryengine.v1alpha.DataStoreView.google.cloud.discoveryengine.v1alpha.GetDataStoreRequest.view` respectively. |

## BillingEstimation

Estimation of data size per data store.

| Fields ||
|---|---|
| `structured_data_size` | `int64` Data size for structured data in terms of bytes. |
| `unstructured_data_size` | `int64` Data size for unstructured data in terms of bytes. |
| `website_data_size` | `int64` Data size for websites in terms of bytes. |
| `structured_data_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Last updated timestamp for structured data. |
| `unstructured_data_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Last updated timestamp for unstructured data. |
| `website_data_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Last updated timestamp for websites. |

## ConfigurableBillingApproach

Configuration for configurable billing approach.

| Enums ||
|---|---|
| `CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED` | Default value. For Spark and non-Spark non-configurable billing approach. |
| `CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE` | Use the subscription base + overage billing for indexing core for non embedding storage. |
| `CONFIGURABLE_CONSUMPTION_EMBEDDING` | Use the consumption pay-as-you-go billing for embedding storage add-on. |

## ContentConfig

Content config of the data store.

| Enums ||
|---|---|
| `CONTENT_CONFIG_UNSPECIFIED` | Default value. |
| `NO_CONTENT` | Only contains documents without any `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.google.cloud.discoveryengine.v1alpha.Document.Content.google.cloud.discoveryengine.v1alpha.Document.content`. |
| `CONTENT_REQUIRED` | Only contains documents with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.google.cloud.discoveryengine.v1alpha.Document.Content.google.cloud.discoveryengine.v1alpha.Document.content`. |
| `PUBLIC_WEBSITE` | The data store is used for public website search. |
| `GOOGLE_WORKSPACE` | The data store is used for workspace search. Details of workspace data store are specified in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig`. |

## FederatedSearchConfig

Stores information for federated search.

| Fields ||
|---|---|
| Union field `data_source_config`. Configuration for the data source this data store is connected to. `data_source_config` can be only one of the following: ||
| `alloy_db_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig` AlloyDB config. If set, this DataStore is connected to AlloyDB. |
| `third_party_oauth_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.ThirdPartyOauthConfig` Third Party OAuth config. If set, this DataStore is connected to a third party application. |
| `notebooklm_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.NotebooklmConfig` NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. |

## AlloyDbConfig

Stores information for connecting to AlloyDB.

| Fields ||
|---|---|
| `alloydb_connection_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbConnectionConfig` Required. Configuration for connecting to AlloyDB. |
| `alloydb_ai_nl_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbAiNaturalLanguageConfig` Optional. Configuration for Magic. |
| `returned_fields[]` | `string` Optional. Fields to be returned in the search results. If empty, all fields will be returned. |

## AlloyDbAiNaturalLanguageConfig

Configuration for AlloyDB AI Natural Language.

| Fields ||
|---|---|
| `nl_config_id` | `string` Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. |

## AlloyDbConnectionConfig

Configuration for connecting to AlloyDB.

| Fields ||
|---|---|
| `instance` | `string` Required. The AlloyDB instance to connect to. |
| `database` | `string` Required. The AlloyDB database to connect to. |
| `user` | `string` Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. |
| `password` | `string` Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. |
| `auth_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FederatedSearchConfig.AlloyDbConfig.AlloyDbConnectionConfig.AuthMode` Optional. Auth mode. |
| `enable_psvs` | `bool` Optional. If true, enable PSVS for AlloyDB. |

## AuthMode

Auth mode.

| Enums ||
|---|---|
| `AUTH_MODE_UNSPECIFIED` |   |
| `AUTH_MODE_SERVICE_ACCOUNT` | Uses P4SA when VAIS talks to AlloyDB. |
| `AUTH_MODE_END_USER_ACCOUNT` | Uses EUC when VAIS talks to AlloyDB. |

## NotebooklmConfig

Config for connecting to NotebookLM Enterprise.

| Fields ||
|---|---|
| `search_config` | `string` Required. Search config name. Format: projects/\*/locations/global/notebookLmSearchConfigs/\* |
| `notebooks[]` | `string` Optional. Restricts this data store to the given notebooks. When empty, the data store covers every notebook the querying user can access, which is the existing behaviour. Each entry is a full notebook resource name, such as `projects/*/locations/*/notebooks/*`. Scoping is enforced on results as well as requested upstream, so a notebook outside this list cannot appear in a search response through this data store even if the backend returns one. |

## ThirdPartyOauthConfig

Stores information for third party applicationOAuth.

| Fields ||
|---|---|
| `app_name` | `string` Optional. The type of the application. E.g., "jira", "box", etc. |
| `instance_name` | `string` Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". |

## ServingConfigDataStore

Stores information regarding the serving configurations at DataStore level.

| Fields ||
|---|---|
| `disabled_for_serving` | `bool` Optional. If set true, the DataStore will not be available for serving search requests. |

## DataStoreView

A view that controls which fields of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` are populated in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore` responses.

| Enums ||
|---|---|
| `DATA_STORE_VIEW_UNSPECIFIED` | The default / unset value. The API defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_BASIC`. |
| `DATA_STORE_VIEW_BASIC` | Does not populate `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.string.google.cloud.discoveryengine.v1alpha.DataStore.icon_uri`. This is the default view. |
| `DATA_STORE_VIEW_FULL` | Additionally populates `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.string.google.cloud.discoveryengine.v1alpha.DataStore.icon_uri` for connector-backed data stores. Resolving connector icons requires extra lookups, so request this view only when the icons are rendered. |

## DebugParams

DebugParams message for WidgetService methods for debugging.

| Fields ||
|---|---|
| `experiment_ids[]` | `int32` Optional. The experiment ids to force. |
| `enable_internal_debugging` | `bool` Optional. Whether to enable internal debugging. |

## DedicatedCrawlRateTimeSeries

The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.

| Fields ||
|---|---|
| `user_triggered_crawl_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. |
| `auto_refresh_crawl_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. |
| `user_triggered_crawl_error_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Vertex AI's error rate time series of user triggered dedicated crawl. |
| `auto_refresh_crawl_error_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Vertex AI's error rate time series of auto-refresh dedicated crawl. |

## DeleteAgentMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.DeleteAgent` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteAgentRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.DeleteAgent` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteAlphaEvolveExperimentAndProgramsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.DeleteAlphaEvolveExperimentAndPrograms`.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the experiment to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |

## DeleteAssistantRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.DeleteAssistant` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` to delete does not exist, a NOT_FOUND error is returned. |

## DeleteAuthorizationRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.DeleteAuthorization` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteCachedContentRequest

Request for `AssistantService.DeleteCachedContent`.

Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` serving the request. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `model` | `string` Required. Opaque model ID the cache belongs to; must match the CreateCachedContent request so the proxy can resolve the backend. |
| `cached_content` | `string` Required. The `cachedContents/{id}` resource-name segment of the `name` returned by CreateCachedContent, identifying the cache to delete. |

## DeleteCannedQueryRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.DeleteCannedQuery` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteCmekConfigMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService.DeleteCmekConfig` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteCmekConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService.DeleteCmekConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. |

## DeleteCollectionMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.UpdateCollection` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteCollectionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.DeleteCollection` method.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`. |

## DeleteControlRequest

Request for DeleteControl method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` |

## DeleteConversationRequest

Request for DeleteConversation method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` |

## DeleteDataStoreMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteDataStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.DeleteDataStore` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` to delete does not exist, a NOT_FOUND error is returned. |

## DeleteDocumentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.DeleteDocument` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteEngineMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteEngineRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.DeleteEngine` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` to delete does not exist, a NOT_FOUND error is returned. |

## DeleteIdentityMappingStoreMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.DeleteIdentityMappingStore` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteIdentityMappingStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.DeleteIdentityMappingStore`

| Fields ||
|---|---|
| `name` | `string` Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}` |

## DeletePatientFiltersRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.DeletePatientFilters` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not exist, a NOT_FOUND error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not have a patient filter, a NOT_FOUND error will be returned. |

## DeleteSampleQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.DeleteSampleQuery` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteSampleQuerySetRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` to delete does not exist, a `NOT_FOUND` error is returned. |

## DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteSchemaRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.DeleteSchema` method.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. |

## DeleteServingConfigRequest

Request for DeleteServingConfig method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` |

## DeleteSessionRequest

Request for DeleteSession method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` |

## DeleteSitemapMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteSitemap` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteSitemapRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteSitemap` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` does not exist, a NOT_FOUND error is returned. |

## DeleteTargetSiteMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeleteTargetSiteRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DeleteTargetSite` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` does not exist, a NOT_FOUND error is returned. |

## DeleteUserStoreMetadata

Metadata related to the progress of the `UserStoreService.DeleteUserStore` operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.

| Fields ||
|---|---|
| `success_count` | `int64` The number of end users under the user store that were successfully deleted. |
| `failure_count` | `int64` The number of end users under the user store that failed to be deleted. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeployAgentMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.DeployAgent` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DeployAgentRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.DeployAgent` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `force` | `bool` Optional. If true, force to redeploy the deployed agent. |

## DeployAgentResponse

This type has no fields.
Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.DeployAgent` method.

## DeploymentInfo

Automatic deployment information for the agent.

| Fields ||
|---|---|
| `operation` | `string` Output only. Long-running operation resource for the deployment. Can be used to poll the deployment status. When the deployment finishes, this field will be empty. If the deployment fails,the field will contain the resource name of the failed LRO, but the operation resource itself will be deleted automatically after some time. |
| `finish_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Deployment finish time - only set if the deployment is finished or failed. |

## DestinationConfig

Defines target endpoints used to connect to third-party sources.

| Fields ||
|---|---|
| `key` | `string` Optional. Unique destination identifier that is supported by the connector. |
| `destinations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DestinationConfig.Destination` Optional. The destinations for the corresponding key. |
| Union field `destination_config_params`. Additional parameters for this destination config. `destination_config_params` can be only one of the following: ||
| `params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Additional parameters for this destination config in structured json format. |
| `json_params` | `string` Additional parameters for this destination config in json string format. |

## Destination

Defines a target endpoint

| Fields ||
|---|---|
| `port` | `int32` Optional. Target port number accepted by the destination. |
| Union field `destination`. The endpoint destination. `destination` can be only one of the following: ||
| `host` | `string` Publicly routable host. |

## DialogflowAgentDefinition

Stored definition of an agent that uses a Dialogflow agent.

| Fields ||
|---|---|
| `tool_settings (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentToolSettings` > [!WARNING] > This item is deprecated! Optional. The parameters that define how the agent is presented to the planner LLM. DEPRECATED: Use agent_invocation_spec instead. |
| `dialogflow_agent` | `string` Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}` |

## DisableAdvancedSiteSearchMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## DisableAdvancedSiteSearchRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. Full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. |

## DisableAdvancedSiteSearchResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.DisableAdvancedSiteSearch` method.

## DistributeLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.DistributeLicenseConfig` method.

| Fields ||
|---|---|
| `billing_account_license_config` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. |
| `project_number` | `int64` Required. The target GCP project number to distribute the license config to. |
| `location` | `string` Required. The target GCP project region to distribute the license config to. |
| `license_count` | `int64` Required. The number of licenses to distribute. |
| `license_config_id` | `string` Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config. |

## DistributeLicenseConfigResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.DistributeLicenseConfig` method.

| Fields ||
|---|---|
| `license_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` The updated or created LicenseConfig. |

## Document

Document captures all raw metadata information of items to be recommended or searched.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `id` | `string` Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. |
| `schema_id` | `string` The identifier of the schema located in the same data store. |
| `content` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.Content` The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. |
| `parent_document_id` | `string` The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |
| `derived_struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. |
| `acl_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.AclInfo` Access control information for the document. |
| `index_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed. |
| `index_status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.IndexStatus` Output only. The index status of the document. - If document is indexed successfully, the index_time field is populated. - Otherwise, if document is not indexed due to errors, the error_samples field is populated. - Otherwise, if document's index is in progress, the pending_message field is populated. |
| Union field `data`. Data representation. One of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.google.protobuf.Struct.google.cloud.discoveryengine.v1alpha.Document.struct_data` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.json_data` should be provided otherwise an `INVALID_ARGUMENT` error is thrown. `data` can be only one of the following: ||
| `struct_data` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The structured JSON data for the document. It should conform to the registered `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` or an `INVALID_ARGUMENT` error is thrown. |
| `json_data` | `string` The JSON string representation of the document. It should conform to the registered `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` or an `INVALID_ARGUMENT` error is thrown. |

## AclInfo

ACL Information of the Document.

| Fields ||
|---|---|
| `readers[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.AclInfo.AccessRestriction` Readers of the document. |

## AccessRestriction

AclRestriction to model complex inheritance restrictions.

Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document.

Document Hierarchy - Space_S --\> Page_P.

Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL Restriction - { "acl_info": { "readers": \[ { "principals": \[ { "group_id": "group_1" }, { "user_id": "user_1" } \] } \] } }

Page_P ACL Restriction. { "acl_info": { "readers": \[ { "principals": \[ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } \], }, { "principals": \[ { "group_id": "group_1" }, { "user_id": "user_1" } \], } \] } }

| Fields ||
|---|---|
| `principals[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Principal` List of principals. |
| `idp_wide` | `bool` All users within the Identity Provider. |

## Content

Unstructured data linked to this document.

| Fields ||
|---|---|
| `mime_type` | `string` The MIME type of the content. Supported types: - `application/pdf` (PDF, only native PDFs are supported for now) - `text/html` (HTML) - `text/plain` (TXT) - `application/xml` or `text/xml` (XML) - `application/json` (JSON) - `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) - `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) - `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) - `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: - `image/bmp` (BMP) - `image/gif` (GIF) - `image/jpeg` (JPEG) - `image/png` (PNG) - `image/tiff` (TIFF) See <https://www.iana.org/assignments/media-types/media-types.xhtml>. |
| Union field `content`. The content of the unstructured document. `content` can be only one of the following: ||
| `raw_bytes` | `bytes` The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / \~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See <https://developers.google.com/protocol-buffers/docs/proto3#json>. |
| `uri` | `string` The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. |

## IndexStatus

Index status of the document.

| Fields ||
|---|---|
| `index_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time when the document was indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. |
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. |
| `pending_message` | `string` Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. |

## DocumentInfo

Detailed document information associated with a user event.

| Fields ||
|---|---|
| `promotion_ids[]` | `string` The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. |
| `joined` | `bool` Output only. Whether the referenced Document can be found in the data store. |
| Union field `document_descriptor`. A required descriptor of the associated `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. - If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.DocumentInfo.id` is specified, then the default values for `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are used when annotating with the stored Document. - If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.DocumentInfo.name` is specified, then the provided values (default values allowed) for `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are used when annotating with the stored Document. `document_descriptor` can be only one of the following: ||
| `id` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` resource ID. |
| `name` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` |
| `uri` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` URI - only allowed for website data stores. |
| `quantity` | `int32` Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: - `add-to-cart` - `purchase` |
| `conversion_value` | `float` Optional. The conversion value associated with this Document. Must be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.event_type` is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type. |

## DocumentProcessingConfig

A singleton resource of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. If it's empty when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is created and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.CONTENT_REQUIRED`, the default parser will default to digital parser.

| Fields ||
|---|---|
| `name` | `string` The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. |
| `chunking_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig` Whether chunking mode is enabled. |
| `default_parsing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig` Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. |
| `parsing_config_overrides` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig`>`` Map from file type to override the default parsing configuration based on the file type. Supported keys: - `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. - `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. - `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. - `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. - `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. - `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. |

## ChunkingConfig

Configuration for chunking config.

| Fields ||
|---|---|
| Union field `chunk_mode`. Additional configs that defines the behavior of the chunking. `chunk_mode` can be only one of the following: ||
| `layout_based_chunking_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig` Configuration for the layout based chunking. |

## LayoutBasedChunkingConfig

Configuration for the layout based chunking.

| Fields ||
|---|---|
| `chunk_size` | `int32` The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. |
| `include_ancestor_headings` | `bool` Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. |

## ParsingConfig

Related configurations applied to a specific type of document parser.

| Fields ||
|---|---|
| Union field `type_dedicated_config`. Configs for document processing types. `type_dedicated_config` can be only one of the following: ||
| `digital_parsing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig` Configurations applied to digital parser. |
| `ocr_parsing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.OcrParsingConfig` Configurations applied to OCR parser. Currently it only applies to PDFs. |
| `layout_parsing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig` Configurations applied to layout parser. |

## DigitalParsingConfig

This type has no fields.
The digital parsing configurations for documents.

## LayoutParsingConfig

The layout parsing configurations for documents.

| Fields ||
|---|---|
| `enable_table_annotation` | `bool` Optional. If true, the LLM based annotation is added to the table during parsing. |
| `enable_image_annotation` | `bool` Optional. If true, the LLM based annotation is added to the image during parsing. |
| `enable_llm_layout_parsing` | `bool` Optional. If true, the pdf layout will be refined using an LLM. |
| `structured_content_types[]` | `string` Optional. Contains the required structure types to extract from the document. Supported values: - `shareholder-structure` |
| `exclude_html_elements[]` | `string` Optional. List of HTML elements to exclude from the parsed content. |
| `exclude_html_classes[]` | `string` Optional. List of HTML classes to exclude from the parsed content. |
| `exclude_html_ids[]` | `string` Optional. List of HTML ids to exclude from the parsed content. |
| `enable_get_processed_document` | `bool` Optional. If true, the processed document will be made available for the GetProcessedDocument API. |

## OcrParsingConfig

The OCR parsing configurations for documents.

| Fields ||
|---|---|
| `enhanced_document_elements[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! \[DEPRECATED\] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. |
| `use_native_text` | `bool` If true, will use native text instead of OCR text on pages containing native text. |

## DoubleList

Double list.

| Fields ||
|---|---|
| `values[]` | `double` Double values. |

## DynamicTool

Configuration for dynamic tools.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the tool. |
| `description` | `string` Optional. The description of the tool. |
| `enabled` | `bool` Optional. Whether the tool is enabled. |
| `display_name` | `string` Optional. The display name of the tool. |

## EmbeddingConfig

Defines embedding config, used for bring your own embeddings feature.

| Fields ||
|---|---|
| `field_path` | `string` Full field path in the schema mapped as embedding field. |

## EnableAdvancedSiteSearchMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## EnableAdvancedSiteSearchRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. Full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`. |

## EnableAdvancedSiteSearchResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.EnableAdvancedSiteSearch` method.

## Engine

Metadata that describes the training and serving parameters of an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /\[a-z0-9\]\[a-z0-9-_\]\*/. Otherwise, an INVALID_ARGUMENT error is returned. |
| `display_name` | `string` Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the Recommendation Engine was created at. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the Recommendation Engine was last updated. |
| `data_store_ids[]` | `string` Optional. The data stores associated with this engine. For `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION` type of engines, they can only associate with at most one data store. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT`, multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s in the same `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` can be associated here. Note that when used in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateEngineRequest`, one DataStore ID must be provided as the system will use it for necessary initializations. |
| `solution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` Required. The solutions of the engine. |
| `industry_vertical` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical` Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`: Vertical on Engine has to match vertical of the DataStore linked to the engine. |
| `common_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.CommonConfig` Common config spec that specifies the metadata of the engine. |
| `knowledge_graph_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.KnowledgeGraphConfig` Optional. Configurations for the Knowledge Graph. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `app_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.AppType` Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. |
| `disable_analytics` | `bool` Optional. Whether to disable analytics for searches performed on this engine. |
| `session_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig` Optional. Non-empty default. Session config for the engine. |
| `features` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FeatureState`>`` Optional. Feature config for the engine to opt in or opt out of features. Supported keys: - `*`: all features, if it's present, all other feature state settings are ignored. - `agent-gallery` - `no-code-agent-builder` - `prompt-gallery` - `model-selector` - `notebook-lm` - `people-search` - `people-search-org-chart` - `bi-directional-audio` - `speech-to-text` - `feedback` - `session-sharing` - `personalization-memory` - `personalization-suggested-highlights` - `mobile-app-access` - `disable-agent-sharing` - `disable-image-generation` - `disable-video-generation` - `disable-onedrive-upload` - `disable-talk-to-content` - `disable-google-drive-upload` - `disable-welcome-emails` - `disable-canvas` - `canvas-workspace` - `canvas-app-builder` - `skills` - `skill-sharing` - `skill-sharing-without-admin-approval` - `disable-projects` - `sobi` - `enable-end-user-sharing-with-groups` - `single-agent-orchestration` - `multi-agent-orchestration` - `cross-product-intelligence` - `workflow-agents` - `in-app-notifications` |
| `cmek_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` Output only. CMEK-related information for the Engine. |
| `configurable_billing_approach` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ConfigurableBillingApproach` Optional. Configuration for configurable billing approach. |
| `model_configs` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ModelState`>`` Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. |
| `observability_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObservabilityConfig` Optional. Observability config for the engine. |
| `connector_tenant_info` | `map<string, string>` Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent. |
| `agent_gateway_setting` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentGatewaySetting` Optional. The agent gateway setting for the engine. |
| `marketplace_agent_visibility` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MarketplaceAgentVisibility` Optional. The visibility of marketplace agents in the agent gallery. |
| `procurement_contact_emails[]` | `string` Optional. The emails of the procurement contacts. |
| `associated_agent_registry` | `string` Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. |
| Union field `engine_config`. Additional config specs that defines the behavior of the engine. `engine_config` can be only one of the following: ||
| `similar_documents_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig` Additional config specs for a `similar-items` engine. |
| `chat_engine_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig` Configurations for the Chat Engine. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT`. |
| `search_engine_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig` Configurations for the Search Engine. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `media_recommendation_engine_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig` Configurations for the Media Engine. Only applicable on the data stores with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA` vertical. |
| Union field `engine_metadata`. Engine metadata to monitor the status of the engine. `engine_metadata` can be only one of the following: ||
| `recommendation_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata` Output only. Additional information of a recommendation engine. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. |
| `chat_engine_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata` Output only. Additional information of the Chat Engine. Only applicable if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Engine.solution_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT`. |

## AppType

The app of the engine.

| Enums ||
|---|---|
| `APP_TYPE_UNSPECIFIED` | All non specified apps. |
| `APP_TYPE_INTRANET` | App type for intranet search and Agentspace. |

## ChatEngineConfig

Configurations for a Chat Engine.

| Fields ||
|---|---|
| `agent_creation_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig.AgentCreationConfig` The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.GetEngine` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` API after engine creation. |
| `dialogflow_agent_to_link` | `string` The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.GetEngine` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` API after engine creation. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.FIELDS.string.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata.dialogflow_agent` for actual agent association after Engine is created. |
| `allow_cross_region` | `bool` Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.CreateEngine`. It means they cannot be retrieved using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.GetEngine` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` API after engine creation. |

## AgentCreationConfig

Configurations for generating a Dialogflow agent.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.GetEngine` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` API after engine creation.

| Fields ||
|---|---|
| `business` | `string` Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. |
| `default_language_code` | `string` Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. |
| `time_zone` | `string` Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. |
| `location` | `string` Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. |

## ChatEngineMetadata

Additional information of a Chat Engine. Fields in this message are output only.

| Fields ||
|---|---|
| `dialogflow_agent` | `string` The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. |

## CommonConfig

Common configurations for an Engine.

| Fields ||
|---|---|
| `company_name` | `string` The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. |

## ConfigurableBillingApproach

Configuration for configurable billing approach.

| Enums ||
|---|---|
| `CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED` | Default value. For Spark and non-Spark non-configurable billing approach. General pricing model. |
| `CONFIGURABLE_BILLING_APPROACH_ENABLED` | The billing approach follows configurations specified by customer. |

## FeatureState

The state of the feature for the engine.

| Enums ||
|---|---|
| `FEATURE_STATE_UNSPECIFIED` | The feature state is unspecified. |
| `FEATURE_STATE_ON` | The feature is turned on to be accessible. |
| `FEATURE_STATE_OFF` | The feature is turned off to be inaccessible. |

## KnowledgeGraphConfig

Configuration message for the Knowledge Graph.

| Fields ||
|---|---|
| `enable_cloud_knowledge_graph` | `bool` Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. |
| `cloud_knowledge_graph_types[]` | `string` Specify entity types to support. |
| `enable_private_knowledge_graph` | `bool` Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. |
| `private_knowledge_graph_types[]` | `string` Specify entity types to support. |
| `feature_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.KnowledgeGraphConfig.FeatureConfig` Optional. Feature config for the Knowledge Graph. |

## FeatureConfig

Feature config for the Knowledge Graph.

| Fields ||
|---|---|
| `disable_private_kg_query_understanding` | `bool` Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. |
| `disable_private_kg_enrichment` | `bool` Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. |
| `disable_private_kg_auto_complete` | `bool` Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. |
| `disable_private_kg_query_ui_chips` | `bool` Whether to disable the private KG for query UI chips. Defaults to false if not specified. |

## MarketplaceAgentVisibility

Represents which marketplace agents are visible to any users in agent gallery.

| Enums ||
|---|---|
| `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED` | Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`. |
| `SHOW_AVAILABLE_AGENTS_ONLY` | Only agents that are currently available for use by the user are visible. |
| `SHOW_AGENTS_ALREADY_INTEGRATED` | Show marketplace agents that the user does not yet have access to but are integrated into the engine. This level also includes all agents visible with `SHOW_AVAILABLE_AGENTS_ONLY`. |
| `SHOW_AGENTS_ALREADY_PURCHASED` | Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus agents that have already been purchased by the project/organization, even if they are not currently integrated into the engine. |
| `SHOW_ALL_AGENTS` | All agents in the marketplace are visible, regardless of access or purchase status. This level encompasses all agents shown in the previous levels. |

## MediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine.

| Fields ||
|---|---|
| `type` | `string` Required. The type of engine. e.g., `recommended-for-you`. This field together with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.optimization_objective` describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. |
| `optimization_objective` | `string` The optimization objective. e.g., `cvr`. This field together with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type` describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` =\> `ctr` `others-you-may-like` =\> `ctr` |
| `optimization_objective_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig` Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400\] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0\] (excludes 0, includes 1.0) (e.g., 0.5). |
| `training_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.TrainingState` The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before. |
| `engine_features_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig` Optional. Additional engine features config. |

## EngineFeaturesConfig

More feature configs of the selected engine type.

| Fields ||
|---|---|
| Union field `type_dedicated_config`. Feature related configurations applied to a specific type of media recommendation engines. `type_dedicated_config` can be only one of the following: ||
| `recommended_for_you_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig` Recommended for you engine feature config. |
| `most_popular_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig` Most popular engine feature config. |

## MostPopularFeatureConfig

Feature configurations that are required for creating a Most Popular engine.

| Fields ||
|---|---|
| `time_window_days` | `int64` The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. |

## OptimizationObjectiveConfig

Custom threshold for `cvr` optimization_objective.

| Fields ||
|---|---|
| `target_field` | `string` Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. |
| `target_field_value_float` | `float` Required. The threshold to be applied to the target (e.g., 0.5). |

## RecommendedForYouFeatureConfig

Additional feature configurations for creating a `recommended-for-you` engine.

| Fields ||
|---|---|
| `context_event_type` | `string` The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`. |

## TrainingState

The training state of the engine.

| Enums ||
|---|---|
| `TRAINING_STATE_UNSPECIFIED` | Unspecified training state. |
| `PAUSED` | The engine training is paused. |
| `TRAINING` | The engine is training. |

## ModelState

The status of the model for the engine.

| Enums ||
|---|---|
| `MODEL_STATE_UNSPECIFIED` | The model state is unspecified. |
| `MODEL_ENABLED` | The model is enabled by admin. |
| `MODEL_DISABLED` | The model is disabled by admin. |

## RecommendationMetadata

Additional information of a recommendation engine.

| Fields ||
|---|---|
| `serving_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState` Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. |
| `data_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState` Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. |
| `last_tune_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. |
| `last_train_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines. |
| `tuning_operation` | `string` Output only. The latest tune operation ID associated with the engine. Only applicable on Media Recommendation engines. If present, this operation ID can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation ID in the engine resource format. If no tuning has happened for this engine, the string is empty. |

## DataState

Describes whether this engine have sufficient training data to be continuously trained.

| Enums ||
|---|---|
| `DATA_STATE_UNSPECIFIED` | Unspecified default value, should never be explicitly set. |
| `DATA_OK` | The engine has sufficient training data. |
| `DATA_ERROR` | The engine does not have sufficient training data. Error messages can be queried via Stackdriver. |

## ServingState

The serving state of the recommendation engine.

| Enums ||
|---|---|
| `SERVING_STATE_UNSPECIFIED` | Unspecified serving state. |
| `INACTIVE` | The engine is not serving. |
| `ACTIVE` | The engine is serving and can be queried. |
| `TUNED` | The engine is trained on tuned hyperparameters and can be queried. |

## SearchEngineConfig

Configurations for a Search Engine.

| Fields ||
|---|---|
| `search_tier` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTier` The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTier.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchTier.SEARCH_TIER_STANDARD` if not specified. |
| `required_subscription_tier` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTier` Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTier.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`. |
| `search_add_ons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchAddOn` The add-on that this search engine enables. |

## SimilarDocumentsEngineConfig

This type has no fields.
Additional config specs for a `similar-items` engine.

## EntityType

The type of an entity and its supported operations.

| Fields ||
|---|---|
| `name` | `string` The name of this entity type. |
| `operations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EntityTypeOperation` The operation supported by this entity. |

## EntityTypeOperation

Operation enum contains the list of operations supported by the entity type.

| Enums ||
|---|---|
| `ENTITY_TYPE_OPERATION_UNSPECIFIED` | Operation unspecified. |
| `LIST` | This operation means entity type supports LIST method. |
| `GET` | This operation means entity type supports GET method. |
| `CREATE` | This operation means entity type supports CREATE method. |
| `UPDATE` | This operation means entity type supports UPDATE method. |
| `DELETE` | This operation means entity type supports DELETE method. |

## EstimateDataSizeMetadata

Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |

## EstimateDataSizeRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateBillingService.EstimateDataSize` method

| Fields ||
|---|---|
| `location` | `string` Required. Full resource name of the location, such as `projects/{project}/locations/{location}`. |
| Union field `data_source`. Data source for which we are estimating its size. `data_source` can be only one of the following: ||
| `website_data_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.WebsiteDataSource` Website data. |
| `file_data_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.FileDataSource` Structured or unstructured data. |

## FileDataSource

Data source contains files either in Cloud Storage or BigQuery.

| Fields ||
|---|---|
| Union field `source`. Which source contains the files to be used. `source` can be only one of the following: ||
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. |
| `bigquery_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` BigQuery input source. |

## WebsiteDataSource

Data source is a set of website patterns that we crawl to get the total number of websites.

| Fields ||
|---|---|
| `estimator_uri_patterns[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EstimateDataSizeRequest.WebsiteDataSource.EstimatorUriPattern` Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown. |

## EstimatorUriPattern

URI patterns that we use to crawl.

| Fields ||
|---|---|
| `provided_uri_pattern` | `string` User provided URI pattern. For example, `foo.com/bar/*`. |
| `exact_match` | `bool` Whether we infer the generated URI or use the exact provided one. |
| `exclusive` | `bool` Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default. |

## EstimateDataSizeResponse

Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

| Fields ||
|---|---|
| `data_size_bytes` | `int64` Data size in terms of bytes. |
| `document_count` | `int64` Total number of documents. |

## Evaluation

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `evaluation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec` Required. The specification of the evaluation. |
| `quality_metrics` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics` Output only. The metrics produced by the evaluation, averaged across all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`. Only populated when the evaluation's state is SUCCEEDED. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.State` Output only. The state of the evaluation. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` was created at. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` was completed at. |
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Output only. A sample of errors encountered while processing the request. |

## EvaluationSpec

Describes the specification of the evaluation.

| Fields ||
|---|---|
| `query_set_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec.QuerySetSpec` Optional. The specification of the query set. |
| Union field `search_spec`. The search specification. `search_spec` can be only one of the following: ||
| `search_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest` Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.branch` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id` |

## QuerySetSpec

Describes the specification of the query set.

| Fields ||
|---|---|
| `sample_query_set` | `string` Optional. The full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. |

## State

Describes the state of an evaluation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The evaluation is unspecified. |
| `PENDING` | The service is preparing to run the evaluation. |
| `RUNNING` | The evaluation is in progress. |
| `SUCCEEDED` | The evaluation completed successfully. |
| `FAILED` | The evaluation failed. |

## ExecuteActionRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.ExecuteAction` method.

| Fields ||
|---|---|
| `name` | `string` Required. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` resource. The data connector used for executing the action. |
| `action_name` | `string` Required. Name of the action. For example: `"send_email"` |
| `args` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Required. Named arguments of the action. For example: `{"recipient": "tom@...", "subject": ... }` When offered to a user, this part might be editable. |
| `language_code` | `string` Optional. Language to be used for status and error messages created by actions. |
| `assist_answer_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionRequest.AssistAnswerInfo` Optional. If specified, the result of the action execution will be associated with the given assist answer. This lets the assistant take the result into account in subsequent answers in the same session. The referenced assist answer resource must exist. |

## AssistAnswerInfo

Message that identifes an action invocation in the assist answer.

| Fields ||
|---|---|
| `assist_answer` | `string` Required. Name of the assist answer. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` |
| `invocation_id` | `string` Required. The action invocation ID. |

## ExecuteActionResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.ExecuteAction` method.

| Fields ||
|---|---|
| `status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Status of the action execution. |
| `text_result` | `string` Human readable result of the action execution in case of success. |
| `result` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Detailed result of the action execution in case of success. |

## ExportMetricsMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## ExportMetricsRequest

Request message for the `ExportMetrics` method.

| Fields ||
|---|---|
| `analytics` | `string` Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/analytics`. |
| `output_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OutputConfig` Required. The output location of the data. |
| `start_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Optional. The earliest date (inclusive), interpreted in the UTC time zone, whose metrics are included in the export. If unset, defaults to 30 days before the current UTC date. The value must be a valid calendar date that is not in the future and not older than 180 days (the source data retention window); otherwise the request fails with `INVALID_ARGUMENT`. |

## ExportMetricsResponse

This type has no fields.
Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.

## ExportUserLicensesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ExportUserLicenses`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. All `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense`s under this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` are exported. |

## ExportUserLicensesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ExportUserLicenses`.

| Fields ||
|---|---|
| Union field `result`. The exported result. M1 returns the CSV inline in `csv_data`; the oneof leaves room for a future large-export variant (e.g. a GCS URI) without breaking the contract. `result` can be only one of the following: ||
| `csv_data` | `bytes` The full CSV document as raw bytes: the header row followed by one row per `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense`. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row. |

## ExternalIdentity

External identity representing either a user or group. This user or group is from an external identity provider (IdP).

| Fields ||
|---|---|
| `external_id` | `string` The unique 3P ID(external_id) of the entity (user or group). |
| `display_name` | `string` The display name of the user or group. |
| `subject` | `string` Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings. |
| Union field `EntityType`. The type of the external identity. This is used to indicate the type of entity (user or group) and the corresponding metadata. `EntityType` can be only one of the following: ||
| `user_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity.UserMetadata` Metadata corresponding to the external user. |
| `group_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExternalIdentity.GroupMetadata` Metadata corresponding to the external user. |

## GroupMetadata

This type has no fields.
Metadata corresponding to the external group.

## UserMetadata

Metadata corresponding to the external user.

| Fields ||
|---|---|
| `given_name` | `string` The user's given name. |
| `family_name` | `string` The user's family name. |
| `primary_email` | `string` The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject. |

## FactChunk

Fact Chunk.

| Fields ||
|---|---|
| `chunk_text` | `string` Text content of the fact chunk. Can be at most 10K characters long. |
| `source` | `string` Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. |
| `index` | `int32` The index of this chunk. Currently, only used for the streaming mode. |
| `source_metadata` | `map<string, string>` More fine-grained information for the source reference. |
| `uri` | `string` The URI of the source. |
| `title` | `string` The title of the source. |
| `domain` | `string` The domain of the source. |

## Feedback

Information about the user feedback. This information will be used for logging and metrics purpose.

| Fields ||
|---|---|
| `feedback_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.FeedbackType` Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. |
| `reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.Reason` Optional. The reason if user gives a thumb down. |
| `comment` | `string` Optional. The additional user comment of the feedback if user gives a thumb down. |
| `conversation_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.ConversationInfo` The related conversation information when user gives feedback. |
| `llm_model_version` | `string` The version of the LLM model that was used to generate the response. |
| `feedback_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback.FeedbackSource` Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP. |
| `component_version` | `string` Optional. The version of the component that this report is being sent from. |
| `data_terms_accepted` | `bool` Optional. Whether the customer accepted data use terms. |

## ConversationInfo

The conversation information such as the question index and session name.

| Fields ||
|---|---|
| `question_index` | `int32` The index of the user input within the conversation messages. |
| `session` | `string` Name of the newly generated or continued session. |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Required. The user's search query. |
| `assist_token` | `string` Optional. The token which could be used to fetch the assistant log. |
| `answer_query_token` | `string` Optional. The token which could be used to fetch the answer log. |
| `task_name` | `string` Optional. The full resource name of the Sobi task if the conversation was handled by a long-running agent task. Format: projects/{project}/locations/{location}/tasks/{task_id} |

## FeedbackSource

Source of the feedback as per integration.

| Enums ||
|---|---|
| `FEEDBACK_SOURCE_UNSPECIFIED` | Unspecified feedback source. |
| `GOOGLE_CONSOLE` | Feedback source is Google Console. |
| `GOOGLE_WIDGET` | Feedback source is Google Widget. |
| `GOOGLE_WEBAPP` | Feedback source is Google Webapp. |
| `GOOGLE_AGENTSPACE_MOBILE` | Feedback source is Google AgentSpace Mobile app. |

## FeedbackType

The type of the feedback user gives.

| Enums ||
|---|---|
| `FEEDBACK_TYPE_UNSPECIFIED` | Unspecified feedback type. |
| `LIKE` | The user gives a positive feedback. |
| `DISLIKE` | The user gives a negative feedback. |

## Reason

The reason why user gives a negative feedback.

| Enums ||
|---|---|
| `REASON_UNSPECIFIED` | Unspecified reason. |
| `INACCURATE_RESPONSE` | The response is inaccurate. |
| `NOT_RELEVANT` | The response is not relevant. |
| `INCOMPREHENSIVE` | The response is incomprehensive. |
| `OFFENSIVE_OR_UNSAFE` | The response is offensive or unsafe. |
| `FORMAT_AND_STYLES` | The response is not well-formatted. |
| `BAD_CITATION` | The response is not well-associated with the query. |
| `CANVAS_NOT_GENERATED` | The expected canvas was not generated for the response. |
| `CANVAS_QUALITY_BAD` | The generated canvas is of bad quality (e.g. inaccurate, incomplete, poorly formatted). |
| `CANVAS_EXPORT_FAILED` | Exporting the generated canvas failed (e.g. download or external export action did not complete successfully). |

## FetchDocumentsRequest

Request message for `HomepageDataService.FetchDocuments` method.

| Fields ||
|---|---|
| `homepage_data_config` | `string` Required. The name of the homepage data config. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/homepageDataConfig` |
| `page_size` | `int32` The maximum number of documents to return. Maximum allowed value is 20. |
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Type` The type of request. |
| `disable_cache` | `bool` Optional. If true, then cache will not be used. |
| Union field `request_type`. Type for the request. `request_type` can be only one of the following: ||
| `recommended_documents` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecommendedDocuments` Configuration to fetch recommended documents for the user. |
| `recent_documents` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentDocuments` Configuration to fetch recent documents for the user. |
| `recent_events` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentEvents` Configuration to fetch recent events for the user. |
| `announcements` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Announcements` Configuration to fetch announcements for the user. |

## Announcements

Configuration to fetch announcements for the user.

| Fields ||
|---|---|
| `types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.Announcements.Type` Optional. The type of announcements to return. If empty then all types of announcements are returned. |

## Type

Defines the type of announcements to return.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. Not allowed. |
| `COMPANY_ADMIN` | Type for Company admin Announcements. |
| `NEW_TEAM_MEMBER` | Type for Announcements for new team members. |

## RecentDocuments

Configuration to fetch recent documents for the user.

| Fields ||
|---|---|
| `types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecentDocuments.Type` Optional. The type of documents to return in the recent documents. If empty then all types of documents are returned. |

## Type

Defines the type of documents to return in the recent documents.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. Not allowed. |
| `GOOGLE_DRIVE` | Type for Google Drive documents. |
| `MICROSOFT_SHAREPOINT_FILE` | Type for Microsoft Sharepoint file documents. |

## RecentEvents

This type has no fields.
Configuration to fetch recent events for the user.

## RecommendedDocuments

Configuration to fetch recommended documents for the user.

| Fields ||
|---|---|
| `types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest.RecommendedDocuments.Type` Optional. The type of documents to return in the recommended documents. If empty then all types of documents are returned. |

## Type

Defines the type of documents to return in the recommended documents.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. Not allowed. |
| `MICROSOFT_SHAREPOINT_FILE` | Type for Microsoft Sharepoint file documents. |

## Type

Defines different types of requests.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Default value. |
| `GOOGLE_DRIVE_RECOMMENDED_DOCUMENTS` | Type to fetch recommended documents for the user from Google Drive. |
| `GOOGLE_CALENDAR_RECENT_EVENTS` | Type to fetch recent events for the user from Google Calendar. |
| `ANNOUNCEMENTS` | Type to fetch announcements for the user. |

## FetchDocumentsResponse

Response message for `HomepageDataService.FetchDocuments` method.

| Fields ||
|---|---|
| `results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse.Result` A list of results. The order represents the ranking of results. |
| `request_token` | `string` Unique request identifier. |

## Result

Defines a single result being returned from the homepage data service.

| Fields ||
|---|---|
| `document_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse.Result.DocumentType` The type of document. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` Contains the document data. |

## DocumentType

Defines the type of document.

| Enums ||
|---|---|
| `DOCUMENT_TYPE_UNSPECIFIED` | Default value. |
| `GOOGLE_DRIVE` | Type for Google Drive documents. |
| `GOOGLE_CALENDAR` | Type for Google Calendar events. |
| `ANNOUNCEMENTS` | Type for Announcements. |
| `MICROSOFT_SHAREPOINT_FILE` | Type for Microsoft Sharepoint file documents. |
| `NEW_TEAM_MEMBER` | Type for new team member documents. |

## FetchDomainVerificationStatusRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. |
| `page_size` | `int32` Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| `page_token` | `string` A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. |

## FetchDomainVerificationStatusResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchDomainVerificationStatus` method.

| Fields ||
|---|---|
| `target_sites[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` List of TargetSites containing the site verification status. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `total_size` | `int32` The total number of items matching the request. This will always be populated in the response. |

## FetchEntitiesTypesRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.FetchEntitiesTypes` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` does not exist, a `NOT_FOUND` error is returned. |
| `page_size` | `int32` Optional. Requested page size for number of entities to return. |
| `page_token` | `string` Optional. A page token, provided by a previous call to FetchEntities. Used to fetch the next page in a paginated response. |

## FetchEntitiesTypesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.FetchEntitiesTypes` method.

| Fields ||
|---|---|
| `entity_types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EntityType` List of entity types |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## FetchSitemapsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchSitemaps` method.

| Fields ||
|---|---|
| `parent` | `string` Required. Parent resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. |
| `matcher` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest.Matcher` Optional. If specified, fetches the matching `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s. If not specified, fetches all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. |

## Matcher

Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s. Currently only supports uris matcher.

| Fields ||
|---|---|
| Union field `matcher`. Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s. `matcher` can be only one of the following: ||
| `uris_matcher` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsRequest.UrisMatcher` Matcher by sitemap URIs. |

## UrisMatcher

Matcher for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s by their uris.

| Fields ||
|---|---|
| `uris[]` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` uris. |

## FetchSitemapsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.FetchSitemaps` method.

| Fields ||
|---|---|
| `sitemaps_metadata[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchSitemapsResponse.SitemapMetadata` List of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`s fetched. |

## SitemapMetadata

Contains a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` and its metadata.

| Fields ||
|---|---|
| `sitemap` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Sitemap`. |

## FhirStoreSource

Cloud FhirStore source import data from.

| Fields ||
|---|---|
| `fhir_store` | `string` Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. |
| `gcs_staging_dir` | `string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. |
| `resource_types[]` | `string` The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. |
| `update_from_latest_predefined_schema` | `bool` Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import. |

## FieldConfig

Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.

| Fields ||
|---|---|
| `field_path` | `string` Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. |
| `field_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType` Output only. Raw type of the field. |
| `indexable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED`, field values are indexed so that it can be filtered or faceted in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED` for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option` setting, and setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `dynamic_facetable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED`, field values are available for dynamic facet. Could only be `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED` if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED`. Otherwise, an `INVALID_ARGUMENT` error will be returned. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED` for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `searchable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED`, field values are searchable by text queries in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED` but field type is numerical, field values will not be searchable by text queries in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search`, as there are no text values associated to numerical fields. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED` for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option`. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `retrievable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED`, field values are included in the search results. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED` for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `completable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED`, field values are directly used and returned as suggestions for Autocomplete in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option` is unset, the server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED` for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option` for those fields will throw `INVALID_ARGUMENT` error. |
| `recs_filterable_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption` If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED`, field values are filterable by filter expression in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED` but the field type is numerical, field values are not filterable by text queries in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. Only textual fields are supported. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option` is unset, the default setting is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED` for fields that support setting filterable options. When a field set to \[FILTERABLE_DISABLED\] is filtered, a warning is generated and an empty result is returned. |
| `key_property_type` | `string` Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. |
| `advanced_site_search_data_sources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource` If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`. |
| `schema_org_paths[]` | `string` Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: - Publish date of the root: _root.datePublished - Publish date of the reviews: _root.review.datePublished |
| `metatag_name` | `string` Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.FieldConfig.field_path` will be used to extract metatag. |
| `searchable_field_importance` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableFieldImportance` Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). |

## AdvancedSiteSearchDataSource

Optional source of the advanced site search field.

| Enums ||
|---|---|
| `ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED` | Value used when unset. |
| `METATAGS` | Retrieve value from meta tag. |
| `PAGEMAP` | Retrieve value from page map. |
| `URI_PATTERN_MAPPING` | Retrieve value from the attributes set by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData` API. |
| `SCHEMA_ORG` | Retrieve value from schema.org data. |

## CompletableOption

The setting of Completable options in schema.

| Enums ||
|---|---|
| `COMPLETABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `COMPLETABLE_ENABLED` | Completable option enabled for a schema field. |
| `COMPLETABLE_DISABLED` | Completable option disabled for a schema field. |

## DynamicFacetableOption

The status of the dynamic facetable option of a schema field.

| Enums ||
|---|---|
| `DYNAMIC_FACETABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `DYNAMIC_FACETABLE_ENABLED` | Dynamic facetable option enabled for a schema field. |
| `DYNAMIC_FACETABLE_DISABLED` | Dynamic facetable option disabled for a schema field. |

## FieldType

Field value type in the Schema.

| Enums ||
|---|---|
| `FIELD_TYPE_UNSPECIFIED` | Field type is unspecified. |
| `OBJECT` | Field value type is Object. |
| `STRING` | Field value type is String. |
| `NUMBER` | Field value type is Number. |
| `INTEGER` | Field value type is Integer. |
| `BOOLEAN` | Field value type is Boolean. |
| `GEOLOCATION` | Field value type is Geolocation. Geolocation is expressed as an object with the following keys: - `id`: a string representing the location id - `longitude`: a number representing the longitude coordinate of the location - `latitude`: a number repesenting the latitude coordinate of the location - `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided. |
| `DATETIME` | Field value type is Datetime. Datetime can be expressed as either: - a number representing milliseconds-since-the-epoch - a string representing milliseconds-since-the-epoch. e.g. `"1420070400001"` - a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` |

## FilterableOption

Sets the filterable option for schema fields.

| Enums ||
|---|---|
| `FILTERABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `FILTERABLE_ENABLED` | Filterable option enabled for a schema field. |
| `FILTERABLE_DISABLED` | Filterable option disabled for a schema field. |

## IndexableOption

The setting of Indexable options in schema.

| Enums ||
|---|---|
| `INDEXABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `INDEXABLE_ENABLED` | Indexable option enabled for a schema field. |
| `INDEXABLE_DISABLED` | Indexable option disabled for a schema field. |

## RetrievableOption

The setting of Retrievable options in schema.

| Enums ||
|---|---|
| `RETRIEVABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `RETRIEVABLE_ENABLED` | Retrievable option enabled for a schema field. |
| `RETRIEVABLE_DISABLED` | Retrievable option disabled for a schema field. |

## SearchableFieldImportance

Specifies the importance of the field for search. New values are not expected to be added to this enum.

| Enums ||
|---|---|
| `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED` | Value used when unset. Behaves as `DEFAULT_IMPORTANCE` if the field is searchable. |
| `VERY_LOW_IMPORTANCE` | Provides a tiny signal for search. |
| `LOW_IMPORTANCE` | Indicates the field is used for search, but is less important than the default. |
| `DEFAULT_IMPORTANCE` | Default importance. Equivalent to previous behavior. |
| `HIGH_IMPORTANCE` | More important than default fields. |
| `VERY_HIGH_IMPORTANCE` | Most important field for search. |

## SearchableOption

The setting of Searchable options in schema.

| Enums ||
|---|---|
| `SEARCHABLE_OPTION_UNSPECIFIED` | Value used when unset. |
| `SEARCHABLE_ENABLED` | Searchable option enabled for a schema field. |
| `SEARCHABLE_DISABLED` | Searchable option disabled for a schema field. |

## FileCharacteristics

Caracteristics of other file types.

| Fields ||
|---|---|
| `characteristics` | `map<string, string>` Output only. Generic map of characteristics. |

## FileMetadata

Represents a file attached to a session (context file)

| Fields ||
|---|---|
| `file_id` | `string` Output only. The ID of the file. |
| `name` | `string` Output only. The name of the file uploaded. |
| `mime_type` | `string` The content type of the file, see <https://www.iana.org/assignments/media-types/media-types.xhtml>. |
| `byte_size` | `int64` Output only. The size of the context file in bytes. |
| `original_uri` | `string` Optional. The original location of the file. It may be a local file path, or any other URI that allows accessing the file in an external system. There are two scenarios in which this url may be empty: 1. If the file was sent as inline data (e.g. pasted from the clipboard). 2. If the original location is not available. Note that there's no guarantee that the URI will be pointing to a valid or actually existing file. For example, a file might have been uploaded to the session, and then deleted from the original source. |
| `original_source_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileSource` Optional. The type of the original source of the file. |
| `upload_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the file was uploaded (If this is a file generated by an internal process and then made available to the session, this indicates the moment it happened). |
| `last_add_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the file was added to the session. Note that if a file was added, then modified externally, then added again, the add time will be updated. |
| `metadata` | `map<string, string>` Optional. Represents metadata related to the file that can suit particular use cases. The prefix "google." is reserved for the key for use by Google, but other prefixes can be freely used. |
| `download_uri` | `string` Output only. The `AssistantService.DownloadSessionFile` URL to download the file. This URL will need the same credentials as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata` method and will provide the resource. |
| `file_origin_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileOriginType` Optional. The origin of the file. |
| `views` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileView`>`` Output only. Alternate views of this file object. Each file view is attached to a specific role. Possible example keys: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation" |

## FileOriginType

The origin of the file.

| Enums ||
|---|---|
| `FILE_ORIGIN_TYPE_UNSPECIFIED` | Default value. |
| `USER_PROVIDED` | The file was provided by the user. |
| `AI_GENERATED` | The file was generated by an AI model. |
| `INTERNALLY_GENERATED` | The file was generated from other files by an internal process. |

## FileSource

Original source of the file.

| Enums ||
|---|---|
| `FILE_SOURCE_UNSPECIFIED` | Default value. Unknown source. |
| `FILE_SOURCE_INLINE` | The data of the file was provided inline (e.g. pasted from the clipboard). |
| `FILE_SOURCE_LOCAL` | The file was uploaded from a local file. |
| `FILE_SOURCE_CLOUD_STORAGE` | The file was uploaded from Cloud Storage. |
| `FILE_SOURCE_CLOUD_DRIVE` | The file was uploaded from Drive. |
| `FILE_SOURCE_URL` | The file was retrieved from a URL (e.g. public web). |

## FileView

Represents a specific alternate version or "view" of a file object, such as a summary, a thumbnail, a translated version, etc.

| Fields ||
|---|---|
| `view_id` | `string` Output only. Globally Unique ID for this specific view. |
| `uri` | `string` Output only. The URI to access this media view. |
| `mime_type` | `string` Output only. MIME type (e.g., "image/jpeg", "image/png", "text/plain", "video/mp4") |
| `byte_size` | `int64` Output only. The size of the view in bytes. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the view was created. |
| Union field `characteristics`. Characteristics of the media view, allowing for flexible extensions. Metadata is always internally generated by the process creating the view. `characteristics` can be only one of the following: ||
| `image_characteristics` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImageCharacteristics` Output only. Characteristics of an image media view. |
| `video_characteristics` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.VideoCharacteristics` Output only. Characteristics of a video media view. |
| `file_characteristics` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileCharacteristics` Output only. Characteristics of other file types. |

## FirestoreSource

Firestore source import data from.

| Fields ||
|---|---|
| `project_id` | `string` The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `database_id` | `string` Required. The Firestore database to copy the data from with a length limit of 256 characters. |
| `collection_id` | `string` Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. |
| `gcs_staging_dir` | `string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |

## GcsSource

Cloud Storage location for input content.

| Fields ||
|---|---|
| `input_uris[]` | `string` Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). |
| `data_schema` | `string` The schema to use when parsing the data from the source. Supported values for document imports: - `document` (default): One JSON `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` per line. Each document must have a valid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id`. - `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. - `custom`: One custom data JSON per row in arbitrary format that conforms to the defined `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` of the data store. This can only be used by the GENERIC Data Store vertical. - `csv`: A CSV file with header conforming to the defined `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: - `user_event` (default): One JSON `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` per line. |

## GenerateContentRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.GenerateContent` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.StreamGenerateContent`.

Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` serving the request. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `model` | `string` Required. The model to serve the request. This is an opaque model identifier, not a Discovery Engine resource. |
| `http_body` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody` Required. The opaque request body. |

## GetAclConfigRequest

Request message for GetAclConfigRequest method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig`, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. |

## GetAgentRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.GetAgent` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |

## GetAlphaEvolveExperimentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.GetAlphaEvolveExperiment`.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |

## GetAlphaEvolveProgramRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.GetAlphaEvolveProgram`.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}` |

## GetAnalyticsConfigRequest

Request for GetAnalyticsConfig method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the analytics customer config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/analytics/config` |

## GetAnswerRequest

Request for GetAnswer method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` |

## GetAssistAnswerRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswerService.GetAssistAnswer` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` |

## GetAssistantRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.GetAssistant` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |

## GetAuthorizationRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.GetAuthorization` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |

## GetBillingAccountLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.GetBillingAccountLicenseConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. |

## GetBranchRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchService.GetBranch` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. |
| `view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView` The view to apply to the returned `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.BranchView.BRANCH_VIEW_BASIC` if unspecified. |

## GetCannedQueryRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.GetCannedQuery` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` |

## GetChunkRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService.GetChunk` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` does not exist, a `NOT_FOUND` error is returned. |

## GetCmekConfigRequest

Request message for GetCmekConfigRequest method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. |

## GetCollectionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.GetCollection` method.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}`. |

## GetCompletionConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.GetCompletionConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` |

## GetConnectorSecretRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.GetConnectorSecret`.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the associated data connector. |

## GetConnectorSecretResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.GetConnectorSecret`.

| Fields ||
|---|---|
| `app` | `string` The app name of the associated Connector. |
| `instance` | `string` The instance name of the associated Connector. |
| `tenant_id` | `string` The tenant ID of the associated Connector. |
| `client_id` | `string` The client ID of the associated Connector. |
| `redirect_uri` | `string` The redirect url of the associated Connector. |
| `authorization_uri` | `string` The authorization uri for the data connector. |

## GetControlRequest

Request for GetControl method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` |

## GetConversationRequest

Request for GetConversation method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` |

## GetDataConnectorRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.GetDataConnector` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` does not exist, a `NOT_FOUND` error is returned. |

## GetDataStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.GetDataStore` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not exist, a NOT_FOUND error is returned. |
| `view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView` Optional. The view to apply to the returned `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_BASIC` if unspecified. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_FULL` additionally populates `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.string.google.cloud.discoveryengine.v1alpha.DataStore.icon_uri` for a connector-backed data store. Resolving the connector icon requires extra lookups, so request it only when the caller renders the icon. |

## GetDocumentProcessingConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.GetDocumentProcessingConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` |

## GetDocumentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` does not exist, a `NOT_FOUND` error is returned. |

## GetEngineRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.GetEngine` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. |

## GetEvaluationRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.GetEvaluation` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` does not exist, a NOT_FOUND error is returned. |

## GetIdentityMappingStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.GetIdentityMappingStore`

| Fields ||
|---|---|
| `name` | `string` Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}` |

## GetLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.GetLicenseConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` does not exist, a NOT_FOUND error is returned. |

## GetProcessedDocumentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` does not exist, a `NOT_FOUND` error is returned. |
| `processed_document_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType` Required. What type of processing to return. |
| `processed_document_format` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat` What format output should be. If unspecified, defaults to JSON. |
| `image_id` | `string` Optional. Specifies config for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType.IMAGE_BYTES`. |

## ProcessedDocumentFormat

The format of the returned processed document. If unspecified, defaults to JSON.

| Enums ||
|---|---|
| `PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED` | Default value. |
| `JSON` | Output format is a JSON string representation of processed document. |

## ProcessedDocumentType

The type of processing to return in the response.

| Enums ||
|---|---|
| `PROCESSED_DOCUMENT_TYPE_UNSPECIFIED` | Default value. |
| `PARSED_DOCUMENT` | Available for all data store parsing configs. |
| `CHUNKED_DOCUMENT` | Only available if ChunkingConfig is enabled on the data store. |
| `IMAGE_CONVERTED_DOCUMENT` | Returns the converted Image bytes (as JPEG or PNG) if available. |
| `IMAGE_BYTES` | Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now. |

## GetProjectRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectService.GetProject` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`, such as `projects/{project_id_or_number}`. |

## GetSampleQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.GetSampleQuery` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` does not exist, a NOT_FOUND error is returned. |

## GetSampleQuerySetRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` does not exist, a NOT_FOUND error is returned. |

## GetSchemaRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.GetSchema` method.

| Fields ||
|---|---|
| `name` | `string` Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. |

## GetServingConfigRequest

Request for GetServingConfig method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` |

## GetSessionRequest

Request for GetSession method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` |
| `include_answer_details` | `bool` Optional. If set to true, the full session including all answer details will be returned. |

## GetSiteSearchEngineRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetSiteSearchEngine` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the \[SiteSearchEngine\], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. |

## GetTargetSiteRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetTargetSite` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` does not exist, a NOT_FOUND error is returned. |

## GetUriPatternDocumentDataRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. Full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. |

## GetUriPatternDocumentDataResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData` method.

| Fields ||
|---|---|
| `document_data_map` | ``map<string, `https://protobuf.dev/reference/protobuf/google.protobuf#struct`>`` Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/\*": { "Categories": \["category1", "category2"\] }, "www.url2.com/\*": { "Categories": \["category3"\] } } |

## GetUserStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStoreService.GetUserStore`

| Fields ||
|---|---|
| `name` | `string` Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` |

## GetWidgetConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfigService.GetWidgetConfig` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` |
| `accept_cache` | `bool` Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. |
| `get_widget_config_request_option` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetWidgetConfigRequest.GetWidgetConfigRequestOption` Optional. Options for GetWidgetConfigRequest. |
| `language_code` | `string` Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). |
| `model_info_view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ModelInfoView` Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. |

## GetWidgetConfigRequestOption

Options for GetWidgetConfigRequest.

| Fields ||
|---|---|
| `turn_off_collection_components` | `bool` Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. |

## GetWorkspaceSettingsRequest

Request for GetWorkspaceSettings method.

| Fields ||
|---|---|
| `name` | `string` Required. Full Engine resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` |

## GroundingFact

Grounding Fact.

| Fields ||
|---|---|
| `fact_text` | `string` Text content of the fact. Can be at most 10K characters long. |
| `attributes` | `map<string, string>` Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. |

## GuidedSearchSpec

Defines guided search spec.

| Fields ||
|---|---|
| `enable_refinement_attributes` | `bool` Whether or not to enable and include refinement attributes in gudied search result. |
| `enable_related_questions` | `bool` Whether or not to enable and include related questions in search response. |
| `max_related_questions` | `int32` Max number of related questions to be returned. The valid range is \[1, 5\]. If enable_related_questions is true, the default value is 3. |

## HarmCategory

Harm categories that will block the content.

| Enums ||
|---|---|
| `HARM_CATEGORY_UNSPECIFIED` | The harm category is unspecified. |
| `HARM_CATEGORY_HATE_SPEECH` | The harm category is hate speech. |
| `HARM_CATEGORY_DANGEROUS_CONTENT` | The harm category is dangerous content. |
| `HARM_CATEGORY_HARASSMENT` | The harm category is harassment. |
| `HARM_CATEGORY_SEXUALLY_EXPLICIT` | The harm category is sexually explicit content. |
| `HARM_CATEGORY_CIVIC_INTEGRITY` | The harm category is civic integrity. |

## HealthcareFhirConfig

Config to data store for `HEALTHCARE_FHIR` vertical.

| Fields ||
|---|---|
| `enable_configurable_schema` | `bool` Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. |
| `enable_static_indexing_for_batch_ingestion` | `bool` Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. |
| `initial_filter_groups[]` | `string` Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. |

## IdentityMappingEntry

Identity Mapping Entry that maps an external identity to an internal identity.

| Fields ||
|---|---|
| `external_identity` | `string` Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. |
| `external_identity_name` | `string` Optional. The name of the external identity. |
| Union field `identity_provider_id`. Union field identity_provider_id. Identity Provider ID can be a user or a group. `identity_provider_id` can be only one of the following: ||
| `user_id` | `string` User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. |
| `group_id` | `string` Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. |

## IdentityMappingEntryOperationMetadata

IdentityMappingEntry LongRunningOperation metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ImportIdentityMappings` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.PurgeIdentityMappings`

| Fields ||
|---|---|
| `success_count` | `int64` The number of IdentityMappingEntries that were successfully processed. |
| `failure_count` | `int64` The number of IdentityMappingEntries that failed to be processed. |
| `total_count` | `int64` The total number of IdentityMappingEntries that were processed. |

## IdentityMappingStore

Identity Mapping Store which contains Identity Mapping Entries.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `idp_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig` Output only. The identity provider configuration this is bound to translate the identity mapping entries within. |
| `kms_key_name` | `string` Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field. |
| `cmek_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` Output only. CMEK-related information for the Identity Mapping Store. |

## IdentityScheduleConfig

The configuration for the identity data synchronization runs.

| Fields ||
|---|---|
| `refresh_interval` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. |
| `next_sync_time` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.DateTime` Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. |

## IdpConfig

Identity Provider Config.

| Fields ||
|---|---|
| `idp_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig.IdpType` Identity provider type configured. |
| `external_idp_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdpConfig.ExternalIdpConfig` External Identity provider config. |

## ExternalIdpConfig

Third party IDP Config.

| Fields ||
|---|---|
| `workforce_pool_name` | `string` Workforce pool name. Example: "locations/global/workforcePools/pool_id" |

## IdpType

Identity Provider Type.

| Enums ||
|---|---|
| `IDP_TYPE_UNSPECIFIED` | Default value. ACL search not enabled. |
| `GSUITE` | Google 1P provider. |
| `THIRD_PARTY` | Third party provider. |

## ImageCharacteristics

Standard characteristics of an image media view.

| Fields ||
|---|---|
| `width` | `int32` Output only. Image width in pixels. |
| `height` | `int32` Output only. Image height in pixels. |
| `color_space` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImageCharacteristics.ColorSpace` Output only. Color space of the image (e.g., "RGB", "CMYK", "Grayscale"). |
| `bit_depth` | `int32` Output only. Bit depth of the image (e.g., 8-bit, 16-bit). |

## ColorSpace

Possible color spaces of an image (e.g., "RGB", "CMYK", "Grayscale").

| Enums ||
|---|---|
| `COLOR_SPACE_UNSPECIFIED` | Default value. Unknown color space. |
| `RGB` | Red, green, blue colorspace. |
| `CMYK` | Cyan, magenta, yellow, and black colorspace. |
| `GRAYSCALE` | Grayscale colorspace. |
| `YUV` | YUV colorspace. |
| `OTHER_COLOR_SPACE` | Other colorspace. |

## ImportAgentFileRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ImportAgentFile` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `file_name` | `string` Required. The name of the file. |
| `mime_type` | `string` Optional. The content type of the file, see <https://www.iana.org/assignments/media-types/media-types.xhtml>. This field is required when the data source does not provide the content type. |

## ImportAgentFileResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ImportAgentFile` method.

| Fields ||
|---|---|
| `agent_file` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentFile` The imported `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentFile`. |

## ImportCompletionSuggestionsMetadata

Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion`s successfully imported. |
| `failure_count` | `int64` Count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion`s that failed to be imported. |

## ImportCompletionSuggestionsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/*/locations/*/collections/*/dataStores/*` |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. |
| Union field `source`. The source of the autocomplete suggestions. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsRequest.InlineSource` The Inline source for suggestion entries. |
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. |
| `bigquery_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` BigQuery input source. |

## InlineSource

The inline source for CompletionSuggestions.

| Fields ||
|---|---|
| `suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionSuggestion` Required. A list of all denylist entries to import. Max of 1000 items. |

## ImportCompletionSuggestionsResponse

Response of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions` method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. |

## ImportDocumentsMetadata

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of entries that were processed successfully. |
| `failure_count` | `int64` Count of entries that encountered errors while processing. |
| `total_count` | `int64` Total count of entries that were processed. |

## ImportDocumentsRequest

Request message for Import methods.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. |
| `reconciliation_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode` The mode of reconciliation between existing documents and the documents to be imported. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL`. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. |
| `auto_generate_ids` | `bool` Whether to automatically generate IDs for the documents if absent. If set to `true`, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id`s are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL` is highly recommended to avoid duplicate contents. If unset or set to `false`, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id`s have to be specified using `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field`, otherwise, documents without IDs fail to be imported. Supported data sources: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource.FIELDS.string.google.cloud.discoveryengine.v1alpha.GcsSource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource.FIELDS.string.google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SpannerSource`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CloudSqlSource`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FirestoreSource`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableSource`. |
| `id_field` | `string` The field indicates the ID field or column to be used as unique IDs of the documents. For `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id`s. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids` is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource.FIELDS.string.google.cloud.discoveryengine.v1alpha.GcsSource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource`. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource.FIELDS.string.google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SpannerSource`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CloudSqlSource`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableSource`. |
| `force_refresh_content` | `bool` Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. |
| Union field `source`. Required. The source of the input. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource` The Inline source for the input content for documents. |
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. |
| `bigquery_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` BigQuery input source. |
| `fhir_store_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FhirStoreSource` FhirStore input source. |
| `spanner_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SpannerSource` Spanner input source. |
| `cloud_sql_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CloudSqlSource` Cloud SQL input source. |
| `firestore_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FirestoreSource` Firestore input source. |
| `alloy_db_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlloyDbSource` AlloyDB input source. |
| `bigtable_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigtableSource` Cloud Bigtable input source. |

## InlineSource

The inline source for the input config for ImportDocuments method.

| Fields ||
|---|---|
| `documents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` Required. A list of documents to update/create. Each document must have a valid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id`. Recommended max of 100 items. |

## ReconciliationMode

Indicates how imported documents are reconciled with the existing documents created or imported before.

| Enums ||
|---|---|
| `RECONCILIATION_MODE_UNSPECIFIED` | Defaults to `INCREMENTAL`. |
| `INCREMENTAL` | Inserts new documents or updates existing documents. |
| `FULL` | Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location. When using this mode, there won't be any downtime on the dataset targeted. Any document that should remain unchanged or that should be updated will continue serving while the operation is running. |

## ImportDocumentsResponse

Response of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest`. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` Echoes the destination for the complete errors in the request if set. |

## ImportErrorConfig

Configuration of destination for Import related errors.

| Fields ||
|---|---|
| Union field `destination`. Required. Errors destination. `destination` can be only one of the following: ||
| `gcs_prefix` | `string` Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. |

## ImportIdentityMappingsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ImportIdentityMappings`

| Fields ||
|---|---|
| `identity_mapping_store` | `string` Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}` |
| Union field `source`. The source of the input. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportIdentityMappingsRequest.InlineSource` The inline source to import identity mapping entries from. |

## InlineSource

The inline source to import identity mapping entries from.

| Fields ||
|---|---|
| `identity_mapping_entries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingEntry` A maximum of 10000 entries can be imported at one time |

## ImportIdentityMappingsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ImportIdentityMappings`

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |

## ImportSampleQueriesMetadata

Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` ImportSampleQueries operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s successfully imported. |
| `failure_count` | `int64` Count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s that failed to be imported. |
| `total_count` | `int64` Total count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s that were processed. |

## ImportSampleQueriesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. |
| Union field `source`. The source of the sample queries. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSampleQueriesRequest.InlineSource` The Inline source for sample query entries. |
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. |
| `bigquery_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` BigQuery input source. |

## InlineSource

The inline source for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s.

| Fields ||
|---|---|
| `sample_queries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` Required. A list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s to import. Max of 1000 items. |

## ImportSampleQueriesResponse

Response of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries` method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. |

## ImportSuggestionDenyListEntriesMetadata

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## ImportSuggestionDenyListEntriesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/\*/locations/\*/collections/\*/dataStores/\*. |
| Union field `source`. The source of the updated SuggestionDenyList. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportSuggestionDenyListEntriesRequest.InlineSource` The Inline source for the input content for suggestion deny list entries. |
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: - `suggestion_deny_list` (default): One JSON \[SuggestionDenyListEntry\] per line. |

## InlineSource

The inline source for SuggestionDenyListEntry.

| Fields ||
|---|---|
| `entries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry` Required. A list of all denylist entries to import. Max of 1000 items. |

## ImportSuggestionDenyListEntriesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.ImportSuggestionDenyListEntries` method.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |
| `imported_entries_count` | `int64` Count of deny list entries successfully imported. |
| `failed_entries_count` | `int64` Count of deny list entries that failed to be imported. |

## ImportUserEventsMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of entries that were processed successfully. |
| `failure_count` | `int64` Count of entries that encountered errors while processing. |

## ImportUserEventsRequest

Request message for the ImportUserEvents request.

| Fields ||
|---|---|
| `parent` | `string` Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the Import. Cannot be set for inline user event imports. |
| Union field `source`. Required - The desired input source of the user event data. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest.InlineSource` The Inline source for the input content for UserEvents. |
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. |
| `bigquery_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQuerySource` BigQuery input source. |

## InlineSource

The inline source for the input config for ImportUserEvents method.

| Fields ||
|---|---|
| `user_events[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` Required. A list of user events to import. Recommended max of 10k items. |

## ImportUserEventsResponse

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` Echoes the destination for the complete errors if this field was set in the request. |
| `joined_events_count` | `int64` Count of user events imported with complete existing Documents. |
| `unjoined_events_count` | `int64` Count of user events imported, but with Document information not found in the existing Branch. |

## IndustryVertical

The industry vertical associated with the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`.

| Enums ||
|---|---|
| `INDUSTRY_VERTICAL_UNSPECIFIED` | Value used when unset. |
| `GENERIC` | The generic vertical for documents that are not specific to any industry vertical. |
| `MEDIA` | The media industry vertical. |
| `HEALTHCARE_FHIR` | The healthcare FHIR vertical. |

## Interval

A floating point interval.

| Fields ||
|---|---|
| Union field `min`. The lower bound of the interval. If neither of the min fields are set, then the lower bound is negative infinity. This field must be not larger than max. Otherwise, an `INVALID_ARGUMENT` error is returned. `min` can be only one of the following: ||
| `minimum` | `double` Inclusive lower bound. |
| `exclusive_minimum` | `double` Exclusive lower bound. |
| Union field `max`. The upper bound of the interval. If neither of the max fields are set, then the upper bound is positive infinity. This field must be not smaller than min. Otherwise, an `INVALID_ARGUMENT` error is returned. `max` can be only one of the following: ||
| `maximum` | `double` Inclusive upper bound. |
| `exclusive_maximum` | `double` Exclusive upper bound. |

## InvokeConnectorMcpRequest

Request message for making a call to an MCP connector. It carries the connector name, the method to invoke, and optional parameters.

| Fields ||
|---|---|
| `name` | `string` Required. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` resource. The data connector used for making the MCP call. |
| `method` | `string` Required. The method to invoke (e.g. "tools/list", "tools/call", "resources/read", "prompts/get", etc.). |
| `params` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Arbitrary structured parameters for the method. Using google.protobuf.Struct keeps the payload schema-flexible, matching JSON-RPC's free-form `params` field. |
| `engine` | `string` Optional. The engine resource name (e.g. "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}"). Used as the search engine ID when invoking tool registry tools that issue Discovery Search Service requests. |
| `tool_spec_version` | `string` Optional. The tool spec version to resolve the connector's tool surface against. This corresponds to the connector's BAP tool spec file name (e.g. "v2", "v5.2"). When unset, the server uses its default (latest) tool spec for the connector. Applies to all methods (e.g. "tools/list" and "tools/call"). |

## InvokeConnectorMcpResponse

Response message returning the result of an MCP connector invocation. It contains either a successful result payload or error details.

| Fields ||
|---|---|
| Union field `payload`. Exactly one of `result` or `error` should be set. `payload` can be only one of the following: ||
| `result` | `https://protobuf.dev/reference/protobuf/google.protobuf#value` Successful result --- arbitrary structured data. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.McpError` Error details when the call fails. |

## LanguageInfo

Language info for DataStore.

| Fields ||
|---|---|
| `language_code` | `string` The language code for the DataStore. |
| `normalized_language_code` | `string` Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`. |
| `language` | `string` Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. |
| `region` | `string` Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> \`\`. |

## LicenseConfig

Information about users' licenses.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` |
| `license_count` | `int64` Required. Number of licenses purchased. |
| `subscription_tier` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTier` Required. Subscription tier information for the license config. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig.State` Output only. The state of the license config. |
| `auto_renew` | `bool` Optional. Whether the license config should be auto renewed when it reaches the end date. |
| `start_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Required. The start date. |
| `end_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Optional. The planed end date. |
| `subscription_term` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SubscriptionTerm` Required. Subscription term. |
| `free_trial` | `bool` Optional. Whether the license config is for free trial. |
| `alert_policy_resource_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlertPolicyResourceConfig` Optional. The alert policy config for this license config. |
| `gemini_bundle` | `bool` Output only. Whether the license config is for Gemini bundle. |
| `early_terminated` | `bool` Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. |
| `early_termination_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Output only. The date when the subscription is terminated earlier than the expiration date. |
| `last_user_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). |
| `billing_account_license_config` | `string` Output only. The name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig` from which this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` is assigned, if this field is set. |

## State

License config state enumeration.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default value. The license config does not exist. |
| `ACTIVE` | The license config is effective and being used. |
| `EXPIRED` | The license config has expired. |
| `NOT_STARTED` | The license config has not started yet, and its start date is in the future. |
| `WITHDRAWN` | This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED. |
| `DEACTIVATING` | The license config is in a grace period. Its subscription has ended, either through early termination or by reaching its end date, but the customer keeps access for a limited time. It becomes EXPIRED when the grace period ends. |

## LicenseConfigUsageStats

Stats about users' licenses.

| Fields ||
|---|---|
| `license_config` | `string` Required. The LicenseConfig name. |
| `used_license_count` | `int64` Required. The number of licenses used. |

## ListActiveCannedQueryUserViewsRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListActiveCannedQueryUserViews` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the parent assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `language_code` | `string` Optional. The language code the canned queries should be returned in. If not specified here or corresponding translation is not found, the default texts will be returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryUserView`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListActiveCannedQueryUserViews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListActiveCannedQueryUserViews` must match the call that provided the page token. |

## ListActiveCannedQueryUserViewsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListActiveCannedQueryUserViews` method.

| Fields ||
|---|---|
| `canned_query_user_views[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryUserView` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryUserView`s that are representing active (existing, enabled and capabilities met) canned queries. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListActiveCannedQueryUserViewsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListAgentsRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ListAgents` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `page_size` | `int32` Optional. Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| `page_token` | `string` Optional. A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAgentsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ListAgents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ListAgents` must match the call that provided the page token. |
| `order_by` | `string` Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: - `update_time` - `is_pinned` Example: - "update_time desc" - "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time. |
| `filter` | `string` Optional. Filters the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent`s list. Supported fields: - `display_name`: display name of the agent. Supports `=`, `:`. - `id`: ID of the agent. Supports `=`. - `state`: state of the agent. Supports `=`. - `create_time`: timestamp when the agent was created. Supports `=`, `>`, `<`, `>=`, `<=`. - `update_time`: timestamp when the agent was last updated. Supports `=`, `>`, `<`, `>=`, `<=`. Examples: - `display_name = "My Agent"` - `create_time > "2023-01-01T00:00:00Z"` |

## ListAgentsResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.ListAgents` method.

| Fields ||
|---|---|
| `agents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` The agents visible to the caller under the parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAgentsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAgentsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListAlphaEvolveExperimentsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ListAlphaEvolveExperiments`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (Session) of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `page_size` | `int32` Optional. The maximum number of experiments to return. The service may return fewer than this value. |
| `page_token` | `string` Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page. |

## ListAlphaEvolveExperimentsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ListAlphaEvolveExperiments`.

| Fields ||
|---|---|
| `alpha_evolve_experiments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveExperiment` Output only. List of experiments. |
| `next_page_token` | `string` Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListAlphaEvolveProgramsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ListAlphaEvolvePrograms`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |
| `page_size` | `int32` Optional. The maximum number of programs to return. The service may return fewer than this value. |
| `page_token` | `string` Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page. |
| `order_by` | `string` Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria. |
| `state_filter` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProgramState` Optional. Filter to apply to the programs. Examples: "state_filter = 'COMPLETED'" "state_filter = 'INITIALIZED' OR "state_filter = 'EVALUATING'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL. |

## ListAlphaEvolveProgramsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ListAlphaEvolvePrograms`.

| Fields ||
|---|---|
| `alpha_evolve_programs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgram` Output only. List of programs matching the criteria provided in the request. |
| `next_page_token` | `string` Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListAssistantsRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListAssistants` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAssistantsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListAssistants` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListAssistants` must match the call that provided the page token. |

## ListAssistantsResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListAssistants` method.

| Fields ||
|---|---|
| `assistants[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAssistantsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAssistantsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListAuthorizationsRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ListAuthorizations` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}` |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAuthorizationsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ListAuthorizations` must match the call that provided the page token. |

## ListAuthorizationsResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ListAuthorizations` method.

| Fields ||
|---|---|
| `authorizations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListAuthorizationsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListAuthorizationsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListBillingAccountLicenseConfigsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.ListBillingAccountLicenseConfigs` method.

| Fields ||
|---|---|
| `parent` | `string` Required. Format: `billingAccounts/{billing_account}`. |
| `page_size` | `int32` Optional. Not supported. |
| `page_token` | `string` Optional. Not supported. |

## ListBillingAccountLicenseConfigsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.ListBillingAccountLicenseConfigs` method.

| Fields ||
|---|---|
| `billing_account_license_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig` All `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`s for the given billing account. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListBillingAccountLicenseConfigsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListBranchesRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchService.ListBranches` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name. |
| `view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView` The view to apply to the returned `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch`. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.BranchView.BRANCH_VIEW_BASIC` if unspecified. |

## ListBranchesResponse

Response for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BranchService.ListBranches` method.

| Fields ||
|---|---|
| `branches[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Branch` The Branches. |

## ListCannedQueriesRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListCannedQueries` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `filter` | `string` Optional. The filter expression. Supported fields: - `enabled` - `google_defined` Examples: - `enabled=true` - `google_defined=true` - `enabled=true AND google_defined=true` |
| `page_size` | `int32` Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| `page_token` | `string` A page token received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListCannedQueries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListCannedQueries` must match the call that provided the page token. |

## ListCannedQueriesResponse

Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.ListCannedQueries` method.

| Fields ||
|---|---|
| `canned_queries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` The list of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery`s matching the request. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCannedQueriesRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListCannedQueriesRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListChunksRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`s under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListChunksResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListChunksResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChunkService.ListChunks` method.

| Fields ||
|---|---|
| `chunks[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListChunksRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListChunksRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListCmekConfigsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService.ListCmekConfigs` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`s under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. |

## ListCmekConfigsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService.ListCmekConfigs` method.

| Fields ||
|---|---|
| `cmek_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig`s. |

## ListCollectionsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.ListCollections` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}`. |
| `page_size` | `int32` The maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`s to return. The service may return fewer than this value. If unspecified, at most 100 `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`s will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| `page_token` | `string` A page token, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.ListCollections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.ListCollections` must match the call that provided the page token. |
| `filter` | `string` Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location. |

## ListCollectionsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.ListCollections` method.

| Fields ||
|---|---|
| `collections[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListCollectionsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListCollectionsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListConnectorRunsRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.ListConnectorRuns` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`s under this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, regardless of whether or not this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token. |

## ListConnectorRunsResponse

Response for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.ListConnectorRuns` method.

| Fields ||
|---|---|
| `connector_runs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun` List of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConnectorRun`s. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListControlsRequest

Request for ListControls method.

| Fields ||
|---|---|
| `parent` | `string` Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. |
| `page_size` | `int32` Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. |
| `filter` | `string` Optional. A filter to apply on the list results. Supported features: - List all the products under the parent branch if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListControlsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter` is unset. Currently this field is unsupported. |

## ListControlsResponse

Response for ListControls method.

| Fields ||
|---|---|
| `controls[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` All the Controls for a given data store. |
| `next_page_token` | `string` Pagination token, if not returned indicates the last page. |

## ListConversationsRequest

Request for ListConversations method.

| Fields ||
|---|---|
| `parent` | `string` Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` |
| `page_size` | `int32` Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| `page_token` | `string` A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. |
| `filter` | `string` A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
| `order_by` | `string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: \* `update_time` \* `create_time` \* `conversation_name` Example: "update_time desc" "create_time" |

## ListConversationsResponse

Response for ListConversations method.

| Fields ||
|---|---|
| `conversations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` All the Conversations for a given data store. |
| `next_page_token` | `string` Pagination token, if not returned indicates the last page. |

## ListCustomModelsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. |

## ListCustomModelsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTuningService.ListCustomModels` method.

| Fields ||
|---|---|
| `models[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomTuningModel` List of custom tuning models. |

## ListDataStoresRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. |
| `filter` | `string` Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` |
| `view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView` Optional. The view to apply to the returned `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_BASIC` if unspecified. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreView.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStoreView.DATA_STORE_VIEW_FULL` additionally populates `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.string.google.cloud.discoveryengine.v1alpha.DataStore.icon_uri` for connector-backed data stores. Resolving connector icons requires extra lookups, so request it only when the caller renders the icons. |

## ListDataStoresResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores` method.

| Fields ||
|---|---|
| `data_stores[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListDataStoresRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListDocumentsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListDocumentsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments` method.

| Fields ||
|---|---|
| `documents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListDocumentsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListDocumentsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListEnginesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. |
| `page_size` | `int32` Optional. Not supported. |
| `page_token` | `string` Optional. Not supported. |
| `filter` | `string` Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH |

## ListEnginesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.ListEngines` method.

| Fields ||
|---|---|
| `engines[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s. |
| `next_page_token` | `string` Not supported. |

## ListEvaluationResultsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults` method.

| Fields ||
|---|---|
| `evaluation` | `string` Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult` under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Optional. Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult` to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` Optional. A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListEvaluationResultsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluationResults` method.

| Fields ||
|---|---|
| `evaluation_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsResponse.EvaluationResult` The evaluation results for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListEvaluationResultsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## EvaluationResult

Represents the results of an evaluation for a single `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`.

| Fields ||
|---|---|
| `sample_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` Output only. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` that was evaluated. |
| `quality_metrics` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics` Output only. The metrics produced by the evaluation, for a given `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`. |

## ListEvaluationsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`s under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Optional. Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` Optional. A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListEvaluationsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListEvaluationsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EvaluationService.ListEvaluations` method.

| Fields ||
|---|---|
| `evaluations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Evaluation`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListFilesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionService.ListFiles` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` Name of the session resource to which the file belong. |
| `filter` | `string` Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: - upload_time - last_add_time - last_use_time - file_name - mime_type Some examples of filters would be: - "file_name = 'file_1'" - "file_name = 'file_1' AND mime_type = 'text/plain'" - "last_use_time \> '2025-06-14T12:00:00Z'" For a full description of the filter format, please see <https://google.aip.dev/160>. |
| `page_size` | `int32` Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error. |
| `page_token` | `string` Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ). |
| `order_by` | `string` Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with `desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: - `upload_time`: The time the file was uploaded. - `file_name`: The name of the file. - `mime_type`: The MIME type of the file. - `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time` |

## ListFilesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionService.ListFiles` method.

| Fields ||
|---|---|
| `files[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileMetadata` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileMetadata`s. |
| `next_page_token` | `string` A token to retrieve next page of results. Pass this value in the `ListFilesRequest.page_token` field in the subsequent call to `ListFiles` method to retrieve the next page of results. |

## ListIdentityMappingStoresRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ListIdentityMappingStores`

| Fields ||
|---|---|
| `parent` | `string` Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`. |
| `page_size` | `int32` Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. |
| `page_token` | `string` A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. |

## ListIdentityMappingStoresResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ListIdentityMappingStores`

| Fields ||
|---|---|
| `identity_mapping_stores[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStore` The Identity Mapping Stores. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListIdentityMappingsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ListIdentityMappings`

| Fields ||
|---|---|
| `identity_mapping_store` | `string` Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}` |
| `page_size` | `int32` Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. |
| `page_token` | `string` A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. |

## ListIdentityMappingsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.ListIdentityMappings`

| Fields ||
|---|---|
| `identity_mapping_entries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingEntry` The Identity Mapping Entries. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListLicenseConfigsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.ListLicenseConfigs` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. |
| `page_size` | `int32` Optional. Not supported. |
| `page_token` | `string` Optional. Not supported. |
| `filter` | `string` Optional. The filter to apply to the list results. The supported fields are: - `subscription_tier` - `state` Examples: - `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. - `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. |

## ListLicenseConfigsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.ListLicenseConfigs` method.

| Fields ||
|---|---|
| `license_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`s. |
| `next_page_token` | `string` Not supported. |

## ListLicenseConfigsUsageStatsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListLicenseConfigsUsageStats` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`. |

## ListLicenseConfigsUsageStatsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListLicenseConfigsUsageStats` method.

| Fields ||
|---|---|
| `license_config_usage_stats[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigUsageStats` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigUsageStats`. |

## ListSampleQueriesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListSampleQueriesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries` method.

| Fields ||
|---|---|
| `sample_queries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListSampleQuerySetsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| `page_token` | `string` A page token `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.next_page_token`, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## ListSampleQuerySetsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets` method.

| Fields ||
|---|---|
| `sample_query_sets[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListSchemasRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. |
| `page_size` | `int32` The maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`s to return. The service may return fewer than this value. If unspecified, at most 100 `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`s are returned. The maximum value is 1000; values above 1000 are set to 1000. |
| `page_token` | `string` A page token, received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas` must match the call that provided the page token. |

## ListSchemasResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas` method.

| Fields ||
|---|---|
| `schemas[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`s. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSchemasRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ListSchemasRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListServingConfigsRequest

Request for ListServingConfigs method.

| Fields ||
|---|---|
| `parent` | `string` Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `page_size` | `int32` Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
| `page_token` | `string` Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. |

## ListServingConfigsResponse

Response for ListServingConfigs method.

| Fields ||
|---|---|
| `serving_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` All the ServingConfigs for a given dataStore. |
| `next_page_token` | `string` Pagination token, if not returned indicates the last page. |

## ListSessionFileMetadataRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |

## ListSessionFileMetadataResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata` method.

| Fields ||
|---|---|
| `file_metadata[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataResponse.FileMetadata` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionFileMetadataResponse.FileMetadata`s. |
| `total_quota_percentage (deprecated)` | `double` > [!WARNING] > This item is deprecated! Deprecated: This field may not be set, or the value may not take all file types into account. To be removed. The total quota percentage used by all the files. |

## FileMetadata

The metadata of the file.

| Fields ||
|---|---|
| `file_id` | `string` The ID of the file. |
| `name` | `string` The name of the file uploaded. |
| `mime_type` | `string` The content type of the file, see <https://www.iana.org/assignments/media-types/media-types.xhtml>. |
| `byte_size` | `int64` The size of the context file in bytes. |
| `token_count (deprecated)` | `int64` > [!WARNING] > This item is deprecated! Deprecated: This field will not be set for all file types, and will eventually be removed. The length of the file measured in tokens. |
| `quota_percentage (deprecated)` | `double` > [!WARNING] > This item is deprecated! Deprecated: This field will not be set for all file types, and will eventually be removed. The percentage of the quota used by the file. |
| `selected` | `bool` If the file is selected to be used. |
| `used_in_conversation` | `bool` Whether the file was used in the session previously (i.e. was used in a query) and is part of the conversation history, or is only uploaded and not used yet. |
| `original_uri` | `string` Optional. The original location of the file. It may be a local file path, or any other URI that allows accessing the file in an external system. There are two scenarios in which this url may be empty: 1. If the file was sent as inline data (e.g. pasted from the clipboard). 2. If the original location is not available. Note that there's no guarantee that the URI will be pointing to a valid or actually existing file. For example, a file might have been uploaded to the session, and then deleted from the original source. |
| `original_source_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FileSource` Optional. The type of the original source of the file. |
| `upload_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the file was uploaded (If this is a file generated by an internal process and then made available to the session, this indicates the moment it happened). |
| `metadata` | `map<string, string>` Optional. Represents metadata related to the file that can suit particular use cases. The prefix "google." is reserved for the key for use by Google, but other prefixes can be freely used. |
| `session` | `string` Output only. The resource name of the session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. |

## ListSessionsRequest

Request for ListSessions method.

| Fields ||
|---|---|
| `parent` | `string` Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` |
| `page_size` | `int32` Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| `page_token` | `string` A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. |
| `filter` | `string` A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: - `user_pseudo_id` - `state` - `display_name` - `starred` - `is_pinned` - `labels` - `create_time` - `update_time` - `collaborative_project` Examples: - `user_pseudo_id = some_id` - `display_name = "some_name"` - `starred = true` - `is_pinned=true AND (NOT labels:hidden)` - `create_time > "1970-01-01T12:00:00Z"` - `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` |
| `order_by` | `string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: - `update_time` - `create_time` - `session_name` - `is_pinned` - `display_name` Example: - `update_time desc` - `create_time` - `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. |

## ListSessionsResponse

Response for ListSessions method.

| Fields ||
|---|---|
| `sessions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` All the Sessions for a given data store. |
| `next_page_token` | `string` Pagination token, if not returned indicates the last page. |

## ListTargetSitesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. |
| `page_size` | `int32` Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| `page_token` | `string` A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. |

## ListTargetSitesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.ListTargetSites` method.

| Fields ||
|---|---|
| `target_sites[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` List of TargetSites. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `total_size` | `int32` The total number of items matching the request. This will always be populated in the response. |

## ListUserLicensesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListUserLicenses`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| `page_token` | `string` Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. |
| `filter` | `string` Optional. Filter for the list request. Supported fields: - `license_assignment_state` - `user_principal` \* Examples: - `license_assignment_state = ASSIGNED` to list assigned user licenses. - `license_assignment_state = NO_LICENSE` to list not licensed users. - `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. - `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. - `user_principal = user1@example.com` to list user license for `user1@example.com`. |
| `order_by` | `string` Optional. The order in which the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense`s are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): - `user_principal` If not set, the default ordering is by `user_principal`. Examples: - `user_principal` to order by `user_principal` in ascending order. - `user_principal desc` to order by `user_principal` in descending order. |

## ListUserLicensesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListUserLicenses`.

| Fields ||
|---|---|
| `user_licenses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense` All the customer's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense`s. |
| `next_page_token` | `string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## LookupWidgetConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.LookupWidgetConfig` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where lookup widget will be performed. Format: `locations/{location}` |
| `widget_config_id` | `string` Required. The UUID of the Widget Config. |
| `accept_cache` | `bool` Optional. Whether to use cache for the widget config and certain related configs. Notice that cache may still be used for some configs even if this flag is set to false. |
| `enable_load_child_configs` | `bool` Optional. If true, load all configs under the widget config. |
| `language_code` | `string` Optional. The language code of the user that the widget is serving. |
| `region_code` | `string` Optional. The region code of the user that the widget is serving. |
| `view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.View` Optional. Controls response composition. Defaults to `MINIMAL` (today's behavior). |
| `model_info_view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ModelInfoView` Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. Forwarded to the downstream `GetWidgetConfig` call. `ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated. `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set. `END_USER_WEB` returns the end-user web selector. |

## View

Controls which connectors are included in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.WidgetConfig.CollectionComponent.google.cloud.discoveryengine.v1alpha.WidgetConfig.collection_components`.

The default (`VIEW_UNSPECIFIED` / `MINIMAL`) preserves today's behavior: only already-attached connectors (those with `connector_auth_state.auth_state == AUTHORIZED`) are returned.

| Enums ||
|---|---|
| `VIEW_UNSPECIFIED` | Default. Equivalent to `MINIMAL`. |
| `MINIMAL` | Returns only already-attached connectors. Today's behavior. |
| `WITH_AVAILABLE_CONNECTORS` | For SaaS / Business engines, additionally include synthetic placeholder entries in `collection_components` for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`) and a pre-built `authorization_uri` built against a synthetic placeholder collection ID so the widget can initiate OAuth before the connector is attached. No effect on Enterprise engines. |

## LookupWidgetConfigResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.LookupWidgetConfig` method.

| Fields ||
|---|---|
| `anonymous_widget_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` The Anonymous Widget Config associated with the UUID. |
| `desktop_enabled` | `bool` Whether the Gemini Enterprise Desktop app is enabled for this project. |
| `desktop_trajectory_export_enabled` | `bool` Whether the Gemini Enterprise Desktop app may export agent trajectories for this project. |

## ManagedAgentDefinition

Stores the definition of a Google managed agent.

| Fields ||
|---|---|
| `tool_settings (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentToolSettings` > [!WARNING] > This item is deprecated! Optional. The parameters that define how the agent is presented to the planner LLM. DEPRECATED: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.google.cloud.discoveryengine.v1alpha.AgentInvocationSpec.google.cloud.discoveryengine.v1alpha.Agent.agent_invocation_spec` instead. |
| `authorizations[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. DEPRECATED: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.repeated.string.google.cloud.discoveryengine.v1alpha.Agent.authorizations` instead. Resource names of the required authorizations. If the user is not authorized, the service will return a number of authorization URIs that the user must open in a browser and authorize. Once all authorizations are granted, the user can retry the query, and the authorizations will be forwarded to the agent. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |
| `deployment_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeploymentInfo` Output only. Automatic deployment information for the agent. |
| Union field `agent_config`. Agent type specific configuration. `agent_config` can be only one of the following: ||
| `data_science_agent_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataScienceAgentConfig` Optional. Configuration specific to Google premade data science agents. This data structure is intended to store deployment and request time configuration for the agent. |

## McpError

McpError represents error details when an MCP call fails. This structure follows the JSON-RPC 2.0 error object shape.

| Fields ||
|---|---|
| `code` | `int32` Numeric error code. |
| `message` | `string` Short, human-readable description of the error. |
| `data` | `https://protobuf.dev/reference/protobuf/google.protobuf#value` Optional structured data with additional error context. |

## MediaInfo

Media-specific user event information.

| Fields ||
|---|---|
| `media_progress_duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then `https://protobuf.dev/reference/protobuf/google.protobuf#duration` should be set to 90. |
| `media_progress_percentage` | `float` Media progress should be computed using only the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.MediaInfo.FIELDS.google.protobuf.Duration.google.cloud.discoveryengine.v1alpha.MediaInfo.media_progress_duration` relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. |

## ModelInfoView

Selects which "view" of the model selector configuration the backend computes for `WidgetConfig.UiSettings.ModelConfigInfo`.

The end-user views (`END_USER_WEB`, `END_USER_MOBILE`) return the user-facing model selector for their respective surface; the `ADMIN` view returns the set surfaced on the Cloud Console admin "Feature Control" page, with `ModelConfigInfo.ResolvedModel.admin_view` populated on each entry.

| Enums ||
|---|---|
| `MODEL_INFO_VIEW_UNSPECIFIED` | Not specified. |
| `END_USER_WEB` | The end-user web model selector view. |
| `ADMIN` | The Cloud Console admin "Feature Control" view that displays model toggles. Returns admin-surfaced models with `ResolvedModel.admin_view` populated. |
| `END_USER_MOBILE` | The end-user model selector view for the Gemini Enterprise mobile app. Returns only mobile-surfaced models, with the mobile default selected. Set explicitly by the mobile client. |

## NaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding.

| Fields ||
|---|---|
| `mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig.Mode` Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED`. |

## Mode

Mode of Natural Language Query Understanding. When the NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural language understanding capabilities will be enabled for a search request if the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the SearchRequest is ENABLED.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Default value. |
| `DISABLED` | Natural Language Query Understanding is disabled. |
| `ENABLED` | Natural Language Query Understanding is enabled. |

## OAuth2Credential

Configuration for OAuth2 authorization.

| Fields ||
|---|---|
| `client_id` | `string` Output only. The client ID. |
| `client_secret` | `string` Output only. The client secret. |
| `nonce` | `string` Output only. The nonce value. |
| `state` | `string` Output only. The state value. |
| `redirect_uri` | `string` Output only. The redirect URI. |
| `auth_response_uri` | `string` Output only. The authorization response URI. |
| `auth_code` | `string` Output only. The authorization code. |
| `access_token` | `string` Output only. The access token. |
| `refresh_token` | `string` Output only. The refresh token. |
| `id_token` | `string` Output only. The ID token. |
| `expire_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The expiration time. |
| `expire_duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Output only. The expiration duration. |
| `audience` | `string` Output only. The audience. |
| `code_verifier` | `string` Output only. The code verifier. |
| `code_challenge_method` | `string` Output only. The code challenge method. |
| `token_endpoint_auth_method` | `string` Output only. The token endpoint authorization method. |

## ObservabilityConfig

Observability config for a resource.

| Fields ||
|---|---|
| `observability_enabled` | `bool` Optional. Enables observability. If `false`, all other flags are ignored. |
| `sensitive_logging_enabled` | `bool` Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If `false`, will sanitize all sensitive fields. |

## ObtainCrawlRateRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.ObtainCrawlRate` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` |
| `crawl_rate_scope` | `string` Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. |

## ObtainCrawlRateResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.ObtainCrawlRate` method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObtainCrawlRateResponse.State` Output only. The state of the response. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Errors from service when handling the request. |
| Union field `crawl_rate_time_series`. Once the user sets the dedicated crawl rate, it will return the dedicated crawl rate time series, otherwise it will return the organic crawl rate time series. `crawl_rate_time_series` can be only one of the following: ||
| `organic_crawl_rate_time_series` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.OrganicCrawlRateTimeSeries` The historical organic crawl rate timeseries data, used for monitoring. |
| `dedicated_crawl_rate_time_series` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DedicatedCrawlRateTimeSeries` The historical dedicated crawl rate timeseries data, used for monitoring. |

## State

Different states of the response.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `SUCCEEDED` | The state is successful. |
| `FAILED` | The state is failed. |

## OrganicCrawlRateTimeSeries

The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.

| Fields ||
|---|---|
| `google_organic_crawl_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to <https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers> for more details about googlebots. |
| `vertex_ai_organic_crawl_rate` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateTimeSeries` Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to <https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot> for more details about Google-CloudVertexBot. |

## OutputConfig

The output configuration setting.

| Fields ||
|---|---|
| Union field `destination`. The configuration of destination for holding output data. `destination` can be only one of the following: ||
| `bigquery_destination` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BigQueryDestination` The BigQuery location where the output is to be written to. |

## PageInfo

Detailed page information.

| Fields ||
|---|---|
| `pageview_id` | `string` A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. |
| `page_category` | `string` The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `uri` | `string` Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters. |
| `referrer_uri` | `string` The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty. |

## PanelInfo

Detailed panel information associated with a user event.

| Fields ||
|---|---|
| `panel_id` | `string` Required. The panel ID. |
| `display_name` | `string` The display name of the panel. |
| `documents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentInfo` Optional. The document IDs associated with this panel. |
| `panel_position` | `int32` The ordered position of the panel, if shown to the user with other panels. If set, then `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PanelInfo.FIELDS.int32.google.cloud.discoveryengine.v1alpha.PanelInfo.total_panels` must also be set. |
| `total_panels` | `int32` The total number of panels, including this one, shown to the user. Must be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PanelInfo.FIELDS.int32.google.cloud.discoveryengine.v1alpha.PanelInfo.panel_position` is set. |

## PatientFilterOperationMetadata

Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `filters_added_count` | `int64` The number of patient IDs added to the patient filter. |
| `filters_removed_count` | `int64` The number of patient IDs removed from the patient filter. |

## PauseEngineRequest

Request for pausing training of an engine.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` |

## PredictRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.Predict`.

Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` serving the request. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `model` | `string` Required. The model to serve the request. This is an opaque model identifier, not a Discovery Engine resource. |
| `http_body` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody` Required. The opaque request body. |

## Principal

Principal identifier of a user or a group.

| Fields ||
|---|---|
| Union field `principal`. Union field principal. Principal can be a user or a group. `principal` can be only one of the following: ||
| `user_id` | `string` User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. |
| `group_id` | `string` Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. |
| `external_entity_id` | `string` For 3P application identities which are not present in the customer identity provider. |

## ProcessedDocument

Document captures all raw metadata information of items to be recommended or searched.

| Fields ||
|---|---|
| `document` | `string` Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. |
| Union field `processed_data_format`. Output format of the processed document. `processed_data_format` can be only one of the following: ||
| `json_data` | `string` The JSON string representation of the processed document. |

## ProgramState

State of a program in an experiment.

| Enums ||
|---|---|
| `PROGRAM_STATE_UNSPECIFIED` | Default value. This value is unused. |
| `INITIALIZED` | The program is initialized. |
| `GENERATING` | The program is in generation. |
| `EVALUATING` | The program is pending evaluation. |
| `COMPLETED` | The program is completed. |

## Project

Metadata and configurations for a Google Cloud project in the service.

| Fields ||
|---|---|
| `name` | `string` Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project ID are both acceptable, but the server will always respond in project number. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when this project is created. |
| `provision_completion_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. |
| `service_terms_map` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms`>`` Output only. A map of terms of services. The key is the `id` of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms`. |
| `customer_provided_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig` Optional. Customer provided configurations. |
| `configurable_billing_status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus` Output only. The current status of the project's configurable billing. |

## ConfigurableBillingStatus

Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.

| Fields ||
|---|---|
| `effective_search_qpm_threshold` | `int64` Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. |
| `effective_indexing_core_threshold` | `int64` Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Optional. The start time of the currently active billing subscription. |
| `terminate_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The latest terminate effective time of search qpm and indexing core subscriptions. |
| `search_qpm_threshold_next_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded. |
| `indexing_core_threshold_next_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded. |
| `update_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus.UpdateType` Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject. |
| `agent_search_token_subscription_statuses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus.AgentSearchTokenSubscriptionStatus` Output only. Per-model Agent Search TPM subscription status. |

## AgentSearchTokenSubscriptionStatus

Per-model Agent Search TPM subscription status. One entry per active `core_subscription.agent_search_token_subscriptions[*]` entry in the customer-provided config; populated by UpdateProject and GetProject.

The lifecycle scalars on this message (`start_time`, `terminate_time`, `update_type`, `tpm_threshold_next_update_time`) are per (project, model_version) --- siblings of the whole-relationship `start_time` / `terminate_time` / `update_type` on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ --- their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.

| Fields ||
|---|---|
| `model_version` | `string` Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see <https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models)>. |
| `effective_tpm_threshold` | `int64` Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching `effective_search_qpm_threshold` semantics. |
| `tpm_threshold_next_update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship `start_time` on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship. |
| `terminate_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from `core_subscription.agent_search_token_subscriptions[*]`. Does NOT move the whole-relationship `terminate_time` on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down. |
| `update_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ConfigurableBillingStatus.UpdateType` Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. `UPDATE_TYPE_UNSPECIFIED` indicates this model_version was not touched by the most recent UpdateProject (its `effective_tpm_threshold` reflects an earlier update). The whole-relationship `update_type` on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together). |

## UpdateType

The type of update performed on the configurable billing configuration.

| Enums ||
|---|---|
| `UPDATE_TYPE_UNSPECIFIED` | Unspecified update type. |
| `CREATE` | Configurable billing was created/enabled. |
| `DELETE` | Configurable billing was deleted/disabled. |
| `SCALE_UP` | Subscription was scaled up (thresholds increased). |
| `SCALE_DOWN` | Subscription was scaled down (thresholds decreased). |

## CustomerProvidedConfig

Customer provided configurations.

| Fields ||
|---|---|
| `notebooklm_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig` Optional. Configuration for NotebookLM settings. |
| `resource_access_control_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.ResourceAccessControlConfig` Optional. Resource-level access control config for Gemini Enterprise users. |

## NotebooklmConfig

Configuration for NotebookLM.

| Fields ||
|---|---|
| `model_armor_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.ModelArmorConfig` Model Armor configuration to be used for sanitizing user prompts and LLM responses. |
| `opt_out_notebook_sharing` | `bool` Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. |
| `data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.DataProtectionPolicy` Optional. Specifies the data protection policy for NotebookLM. |
| `observability_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ObservabilityConfig` Optional. Observability config for NotebookLM. |

## DataProtectionPolicy

Data protection policy config for NotebookLM.

| Fields ||
|---|---|
| `sensitive_data_protection_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.CustomerProvidedConfig.NotebooklmConfig.DataProtectionPolicy.SensitiveDataProtectionPolicy` Optional. The sensitive data protection policy. |

## SensitiveDataProtectionPolicy

Specifies a Sensitive Data Protection (<https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview>) policy.

| Fields ||
|---|---|
| `policy` | `string` Optional. The Sensitive Data Protection policy resource name. |

## ModelArmorConfig

Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.

| Fields ||
|---|---|
| `user_prompt_template` | `string` Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt. |
| `response_template` | `string` Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response. |

## ResourceAccessControlConfig

Controls resource-level access control for Gemini Enterprise users.

| Fields ||
|---|---|
| `data_store_access_control_enabled` | `bool` Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on. |

## ServiceTerms

Metadata about the terms of service.

| Fields ||
|---|---|
| `id` | `string` The unique identifier of this terms of service. Available terms: - `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.FIELDS.string.google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.version` to provide is `2022-11-23`. |
| `version` | `string` The version string of the terms of service. For acceptable values, see the comments for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.FIELDS.string.google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.id` above. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project.ServiceTerms.State` Whether the project has accepted/rejected the service terms or it is still pending. |
| `accept_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The last time when the project agreed to the terms of service. |
| `decline_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The last time when the project declined or revoked the agreement to terms of service. |

## State

The agreement states this terms of service.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The default value of the enum. This value is not actually used. |
| `TERMS_ACCEPTED` | The project has given consent to the terms of service. |
| `TERMS_PENDING` | The project is pending to review and accept the terms of service. |
| `TERMS_DECLINED` | The project has declined or revoked the agreement to terms of service. |

## ProjectSessionDisplayNameUpdatedEvent

Event indicating that a collaborative-project session's display name was created (auto-generated title) or changed (manual rename). Delivered on the project channel so session/chat lists can update the title in real time.

| Fields ||
|---|---|
| `session` | `string` Output only. Resource name of the session whose display name changed. |
| `display_name` | `string` Output only. The new display name of the session. |
| `source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectSessionDisplayNameUpdatedEvent.Source` Output only. What caused the display name to change. |

## Source

What caused the display name to change.

| Enums ||
|---|---|
| `SOURCE_UNSPECIFIED` | Default value. Should not be used. |
| `AUTO_GENERATED` | The display name was auto-generated by the backend (LLM title). |
| `USER_EDITED` | The display name was edited by a user (manual rename). |

## ProvisionProjectMetadata

This type has no fields.
Metadata associated with a project provision operation.

## ProvisionProjectRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject` method.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`, such as `projects/{project_id_or_number}`. |
| `accept_data_use_terms` | `bool` Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). |
| `data_use_terms_version` | `string` Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. |
| `saas_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProvisionProjectRequest.SaasParams` Optional. Parameters for Agentspace. |

## SaasParams

Parameters for Agentspace.

| Fields ||
|---|---|
| `accept_biz_qos` | `bool` Optional. Set to `true` to specify that caller has read and would like to give consent to the \[Terms for Agent Space quality of service\]. |
| `is_biz` | `bool` Optional. Indicates if the current request is for Biz edition (= true) or not (= false). |

## PurgeCompletionSuggestionsMetadata

Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## PurgeCompletionSuggestionsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/\*/locations/\*/collections/\*/dataStores/\*. |

## PurgeCompletionSuggestionsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.PurgeCompletionSuggestions` method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

| Fields ||
|---|---|
| `purge_succeeded` | `bool` Whether the completion suggestions were successfully purged. |
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |

## PurgeDocumentsMetadata

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of entries that were deleted successfully. |
| `failure_count` | `int64` Count of entries that encountered errors while processing. |
| `ignored_count` | `int64` Count of entries that were ignored as entries were not found. |

## PurgeDocumentsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. |
| `filter` | `string` Required. Filter matching documents to purge. Only currently supported value is `*` (all items). |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeErrorConfig` The desired location of errors incurred during the purge. |
| `force` | `bool` Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. |
| Union field `source`. The desired input source for the purging documents based on document IDs. `source` can be only one of the following: ||
| `gcs_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GcsSource` Cloud Storage location for the input content. Supported `data_schema`: \* `document_id`: One valid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id` per line. |
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource` Inline source for the input content for purge. |

## InlineSource

The inline source for the input config for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments` method.

| Fields ||
|---|---|
| `documents[]` | `string` Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items. |

## PurgeDocumentsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments` method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

| Fields ||
|---|---|
| `purge_count` | `int64` The total count of documents purged as a result of the operation. |
| `purge_sample[]` | `string` A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. |

## PurgeErrorConfig

Configuration of destination for Purge related errors.

| Fields ||
|---|---|
| Union field `destination`. Required. Errors destination. `destination` can be only one of the following: ||
| `gcs_prefix` | `string` Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. |

## PurgeIdentityMappingsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingStoreService.PurgeIdentityMappings`

| Fields ||
|---|---|
| `identity_mapping_store` | `string` Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}` |
| `filter` | `string` Filter matching identity mappings to purge. The eligible field for filtering is: - `update_time`: in ISO 8601 "zulu" format. - `external_id` Examples: - Deleting all identity mappings updated in a time range: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` - Deleting all identity mappings for a given external_id: `external_id = "id1"` - Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided. |
| Union field `source`. The source of the input. `source` can be only one of the following: ||
| `inline_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PurgeIdentityMappingsRequest.InlineSource` The inline source to purge identity mapping entries from. |
| `force` | `bool` Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field. |

## InlineSource

The inline source to purge identity mapping entries from.

| Fields ||
|---|---|
| `identity_mapping_entries[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IdentityMappingEntry` A maximum of 10000 entries can be purged at one time |

## PurgeSuggestionDenyListEntriesMetadata

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## PurgeSuggestionDenyListEntriesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/\*/locations/\*/collections/\*/dataStores/\*. |

## PurgeSuggestionDenyListEntriesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.PurgeSuggestionDenyListEntries` method.

| Fields ||
|---|---|
| `purge_count` | `int64` Number of suggestion deny list entries purged. |
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the request. |

## PurgeUserEventsMetadata

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `success_count` | `int64` Count of entries that were deleted successfully. |
| `failure_count` | `int64` Count of entries that encountered errors while processing. |

## PurgeUserEventsRequest

Request message for PurgeUserEvents method.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. |
| `filter` | `string` Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: - `eventType`: Double quoted `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.event_type` string. - `eventTime`: in ISO 8601 "zulu" format. - `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. - `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: - Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` - Deleting specific eventType in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"` - Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"` - Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. |
| `force` | `bool` The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. |

## PurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

| Fields ||
|---|---|
| `purge_count` | `int64` The total count of events purged as a result of the operation. |

## QualityMetrics

Describes the metrics produced by the evaluation.

| Fields ||
|---|---|
| `doc_recall` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): \* For a single `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, If 3 out of 5 relevant documents are retrieved in the top-5, [recall@5](mailto:recall@5) = 3/5 = 0.6 |
| `doc_precision` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): \* For a single `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, If 4 out of 5 retrieved documents in the top-5 are relevant, [precision@5](mailto:precision@5) = 4/5 = 0.8 |
| `doc_ndcg` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: \[D3 (0), D1 (1), D2 (1)\] Ideal: \[D1 (1), D2 (1), D3 (0)\] Calculate [NDCG@3](mailto:NDCG@3) for each `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`: \* [DCG@3](mailto:DCG@3): 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* Ideal [DCG@3](mailto:DCG@3): 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 \* [NDCG@3](mailto:NDCG@3): 1.13/1.63 = 0.693 |
| `page_recall` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): \* For a single `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, if 3 out of 5 relevant pages are retrieved in the top-5, [recall@5](mailto:recall@5) = 3/5 = 0.6 |
| `page_ndcg` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QualityMetrics.TopkMetrics` Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: \[P3 (0), P1 (1), P2 (1)\] Ideal: \[P1 (1), P2 (1), P3 (0)\] Calculate [NDCG@3](mailto:NDCG@3) for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`: \* [DCG@3](mailto:DCG@3): 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 \* Ideal [DCG@3](mailto:DCG@3): 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 \* [NDCG@3](mailto:NDCG@3): 1.13/1.63 = 0.693 |

## TopkMetrics

Stores the metric values at specific top-k levels.

| Fields ||
|---|---|
| `top_1` | `double` The top-1 value. |
| `top_3` | `double` The top-3 value. |
| `top_5` | `double` The top-5 value. |
| `top_10` | `double` The top-10 value. |

## Query

Defines a user inputed query.

| Fields ||
|---|---|
| `query_id` | `string` Output only. Unique Id for the query. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time at which the server accepted this query. |
| `parts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart` Query content parts. |
| Union field `content`. Query content. `content` can be only one of the following: ||
| `text` | `string` Plain text. |

## QueryConfigurablePricingUsageStatsRequest

Request for \[ProjectService.QueryConfigurablePricingUsageStats\] method.

| Fields ||
|---|---|
| `project` | `string` Required. The project to query usage stats for. Format: projects/{project} |
| `location` | `string` Required. The location to query usage stats for. |
| `time_range` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsRequest.TimeRange` Optional. The time range of the usage aggregation. If end_date is not set, it defaults to current date. If start_date is not set, it defaults to 30 days prior to end_date. |
| `metric_types[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingMetricType` Optional. The metric types to return usage for. |

## TimeRange

The time range of the usage aggregation.

| Fields ||
|---|---|
| `start_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Optional. The inclusive start date of the usage aggregation. |
| `end_date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` Optional. The inclusive end date of the usage aggregation. |

## QueryConfigurablePricingUsageStatsResponse

Response for \[ProjectService.QueryConfigurablePricingUsageStats\] method.

| Fields ||
|---|---|
| `metric_usages[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse.MetricUsage` A list of metric usages, one for each requested resource type that has data in the requested time range. |

## DatedUsage

A list of usages for a specific day.

| Fields ||
|---|---|
| `date` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Date` The date of the usage. |
| `usage` | `double` The usage value on the date. |

## MetricUsage

The usage of a metric over a list of days.

| Fields ||
|---|---|
| `metric_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingMetricType` The metric type. |
| `dated_usages[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryConfigurablePricingUsageStatsResponse.DatedUsage` The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM. |
| `total_usage` | `double` The total usage for this resource type. This is populated for metrics like TOTAL_STORAGE. |

## QueryPart

Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.

| Fields ||
|---|---|
| `mime_type` | `string` Optional. The IANA standard MIME type of the data. See <https://www.iana.org/assignments/media-types/media-types.xhtml>. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field. |
| Union field `payload`. The payload of the query part. `payload` can be only one of the following: ||
| `text` | `string` Text content. |
| `ui_json_payload` | `string` This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages. |
| `person_reference` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.PersonReference` Reference to a person. |
| `drive_document_reference` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.DriveDocumentReference` Reference to a Google Drive document. |
| `document_reference` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.DocumentReference` Other VAIS `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` references. |
| `user_supplied_sobi_artifact_reference` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.QueryPart.UserSuppliedSobiArtifactReference` Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above. |

## DocumentReference

Represents a document reference.

| Fields ||
|---|---|
| `document_name` | `string` The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. |
| `display_title` | `string` The display title of the reference. |
| `destination_uri` | `string` The destination uri of the reference. |
| `icon_uri` | `string` The icon uri of the reference. |
| `file_id` | `string` Output only. The file ID of the document data stored in the session context files. |
| `url_for_connector` | `string` Input only. The url_for_connector of the document returned by Federated Search. |

## DriveDocumentReference

Represents a Google Drive document reference.

| Fields ||
|---|---|
| `drive_id` | `string` The Drive ID of the document. |
| `document_name` | `string` The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. |
| `display_title` | `string` The display title of the reference. |
| `destination_uri` | `string` The destination uri of the reference. |
| `icon_uri` | `string` The icon uri of the Drive document reference. |
| `file_id` | `string` Output only. The file ID of the Drive document data stored in the session context files. |

## PersonReference

Represents a person reference.

| Fields ||
|---|---|
| `document_name` | `string` The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. |
| `person_id` | `string` The person ID of the person. |
| `email` | `string` The email of the person. |
| `display_name` | `string` The display name of the person. |
| `display_photo_uri` | `string` The display photo url of the person. |
| `destination_uri` | `string` The destination uri of the person. |
| `file_id` | `string` Output only. The file ID of the person data stored in the session context files. |

## UserSuppliedSobiArtifactReference

Reference to a user-supplied file attached to a long-running-agent (Sobi) task. Rendered by the client as an attachment chip on the user turn's bubble. The file itself is stored on the task's `AgentArtifact` list; the client resolves full metadata (source URI, size, ...) for download or preview by calling `GetTask` on the Sobi Task API and matching `AgentArtifact.name` against `file_name`.

Only `file_name` and `mime_type` appear on this wire deliberately: the backing `gs://` or Drive URI is not exposed to conversation-history readers. Same variant is used for both byte-uploaded and Drive-picked files -- "user attached a file" is one concept regardless of source.

| Fields ||
|---|---|
| `file_name` | `string` Required. Client-supplied filename. Unique per task within the user-supplied artifact set (UI dedupes before upload). Doubles as the artifact identifier used to look up the artifact on `Task.artifacts`. The `_name` suffix is deliberate and the AIP-122 lint is suppressed: this field is not a resource name (which is what AIP-122 reserves the bare `name` for). It is the literal filename, and it serves as the join key against `AgentArtifact.name` on the backing Sobi task -- a structural role that `title` or `display_name` would not communicate to a client picking what to send. The internal mirror (`cloud/ml/discoveryengine/schema/assistant.proto`) uses the same field name so the round-trip converter stays name-for-name. |
| `mime_type` | `string` Optional. IANA MIME type. Used for icon/preview rendering. |

## RankRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankService.Rank` method.

| Fields ||
|---|---|
| `ranking_config` | `string` Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. |
| `model` | `string` The identifier of the model to use. It is one of: - `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. |
| `top_n` | `int32` The number of results to return. If this is unset or no bigger than zero, returns all results. |
| `query` | `string` The query to use. |
| `records[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord` Required. A list of records to rank. |
| `ignore_record_details_in_response` | `bool` If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |

## RankResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankService.Rank` method.

| Fields ||
|---|---|
| `records[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord` A list of records sorted by descending score. |

## RankingRecord

Record message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankService.Rank` method.

| Fields ||
|---|---|
| `id` | `string` The unique ID to represent the record. |
| `title` | `string` The title of the record. Empty by default. At least one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord.FIELDS.string.google.cloud.discoveryengine.v1alpha.RankingRecord.title` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord.FIELDS.string.google.cloud.discoveryengine.v1alpha.RankingRecord.content` should be set otherwise an INVALID_ARGUMENT error is thrown. |
| `content` | `string` The content of the record. Empty by default. At least one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord.FIELDS.string.google.cloud.discoveryengine.v1alpha.RankingRecord.title` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RankingRecord.FIELDS.string.google.cloud.discoveryengine.v1alpha.RankingRecord.content` should be set otherwise an INVALID_ARGUMENT error is thrown. |
| `score` | `float` The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset. |

## RawPredictRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.StreamRawPredict`.

Limited to Gemini Enterprise clients (ASSISTANT_USER visibility); not part of the general Discovery Engine API.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` serving the request. |
| `model` | `string` Required. The model to serve the request. This is an opaque model identifier, not a Discovery Engine resource. |
| `http_body` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.api#google.api.HttpBody` Required. The opaque request body. |

## RecommendQuestionsRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.RecommendQuestions` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `assistant` | `string` Optional. The name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. If specified, the generated questions will respect the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`'s configuration (including but not limited to banned phrases). Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |

## RecommendQuestionsResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.RecommendQuestions` method.

| Fields ||
|---|---|
| `questions[]` | `string` The recommended questions. |

## RecommendRequest

Request message for Recommend method.

| Fields ||
|---|---|
| `serving_config` | `string` Required. Full resource name of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig`: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` requests. |
| `user_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserInfo.user_id` to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` to a random unique ID and leave `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserInfo.user_id` unset. |
| `page_size` | `int32` Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. |
| `filter` | `string` Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: - `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` - `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: - (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) - (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.RecommendRequest.ParamsEntry.google.cloud.discoveryengine.v1alpha.RecommendRequest.params` to receive empty results instead. Note that the API never returns `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. |
| `validate_only` | `bool` Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. |
| `params` | ``map<string, `https://protobuf.dev/reference/protobuf/google.protobuf#value`>`` Additional domain specific parameters for the recommendations. Allowed values: - `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.FIELDS.google.cloud.discoveryengine.v1alpha.Document.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.document`. - `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.MetadataEntry.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.metadata`. The given score indicates the probability of a Document conversion given the user's context and history. - `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. - `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: - `no-diversity` - `low-diversity` - `medium-diversity` - `high-diversity` - `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. - `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |

## RecommendResponse

Response message for Recommend method.

| Fields ||
|---|---|
| `results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult` A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). |
| `attribution_token` | `string` A unique attribution token. This should be included in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. |
| `missing_ids[]` | `string` IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. |
| `validate_only` | `bool` True if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.RecommendRequest.validate_only` was set. |

## RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

| Fields ||
|---|---|
| `id` | `string` Resource ID of the recommended Document. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` Set if `returnDocument` is set to true in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.RecommendRequest.ParamsEntry.google.cloud.discoveryengine.v1alpha.RecommendRequest.params`. |
| `metadata` | ``map<string, `https://protobuf.dev/reference/protobuf/google.protobuf#value`>`` Additional Document metadata or annotations. Possible values: - `score`: Recommendation score in double value. Is set if `returnScore` is set to true in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.RecommendRequest.ParamsEntry.google.cloud.discoveryengine.v1alpha.RecommendRequest.params`. |

## RecrawlUrisMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |
| `invalid_uris[]` | `string` Unique URIs in the request that have invalid format. Sample limited to 1000. |
| `invalid_uris_count` | `int32` Total number of unique URIs in the request that have invalid format. |
| `noindex_uris[]` | `string` URIs that have no index meta tag. Sample limited to 1000. |
| `noindex_uris_count` | `int32` Total number of URIs that have no index meta tag. |
| `uris_not_matching_target_sites[]` | `string` Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000. |
| `uris_not_matching_target_sites_count` | `int32` Total number of URIs that don't match any TargetSites. |
| `valid_uris_count` | `int32` Total number of unique URIs in the request that are not in invalid_uris. |
| `success_count` | `int32` Total number of URIs that have been crawled so far. |
| `pending_count` | `int32` Total number of URIs that have yet to be crawled. |
| `quota_exceeded_count` | `int32` Total number of URIs that were rejected due to insufficient indexing resources. |

## RecrawlUrisRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. Full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. |
| `uris[]` | `string` Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` in `site_search_engine`. |
| `site_credential` | `string` Optional. Credential ID to use for crawling. |

## RecrawlUrisResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.RecrawlUris` method.

| Fields ||
|---|---|
| `failure_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo` Details for a sample of up to 10 `failed_uris`. |
| `failed_uris[]` | `string` URIs that were not crawled before the LRO terminated. |

## FailureInfo

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

| Fields ||
|---|---|
| `uri` | `string` URI that failed to be crawled. |
| `failure_reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo.FailureReason` List of failure reasons by corpus type (e.g. desktop, mobile). |

## FailureReason

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

| Fields ||
|---|---|
| `corpus_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse.FailureInfo.FailureReason.CorpusType` DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. |
| `error_message` | `string` Reason why the URI was not crawled. |

## CorpusType

CorpusType for the failed crawling operation.

| Enums ||
|---|---|
| `CORPUS_TYPE_UNSPECIFIED` | Default value. |
| `DESKTOP` | Denotes a crawling attempt for the desktop version of a page. |
| `MOBILE` | Denotes a crawling attempt for the mobile version of a page. |

## RefreshTokenInfo

Describes a refresh token.

| Fields ||
|---|---|
| `name` | `string` Required. The connection for which this token applies. |
| `scopes[]` | `string` The list of scopes for this token. |

## RejectAgentRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.RejectAgent` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the Agent to reject. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `rejection_reason` | `string` Required. The reason for rejecting the Agent. |

## RemoveContextFileRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.RemoveContextFile` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `file_id` | `string` Required. The ID of the context file. |
| `metadata` | `map<string, string>` Optional. Client-supplied metadata about the file. Mirrors the `metadata` map on `UploadSessionFileRequest`. Keys follow AIP-148 shape (lowercase letters, digits, `-`; no dots or DNS-style namespace prefix). Used today to dispatch the Sobi user-supplied artifact branch (`sobi-scope = SOBI_ARTIFACT`), which carries `sobi-agent-id`, `sobi-task-id`, and `sobi-filename` off-URL because the delete happens outside any session context. |

## RemoveContextFileResponse

This type has no fields.
Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.RemoveContextFile` method.

## RemoveDedicatedCrawlRateMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.RemoveDedicatedCrawlRate` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## RemoveDedicatedCrawlRateRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.RemoveDedicatedCrawlRate` method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` |
| `crawl_rate_scope` | `string` Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. |

## RemoveDedicatedCrawlRateResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.RemoveDedicatedCrawlRate` method. It simply returns the state of the response, and an error message if the state is FAILED.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveDedicatedCrawlRateResponse.State` Output only. The state of the response. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Errors from service when handling the request. |

## State

Different states of the response.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `SUCCEEDED` | The state is successful. |
| `FAILED` | The state is failed. |

## RemovePatientFilterRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.RemovePatientFilter` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not exist, a NOT_FOUND error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not have a patient filter, a NOT_FOUND error will be returned |
| `filter_groups[]` | `string` Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources. |

## RemoveSuggestionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.RemoveSuggestion` method.

| Fields ||
|---|---|
| `completion_config` | `string` Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. |
| `user_pseudo_id` | `string` Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id`. The field must be a UTF-8 encoded string with a length limit of 128. |
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo` Optional. Information about the end user. This should be the same identifier information as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.google.cloud.discoveryengine.v1alpha.UserInfo.google.cloud.discoveryengine.v1alpha.UserEvent.user_info` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.UserInfo.google.cloud.discoveryengine.v1alpha.SearchRequest.user_info`. |
| `remove_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Required. Time at which the suggestion was removed. If not set, the current time will be used. |
| Union field `suggestion`. The suggestion to be removed. `suggestion` can be only one of the following: ||
| `search_history_suggestion` | `string` The search history suggestion to be removed. |
| `remove_all_search_history_suggestions` | `bool` Remove all search history suggestions for the user. |

## RemoveSuggestionResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.RemoveSuggestion` method.

## ReplacePatientFilterRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.ReplacePatientFilter` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` does not exist, a NOT_FOUND error is returned. If the requested `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` already has a patient filter, an ALREADY_EXISTS error will be returned. |
| `filter_groups[]` | `string` Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources. |

## Reply

Defines a reply message to user.

| Fields ||
|---|---|
| `reply (deprecated)` | `string` > [!WARNING] > This item is deprecated! DEPRECATED: use `summary` instead. Text reply. |
| `references[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Reply.Reference` > [!WARNING] > This item is deprecated! References in the reply. |
| `summary` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary` Summary based on search results. |

## Reference

> [!WARNING]
> This item is deprecated!

Defines reference in reply.

| Fields ||
|---|---|
| `uri` | `string` URI link reference. |
| `anchor_text` | `string` Anchor text. |
| `start` | `int32` Anchor text start index. |
| `end` | `int32` Anchor text end index. |

## ReportConsentChangeRequest

Request for ReportConsentChange method.

| Fields ||
|---|---|
| `consent_change_action` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.ConsentChangeAction` Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported. |
| `project` | `string` Required. Full resource name of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`, such as `projects/{project_id_or_number}`. |
| `service_term_id` | `string` Required. The unique identifier of the terms of service to update. Available term ids: - `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version` to provide is `2022-11-23`. |
| `service_term_version` | `string` Required. The version string of the terms of service to update. |

## ConsentChangeAction

Type of consent acknowledgement (accept / reject).

At this moment, only `ACCEPT` action is supported.

| Enums ||
|---|---|
| `CONSENT_CHANGE_ACTION_UNSPECIFIED` | Invalid action, user must specify accept/decline |
| `ACCEPT` | User accepts service terms. |

## RequestAgentReviewRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.RequestAgentReview` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the Agent to request review for. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `revision_id` | `string` Optional. The Revision ID of the Agent to request review for. If not specified, the latest revision will be reviewed. |

## RequiredAuthorization

Represents an authorization that is required for the agent to function.

| Fields ||
|---|---|
| `authorization` | `string` Output only. The name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. |
| `display_name` | `string` Output only. The display name of the authorization. |
| `authorization_uri` | `string` Output only. The URI the user should open to authorize. |
| `auth_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthConfig` Output only. Configuration for an authorization required by a third-party (ADK) agent. This is populated when the authorization originates from an ADK agent; in that case the first-party `authorization` resource name above is typically not set. |

## Requirement

A data requirement.

| Fields ||
|---|---|
| `type` | `string` The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: - `library.googleapis.com/books/min_available_books` - `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate` |
| `display_name` | `string` The name of the requirement. |
| `description` | `string` The description of the requirement. |
| `condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.Expr` The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`. |
| `metric_bindings[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.MetricBinding` A list of the metric bindings to be used in `condition`. |
| `threshold_bindings[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ThresholdBinding` A list of threshold bindings to be used in `condition`. |
| `violation_samples_bindings[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ViolationSamplesBinding` A list of the metric bindings to be used in `condition`. |
| `severity[]` | `string` The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: - `BLOCKING` - `CRITICAL` - `WARNING` All thresholds in the requirement must have all the severity here. |

## MetricBinding

Specifies a metrics query and bind its result to a variable which will be used in the `condition`.

| Fields ||
|---|---|
| `variable_id` | `string` The variable ID to be referenced in `condition`. |
| `resource_type` | `string` The resource being monitored for the metric. |
| `metric_filter` | `string` The filter string used for metrics query. Example: "metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS"" |
| `description` | `string` Human readable description of the corresponding metric filter. |
| `category` | `string` The category of the metric's target resource. Example: "Events" |

## ThresholdBinding

Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.

| Fields ||
|---|---|
| `variable_id` | `string` The variable ID to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`. |
| `description` | `string` Human readable description of the corresponding threshold and sub-requirement. |
| `threshold_values[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Requirement.ThresholdBinding.ThresholdValue` The values of the threshold. The values should be ordered from the most strict to the least strict. |

## ThresholdValue

Specifies a threshold value for a given severity.

| Fields ||
|---|---|
| `severity` | `string` The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement. |
| `value` | `double` The value of the threshold. |

## ViolationSamplesBinding

Specifies a samples query and bind its result to a variable which will be used in the `condition`.

| Fields ||
|---|---|
| `variable_id` | `string` The variable ID to be referenced in `condition`. |
| `sample_filter` | `string` The filter string used for samples query. Example: "sample.type = "retail.googleapis.com/user_event" AND " "sample.labels.event_type = "PURCHASE" " |
| `description` | `string` Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long. |

## ResumeEngineRequest

Request for resuming training of an engine.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` |

## ResumeExperimentMetadata

Metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ResumeExperiment` long running operation.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was last updated. |

## ResumeExperimentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.ResumeExperiment`.

| Fields ||
|---|---|
| `name` | `string` Required. Experiment to resume. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |

## RetractLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.RetractLicenseConfig` method.

| Fields ||
|---|---|
| `billing_account_license_config` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.BillingAccountLicenseConfig`. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. |
| `license_config` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig`. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`. |
| `full_retract` | `bool` Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count. |
| `license_count` | `int64` Optional. The number of licenses to retract. Only used when full_retract is false. |

## RetractLicenseConfigResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.RetractLicenseConfig` method.

| Fields ||
|---|---|
| `license_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` The updated LicenseConfig. |

## SafetyRating

Safety rating corresponding to the generated content.

| Fields ||
|---|---|
| `category` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.HarmCategory` Output only. Harm category. |
| `probability` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating.HarmProbability` Output only. Harm probability levels in the content. |
| `probability_score` | `float` Output only. Harm probability score. |
| `severity` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SafetyRating.HarmSeverity` Output only. Harm severity levels in the content. |
| `severity_score` | `float` Output only. Harm severity score. |
| `blocked` | `bool` Output only. Indicates whether the content was filtered out because of this rating. |

## HarmProbability

Harm probability levels in the content.

| Enums ||
|---|---|
| `HARM_PROBABILITY_UNSPECIFIED` | Harm probability unspecified. |
| `NEGLIGIBLE` | Negligible level of harm. |
| `LOW` | Low level of harm. |
| `MEDIUM` | Medium level of harm. |
| `HIGH` | High level of harm. |

## HarmSeverity

Harm severity levels.

| Enums ||
|---|---|
| `HARM_SEVERITY_UNSPECIFIED` | Harm severity unspecified. |
| `HARM_SEVERITY_NEGLIGIBLE` | Negligible level of harm severity. |
| `HARM_SEVERITY_LOW` | Low level of harm severity. |
| `HARM_SEVERITY_MEDIUM` | Medium level of harm severity. |
| `HARM_SEVERITY_HIGH` | High level of harm severity. |

## SampleQuery

Sample Query captures metadata to be used for evaluation.

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` was created at. |
| Union field `content`. The content of the sample query. `content` can be only one of the following: ||
| `query_entry` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry` The query entry. |

## QueryEntry

Query Entry captures metadata to be used for search evaluation.

| Fields ||
|---|---|
| `query` | `string` Required. The query. |
| `targets[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry.Target` List of targets for the query. |

## Target

Defines the parameters of the query's expected outcome.

| Fields ||
|---|---|
| `uri` | `string` Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. |
| `page_numbers[]` | `int32` Expected page numbers of the target. Each page number must be non negative. |
| `score` | `double` Relevance score of the target. |

## SampleQuerySet

A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` was created at. |
| `description` | `string` The description of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`. |

## Schema

Defines the structure and layout of a type of document data.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `field_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FieldConfig` Output only. Configurations for fields of the schema. |
| Union field `schema`. Schema representation. One of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema.FIELDS.google.protobuf.Struct.google.cloud.discoveryengine.v1alpha.Schema.struct_schema` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema.FIELDS.string.google.cloud.discoveryengine.v1alpha.Schema.json_schema` should be provided otherwise an `INVALID_ARGUMENT` error is thrown. `schema` can be only one of the following: ||
| `struct_schema` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The structured representation of the schema. |
| `json_schema` | `string` The JSON representation of the schema. |

## SearchAddOn

Add-on that provides additional functionality for search.

| Enums ||
|---|---|
| `SEARCH_ADD_ON_UNSPECIFIED` | Default value when the enum is unspecified. This is invalid to use. |
| `SEARCH_ADD_ON_LLM` | Large language model add-on. |

## SearchInfo

Detailed search information.

| Fields ||
|---|---|
| `search_query` | `string` Optional. The user's search query. See `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.query` for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchInfo.search_query` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PageInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.PageInfo.page_category` is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `order_by` | `string` The order in which products are returned, if applicable. See `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.order_by` for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `offset` | `int32` An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.offset` for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. |

## SearchLinkPromotion

Promotion proto includes uri and other helping information to display the promotion.

| Fields ||
|---|---|
| `title` | `string` Required. The title of the promotion. Maximum length: 160 characters. |
| `uri` | `string` Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional. |
| `document` | `string` Optional. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri. |
| `image_uri` | `string` Optional. The promotion thumbnail image url. |
| `description` | `string` Optional. The Promotion description. Maximum length: 200 characters. |
| `enabled` | `bool` Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. |

## SearchRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` method.

| Fields ||
|---|---|
| `serving_config` | `string` Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. |
| `branch` | `string` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. |
| `query` | `string` Raw search query. |
| `page_categories[]` | `string` Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PageInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.PageInfo.page_category`. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` |
| `image_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery` Raw image query. |
| `page_size` | `int32` Maximum number of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. - Websites with basic indexing: Default `10`, Maximum `25`. - Websites with advanced indexing: Default `25`, Maximum `50`. - Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. |
| `page_token` | `string` A page token received from a previous `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `offset` | `int32` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s deemed by the API as relevant) in search results. This field is only considered if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token` is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. |
| `one_box_page_size` | `int32` The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. |
| `data_store_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` Specifications that define the specific `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to be searched, along with configurations for those data stores. This is only considered for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s with multiple data stores. For engines with a single data store, the specs directly under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest` should be used. On an engine with multiple data stores, this field is optional. If it's empty, all of the engine's data stores are searched (blended search). Unless it specifies exactly one data store, some request fields, such as `order_by` and `query_expansion_spec`, aren't supported and return an `INVALID_ARGUMENT` error. |
| `num_results_per_data_store` | `int32` Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec.num_results` if provided, otherwise there is no limit. |
| `filter` | `string` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |
| `canonical_filter` | `string` The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.filter`. |
| `order_by` | `string` The order in which documents are returned. Documents can be ordered by a field in an `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. |
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo` Information about the end user. Highly recommended for analytics and personalization. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent` is used to deduce `device_type` for analytics. |
| `language_code` | `string` The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. |
| `region_code` | `string` The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. |
| `facet_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec` Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec` Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) |
| `params` | ``map<string, `https://protobuf.dev/reference/protobuf/google.protobuf#value`>`` Additional search parameters. For public website search only, supported values are: - `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` |
| `query_expansion_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec` The query expansion specification that specifies the conditions under which query expansion occurs. |
| `spell_correction_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec` The spell correction specification that specifies the mode under which spell correction takes effect. |
| `user_pseudo_id` | `string` Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id` The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `use_latest_data` | `bool` Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. |
| `content_search_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec` A specification for configuring the behavior of content search. |
| `embedding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec` Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.FIELDS.repeated.float.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector` and the document embedding that is provided in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path` is not provided, it will use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.EmbeddingConfig.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config`. |
| `ranking_expression` | `string` Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression`. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend` is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". - ranking_expression = function, { " + ", function }; Supported functions: - double \* relevance_score - double \* dotProduct(embedding_field_path) Function variables: - `relevance_score`: pre-defined keywords, used for measure relevance between query and document. - `embedding_field_path`: the document embedding field used with query embedding vector. - `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend` is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or \* operators) are supported: - `double` - `signal` - `log(signal)` - `exp(signal)` - `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. - `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. - `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 \| double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: - `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. - `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. - `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. - `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. - `freshness_rank`: freshness adjustment as a rank - `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). - `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. - `base_rank`: the default rank of the result - `media_actor_match`: whether the media actor matches the query - `media_director_match`: whether the media director matches the query - `media_genre_match`: whether the media genre matches the query - `media_language_match`: whether the media language matches the query - `media_title_match`: whether the media title matches the query - `media_prefix_similarity_rank`: prefix similarity rank for media results - `media_semantic_similarity_rank`: semantic similarity rank for media results |
| `ranking_expression_backend` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend` Optional. The backend to use for the ranking expression evaluation. |
| `safe_search` | `bool` Whether to turn on safe search. This is only supported for website search. |
| `user_labels` | `map<string, string>` The user labels applied to a resource must meet the following requirements: - Each resource can have multiple labels, up to a maximum of 64. - Each label must be a key-value pair. - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. - The key portion of a label must be unique. However, you can use the same key with multiple resources. - Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. |
| `natural_language_query_understanding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec` Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. |
| `search_as_you_type_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec` Search as you type configuration. Only supported for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA` vertical. |
| `custom_fine_tuning_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec` Custom fine tuning configs. If set, it has higher priority than the configs set in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec`. |
| `display_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DisplaySpec` Optional. Config for display feature, like match highlighting on search results. |
| `crowding_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec` Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted. |
| `session` | `string` The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. |
| `session_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec` Session specification. Can be used only when `session` is set. |
| `relevance_threshold` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold` The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. |
| `relevance_filter_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceFilterSpec` Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. |
| `personalization_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec` The specification for personalization. Notice that if both `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.ServingConfig.personalization_spec` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.personalization_spec` are set, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.personalization_spec` overrides `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.ServingConfig.personalization_spec`. |
| `relevance_score_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceScoreSpec` Optional. The specification for returning the relevance score. |
| `search_addon_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAddonSpec` Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. |
| `custom_ranking_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CustomRankingParams` Optional. Optional configuration for the Custom Ranking feature. |
| `entity` | `string` Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.entity` to get search results boosted by entity. |

## BoostSpec

Boost specification to boost certain documents.

| Fields ||
|---|---|
| `condition_boost_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec` Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. |

## ConditionBoostSpec

Boost applies to documents which match a condition.

| Fields ||
|---|---|
| `condition` | `string` An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.filter` for detail syntax and limitations. Examples: - To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` |
| `boost` | `float` Strength of the condition boost, which should be in \[-1, 1\]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. |
| `boost_control_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec` Complex specification for custom ranking based on customer defined attribute value. |

## BoostControlSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

| Fields ||
|---|---|
| `field_name` | `string` The name of the field whose value will be used to determine the boost amount. |
| `attribute_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
| `interpolation_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` The interpolation type to be applied to connect the control points listed below. |
| `control_points[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |

## AttributeType

The attribute(or function) for which the custom ranking is to be applied.

| Enums ||
|---|---|
| `ATTRIBUTE_TYPE_UNSPECIFIED` | Unspecified AttributeType. |
| `NUMERICAL` | The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
| `FRESHNESS` | For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. For example, `5D`, `3DT12H30M`, `T24H`. |

## ControlPoint

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

| Fields ||
|---|---|
| `attribute_value` | `string` Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. |
| `boost_amount` | `float` The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |

## InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

| Enums ||
|---|---|
| `INTERPOLATION_TYPE_UNSPECIFIED` | Interpolation type is unspecified. In this case, it defaults to Linear. |
| `LINEAR` | Piecewise linear interpolation will be applied. |

## ContentSearchSpec

A specification for configuring the behavior of content search.

| Fields ||
|---|---|
| `snippet_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec` If `snippetSpec` is not specified, snippets are not included in the search response. |
| `summary_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec` If `summarySpec` is not specified, summaries are not included in the search response. |
| `extractive_content_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ExtractiveContentSpec` If there is no extractive_content_spec provided, there will be no extractive answer in the search response. |
| `search_result_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode` Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. |
| `chunk_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.ChunkSpec` Specifies the chunk spec to be returned from the search response. Only available if the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS` |

## ChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS`

| Fields ||
|---|---|
| `num_previous_chunks` | `int32` The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. |
| `num_next_chunks` | `int32` The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |

## ExtractiveContentSpec

A specification for configuring the extractive content in a search response.

| Fields ||
|---|---|
| `max_extractive_answer_count` | `int32` The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult`. |
| `max_extractive_segment_count` | `int32` The max number of extractive segments returned in each search result. Only applied if the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig.CONTENT_REQUIRED` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.DataStore.solution_types` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT`. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. |
| `return_extractive_segment_score` | `bool` Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. |
| `num_previous_segments` | `int32` Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. |
| `num_next_segments` | `int32` Return at most `num_next_segments` segments after each selected segments. |

## SearchResultMode

Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.

| Enums ||
|---|---|
| `SEARCH_RESULT_MODE_UNSPECIFIED` | Default value. |
| `DOCUMENTS` | Returns documents in the search result. |
| `CHUNKS` | Returns chunks in the search result. Only available if the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.ChunkingConfig.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig.chunking_config` is specified. |

## SnippetSpec

A specification for configuring snippets in a search response.

| Fields ||
|---|---|
| `max_snippet_count (deprecated)` | `int32` > [!WARNING] > This item is deprecated! \[DEPRECATED\] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. |
| `reference_only (deprecated)` | `bool` > [!WARNING] > This item is deprecated! \[DEPRECATED\] This field is deprecated and will have no affect on the snippet. |
| `return_snippet` | `bool` If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. |

## SummarySpec

A specification for configuring a summary returned in a search response.

| Fields ||
|---|---|
| `summary_result_count` | `int32` The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS`. |
| `include_citations` | `bool` Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse \[1\]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform \[2, 3\]. The citation numbers refer to the returned search results and are 1-indexed. For example, \[1\] means that the sentence is attributed to the first search result. \[2, 3\] means that the sentence is attributed to both the second and third search results. |
| `ignore_adversarial_query` | `bool` Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. |
| `ignore_non_summary_seeking_query` | `bool` Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. |
| `ignore_low_relevant_content` | `bool` Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. |
| `ignore_jail_breaking_query` | `bool` Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. |
| `multimodal_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.MultiModalSpec` Optional. Multimodal specification. |
| `model_prompt_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec` If specified, the spec will be used to modify the prompt provided to the LLM. |
| `language_code` | `string` Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. |
| `model_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec` If specified, the spec will be used to modify the model specification provided to the LLM. |
| `use_semantic_chunks` | `bool` If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. |

## ModelPromptSpec

Specification of the prompt to use with the model.

| Fields ||
|---|---|
| `preamble` | `string` Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. |

## ModelSpec

Specification of the model.

| Fields ||
|---|---|
| `version` | `string` The model version used to generate the summary. Supported values are: - `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). - `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). |

## MultiModalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.

| Fields ||
|---|---|
| `image_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.MultiModalSpec.ImageSource` Optional. Source of image returned in the answer. |

## ImageSource

Specifies the image source.

| Enums ||
|---|---|
| `IMAGE_SOURCE_UNSPECIFIED` | Unspecified image source (multimodal feature is disabled by default). |
| `ALL_AVAILABLE_SOURCES` | Behavior when service determines the pick from all available sources. |
| `CORPUS_IMAGE_ONLY` | Includes image from corpus in the answer. |
| `FIGURE_GENERATION_ONLY` | Triggers figure generation in the answer. |

## CrowdingSpec

Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.

| Fields ||
|---|---|
| `field` | `string` The field to use for crowding. Documents can be crowded by a field in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` object. Crowding field is case sensitive. |
| `max_count` | `int32` The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1. |
| `mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec.Mode` Mode to use for documents that are crowded away. |

## Mode

Enum describing the mode to use for documents that are crowded away. They can be dropped or demoted to the later pages.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Unspecified crowding mode. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.CrowdingSpec.Mode.DROP_CROWDED_RESULTS`. |
| `DROP_CROWDED_RESULTS` | Drop crowded results. |
| `DEMOTE_CROWDED_RESULTS_TO_END` | Demote crowded results to the later pages. |

## CustomRankingParams

Configuration parameters for the Custom Ranking feature.

| Fields ||
|---|---|
| `expressions_to_precompute[]` | `string` Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. |

## DataStoreSpec

A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.

| Fields ||
|---|---|
| `data_store` | `string` Required. Full resource name of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project ID is not supported for this field. |
| `filter` | `string` Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |
| `boost_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec` Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) |
| `custom_search_operators` | `string` Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). |
| `num_results` | `int32` Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.num_results_per_data_store` if provided, otherwise there is no limit. If both this field and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.num_results_per_data_store` are specified, this field will be used. |

## DisplaySpec

Specifies features for display, like match highlighting.

| Fields ||
|---|---|
| `match_highlighting_condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DisplaySpec.MatchHighlightingCondition` The condition under which match highlighting should occur. |

## MatchHighlightingCondition

Enum describing under which condition match highlighting should occur.

| Enums ||
|---|---|
| `MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED` | Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. |
| `MATCH_HIGHLIGHTING_DISABLED` | Disables match highlighting on all documents. |
| `MATCH_HIGHLIGHTING_ENABLED` | Enables match highlighting on all documents. |

## EmbeddingSpec

The specification that uses customized query embedding vector to do semantic document retrieval.

| Fields ||
|---|---|
| `embedding_vectors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector` The embedding vector used for retrieval. Limit to 1. |

## EmbeddingVector

Embedding vector.

| Fields ||
|---|---|
| `field_path` | `string` Embedding field path in schema. |
| `vector[]` | `float` Query embedding vector. |

## FacetSpec

A facet specification to perform faceted search.

| Fields ||
|---|---|
| `facet_key` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey` Required. The facet key specification. |
| `limit` | `int32` Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the \[FacetKey.key\] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. |
| `excluded_filter_keys[]` | `string` List of keys to exclude when faceting. By default, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key` is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key` would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `enable_dynamic_position` | `bool` Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: - "rating", enable_dynamic_position = true - "price", enable_dynamic_position = false - "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. |

## FacetKey

Specifies how a facet is computed.

| Fields ||
|---|---|
| `key` | `string` Required. Supported textual and numerical facet keys in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` object, over which the facet values are computed. Facet key is case-sensitive. |
| `intervals[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Interval` Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. |
| `restricted_values[]` | `string` Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. |
| `prefixes[]` | `string` Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. |
| `contains[]` | `string` Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. |
| `case_insensitive` | `bool` True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. |
| `order_by` | `string` The order in which documents are returned. Allowed values are: - "count desc", which means order by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.FIELDS.int64.google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.count` descending. - "value desc", which means order by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue.value` descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Interval.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals`. |

## ImageQuery

Specifies the image query input.

| Fields ||
|---|---|
| Union field `image`. Specifies the image bytes. `image` can be only one of the following: ||
| `image_bytes` | `string` Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. |

## NaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests.

| Fields ||
|---|---|
| `filter_extraction_condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition` The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. |
| `geo_search_query_detection_field_names[]` | `string` Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. |
| `extracted_filter_behavior` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior` Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED`. |
| `allowed_field_names[]` | `string` Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. |

## ExtractedFilterBehavior

Enum describing how extracted filters are applied to the search.

| Enums ||
|---|---|
| `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` | `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts. |
| `HARD_FILTER` | Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set. |
| `SOFT_BOOST` | Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set. |

## FilterExtractionCondition

Enum describing under which condition filter extraction should occur.

| Enums ||
|---|---|
| `CONDITION_UNSPECIFIED` | Server behavior defaults to `DISABLED`. |
| `DISABLED` | Disables NL filter extraction. |
| `ENABLED` | Enables NL filter extraction. |

## PersonalizationSpec

The specification for personalization.

| Fields ||
|---|---|
| `mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode` The personalization mode of the search request. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode.AUTO`. |

## Mode

The personalization mode of each search request.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Default value. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.Mode.AUTO`. |
| `AUTO` | Personalization is enabled if data quality requirements are met. |
| `DISABLED` | Disable personalization. |

## QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

| Fields ||
|---|---|
| `condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition` The condition under which query expansion should occur. Default to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED`. |
| `pin_unexpanded_results` | `bool` Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. |

## Condition

Enum describing under which condition query expansion should occur.

| Enums ||
|---|---|
| `CONDITION_UNSPECIFIED` | Unspecified query expansion condition. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.Condition.DISABLED`. |
| `DISABLED` | Disabled query expansion. Only the exact search query is used, even if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchResponse.total_size` is zero. |
| `AUTO` | Automatic query expansion built by the Search API. |

## RankingExpressionBackend

The backend to use for the ranking expression evaluation.

| Enums ||
|---|---|
| `RANKING_EXPRESSION_BACKEND_UNSPECIFIED` | Default option for unspecified/unknown values. |
| `BYOE` | Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead. > [!WARNING] > This item is deprecated! |
| `CLEARBOX` | Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead. > [!WARNING] > This item is deprecated! |
| `RANK_BY_EMBEDDING` | Ranking by custom embedding model, the default way to evaluate the ranking expression. |
| `RANK_BY_FORMULA` | Ranking by custom formula. |

## RelevanceFilterSpec

Relevance filtering specification.

| Fields ||
|---|---|
| `keyword_search_threshold` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpec` Optional. Relevance filtering threshold specification for keyword search. |
| `semantic_search_threshold` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpec` Optional. Relevance filtering threshold specification for semantic search. |

## RelevanceThresholdSpec

Specification for relevance filtering on a specific sub-search.

| Fields ||
|---|---|
| Union field `relevance_threshold_spec`. Configures how the relevance threshold is determined. `relevance_threshold_spec` can be only one of the following: ||
| `relevance_threshold` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold` Pre-defined relevance threshold for the sub-search. |
| `semantic_relevance_threshold` | `float` Custom relevance threshold for the sub-search. The value must be in \[0.0, 1.0\]. |

## RelevanceScoreSpec

The specification for returning the document relevance score.

| Fields ||
|---|---|
| `return_relevance_score` | `bool` Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. |

## RelevanceThreshold

The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.

| Enums ||
|---|---|
| `RELEVANCE_THRESHOLD_UNSPECIFIED` | Default value. In this case, server behavior defaults to Google defined threshold. |
| `LOWEST` | Lowest relevance threshold. |
| `LOW` | Low relevance threshold. |
| `MEDIUM` | Medium relevance threshold. |
| `HIGH` | High relevance threshold. |

## SearchAddonSpec

SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.

| Fields ||
|---|---|
| `disable_semantic_add_on` | `bool` Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. |
| `disable_kpi_personalization_add_on` | `bool` Optional. If true, disables event re-ranking and personalization to optimize KPIs \& personalize results. |
| `disable_generative_answer_add_on` | `bool` Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. |

## SearchAsYouTypeSpec

Specification for search as you type in search requests.

| Fields ||
|---|---|
| `condition` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition` The condition under which search as you type should occur. Default to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED`. |
| `fields[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Field` Optional. The list of fields to be used for Search As You Type scoring. |
| `score_threshold` | `double` Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`. |

## Condition

Enum describing under which condition search as you type should occur.

| Enums ||
|---|---|
| `CONDITION_UNSPECIFIED` | Server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED`. |
| `DISABLED` | Disables Search As You Type. |
| `ENABLED` | Enables Search As You Type. |
| `AUTO` | Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing). |

## Field

A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.

| Fields ||
|---|---|
| `key` | `string` Required. A field key that has been indexed for Search As You Type. |
| `weight` | `double` Optional. Weight for scores from this field. Defaults to 1.0 if not specified. |

## SessionSpec

Session specification.

| Fields ||
|---|---|
| `query_id` | `string` If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID \& query ID. |
| `search_result_persistence_count` | `int32` The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count`. At most 10 results for documents mode, or 50 for chunks mode. |

## SpellCorrectionSpec

The specification for query spell correction.

| Fields ||
|---|---|
| `mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode` The mode under which spell correction replaces the original search query. Defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO`. |

## Mode

Enum describing under which mode spell correction should occur.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Unspecified spell correction mode. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO`. |
| `SUGGESTION_ONLY` | Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchResponse.corrected_query`. The spelling suggestion won't be used as the search query. |
| `AUTO` | Automatic spell correction built by the Search API. Search will be based on the corrected query if found. |

## SearchResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` method.

| Fields ||
|---|---|
| `results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult` A list of matched documents. The order represents the ranking. |
| `facets[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet` Results of facets requested by user. |
| `guided_search_result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult` Guided search result. |
| `total_size` | `int32` The estimated total count of matched items irrespective of pagination. The count of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.google.cloud.discoveryengine.v1alpha.SearchResponse.results` returned by pagination may be less than the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.int32.google.cloud.discoveryengine.v1alpha.SearchResponse.total_size` that matches. |
| `attribution_token` | `string` A unique search token. This should be included in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios. |
| `redirect_uri` | `string` The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchResponse.redirect_uri` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token` are set in the response. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `corrected_query` | `string` Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. |
| `suggested_query` | `string` Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). |
| `summary` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary` A summary as part of the search results. This field is only returned if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.summary_spec` is set. |
| `applied_controls[]` | `string` Optional. Controls applied as part of the Control service. |
| `geo_search_debug_info[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GeoSearchDebugInfo` |
| `query_expansion_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.QueryExpansionInfo` Query expansion information for the returned results. |
| `natural_language_query_understanding_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo` Output only. Natural language query understanding information for the returned results. |
| `session_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SessionInfo` Session information. Only set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.session` is provided. See its description for more details. |
| `one_box_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult` A list of One Box results. There can be multiple One Box results of different types. |
| `search_link_promotions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchLinkPromotion` Promotions for site search. |
| `semantic_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SemanticState` Output only. Indicates the semantic state of the search response. |

## Facet

A facet result.

| Fields ||
|---|---|
| `key` | `string` The key for this facet. For example, `"colors"` or `"price"`. It matches `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.key`. |
| `values[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Facet.FacetValue` The facet values for this field. |
| `dynamic_facet` | `bool` Whether the facet is dynamically generated. |

## FacetValue

A facet value which contains value names and their count.

| Fields ||
|---|---|
| `count` | `int64` Number of items that have this facet value. |
| Union field `facet_value`. A facet value which contains values. `facet_value` can be only one of the following: ||
| `value` | `string` Text value of a facet, such as "Black" for facet "colors". |
| `interval` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Interval` Interval value for a facet, such as \[10, 20) for facet "price". It matches `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Interval.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals`. |

## GeoSearchDebugInfo

Debug information specifically related to forward geocoding issues arising from Geolocation Search.

| Fields ||
|---|---|
| `original_address_query` | `string` The address from which forward geocoding ingestion produced issues. |
| `error_message` | `string` The error produced. |

## GuidedSearchResult

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.

| Fields ||
|---|---|
| `refinement_attributes[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.GuidedSearchResult.RefinementAttribute` A list of ranked refinement attributes. |
| `follow_up_questions[]` | `string` Suggested follow-up questions. |

## RefinementAttribute

Useful attribute for search result refinements.

| Fields ||
|---|---|
| `attribute_key` | `string` Attribute key used to refine the results. For example, `"movie_type"`. |
| `attribute_value` | `string` Attribute value used to refine the results. For example, `"drama"`. |

## NaturalLanguageQueryUnderstandingInfo

Information describing what natural language understanding was done on the input query.

| Fields ||
|---|---|
| `extracted_filters` | `string` The filters that were extracted from the input query. |
| `rewritten_query` | `string` Rewritten input query minus the extracted filters. |
| `classified_intents[]` | `string` The classified intents from the input query. |
| `structured_extracted_filter` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter` The filters that were extracted from the input query represented in a structured form. |

## StructuredExtractedFilter

The filters that were extracted from the input query represented in a structured form.

| Fields ||
|---|---|
| `expression` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression` The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. |

## AndExpression

Logical `And` operator.

| Fields ||
|---|---|
| `expressions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression` The expressions that were ANDed together. |

## Expression

The expression denoting the filter that was extracted from the input query.

| Fields ||
|---|---|
| Union field `expr`. The expression type. `expr` can be only one of the following: ||
| `string_constraint` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.StringConstraint` String constraint expression. |
| `number_constraint` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint` Numerical constraint expression. |
| `geolocation_constraint` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraint` Geolocation constraint expression. |
| `and_expr` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.AndExpression` Logical "And" compound operator connecting multiple expressions. |
| `or_expr` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.OrExpression` Logical "Or" compound operator connecting multiple expressions. |

## GeolocationConstraint

Constraint of a geolocation field. Name of the geolocation field as defined in the schema.

| Fields ||
|---|---|
| `field_name` | `string` The name of the geolocation field as defined in the schema. |
| `address` | `string` The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. |
| `latitude` | `double` The latitude of the geolocation inferred from the input query. |
| `longitude` | `double` The longitude of the geolocation inferred from the input query. |
| `radius_in_meters` | `float` The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. |

## NumberConstraint

Constraint expression of a number field. Example: price \< 100.

| Fields ||
|---|---|
| `field_name` | `string` Name of the numerical field as defined in the schema. |
| `comparison` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint.Comparison` The comparison operation performed between the field value and the value specified in the constraint. |
| `value` | `double` The value specified in the numerical constraint. |
| `query_segment` | `string` Identifies the keywords within the search query that match a filter. |

## Comparison

The comparison operation that was performed.

| Enums ||
|---|---|
| `COMPARISON_UNSPECIFIED` | Undefined comparison operator. |
| `EQUALS` | Denotes equality `=` operator. |
| `LESS_THAN_EQUALS` | Denotes less than or equal to `<=` operator. |
| `LESS_THAN` | Denotes less than `<` operator. |
| `GREATER_THAN_EQUALS` | Denotes greater than or equal to `>=` operator. |
| `GREATER_THAN` | Denotes greater than `>` operator. |

## OrExpression

Logical `Or` operator.

| Fields ||
|---|---|
| `expressions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression` The expressions that were ORed together. |

## StringConstraint

Constraint expression of a string field.

| Fields ||
|---|---|
| `field_name` | `string` Name of the string field as defined in the schema. |
| `values[]` | `string` Values of the string field. The record will only be returned if the field value matches one of the values specified here. |
| `query_segment` | `string` Identifies the keywords within the search query that match a filter. |

## OneBoxResult

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

| Fields ||
|---|---|
| `one_box_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.OneBoxResult.OneBoxType` The type of One Box result. |
| `search_results[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult` The search results for this One Box. |

## OneBoxType

The type of One Box result.

| Enums ||
|---|---|
| `ONE_BOX_TYPE_UNSPECIFIED` | Default value. Should not be used. |
| `PEOPLE` | One Box result contains people results. |
| `ORGANIZATION` | One Box result contains organization results. |
| `SLACK` | One Box result contains slack results. |
| `KNOWLEDGE_GRAPH` | One Box result contains Knowledge Graph search responses. |

## QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

| Fields ||
|---|---|
| `expanded_query` | `bool` Bool describing whether query expansion has occurred. |
| `pinned_result_count` | `int64` Number of pinned results. This field will only be set when expansion happens and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.FIELDS.bool.google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec.pin_unexpanded_results` is set to true. |

## SearchResult

Represents the search results.

| Fields ||
|---|---|
| `id` | `string` `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.id` of the searched `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`. |
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. |
| `chunk` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Chunk` The chunk data in the search response if the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode` is set to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS`. |
| `model_scores` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DoubleList`>`` Output only. Google provided available scores. |
| `rank_signals` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals` Optional. A set of ranking signals associated with the result. |
| `retrieval_signals` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RetrievalSignals` Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. |

## RankSignals

A set of ranking signals.

| Fields ||
|---|---|
| `default_rank` | `float` Optional. The default rank of the result. |
| `custom_signals[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal` Optional. A list of custom clearbox signals. |
| `precomputed_expression_values[]` | `float` Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. |
| `keyword_similarity_score` | `float` Optional. Keyword matching adjustment. |
| `relevance_score` | `float` Optional. Semantic relevance adjustment. |
| `semantic_similarity_score` | `float` Optional. Semantic similarity adjustment. |
| `pctr_rank` | `float` Optional. Predicted conversion rate adjustment as a rank. |
| `topicality_rank` | `float` Optional. Topicality adjustment as a rank. |
| `document_age` | `float` Optional. Age of the document in hours. |
| `boosting_factor` | `float` Optional. Combined custom boosts for a doc. |

## CustomSignal

Custom clearbox signal represented by name and value pair.

| Fields ||
|---|---|
| `name` | `string` Optional. Name of the signal. |
| `value` | `float` Optional. Float value representing the ranking signal (e.g. 1.25 for BM25). |

## RetrievalSignals

Contains a set of signals used by the relevance filter.

| Fields ||
|---|---|
| `retrieval_sources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource` Optional. Indicates how the result was retrieved. |
| `semantic_relevance_score` | `float` Optional. Relevance score used by the filter when semantic_relevance_threshold is set. |

## RetrievalSource

Indicates the source of the retrieval.

| Enums ||
|---|---|
| `RETRIEVAL_SOURCE_UNSPECIFIED` | Unspecified retrieval source. |
| `KEYWORD_SEARCH` | Indicates the result was retrieved by keyword search. |
| `SEMANTIC_SEARCH` | Indicates the result was retrieved by semantic search. |

## SemanticState

Semantic state of the search response.

| Enums ||
|---|---|
| `SEMANTIC_STATE_UNSPECIFIED` | Default value. Should not be used. |
| `DISABLED` | Semantic search was disabled for this search response. |
| `ENABLED` | Semantic search was enabled for this search response. |

## SessionInfo

Information about the session.

| Fields ||
|---|---|
| `name` | `string` Name of the session. If the auto-session mode is used (when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.session` ends with "-"), this field holds the newly generated session name. |
| `query_id` | `string` Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. |

## Summary

Summary of the top N search results specified by the summary spec.

| Fields ||
|---|---|
| `summary_text` | `string` The summary content. |
| `summary_skipped_reasons[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SummarySkippedReason` Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. |
| `safety_attributes` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SafetyAttributes` A collection of Safety Attribute categories and their associated confidence scores. |
| `summary_with_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.SummaryWithMetadata` Summary with metadata information. |

## BlobAttachment

Stores binarydata attached to text answer, e.g. image, video, audio, etc.

| Fields ||
|---|---|
| `data` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment.Blob` Output only. The blob data. |
| `attribution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment.AttributionType` Output only. The attribution type of the blob. |

## AttributionType

Defines the attribution type of the blob.

| Enums ||
|---|---|
| `ATTRIBUTION_TYPE_UNSPECIFIED` | Unspecified attribution type. |
| `CORPUS` | The attachment data is from the corpus. |
| `GENERATED` | The attachment data is generated by the model through code generation. |

## Blob

Stores type and data of the blob.

| Fields ||
|---|---|
| `mime_type` | `string` Output only. The media type (MIME type) of the generated data. |
| `data` | `bytes` Output only. Raw bytes. |

## Citation

Citation info for a segment.

| Fields ||
|---|---|
| `start_index` | `int64` Index indicates the start of the segment, measured in bytes/unicode. |
| `end_index` | `int64` End of the attributed segment, exclusive. |
| `sources[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationSource` Citation sources for the attributed segment. |

## CitationMetadata

Citation metadata.

| Fields ||
|---|---|
| `citations[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Citation` Citations for segments. |

## CitationSource

Citation source.

| Fields ||
|---|---|
| `reference_index` | `int64` Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. |

## Reference

Document reference.

| Fields ||
|---|---|
| `title` | `string` Title of the document. |
| `document` | `string` Required. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document.FIELDS.string.google.cloud.discoveryengine.v1alpha.Document.name` of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. |
| `uri` | `string` Cloud Storage or HTTP uri for the document. |
| `chunk_contents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference.ChunkContent` List of cited chunk contents derived from document content. |

## ChunkContent

Chunk content.

| Fields ||
|---|---|
| `content` | `string` Chunk textual content. |
| `page_identifier` | `string` Page identifier. |
| `blob_attachment_indexes[]` | `int64` Output only. Stores indexes of blobattachments linked to this chunk. |

## SafetyAttributes

Safety Attribute categories and their associated confidence scores.

| Fields ||
|---|---|
| `categories[]` | `string` The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. |
| `scores[]` | `float` The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. |

## SummarySkippedReason

An Enum for summary-skipped reasons.

| Enums ||
|---|---|
| `SUMMARY_SKIPPED_REASON_UNSPECIFIED` | Default value. The summary skipped reason is not specified. |
| `ADVERSARIAL_QUERY_IGNORED` | The adversarial query ignored case. Only used when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.FIELDS.bool.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_adversarial_query` is set to `true`. |
| `NON_SUMMARY_SEEKING_QUERY_IGNORED` | The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.FIELDS.bool.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_summary_seeking_query` is set to `true`. |
| `OUT_OF_DOMAIN_QUERY_IGNORED` | The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B. |
| `POTENTIAL_POLICY_VIOLATION` | The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic. |
| `LLM_ADDON_NOT_ENABLED` | The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled. |
| `NO_RELEVANT_CONTENT` | The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results. |
| `JAIL_BREAKING_QUERY_IGNORED` | The jail-breaking query ignored case. For example, "Reply in the tone of a competing company's CEO". Only used when \[SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query\] is set to `true`. |
| `CUSTOMER_POLICY_VIOLATION` | The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer. |
| `NON_SUMMARY_SEEKING_QUERY_IGNORED_V2` | The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when \[SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query\] is set to `true`. |
| `TIME_OUT` | The time out case. Google skips the summary if the time out. |

## SummaryWithMetadata

Summary with metadata information.

| Fields ||
|---|---|
| `summary` | `string` Summary text with no citation information. |
| `citation_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.CitationMetadata` Citation metadata for given summary. |
| `references[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.Reference` Document References. |
| `blob_attachments[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.Summary.BlobAttachment` Output only. Store multimodal data for answer enhancement. |

## SearchTier

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

| Enums ||
|---|---|
| `SEARCH_TIER_UNSPECIFIED` | Default value when the enum is unspecified. This is invalid to use. |
| `SEARCH_TIER_STANDARD` | Standard tier. |
| `SEARCH_TIER_ENTERPRISE` | Enterprise tier. |

## SearchUseCase

Defines a further subdivision of `SolutionType`. Specifically applies to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`.

| Enums ||
|---|---|
| `SEARCH_USE_CASE_UNSPECIFIED` | Value used when unset. Will not occur in CSS. |
| `SEARCH_USE_CASE_SEARCH` | Search use case. Expects the traffic has a non-empty `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.query`. |
| `SEARCH_USE_CASE_BROWSE` | Browse use case. Expects the traffic has an empty `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.query`. |

## SelectContextFilesRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.SelectContextFiles` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `file_selections[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest.FileSelection` Required. File selection changes. Only files previously uploaded to the session can be selected (or deselected). Files not mentioned here will keep their current selection status. |

## FileSelection

The selection status of a context file.

| Fields ||
|---|---|
| `file_id` | `string` Required. The ID of the context file. |
| `selected` | `bool` Required. Whether the file is selected to be used in the session. |

## SelectContextFilesResponse

This type has no fields.
Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.SelectContextFiles` method.

## ServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

| Fields ||
|---|---|
| `name` | `string` Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` |
| `display_name` | `string` Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `solution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` Required. Immutable. Specifies the solution type that a serving config can be associated with. |
| `model_id` | `string` The ID of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. |
| `diversity_level` | `string` How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: - `no-diversity` - `low-diversity` - `medium-diversity` - `high-diversity` - `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`. |
| `embedding_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EmbeddingConfig` Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.FIELDS.repeated.float.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector` and the document embeddings that are provided by this EmbeddingConfig. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.FIELDS.repeated.float.google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.vector` is provided, it overrides this `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.EmbeddingConfig.google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config`. |
| `ranking_expression` | `string` The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". - ranking_expression = function, { " + ", function }; Supported functions: - double \* relevance_score - double \* dotProduct(embedding_field_path) Function variables: - `relevance_score`: pre-defined keywords, used for measure relevance between query and document. - `embedding_field_path`: the document embedding field used with query embedding vector. - `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. |
| `guided_search_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GuidedSearchSpec` Guided search configs. |
| `custom_fine_tuning_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec` Custom fine tuning configs. If `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.custom_fine_tuning_spec` is set, it has higher priority than the configs set here. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. ServingConfig created timestamp. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. ServingConfig updated timestamp. |
| `filter_control_ids[]` | `string` Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. |
| `boost_control_ids[]` | `string` Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. |
| `redirect_control_ids[]` | `string` IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `synonyms_control_ids[]` | `string` Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `oneway_synonyms_control_ids[]` | `string` Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `dissociate_control_ids[]` | `string` Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `replacement_control_ids[]` | `string` Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH`. |
| `ignore_control_ids[]` | `string` Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. |
| `promote_control_ids[]` | `string` Condition promote specifications. Maximum number of specifications is 100. |
| `personalization_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec` The specification for personalization spec. Notice that if both `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.ServingConfig.personalization_spec` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.personalization_spec` are set, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.SearchRequest.personalization_spec` overrides `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.google.cloud.discoveryengine.v1alpha.SearchRequest.PersonalizationSpec.google.cloud.discoveryengine.v1alpha.ServingConfig.personalization_spec`. |
| `answer_generation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerGenerationSpec` Optional. The specification for answer generation. |
| Union field `vertical_config`. Industry vertical specific config. `vertical_config` can be only one of the following: ||
| `media_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig` The MediaConfig of the serving configuration. |
| `generic_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.GenericConfig` The GenericConfig of the serving configuration. |

## GenericConfig

Specifies the configurations needed for Generic Discovery.Currently we support:

- `content_search_spec`: configuration for generic content search.

| Fields ||
|---|---|
| `content_search_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec` Specifies the expected behavior of content search. Only valid for content-search enabled data store. |

## MediaConfig

Specifies the configurations needed for Media Discovery. Currently we support:

- `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.
- `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION`.

| Fields ||
|---|---|
| `demotion_event_type` | `string` Specifies the event type used for demoting recommendation result. Currently supported values: - `view-item`: Item viewed. - `media-play`: Start/resume watching a video, playing a song, etc. - `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. |
| `demote_content_watched_past_days` | `int32` Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. |
| `content_freshness_cutoff_days` | `int32` Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. |
| Union field `demote_content_watched`. Specify the threshold for demoting watched content, the threshold can be either percentage or minutes value. This must be set for `media-complete` event type. `demote_content_watched` can be only one of the following: ||
| `content_watched_percentage_threshold` | `float` Specifies the content watched percentage threshold for demotion. Threshold value must be between \[0, 1.0\] inclusive. |
| `content_watched_seconds_threshold` | `float` Specifies the content watched minutes threshold for demotion. |

## Session

External session proto definition.

| Fields ||
|---|---|
| `name` | `string` Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` |
| `display_name` | `string` Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session.State` The state of the session. |
| `user_pseudo_id` | `string` A unique identifier for tracking users. |
| `turns[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session.Turn` Turns. |
| `labels[]` | `string` Optional. The labels for the session. Can be set as filter in ListSessionsRequest. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the session started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the session finished. |
| `is_pinned` | `bool` Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
| `pending_async_assist_operation_id` | `string` Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`. Set when the operation starts and cleared when it finishes. |

## State

Enumeration of the state of the session.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State is unspecified. |
| `IN_PROGRESS` | The session is currently open. |

## Turn

Represents a turn, including a query from the user and a answer from service.

| Fields ||
|---|---|
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn |
| `answer` | `string` Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. |
| `assist_answer` | `string` Output only. The resource name of the Assistant answer to the user query. Only set if an assist call (/assist API call) happened in this turn. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. To get all AssistAnswers for a session set GetSessionRequest.include_answer_details to true. Alternatively, to get an individual AssistAnswer resource, use the AssistAnswerService.GetAssistAnswer API. |
| `detailed_answer` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Answer` Output only. In `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession` API, if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.GetSessionRequest.include_answer_details` is set to true, this field will be populated when getting answer query session. |
| `detailed_assist_answer` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` Output only. In `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetSession` API, if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.GetSessionRequest.include_answer_details` is set to true, this field will be populated when getting assistant session. |
| `query_config` | `map<string, string>` Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix "google." is reserved for Google-developed functionality. |
| `live` | `bool` Optional. Indicates whether this turn is a live turn. |

## SessionConfig

Configuration for the session.

| Fields ||
|---|---|
| `session_management_policy` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig.SessionManagementPolicy` Optional. Session management policy that defines who will manage the session. |
| `session_ttl` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionConfig.SessionTtl` Optional. The TTL for the session. If unset, the default value is 60 days. |

## SessionManagementPolicy

Session management policy that defines who will manage the session.

| Enums ||
|---|---|
| `SESSION_MANAGEMENT_POLICY_UNSPECIFIED` | Default value. |
| `NOT_MANAGED` | The session will be managed by the customer. |
| `VERTEX_AI_MANAGED` | Sessions multi-tenancy will be controlled by Google using 1P or 3P identity providers. |

## SessionTtl

Defines the TTL for sessions.

| Fields ||
|---|---|
| Union field `time_info`. TTL can be either a number of days or indefinite. `time_info` can be only one of the following: ||
| `days` | `int32` Defines the number of days for session TTL. |

## SessionUserInfo

User info for the user initiating the query or action.

| Fields ||
|---|---|
| `username` | `string` Output only. Stable, unique identifier for the user. |
| `display_name` | `string` Output only. Display name of the user. |

## SetDedicatedCrawlRateMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.SetDedicatedCrawlRate` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## SetDedicatedCrawlRateRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.SetDedicatedCrawlRate` method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}` |
| `crawl_rate_scope` | `string` Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name. |
| `crawl_rate` | `int32` Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website. |
| `crawl_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest.CrawlType` Optional. Whether it's the crawl rate of user-triggered or auto-refresh. |
| `mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest.Mode` Optional. Whether the rate is explicitly set by users, or set by vertex AI. |

## CrawlType

Crawl type is used to distinguish user-triggered and auto-refresh. User-triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. Auto-refresh crawl rate is for best effort use cases like refreshing urls periodically.

| Enums ||
|---|---|
| `CRAWL_TYPE_UNSPECIFIED` | The crawl type is unspecified. |
| `USER_TRIGGERED` | The crawl type is user-triggered. |
| `AUTO_REFRESH` | The crawl type is auto-refresh. |

## Mode

Whether the rate is explicitly set by users, or set by vertex AI.

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC. |
| `AUTOMATIC` | Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateRequest.CrawlType` if the mode is AUTOMATIC. |
| `EXPLICIT` | Users explicitly set user-triggered or auto-refresh crawl rate. |

## SetDedicatedCrawlRateResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CrawlRateManagementService.SetDedicatedCrawlRate` method. It simply returns the state of the response, and an error message if the state is FAILED.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetDedicatedCrawlRateResponse.State` Output only. The state of the response. |
| `error` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` Errors from service when handling the request. |

## State

Different states of the response.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `SUCCEEDED` | The state is successful. |
| `FAILED` | The state is failed. |

## SetUpDataConnectorMetadata

This type has no fields.
Metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` method.

## SetUpDataConnectorRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.SetUpDataConnector` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`, in the format of `projects/{project}/locations/{location}`. |
| `collection_id` | `string` Required. The ID to use for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`, which will become the final component of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`'s resource name. A new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` is created as part of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` setup. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` is a singleton resource under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`, managing all `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `collection_display_name` | `string` Required. The display name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. |
| `data_connector` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` to initialize in the newly created `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection`. |

## SetUriPatternDocumentDataMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## SetUriPatternDocumentDataRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData` method.

| Fields ||
|---|---|
| `site_search_engine` | `string` Required. Full resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngine`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. |
| `document_data_map` | ``map<string, `https://protobuf.dev/reference/protobuf/google.protobuf#struct`>`` Document data keyed by URI pattern. Each entry must be consistent with the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. For example: `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/\*": { "Categories": \["category1", "category2"\] }, "www.url2.com/\*": { "Categories": \["category3"\] } } |
| `empty_document_data_map` | `bool` If true, clears the document data map. If true, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.DocumentDataMapEntry.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map` must be empty. |
| `schema` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. If not provided, the current `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` is used. If provided, validates and updates the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema`. If validation fails, an error is returned. |

## SetUriPatternDocumentDataResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData` method.

## SingleRegionKey

Metadata for single-regional CMEKs.

| Fields ||
|---|---|
| `kms_key` | `string` Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. |

## SiteSearchEngine

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

| Fields ||
|---|---|
| `name` | `string` The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` |

## SiteVerificationInfo

Verification information for target sites in advanced site search.

| Fields ||
|---|---|
| `site_verification_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteVerificationInfo.SiteVerificationState` Site verification state indicating the ownership and validity. |
| `verify_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Latest site verification time. |

## SiteVerificationState

Site verification state.

| Enums ||
|---|---|
| `SITE_VERIFICATION_STATE_UNSPECIFIED` | Defaults to VERIFIED. |
| `VERIFIED` | Site ownership verified. |
| `UNVERIFIED` | Site ownership pending verification or verification failed. |
| `EXEMPTED` | Site exempt from verification, e.g., a public website that opens to all. |

## Sitemap

A sitemap for the SiteSearchEngine.

| Fields ||
|---|---|
| `name` | `string` Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The sitemap's creation time. |
| Union field `feed`. Supported feed sources. `feed` can be only one of the following: ||
| `uri` | `string` Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. |

## SolutionType

The type of solution.

| Enums ||
|---|---|
| `SOLUTION_TYPE_UNSPECIFIED` | Default value. |
| `SOLUTION_TYPE_RECOMMENDATION` | Used for Recommendations AI. |
| `SOLUTION_TYPE_SEARCH` | Used for Discovery Search. |
| `SOLUTION_TYPE_CHAT` | Used for use cases related to the Generative AI agent. |
| `SOLUTION_TYPE_GENERATIVE_CHAT` | Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution. |
| `SOLUTION_TYPE_AI_MODE` | Used for AI Mode. |

## SpannerSource

The Spanner source for importing data

| Fields ||
|---|---|
| `project_id` | `string` The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
| `instance_id` | `string` Required. The instance ID of the source Spanner table. |
| `database_id` | `string` Required. The database ID of the source Spanner table. |
| `table_id` | `string` Required. The table name of the Spanner database that needs to be imported. |
| `enable_data_boost` | `bool` Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). |

## StartConnectorRunRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.StartConnectorRun` method.

| Fields ||
|---|---|
| `parent` | `string` Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector` |
| `entities[]` | `string` Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced. |
| `healthcare_fhir_resource_types[]` | `string` The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. |
| `force_refresh_content` | `bool` Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content. |
| `sync_identity` | `bool` If true, trigger Identity sync. |
| `sync_since_timestamp` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors. |

## StartExperimentMetadata

Metadata for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.StartExperiment` long running operation.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was last updated. |

## StartExperimentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.StartExperiment`.

| Fields ||
|---|---|
| `name` | `string` Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |

## StoreUserAuthorizationRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.StoreUserAuthorization` method.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization`. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` |
| `full_redirect_uri` | `string` Required. The URI the user is redirected to after authorization, including all parameters. E.g., `https://example.com/redir?code=5` |

## StoreUserAuthorizationResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.StoreUserAuthorization` method.

## StreamAssistRequest

Request for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.StreamAssist` method.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |
| `query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Query` Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. |
| `answer_generation_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AnswerGenerationMode` Optional. The answer generation mode. If not specified, it defaults to `NORMAL`. |
| `session` | `string` Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `is_session_less` | `bool` Optional. Specifies whether the request is session-less. If true, the request runs without any session: no session will be created, and the request will not be associated with any existing session, even if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.session` is empty or set to "-". The response's `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.SessionInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.StreamAssistResponse.SessionInfo.session` will be empty. If true and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.session` is also set to a non-empty value other than "-", the request is rejected with `INVALID_ARGUMENT`. |
| `assist_skipping_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AssistSkippingMode` Optional. Determines the cases in which the assistant will not answer the query. If the answer is skipped, the reasons will be listed in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.AssistAnswer.AssistSkippedReason.google.cloud.discoveryengine.v1alpha.AssistAnswer.assist_skipped_reasons` within `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse.FIELDS.google.cloud.discoveryengine.v1alpha.AssistAnswer.google.cloud.discoveryengine.v1alpha.AssistResponse.answer`. |
| `file_ids[]` | `string` Optional. The IDs of the files to be used for answering the request. When uploading a file, its ID is returned in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileResponse.file_id`. |
| `browser_context` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext` Optional. Context about the page the user is viewing, e.g. from the Gemini Enterprise Chrome side panel. |
| `user_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistUserMetadata` Optional. Information about the user initiating the query. |
| `language_code (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. Deprecated. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistUserMetadata.FIELDS.string.google.cloud.discoveryengine.v1alpha.AssistUserMetadata.preferred_language_code` instead. Language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. |
| `google_search_grounding_enabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated. Please refrain from using this field. |
| `web_grounding_enabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated. Please refrain from using this field. |
| `data_store_specs[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` > [!WARNING] > This item is deprecated! Optional. Deprecated: Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.data_store_specs` instead. Specs defining `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to filter on in a search call and configurations for those data stores. This is only considered for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s with multiple data stores. Not setting this field will result in using all data stores in the engine, except when `ignore_data_stores` is set to true. |
| `agents_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig` Optional. Configuration of agents that are used to serve the request. |
| `agents_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec` Optional. Specification of agents that are used to serve the request. |
| `assist_generation_config (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistGenerationConfig` > [!WARNING] > This item is deprecated! Optional. Deprecated. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.FIELDS.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.GenerationSpec.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.generation_spec` instead. Request level generation configuration. This is used to override the default generation configuration at the engine level. |
| `canned_query` | `string` Optional. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` for this request. This parameter can only be set if the session is new, otherwise an `INVALID_ARGUMENT` error is returned. A session is considered new if there is a `StreamAssistRequest.session` provided and the corresponding `Session` does not have any turns in it, or if there is no `StreamAssistRequest.session` provided (and a new `Session` gets created). If the `canned_query` parameter is given, the corresponding `CannedQuery` will be taken into account during processing. The exact behaviour is described and documented in the `CannedQuery`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` |
| `tools_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec` Optional. Specification of tools that are used to serve the request. |
| `generation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.GenerationSpec` Optional. Specification of the generation configuration for the request. |
| `action_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ActionSpec` Optional. Specification of actions for the request. |

## ActionSpec

Specification of actions for the request.

| Fields ||
|---|---|
| `action_disabled` | `bool` Optional. If true, actions will not be served for the request. This only works for enterprise edition. |

## AgentsConfig

Configuration of agents that are used to serve the request.

| Fields ||
|---|---|
| Union field `config`. Configuration of the different types of agents. `config` can be only one of the following: ||
| `no_code_agents_config (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.NoCodeAgentsConfig` > [!WARNING] > This item is deprecated! Optional. Deprecated: Configuration for No-Code Agentspace agents. When set, the Assist request will be served according to the configuration. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.agent` instead. |
| `assistant_agent_config_id` | `string` Optional. ID of the agent from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Assistant.AgentConfig.google.cloud.discoveryengine.v1alpha.Assistant.agent_configs` |
| `agent` | `string` The name of the agent to use. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |
| `inline_agent` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` The inline definition of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` to use. If provided, an agent based on this definition will be used. This is a temporary representation of an agent, the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent.FIELDS.string.google.cloud.discoveryengine.v1alpha.Agent.name` field will be ignored. |
| `vertex_ai_agent_id` | `string` Optional. ID of the agent from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.Assistant.VertexAiAgentConfig.google.cloud.discoveryengine.v1alpha.Assistant.vertex_ai_agent_configs` The ID can be either the full name registered in the config or the last part after the last slash. |

## NoCodeAgentsConfig

Deprecated: Configuration for No-Code Agentspace agents. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.NoCodeAgentsConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.NoCodeAgentsConfig.agent` instead.

| Fields ||
|---|---|
| `agent` | `string` Optional. The name of the agent to use. |

## AgentsSpec

Specification of agents that are used to serve the request.

| Fields ||
|---|---|
| `agent_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec.AgentSpec` Optional. Specification of agents that are used to serve the request. |
| `mention_mode` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsSpec.MentionMode` Optional. How to invoke the mentioned agents in `agent_specs`. See `MentionMode`. |

## AgentSpec

Specification of an agent.

| Fields ||
|---|---|
| `agent_id` | `string` Required. ID to identify the agent resource serving the request. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. |
| `input_variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Input variables supplied at invocation time for a WorkflowAgent. The keys are the declared input variable names; the values are the user- or caller-supplied values. Exposed to downstream nodes as global inputs. |

## MentionMode

How to invoke the mentioned agents in `agent_specs`.

| Enums ||
|---|---|
| `MENTION_MODE_UNSPECIFIED` | Defaults to `DIRECT`. |
| `DIRECT` | Mentioned agent becomes the top-level agent that runs the turn. Only one entry in `agent_specs` is allowed. |
| `TOOL` | Each `AgentSpec` is attached as a tool under a synthesized orchestrator. Multi-mention. MVP: workflow agents only, latest published revision; do not set `version` / `revision_id`. |
| `TOOL_WORKFLOW_DIRECT` | Single workflow agent as its own chat surface. Exactly one `AgentSpec`; set either `version = "draft"` (Agent table) or `revision_id` (specific `AgentRevision`). Workflow must have a `ManualTrigger`. |

## AnswerGenerationMode

Available answer generation modes.

| Enums ||
|---|---|
| `ANSWER_GENERATION_MODE_UNSPECIFIED` | Unspecified answer generation mode. |
| `NORMAL` | Normal answer generation mode. May trigger a few searches and call actions. |
| `RESEARCH` | Research answer generation mode. Deep dives into the query, triggering many searches for a wide range of topics related to the query. |
| `AGENT` | Direct Agent answer generation mode. Uses an agent defined in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.FIELDS.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.AgentsConfig.google.cloud.discoveryengine.v1alpha.StreamAssistRequest.agents_config` to generate the answer. |

## AssistSkippingMode

Available skipping behaviors for assist requests.

| Enums ||
|---|---|
| `ASSIST_SKIPPING_MODE_UNSPECIFIED` | Default value. The answer can be skipped if the query isn't seeking assistance. |
| `REQUEST_ASSIST` | Request Assistant answer. The answer may still be skipped if the query fails policy checks. |

## BrowserContext

Context about the page the user is viewing, e.g. from the Gemini Enterprise Chrome side panel. The files it references are encrypted by the client and are not attached to the request as model inputs; a consumer reads them using `encryption_metadata`.

| Fields ||
|---|---|
| `active_tab` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext.Tab` Optional. The tab the user is currently viewing. Each file ID refers to a file uploaded to the session beforehand (its ID is returned in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.AddContextFileResponse.file_id`). Do not also list those IDs in `file_ids`: that attaches them as ordinary files and bypasses browser-context handling. |
| `encryption_metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.BrowserContext.EncryptionMetadata` Optional. How the files referenced by this browser context are encrypted. One keyset covers the whole request rather than an individual tab. |

## EncryptionMetadata

How the browser-context files were encrypted by the client.

| Fields ||
|---|---|
| `encrypted` | `bool` Optional. Whether the browser-context files are encrypted. If `true`, `keyset` must be set, or the files cannot be read. |
| `keyset` | `bytes` Optional. Serialized Tink keyset using the AEAD primitive, used to decrypt the browser-context files. Present only for the lifetime of the request and never logged. |

## Tab

A browser tab whose context is attached to the request.

| Fields ||
|---|---|
| `uri` | `string` Optional. URI of the page the tab is showing. Not necessarily an http(s) URL: a tab can be showing `chrome://settings`, `about:blank` or a `file://` path. |
| `title` | `string` Optional. Title of the page the tab is showing. |
| `selected_text` | `string` Optional. Text the user has selected on the page, if any. |
| `screenshot_file_id` | `string` Optional. ID of the uploaded screenshot of the visible page. |
| `annotated_page_content_file_id` | `string` Optional. ID of the uploaded page content: a serialized Annotated Page Content (APC) capture, not pre-rendered text. |

## GenerationSpec

Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.

| Fields ||
|---|---|
| `model_id` | `string` Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. |

## ToolsSpec

Specification of tools that are used to serve the request.

| Fields ||
|---|---|
| `tool_registry` | `string` Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` |
| `vertex_ai_search_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec` Optional. Specification of the Vertex AI Search tool. |
| `web_grounding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.WebGroundingSpec` Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.FIELDS.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.google.cloud.discoveryengine.v1alpha.Assistant.web_grounding_type` is `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.Assistant.WebGroundingType.WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. |
| `image_generation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.ImageGenerationSpec` Optional. Specification of the image generation tool. |
| `video_generation_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.VideoGenerationSpec` Optional. Specification of the video generation tool. |
| `maps_grounding_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistRequest.ToolsSpec.MapsGroundingSpec` Optional. Specification of the Google Maps grounding tool. If field is present, enables grounding with Google Maps. |

## ImageGenerationSpec

This type has no fields.
Specification of the image generation tool.

## MapsGroundingSpec

This type has no fields.
Specification of the Google Maps grounding tool.

## VertexAiSearchSpec

Specification of the Vertex AI Search tool.

| Fields ||
|---|---|
| `disabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. |
| `data_store_specs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec` Optional. Specs defining `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`s to filter on in a search call and configurations for those data stores. This is only considered for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`s with multiple data stores. |
| `filter` | `string` Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |

## VideoGenerationSpec

This type has no fields.
Specification of the video generation tool.

## WebGroundingSpec

This type has no fields.
Specification of the web grounding tool.

## StreamAssistResponse

Response for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.StreamAssist` method.

| Fields ||
|---|---|
| `answer` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer` Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.AssistAnswer.Reply.google.cloud.discoveryengine.v1alpha.AssistAnswer.replies`. Observe `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.google.cloud.discoveryengine.v1alpha.AssistAnswer.State.google.cloud.discoveryengine.v1alpha.AssistAnswer.state` to see if more parts are to be expected. While the state is `IN_PROGRESS`, the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.AssistAnswer.Reply.google.cloud.discoveryengine.v1alpha.AssistAnswer.replies` field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.string.google.cloud.discoveryengine.v1alpha.AssistAnswer.name` won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.FIELDS.string.google.cloud.discoveryengine.v1alpha.AssistAnswer.name` will have a value. |
| `session_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.SessionInfo` Session information. Only included in the final StreamAssistResponse of the response stream. |
| `status_updates[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.StatusUpdate` Optional progress updates. |
| `assist_token` | `string` A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. |
| `tool_result[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.ToolResult` > [!WARNING] > This item is deprecated! Results of tool invocations. |
| `final_result_tool_invocation_id` | `string` If this field is present, it contains the ID of the tool invocation whose result is used as the final answer. |
| `invocation_tools[]` | `string` The tool names of the tools that were invoked. |
| `invoked_skills[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.InvokedSkill` The skills executed during the turn. |
| `connector_auth_errors[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.StreamAssistResponse.ConnectorAuthError` Per-connector authentication errors encountered during the request. Present when one or more connectors failed authentication but the request proceeded with the remaining connectors. |

## ConnectorAuthError

Describes an authentication error for a specific data connector.

| Fields ||
|---|---|
| `data_connector` | `string` Resource name of the data connector that failed authentication. |
| `error_message` | `string` Human-readable error message describing the auth failure. |

## InvokedSkill

Represents a skill used during the assist call.

| Fields ||
|---|---|
| `name` | `string` The resource name of the skill. |
| `display_name` | `string` The display name of the skill. |

## SessionInfo

Information about the session.

| Fields ||
|---|---|
| `session` | `string` Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. |
| `query_id` | `string` Query ID that corresponds to this assist API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Assist API call, the assist request happens in the context of the search results from this search call. |

## StatusUpdate

Update about how the assist call is progressing.

| Fields ||
|---|---|
| `update_text` | `string` Free text status status update, e.g., 'Starting internal search in HR docs for benefits', or 'Web search for "Moon landing" got 12 results'. |
| `invocation_id` | `string` Unique identifier of the invocation that generates the update. |

## ToolResult

(Partial) result of a tool invocation.

| Fields ||
|---|---|
| `tool_invocation_id` | `string` Unique identifier of the tool invocation that generates the result. |
| `result` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistAnswer.Reply` Partial content of the result. |

## SubmitProgramsEvaluationsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.SubmitProgramsEvaluations`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` |
| `evaluation_submissions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveProgramEvaluationSubmission` Required. List of program evaluations to submit. At this time, only one evaluation submission is supported. |

## SubmitProgramsEvaluationsResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AlphaEvolveService.SubmitProgramsEvaluations`.

## SubscriptionTerm

Subscription term.

| Enums ||
|---|---|
| `SUBSCRIPTION_TERM_UNSPECIFIED` | Default value, do not use. |
| `SUBSCRIPTION_TERM_ONE_MONTH` | 1 month. |
| `SUBSCRIPTION_TERM_ONE_YEAR` | 1 year. |
| `SUBSCRIPTION_TERM_THREE_YEARS` | 3 years. |
| `SUBSCRIPTION_TERM_CUSTOM` | Custom term. Must set the end_date. |

## SubscriptionTier

Subscription tier information.

| Enums ||
|---|---|
| `SUBSCRIPTION_TIER_UNSPECIFIED` | Default value. |
| `SUBSCRIPTION_TIER_SEARCH` | Search tier. Search tier can access Vertex AI Search features and NotebookLM features. |
| `SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT` | Gemini Enterprise Plus tier. |
| `SUBSCRIPTION_TIER_NOTEBOOK_LM` | NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features. |
| `SUBSCRIPTION_TIER_FRONTLINE_WORKER` | Gemini Frontline worker tier. |
| `SUBSCRIPTION_TIER_AGENTSPACE_STARTER` | Gemini Business Starter tier. |
| `SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS` | Gemini Business tier. |
| `SUBSCRIPTION_TIER_ENTERPRISE` | Gemini Enterprise Standard tier. |
| `SUBSCRIPTION_TIER_ENTERPRISE_EMERGING` | Gemini Enterprise Standard tier for emerging markets. |
| `SUBSCRIPTION_TIER_EDU` | Gemini Enterprise EDU tier. |
| `SUBSCRIPTION_TIER_EDU_PRO` | Gemini Enterprise EDU Pro tier. |
| `SUBSCRIPTION_TIER_EDU_EMERGING` | Gemini Enterprise EDU tier for emerging market only. |
| `SUBSCRIPTION_TIER_EDU_PRO_EMERGING` | Gemini Enterprise EDU Pro tier for emerging market. |
| `SUBSCRIPTION_TIER_FRONTLINE_STARTER` | Gemini Frontline Starter tier. |
| `SUBSCRIPTION_TIER_CONSUMPTION_ONLY` | Represents the Gemini Enterprise Consumption-only tier: $0 subscription billed purely on usage (PAYG). |
| `SUBSCRIPTION_TIER_EDU_GOV_EMERGING` | Gemini Enterprise EDU tier for government in emerging markets. |

## SuggestionDenyListEntry

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

| Fields ||
|---|---|
| `block_phrase` | `string` Required. Phrase to block from suggestions served. Can be maximum 125 characters. |
| `match_operator` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SuggestionDenyListEntry.MatchOperator` Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. |

## MatchOperator

Operator for matching with the generated suggestions.

| Enums ||
|---|---|
| `MATCH_OPERATOR_UNSPECIFIED` | Default value. Should not be used |
| `EXACT_MATCH` | If the suggestion is an exact match to the block_phrase, then block it. |
| `CONTAINS` | If the suggestion contains the block_phrase, then block it. |

## TargetSite

A target site for the SiteSearchEngine.

| Fields ||
|---|---|
| `name` | `string` Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. |
| `provided_uri_pattern` | `string` Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. |
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.Type` The type of the target site, e.g., whether the site is to be included or excluded. |
| `exact_match` | `bool` Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. |
| `generated_uri_pattern` | `string` Output only. This is system-generated based on the provided_uri_pattern. |
| `root_domain_uri` | `string` Output only. Root domain of the provided_uri_pattern. |
| `site_verification_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteVerificationInfo` Output only. Site ownership and validity verification status. |
| `indexing_status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.IndexingStatus` Output only. Indexing status. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The target site's last updated time. |
| `failure_reason` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason` Output only. Failure reason. |

## FailureReason

Site search indexing failure reasons.

| Fields ||
|---|---|
| Union field `failure`. Failure reason. `failure` can be only one of the following: ||
| `quota_failure` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.FailureReason.QuotaFailure` Failed due to insufficient quota. |

## QuotaFailure

Failed due to insufficient quota.

| Fields ||
|---|---|
| `total_required_quota` | `int64` This number is an estimation on how much total quota this project needs to successfully complete indexing. |

## IndexingStatus

Target site indexing status enumeration.

| Enums ||
|---|---|
| `INDEXING_STATUS_UNSPECIFIED` | Defaults to SUCCEEDED. |
| `PENDING` | The target site is in the update queue and will be picked up by indexing pipeline. |
| `FAILED` | The target site fails to be indexed. |
| `SUCCEEDED` | The target site has been indexed. |
| `DELETING` | The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails. |
| `CANCELLABLE` | The target site change is pending but cancellable. |
| `CANCELLED` | The target site change is cancelled. |

## Type

Possible target site types.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | This value is unused. In this case, server behavior defaults to `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite.Type.ENUM_VALUES.google.cloud.discoveryengine.v1alpha.TargetSite.Type.INCLUDE`. |
| `INCLUDE` | Include the target site. |
| `EXCLUDE` | Exclude the target site. |

## Tenant

Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.

| Fields ||
|---|---|
| `id` | `string` The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). |
| `uri` | `string` The URI of the tenant, if applicable. For example, the URI of a Jira instance is <https://my-jira-instance.atlassian.net>, and a Slack tenant does not have a URI. |
| `display_name` | `string` Optional display name for the tenant, e.g. "My Slack Team". |

## TextInput

Defines text input.

| Fields ||
|---|---|
| `input` | `string` Text input. |
| `context` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationContext` Conversation context of the input. |

## TrainCustomModelMetadata

Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## TrainCustomModelRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel` method.

| Fields ||
|---|---|
| `data_store` | `string` Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. |
| `model_type` | `string` Model to be trained. Supported values are: - **search-tuning**: Fine tuning the search system based on data provided. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` The desired location of errors incurred during the data ingestion and training. |
| `model_id` | `string` If not provided, a UUID will be generated. |
| Union field `training_input`. Model training input. `training_input` can be only one of the following: ||
| `gcs_training_input` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput` Cloud Storage training input. |

## GcsTrainingInput

Cloud Storage training data input.

| Fields ||
|---|---|
| `corpus_data_path` | `string` The Cloud Storage corpus data which could be associated in train data. The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}` |
| `query_data_path` | `string` The gcs query data which could be associated in train data. The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} |
| `train_data_path` | `string` Cloud Storage training data path whose format should be `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: - `query-id\tcorpus-id\tscore` - `query1\tdoc1\t1` |
| `test_data_path` | `string` Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. |

## TrainCustomModelResponse

Response of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest`. This message is returned by the google.longrunning.Operations.response field.

| Fields ||
|---|---|
| `error_samples[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.rpc#google.rpc.Status` A sample of errors encountered while processing the data. |
| `error_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ImportErrorConfig` Echoes the destination for the complete errors in the request if set. |
| `model_status` | `string` The trained model status. Possible values are: - **bad-data**: The training data quality is bad. - **no-improvement**: Tuning didn't improve performance. Won't deploy. - **in-progress**: Model training job creation is in progress. - **training**: Model is actively training. - **evaluating**: The model is evaluating trained metrics. - **indexing**: The model trained metrics are indexing. - **ready**: The model is ready for serving. |
| `metrics` | `map<string, double>` The metrics of the trained model. |
| `model_name` | `string` Fully qualified name of the CustomTuningModel. |

## TransactionInfo

A transaction represents the entire purchase transaction.

| Fields ||
|---|---|
| `currency` | `string` Required. Currency code. Use three-character ISO-4217 code. |
| `transaction_id` | `string` The transaction ID with a length limit of 128 characters. |
| `value` | `float` Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. |
| `tax` | `float` All the taxes associated with the transaction. |
| `cost` | `float` All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: - Profit = `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.tax` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.cost` |
| `discount_value` | `float` The total discount(s) value applied to this transaction. This figure should be excluded from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value` For example, if a user paid `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value` amount, then nominal (pre-discount) value of the transaction is the sum of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value` This means that profit is calculated the same way, regardless of the discount value, and that `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.discount_value` can be larger than `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value`: - Profit = `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.value` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.tax` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo.FIELDS.float.google.cloud.discoveryengine.v1alpha.TransactionInfo.cost` |

## TuneEngineMetadata

Metadata associated with a tune operation.

| Fields ||
|---|---|
| `engine` | `string` Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` |

## TuneEngineRequest

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` |

## TuneEngineResponse

This type has no fields.
Response associated with a tune operation.

## TurnStatusUpdateEvent

Event for updating the status of a turn in a collaborative session.

| Fields ||
|---|---|
| `turn_id` | `string` Output only. The unique ID of the turn this status pertains to. |
| `status` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TurnStatusUpdateEvent.TurnStatus` Output only. The updated status of the turn. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp of when this status update occurred. |

## TurnStatus

Enum representing the key state transitions of a turn.

| Enums ||
|---|---|
| `TURN_STATUS_UNSPECIFIED` | Default value. |
| `QUERY_RECEIVED` | Query received and stored by the backend. |
| `ANSWER_PENDING` | The query has been accepted and an answer is pending processing. |
| `ANSWER_SKIPPED` | No answer will be produced for this query. |
| `ANSWER_PROCESSING` | The answer is actively being processed. |
| `ANSWER_COMPLETE` | The answer has been produced and all response events are complete. |
| `ANSWER_CANCELLED` | Turn was cancelled by a user before processing completed. Terminal. |
| `ANSWER_FAILED` | An unrecoverable error occurred while processing the turn. Terminal. |
| `ANSWER_DELETED` | The Gemini response on this turn was deleted by a user. The turn's query is preserved; only the answer is cleared. Terminal. |

## TypingIndicatorEvent

Event indicating a user's typing status in a collaborative session.

| Fields ||
|---|---|
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionUserInfo` Output only. Information about the user sending the message. |
| `typing_start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the user started typing. |

## UpdateAclConfigRequest

Request message for UpdateAclConfig method.

| Fields ||
|---|---|
| `acl_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AclConfig` |

## UpdateAgentRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.UpdateAgent` method.

| Fields ||
|---|---|
| `agent` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Agent` to update. The agent's `name` field is used to identify the agent to update. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to update the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to update does not exist, a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. |

## UpdateAnalyticsConfigRequest

Request for UpdateAnalyticsConfig method.

| Fields ||
|---|---|
| `analytics_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnalyticsConfig` Required. The AnalyticsConfig to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement. |

## UpdateAssistantRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.UpdateAssistant` method.

| Fields ||
|---|---|
| `assistant` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` to update. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`'s `name` field is used to identify the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` to update. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` The list of fields to update. |

## UpdateAuthorizationRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.UpdateAuthorization` method.

| Fields ||
|---|---|
| `authorization` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Authorization` to update. The authorization's `name` field is used to identify the authorization to update. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to update the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to update does not exist, a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` The list of fields to update. |

## UpdateCannedQueryRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQueryService.UpdateCannedQuery` method.

| Fields ||
|---|---|
| `canned_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CannedQuery` to update. The canned query's `name` field is used to identify the canned query to update. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to update the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. For Google-defined canned queries only the "enabled" field can be updated. If the canned query to update does not exist, a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` The list of fields to update. |

## UpdateCmekConfigMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfigService.UpdateCmekConfig` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## UpdateCmekConfigRequest

Request message for UpdateCmekConfig method. rpc.

| Fields ||
|---|---|
| `config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CmekConfig` Required. The CmekConfig resource. |
| `set_default` | `bool` Set the following CmekConfig as the default to be used for child resources if one is not specified. |

## UpdateCollectionMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.UpdateCollection` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## UpdateCollectionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CollectionService.UpdateCollection` method.

| Fields ||
|---|---|
| `collection` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Collection` to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to be updated. |

## UpdateCompletionConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateCompletionConfig` method.

| Fields ||
|---|---|
| `completion_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig`, then a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig` to update. The following are the only supported fields: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.CompletionConfig.matching_order` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.int32.google.cloud.discoveryengine.v1alpha.CompletionConfig.max_suggestions` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.int32.google.cloud.discoveryengine.v1alpha.CompletionConfig.min_prefix_length` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.CompletionConfig.query_model` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.google.cloud.discoveryengine.v1alpha.CompletionConfig.EnableMode.google.cloud.discoveryengine.v1alpha.CompletionConfig.enable_mode` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.int32.google.cloud.discoveryengine.v1alpha.CompletionConfig.query_frequency_threshold` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.int32.google.cloud.discoveryengine.v1alpha.CompletionConfig.num_unique_users_threshold` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.bool.google.cloud.discoveryengine.v1alpha.CompletionConfig.should_serve_content_suggestions` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionConfig.FIELDS.bool.google.cloud.discoveryengine.v1alpha.CompletionConfig.filter_pii_suggestions_using_dlp` If not set, all supported fields are updated. |

## UpdateControlRequest

Request for UpdateControl method.

| Fields ||
|---|---|
| `control` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` Required. The Control to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control` to update. The following are NOT supported: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.FIELDS.string.google.cloud.discoveryengine.v1alpha.Control.name` - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Control.FIELDS.google.cloud.discoveryengine.v1alpha.SolutionType.google.cloud.discoveryengine.v1alpha.Control.solution_type` If not set or empty, all supported fields are updated. |

## UpdateConversationRequest

Request for UpdateConversation method.

| Fields ||
|---|---|
| `conversation` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` Required. The Conversation to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation` to update. The following are NOT supported: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Conversation.FIELDS.string.google.cloud.discoveryengine.v1alpha.Conversation.name` If not set or empty, all supported fields are updated. |

## UpdateDataConnectorRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnectorService.UpdateDataConnector` method.

| Fields ||
|---|---|
| `data_connector` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` does not exist, a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector` to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an `INVALID_ARGUMENT` error. |

## UpdateDataStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDataStore` method.

| Fields ||
|---|---|
| `data_store` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |

## UpdateDocumentProcessingConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStoreService.UpdateDocumentProcessingConfig` method.

| Fields ||
|---|---|
| `document_processing_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig`, then a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Not supported. If `update_mask` is set, the request returns an `UnsupportedFieldError`. To update mutable fields, omit `update_mask`; the full `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig` in the request body then overwrites the existing resource. See the method description for details. |

## UpdateDocumentRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentService.UpdateDocument` method.

| Fields ||
|---|---|
| `document` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` Required. The document to update/create. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` to update does not exist and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.FIELDS.bool.google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing` is not set, a `NOT_FOUND` error is returned. |
| `allow_missing` | `bool` If set to `true` and the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` is not found, a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` is be created. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. |

## UpdateEngineRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.EngineService.UpdateEngine` method.

| Fields ||
|---|---|
| `engine` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |

## UpdateLicenseConfigRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfigService.UpdateLicenseConfig` method.

| Fields ||
|---|---|
| `license_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |

## UpdateProjectRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ProjectService.UpdateProject` method.

| Fields ||
|---|---|
| `project` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Project` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. Supported fields: - `customer_provided_config` - `customer_provided_config.notebooklm_config.observability_config` |

## UpdateSampleQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQueryService.UpdateSampleQuery` method.

| Fields ||
|---|---|
| `sample_query` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` Required. The simple query to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuery` to update does not exist a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. |

## UpdateSampleQuerySetRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet` method.

| Fields ||
|---|---|
| `sample_query_set` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` Required. The sample query set to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet`, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SampleQuerySet` to update does not exist a `NOT_FOUND` error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. |

## UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## UpdateSchemaRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SchemaService.UpdateSchema` method.

| Fields ||
|---|---|
| `schema` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` to update. |
| `allow_missing` | `bool` If set to true, and the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` is not found, a new `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Schema` is created. In this situation, `update_mask` is ignored. |

## UpdateServingConfigRequest

Request for UpdateServingConfig method.

| Fields ||
|---|---|
| `serving_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` Required. The ServingConfig to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig` to update. The following are NOT supported: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ServingConfig.FIELDS.string.google.cloud.discoveryengine.v1alpha.ServingConfig.name` If not set, all supported fields are updated. |

## UpdateSessionRequest

Request for UpdateSession method.

| Fields ||
|---|---|
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` Required. The Session to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` to update. The following are NOT supported: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session.FIELDS.string.google.cloud.discoveryengine.v1alpha.Session.name` If not set or empty, all supported fields are updated. |

## UpdateTargetSiteMetadata

Metadata related to the progress of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite` operation. This will be returned by the google.longrunning.Operation.metadata field.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation create time. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Operation last update time. If the operation is done, this is also the finish time. |

## UpdateTargetSiteRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.UpdateTargetSite` method.

| Fields ||
|---|---|
| `target_site` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` Required. The target site to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TargetSite` to update does not exist, a NOT_FOUND error is returned. |

## UpdateUserStoreRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStoreService.UpdateUserStore` method.

| Fields ||
|---|---|
| `user_store` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore` Required. The User Store to update. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. |

## UpdateWidgetConfigRequest

Request for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfigService.UpdateWidgetConfig` method.

| Fields ||
|---|---|
| `widget_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` to update. If the caller does not have permission to update the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig`, then a PERMISSION_DENIED error is returned. If the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` to update does not exist, a NOT_FOUND error is returned. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Indicates which fields in the provided `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` to update. The following are the only supported fields: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.FIELDS.bool.google.cloud.discoveryengine.v1alpha.WidgetConfig.enable_autocomplete` If not set, all supported fields are updated. |

## UserEvent

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

| Fields ||
|---|---|
| `event_type` | `string` Required. User event type. Allowed values are: Generic values: - `search`: Search for Documents. - `view-item`: Detailed page view of a Document. - `view-item-list`: View of a panel or ordered list of Documents. - `view-home-page`: View of the home page. - `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: - `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping - `purchase`: Purchase an item(s) Media-related values: - `media-play`: Start/resume watching a video, playing a song, etc. - `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: - `conversion`: Customer defined conversion event. |
| `conversion_type` | `string` Optional. Conversion type. Required if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.event_type` is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.event_type` is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc. |
| `user_pseudo_id` | `string` Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field. |
| `engine` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` produced user events. For example, user events from blended search. |
| `data_store` | `string` The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.engine` or `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.DocumentInfo.google.cloud.discoveryengine.v1alpha.UserEvent.documents`. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. |
| `event_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Only required for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` method. Timestamp of when the user event happened. |
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo` Information about the end user. |
| `direct_user_request` | `bool` Should set to true if the request is made directly from the end user, in which case the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent` can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`. |
| `session_id` | `string` A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.string.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id` as prefix. |
| `page_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PageInfo` Page metadata such as categories and other critical information for certain event types such as `view-category-page`. |
| `attribution_token` | `string` Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. This field enables accurate attribution of recommendation model performance. The value must be one of: - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token` for events that are the result of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. - `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchResponse.attribution_token` for events that are the result of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search`. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token` as a URL parameter to product K's page. When recording events on product K's page, log the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendResponse.FIELDS.string.google.cloud.discoveryengine.v1alpha.RecommendResponse.attribution_token` to this field. |
| `filter` | `string` Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest` may contain a filter expression in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.SearchRequest.filter` conforming to <https://google.aip.dev/160#filtering>. Similarly, for `view-item-list` events that are generated from a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest`, this field may be populated directly from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RecommendRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.RecommendRequest.filter` conforming to <https://google.aip.dev/160#filtering>. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| `documents[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DocumentInfo` List of `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document`s associated with this user event. This field is optional except for the following event types: - `view-item` - `add-to-cart` - `purchase` - `media-play` - `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.repeated.google.cloud.discoveryengine.v1alpha.DocumentInfo.google.cloud.discoveryengine.v1alpha.UserEvent.documents` is desired. |
| `panel` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PanelInfo` Panel metadata associated with this user event. |
| `search_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchInfo` `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchService.Search` details related to the event. This field should be set for `search` event. |
| `completion_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionInfo` `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery` details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. |
| `transaction_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.TransactionInfo` The transaction metadata (if any) associated with this user event. |
| `tag_ids[]` | `string` A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. |
| `promotion_ids[]` | `string` The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. |
| `attributes` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CustomAttribute`>`` Optional. Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: - The key must be a UTF-8 encoded string with a length limit of 5,000 characters. - For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. - For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. |
| `media_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.MediaInfo` Media-specific info. |
| `panels[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.PanelInfo` Optional. List of panels associated with this event. Used for page-level impression data. |
| `feedback` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Feedback` Optional. This field is optional except for the `add-feedback` event types. |
| `entity` | `string` Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. |

## UserInfo

Information of an end user.

| Fields ||
|---|---|
| `user_id` | `string` Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. |
| `user_agent` | `string` User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` or if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent.FIELDS.bool.google.cloud.discoveryengine.v1alpha.UserEvent.direct_user_request` is set. |
| `time_zone` | `string` Optional. IANA time zone, e.g. Europe/Budapest. |
| `precise_location` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserInfo.PreciseLocation` Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. |

## PreciseLocation

Precise location info with multiple representation options.

| Fields ||
|---|---|
| Union field `location`. `location` can be only one of the following: ||
| `point` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.type#google.type.LatLng` Optional. Location represented by a latitude/longitude point. |
| `address` | `string` Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. |

## UserLicense

User License information assigned by the admin.

| Fields ||
|---|---|
| `user_principal` | `string` Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. |
| `user_profile` | `string` Optional. The user profile. We user user full name(First name + Last name) as user profile. |
| `license_assignment_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserLicense.LicenseAssignmentState` Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; |
| `license_config` | `string` Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. User created timestamp. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. User update timestamp. |
| `last_login_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. User last logged in time. If the user has not logged in yet, this field will be empty. |

## LicenseAssignmentState

License assignment state enumeration.

| Enums ||
|---|---|
| `LICENSE_ASSIGNMENT_STATE_UNSPECIFIED` | Default value. |
| `ASSIGNED` | License assigned to the user. |
| `UNASSIGNED` | No license assigned to the user. Deprecated, translated to NO_LICENSE. |
| `NO_LICENSE` | No license assigned to the user. |
| `NO_LICENSE_ATTEMPTED_LOGIN` | User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin). |
| `BLOCKED` | User is blocked from assigning a license. |

## UserPresenceEvent

Event indicating that a user entered or exited the resource the subscription is over.

| Fields ||
|---|---|
| `user_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SessionUserInfo` Output only. The user whose presence changed. |
| `state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserPresenceEvent.PresenceState` Output only. The new presence state of the user on the target resource. |

## PresenceState

Type of presence change.

| Enums ||
|---|---|
| `PRESENCE_STATE_UNSPECIFIED` | Default value. Should not be used. |
| `ENTERED` | The user entered the resource (subscribed). |
| `EXITED` | The user exited the resource (unsubscribed or disconnected). |

## UserStore

Configures metadata that is used for End User entities.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` The display name of the User Store. |
| `default_license_config` | `string` Optional. The default subscription `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` for the UserStore, if `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserStore.FIELDS.bool.google.cloud.discoveryengine.v1alpha.UserStore.enable_license_auto_register` is true, new users will automatically register under the default subscription. If default `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LicenseConfig` doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. |
| `enable_license_auto_register` | `bool` Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. |
| `enable_expired_license_auto_update` | `bool` Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. |

## ValidateUserAuthorizationRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ValidateUserAuthorization` method.

| Fields ||
|---|---|
| `session` | `string` Required. The resource name of the assist Session that initiated the consent flow. Used together with `downstream_connector` to recover the server-stored `consent_nonce`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` |
| `user_id_validation_state` | `bytes` Required. The opaque, encrypted validation state returned by Auth Manager in the consent redirect. Forwarded verbatim to FinalizeCredentials. |
| `downstream_connector` | `string` Required. The downstream connector (auth provider) resource name from the consent redirect (`auth_provider_name`). Named `downstream_connector` to disambiguate from the "connector" in the remote agent. |

## ValidateUserAuthorizationResponse

This type has no fields.
Response message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AuthorizationService.ValidateUserAuthorization` method.

## VideoCharacteristics

Standard characteristics of a video media view.

| Fields ||
|---|---|
| `width` | `int32` Output only. Video width in pixels. |
| `height` | `int32` Output only. Video height in pixels. |
| `duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Output only. Video duration. |
| `frame_rate` | `double` Output only. Frame rate (frames per second). |
| `audio_codecs[]` | `string` Output only. Audio codecs used in the video. |
| `video_codecs[]` | `string` Output only. Video codecs used in the video. |
| `video_bitrate_kbps` | `int32` Output only. Bitrate of the video in kbps. |
| `audio_bitrate_kbps` | `int32` Output only. Bitrate of the audio in kbps. |

## WatchLiveEventsInternalRequest

Client message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.WatchLiveEventsInternal` method.

| Fields ||
|---|---|
| Union field `request_payload`. One of the client messages. `request_payload` can be only one of the following: ||
| `setup` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsSetup` Optional. Message to be sent in the first and only first client message. |
| `subscription` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelSubscription` Optional. Subscribes to live events. |
| `unsubscription` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelUnsubscription` Optional. Unsubscribes from live events. |

## WatchLiveEventsInternalResponse

Server message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistantService.WatchLiveEventsInternal` method.

| Fields ||
|---|---|
| Union field `response_payload`. One of the server messages. `response_payload` can be only one of the following: ||
| `setup_complete` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WatchLiveEventsSetupComplete` Sent in response to a `WatchLiveEventsSetup` message from the client. |
| `response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ChannelResponse` Output only. Sent in response to a `ChannelSubscribe` message from the client. |

## WatchLiveEventsSetup

Message to be sent in the first and only first `WatchLiveEventsRequest`. Contains configuration that will apply for the duration of the streaming RPC.

Clients should wait for a `WatchLiveEventsSetupComplete` message before sending any additional messages.

| Fields ||
|---|---|
| `assistant` | `string` Required. The resource name of the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` |

## WatchLiveEventsSetupComplete

This type has no fields.
Sent in response to a `WatchLiveEventsSetup` message from the client.

## WidgetAcquireAccessTokenRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAcquireAccessToken` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget homepage FetchDocuments will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `acquire_access_token_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenRequest` Required. The proxied request to DataConnectorService.AcquireAccessToken. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetAcquireAccessTokenResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAcquireAccessToken` method.

| Fields ||
|---|---|
| `acquire_access_token_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAccessTokenResponse` The proxied response from DataConnectorService.AcquireAccessToken. |
| `u_token` | `string` The token in response. |

## WidgetAcquireAndStoreRefreshTokenRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAcquireAndStoreRefreshToken` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget homepage FetchDocuments will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `acquire_and_store_refresh_token_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenRequest` Required. The proxied request to DataConnectorService.AcquireAndStoreRefreshToken. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetAcquireAndStoreRefreshTokenResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAcquireAndStoreRefreshToken` method.

| Fields ||
|---|---|
| `acquire_and_store_refresh_token_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AcquireAndStoreRefreshTokenResponse` The proxied response from DataConnectorService.AcquireAndStoreRefreshToken. |
| `u_token` | `string` The token in response. |

## WidgetAddContextFileRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAddContextFile` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget add context file will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `add_context_file_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest` Required. The AddContextFileRequest request to perform adding context files. The session resource will be set as sanitized session name hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. The session of AddContextFile will be used for constructing session full resource name in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileRequest`. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetAddContextFileResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAddContextFile` method.

| Fields ||
|---|---|
| `add_context_file_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse` AddContextFileResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AddContextFileResponse`. The session resource returned will be sanitized with hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. |
| `u_token` | `string` The token in response. |

## WidgetAdvancedCompleteQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAdvancedCompleteQuery` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget complete query will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. |
| `advanced_complete_query_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryRequest` Required. The AdvancedCompleteQuery request to perform auto-complete suggestion query. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetAdvancedCompleteQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAdvancedCompleteQuery` method.

| Fields ||
|---|---|
| `u_token` | `string` The token in response. |
| `advanced_complete_query_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdvancedCompleteQueryResponse` AdvancedCompleteQueryResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompletionService.AdvancedCompleteQuery`. |

## WidgetAnswerQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAnswerQuery` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget answer query will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `answer_query_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` Required. The AnswerQueryRequest request to perform answer query. The ServingConfig ID will be `default_search` by default. The session resource will be set as sanitized session name hiding project and location information. Format: `collections/{collection_id}/dataStores/{data_store_id}/sessions/{session_id}`. If set, the session of answer query will be used for constructing session full resource name in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest`. The document name in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` will be sanitized with hiding project and location information also. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |
| `debug_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DebugParams` Optional. Debug params for the widget request. Also used for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetStreamAnswerQuery`, which reuses this request message. |

## WidgetAnswerQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAnswerQuery` method.

| Fields ||
|---|---|
| `answer_query_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse` AnswerQueryResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryResponse`. If session is present in request and is a valid session, the session resource returned will be sanitized with hiding project and location information. Format: `collections/{collection_id}/dataStores/{data_store_id}/sessions/{session_id}`. The returned document name in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AnswerQueryRequest` will be sanitized with hiding project and location information also. |
| `u_token` | `string` The token in response. |

## WidgetAssistRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAssist` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget assist will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `assist_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest` Required. The AssistRequest request to perform assist. The ServingConfig ID will be `default_search` by default. The session resource will be set as sanitized session name hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. If set, the session of assist will be used for constructing session full resource name in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest`. The document name in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest` will be sanitized with hiding project and location information also. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetAssistResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetAssist` method.

| Fields ||
|---|---|
| `assist_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse` AssistResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistResponse`. If session is present in request and is a valid session, the session resource returned will be sanitized with hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. The returned document name in the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AssistRequest` will be sanitized with hiding project and location information also. |
| `u_token` | `string` The token in response. |

## WidgetCompleteQueryRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetCompleteQuery` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget complete query will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. |
| `complete_query_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CompleteQueryRequest` Required. The CompleteQuery request to perform auto-complete suggestion query. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetCompleteQueryResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetCompleteQuery` method.

| Fields ||
|---|---|
| `u_token` | `string` The token in response. |
| `widget_query_suggestions[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetCompleteQueryResponse.WidgetQuerySuggestion` Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion. |

## WidgetQuerySuggestion

Suggestions as search queries.

| Fields ||
|---|---|
| `suggestion` | `string` The suggestion for the query. |

## WidgetConfig

WidgetConfig captures configs at the Widget level.

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `display_name` | `string` Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig` was updated. |
| `enable_autocomplete (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether or not to enable autocomplete. |
| `fields_ui_components_map (deprecated)` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UIComponentField`>`` > [!WARNING] > This item is deprecated! The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. |
| `facet_field[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.FacetField` > [!WARNING] > This item is deprecated! The configuration and appearance of facets in the end user view. |
| `data_store_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreType` Output only. The type of the parent data store. |
| `content_search_spec (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec` > [!WARNING] > This item is deprecated! The content search spec that configs the desired behavior of content search. |
| `enable_summarization (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Turn on or off summarization for the search response. |
| `enable_snippet_result_summary (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Turn on or off summary for each snippets result. |
| `config_id` | `string` Output only. Unique obfuscated identifier of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig`. |
| `enable_quality_feedback (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Turn on or off collecting the search result quality feedback from end users. |
| `solution_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SolutionType` Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
| `industry_vertical` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.IndustryVertical` Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine`. |
| `allow_public_access (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. |
| `allowlisted_domains[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Allowlisted domains that can load this widget. |
| `enable_safe_search (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether to enable safe search. |
| `enable_conversational_search (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). |
| `llm_enabled` | `bool` Output only. Whether LLM is enabled in the corresponding data store. |
| `enable_result_score` | `bool` Whether to show the result score. |
| `result_display_type (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ResultDisplayType` > [!WARNING] > This item is deprecated! The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. |
| `minimum_data_term_accepted` | `bool` Output only. Whether the customer accepted data use terms. |
| `enable_web_app (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether to enable standalone web app. |
| `data_store_ui_configs[] (deprecated)` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreUiConfig` > [!WARNING] > This item is deprecated! Configurable UI configurations per data store. |
| `collection_components[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CollectionComponent` Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). |
| `enable_search_as_you_type (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether to enable search-as-you-type behavior for the search widget |
| `default_search_request_order_by (deprecated)` | `string` > [!WARNING] > This item is deprecated! The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. <https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body> |
| `ui_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings` Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
| `access_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AccessSettings` Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
| `ui_branding` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiBrandingSettings` Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
| `homepage_setting` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.HomepageSetting` Optional. Describes the homepage settings of the widget. |
| `assistant_settings` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings` Optional. Output only. Describes the assistant settings of the widget. |
| `customer_provided_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig` Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. |
| `enable_private_knowledge_graph` | `bool` Optional. Output only. Whether to enable private knowledge graph. |
| `gemini_bundle` | `bool` Output only. Whether the subscription is gemini bundle or not. |
| `batch_auth_statuses[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.BatchAuthStatus` Output only. The batch authorization statuses for the widget's connectors. |
| `nodes[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Node` Output only. The nodes associated with the Widget Config. |

## AccessSettings

Describes widget access settings.

| Fields ||
|---|---|
| `allow_public_access` | `bool` Whether public unauthenticated access is allowed. |
| `allowlisted_domains[]` | `string` List of domains that are allowed to integrate the search widget. |
| `enable_web_app` | `bool` Whether web app access is enabled. |
| `workforce_identity_pool_provider` | `string` Optional. The workforce identity pool provider used to access the widget. |
| `language_code` | `string` Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US". |

## AssistantSettings

Describes the assistant settings of the widget.

| Fields ||
|---|---|
| `google_search_grounding_enabled (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Whether or not the Google search grounding toggle is shown. Deprecated. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.FIELDS.google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.WebGroundingType.google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.web_grounding_type` instead. |
| `web_grounding_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.WebGroundingType` Optional. The type of web grounding to use. |
| `default_web_grounding_toggle_off` | `bool` Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| `disable_location_context` | `bool` Optional. Output only. Whether to disable user location context. |
| `maps_grounding_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.AssistantSettings.MapsGroundingType` Optional. The type of Google Maps grounding to use. |
| `default_maps_grounding_toggle_off` | `bool` Output only. This field controls the default maps grounding toggle for end users if `maps_grounding_type` is set to `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`. By default, this field is set to false. If `maps_grounding_type` is `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`, end users will have maps grounding enabled by default on UI. If true, the grounding toggle will default to the OFF position in the UI. End users can still enable maps grounding in the UI if maps grounding is enabled. |

## MapsGroundingType

The type of Google Maps grounding to use.

| Enums ||
|---|---|
| `MAPS_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `MAPS_GROUNDING_TYPE_DISABLED` | Maps grounding is disabled. |
| `MAPS_GROUNDING_TYPE_GOOGLE_MAPS` | Grounding with Google Maps is enabled. |

## WebGroundingType

The type of web grounding to use.

| Enums ||
|---|---|
| `WEB_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `WEB_GROUNDING_TYPE_DISABLED` | Web grounding is disabled. |
| `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` | Grounding with Google Search is enabled. |
| `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH` | Grounding with Enterprise Web Search is enabled. |

## BatchAuthStatus

Describes the batch authorization status for a batch_authorization_group.

| Fields ||
|---|---|
| `placeholder` | `string` Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. |
| `batch_authorization_group` | `string` Output only. The batch authorization group the placeholder belongs to. |
| `connector_auth_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ConnectorAuthState` Output only. The current authorization state for this connector. |

## CollectionComponent

Read-only collection component that contains data store collections fields that may be used for filtering.

For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connector_auth_state.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`data_store_components`, `tenant`, `action_connector`) are left unset for placeholder entries.

| Fields ||
|---|---|
| `name` | `string` The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService`, such as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection ID that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. |
| `id` | `string` Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id. |
| `display_name` | `string` The display name of the collection. |
| `data_store_components[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreComponent` For the data store collection, list of the children data stores. |
| `data_source` | `string` The name of the data source, retrieved from `Collection.data_connector.data_source`. |
| `data_source_version` | `double` Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`. |
| `data_source_display_name` | `string` Output only. The display name of the data source. |
| `data_source_end_user_display_name` | `string` Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `data_source_display_name`. |
| `connector_icon_link` | `string` Output only. The icon link of the connector source. |
| `connector_auth_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ConnectorAuthState` Output only. The auth uri of the connector source. |
| `metadata` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataConnector.ConnectorMetadata` Output only. User-facing connector metadata (`title`, `description`, `short_description`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page. |
| `is_first_party` | `bool` Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors. |
| `tag` | `string` Output only. The version-independent label of the connector backing this collection, mirroring `DataConnector.tag`. Unlike the version-pinned data store ID it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As `DataConnector.tag` documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying `DataConnector`. Populated only when `ConnectorsFeature.enable_connector_tag` is on. |

## ConnectorAuthState

Read-only connector in CollectionComponent auth state.

| Fields ||
|---|---|
| `auth_state` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ConnectorAuthState.AuthState` Output only. The authorization state of the data connector. |
| `authorization_uri` | `string` Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The authorization state update timestamp. |

## AuthState

The authorization state of the data connector.

| Enums ||
|---|---|
| `AUTH_STATE_UNSPECIFIED` | Default value. Also returned for synthetic placeholder `CollectionComponent` entries surfaced by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS / Business only) --- those entries represent connectors the caller may attach but has not yet attached. |
| `AUTHORIZED` | The user has authorized the data connector. |
| `EXPIRED` | The user authorization for the data connector has expired. |
| `ACTIONS_DISABLED` | The user can still make search requests but actions need to be enabled. |
| `NO_AUTH` | The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth. |

## CustomerProvidedConfig

Customer provided configurations.

| Fields ||
|---|---|
| `customer_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig.CustomerType` Customer type. |
| `compliance_level` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CustomerProvidedConfig.ComplianceLevel` Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. |

## ComplianceLevel

Assured Workloads compliance level of the customer's project.

Not frozen: further levels may be added as more compliance regimes are supported, so a client must treat an unrecognized value as government-restricted rather than as unrestricted.

| Enums ||
|---|---|
| `COMPLIANCE_LEVEL_UNSPECIFIED` | The project has no Assured Workloads compliance level, or reports one that this API version does not model. |
| `COMPLIANCE_LEVEL_FEDRAMP_HIGH` | FedRAMP High compliance level. |
| `COMPLIANCE_LEVEL_IL4` | Impact Level 4 (IL4) compliance level. |
| `COMPLIANCE_LEVEL_IL5` | Impact Level 5 (IL5) compliance level. |

## CustomerType

Customer type.

| Enums ||
|---|---|
| `DEFAULT_CUSTOMER` | Default customer type. |
| `GOVERNMENT_CUSTOMER` | Government customer type. Some features are disabled for government customers due to legal requirements. |

## DataStoreComponent

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.

| Fields ||
|---|---|
| `name` | `string` The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService`, such as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. |
| `id` | `string` Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. |
| `display_name` | `string` The display name of the data store. |
| `entity_name` | `string` The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. |
| `workspace_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig.Type` Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. |
| `content_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore.ContentConfig` Output only. The content config of the data store. |
| `data_store_config_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreComponent.DataStoreConfigType` Output only. The type of the data store config. |

## DataStoreConfigType

The type of the data store config.

| Enums ||
|---|---|
| `DATA_STORE_CONFIG_TYPE_UNSPECIFIED` | Default value. This value is unused. |
| `ALLOW_DB_CONFIG` | The data store is connected to AlloyDB |
| `THIRD_PARTY_OAUTH_CONFIG` | The data store is a connected to a third party data source. |
| `NOTEBOOKLM_CONFIG` | The data store is a connected to NotebookLM Enterprise. |

## DataStoreType

The type of the widget's parent data store.

| Enums ||
|---|---|
| `DATA_STORE_TYPE_UNSPECIFIED` | Unspecified data store type. |
| `SITE_SEARCH` | The parent data store contains a site search engine. |
| `STRUCTURED` | The parent data store contains a search engine for structured data. |
| `UNSTRUCTURED` | The parent data store contains a search engine for unstructured data. |
| `BLENDED` | The parent data store is served for blended search with multiple data stores. |

## DataStoreUiConfig

UI component configuration for data store.

| Fields ||
|---|---|
| `name` | `string` The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService`, such as `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. |
| `id` | `string` Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. |
| `facet_field[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.FacetField` Facet fields that store the mapping of fields to end user widget appearance. |
| `fields_ui_components_map` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UIComponentField`>`` The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. |

## FacetField

Facet fields that store the mapping of fields to end user widget appearance.

| Fields ||
|---|---|
| `field` | `string` Required. Registered field name. The format is `field.abc`. |
| `display_name` | `string` Optional. The field name that end users will see. |

## HomepageSetting

Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.

| Fields ||
|---|---|
| `shortcuts[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.HomepageSetting.Shortcut` Optional. The shortcuts to display on the homepage. |

## Shortcut

Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.

| Fields ||
|---|---|
| `title` | `string` Optional. Title of the shortcut. |
| `icon` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Image` Optional. Icon URL of shortcut. |
| `destination_uri` | `string` Optional. Destination URL of shortcut. |

## Image

Options to store an image.

| Fields ||
|---|---|
| Union field `storage_method`. Various ways to store an image, i.e., as a URL or base64 encoded string. `storage_method` can be only one of the following: ||
| `url` | `string` Image URL. |

## Node

Represents a single reusable computational or logical unit.

| Fields ||
|---|---|
| `display_name` | `string` Output only. A human readable name for the node. |
| `icon_url` | `string` Output only. An identifier or URL pointing to an icon representing this node type. |
| `description` | `string` Output only. A detailed description of what the node does. |
| `parameter_schema` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. The parameter schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see <https://spec.openapis.org/oas/v3.0.3.html> and AIP-146). It describes the expected structure of the parameters that this node accepts. |
| `output_schema` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. The output schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see <https://spec.openapis.org/oas/v3.0.3.html/> and AIP-146). It describes the structure of the output produced by this node. |
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Node.Type` Output only. The type of the node. |

## Type

Identifies the type of the node in the agent flow.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified type. |
| `TRIGGER` | Trigger type. |
| `FLOW` | Flow type. |
| `CONNECTOR` | Connector type. |

## ResultDisplayType

The type of result to display in the ucs widget.

| Enums ||
|---|---|
| `RESULT_DISPLAY_TYPE_UNSPECIFIED` | Unspecified display type (default to showing snippet). |
| `SNIPPET` | Display results from the snippet field. |
| `EXTRACTIVE_ANSWER` | Display results from extractive answers field. |

## UIComponentField

Facet field that maps to a UI Component.

| Fields ||
|---|---|
| `field` | `string` Required. Registered field name. The format is `field.abc`. |
| `device_visibility[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UIComponentField.DeviceVisibility` The field visibility on different types of devices. |
| `display_template` | `string` The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". |

## DeviceVisibility

The visibility of the field on different type of devices.

| Enums ||
|---|---|
| `DEVICE_VISIBILITY_UNSPECIFIED` | Default value when not specified. Server returns INVALID_ARGUMENT if used in requests. |
| `MOBILE` | The UI component is visible on Mobile devices. |
| `DESKTOP` | The UI component is visible on Browser-based client. |

## UiBrandingSettings

Describes widget UI branding settings.

| Fields ||
|---|---|
| `logo` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.Image` Logo image. |

## UiSettings

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

| Fields ||
|---|---|
| `interaction_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.InteractionType` Describes widget (or web app) interaction type |
| `generative_answer_config` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.GenerativeAnswerConfig` Describes generative answer configuration. |
| `result_description_type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.ResultDisplayType` Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. |
| `enable_autocomplete` | `bool` Whether or not to enable autocomplete. |
| `enable_safe_search` | `bool` Whether to enable safe search. |
| `enable_quality_feedback` | `bool` Turn on or off collecting the search result quality feedback from end users. |
| `enable_search_as_you_type` | `bool` Whether to enable search-as-you-type behavior for the search widget. |
| `default_search_request_order_by` | `string` The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. <https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body> |
| `data_store_ui_configs[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.DataStoreUiConfig` Per data store configuration. |
| `disable_user_events_collection` | `bool` If set to true, the widget will not collect user events. |
| `enable_visual_content_summary` | `bool` If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. |
| `enable_people_search` | `bool` Optional. If set to true, the widget will enable people search. |
| `enable_create_agent_button` | `bool` Optional. If set to true, the widget will enable the create agent button. |
| `features` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.FeatureState`>`` Output only. Feature config for the engine to opt in or opt out of features. Supported keys: - `agent-gallery` - `no-code-agent-builder` - `prompt-gallery` - `model-selector` - `notebook-lm` - `people-search` - `people-search-org-chart` - `bi-directional-audio` - `speech-to-text` - `feedback` - `session-sharing` - `personalization-memory` - `personalization-suggested-highlights` - `mobile-app-access` - `disable-agent-sharing` - `disable-image-generation` - `disable-video-generation` - `disable-onedrive-upload` - `disable-talk-to-content` - `disable-google-drive-upload` - `disable-welcome-emails` - `disable-canvas` - `canvas-workspace` - `canvas-app-builder` - `skills` - `skill-sharing` - `skill-sharing-without-admin-approval` - `disable-projects` - `sobi` - `enable-end-user-sharing-with-groups` - `single-agent-orchestration` - `multi-agent-orchestration` - `cross-product-intelligence` - `workflow-agents` - `in-app-notifications` |
| `model_configs` | ``map<string, `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelState`>`` Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. |
| `search_addon_spec` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.SearchAddonSpec` Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. |
| `model_config_info` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo` Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. |
| `source_admin_display_name_enabled` | `bool` Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. |
| `onedrive_picker_enabled` | `bool` Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). |
| `google_drive_picker_enabled` | `bool` Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. |

## FeatureState

The state of the feature for the engine.

| Enums ||
|---|---|
| `FEATURE_STATE_UNSPECIFIED` | The feature state is unspecified. |
| `FEATURE_STATE_ON` | The feature is turned on to be accessible. |
| `FEATURE_STATE_OFF` | The feature is turned off to be inaccessible. |

## GenerativeAnswerConfig

Describes configuration for generative answer.

| Fields ||
|---|---|
| `result_count` | `int32` The number of top results to generate the answer from. Up to 10. |
| `model_version` | `string` The model version used to generate the answer. |
| `model_prompt_preamble` | `string` Text at the beginning of the prompt that instructs the model that generates the answer. |
| `max_rephrase_steps` | `int32` Max rephrase steps. The max number is 5 steps. If not set or set to \< 1, it will be set to 1 by default. |
| `language_code` | `string` Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. |
| `disable_related_questions` | `bool` Whether generated answer contains suggested related questions. |
| `ignore_non_answer_seeking_query` | `bool` Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. |
| `ignore_adversarial_query` | `bool` Optional. Specifies whether to filter out queries that are adversarial. |
| `ignore_low_relevant_content` | `bool` Optional. Specifies whether to filter out queries that are not relevant to the content. |
| `image_source` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.GenerativeAnswerConfig.ImageSource` Optional. Source of image returned in the answer. |

## ImageSource

Source of image returned in the answer.

| Enums ||
|---|---|
| `IMAGE_SOURCE_UNSPECIFIED` | Unspecified image source (multimodal feature is disabled by default) |
| `ALL_AVAILABLE_SOURCES` | Behavior when service determines the pick from all available sources. |
| `CORPUS_IMAGE_ONLY` | Include image from corpus in the answer. |
| `FIGURE_GENERATION_ONLY` | Triggers figure generation in the answer. |

## InteractionType

Describes interaction type.

| Enums ||
|---|---|
| `INTERACTION_TYPE_UNSPECIFIED` | Not specified. Defaults to SEARCH_ONLY. |
| `SEARCH_ONLY` | Search without a generative answer. |
| `SEARCH_WITH_ANSWER` | Search with the generative answer. |
| `SEARCH_WITH_FOLLOW_UPS` | Search with the generative answer that supports follow up questions. Also known as multi-turn search. |

## ModelConfigInfo

The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`.

The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.

| Fields ||
|---|---|
| `resolved_models[]` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel` Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. |
| `default_model_id` | `string` Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. |
| `auto_model_id` | `string` Output only. The `model_id` a client must send when the end-user picks the "Auto" entry (the empty `model_id`). Populated only for surfaces known to have no true "Auto" mode, where leaving the model unset would fall back to a platform default rather than a backend-chosen model. Empty on every other surface, where "Auto" is resolved server-side, and when none of the surface's ranked models is available. When set, it is always one of the non-empty `model_id`s present in `resolved_models`. |

## ResolvedModel

A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.

| Fields ||
|---|---|
| `model_id` | `string` Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. |
| `display_name` | `string` Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.language_code` and `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.FIELDS.string.google.cloud.discoveryengine.v1alpha.LookupWidgetConfigRequest.region_code` of the request. |
| `icon` | `string` Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). |
| `description` | `string` Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. |
| `is_preview` | `bool` Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. |
| `label` | `string` Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. |
| `admin_view` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.UiSettings.ModelConfigInfo.ResolvedModel.AdminView` Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. |
| `promoted` | `bool` Output only. Whether this model should be promoted in the GE chat homepage banner. |
| `icon_url` | `string` Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. |
| `family` | `string` Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized. |

## AdminView

Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.

| Fields ||
|---|---|
| `admin_overridable` | `bool` Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. |
| `enabled_by_default` | `bool` Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. |
| `regions[]` | `string` Output only. Regions where this model is launched. |

## ModelState

The state of the model for the engine.

| Enums ||
|---|---|
| `MODEL_STATE_UNSPECIFIED` | The model state is unspecified. |
| `MODEL_ENABLED` | The model is enabled by admin. |
| `MODEL_DISABLED` | The model is disabled by admin. |

## SearchAddonSpec

SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.

| Fields ||
|---|---|
| `semantic_add_on_disabled` | `bool` Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. |
| `kpi_personalization_add_on_disabled` | `bool` Optional. If true, disables event re-ranking and personalization to optimize KPIs \& personalize results. |
| `generative_answer_add_on_disabled` | `bool` Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. |

## WidgetConverseConversationRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetConverseConversation` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. |
| `converse_conversation_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationRequest` Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig ID will be `default_search` by default. |
| `conversation_id` | `string` Required. The ID of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetConverseConversationResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetConverseConversation` method.

| Fields ||
|---|---|
| `converse_conversation_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConverseConversationResponse` ConverseConversationResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation`. |
| `u_token` | `string` The token in response. |
| `conversation_id` | `string` The ID of the Conversation returned. |

## WidgetCreateSessionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetCreateSession` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget update session will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |
| `create_session_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.CreateSessionRequest` Required. The proxied request to ConversationalSearchService.CreateSession. |

## WidgetCreateSessionResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetCreateSession` method.

| Fields ||
|---|---|
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` The proxied response from ConversationalSearchService.CreateSession. |
| `u_token` | `string` The token in response. |

## WidgetDeleteSessionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetDeleteSession` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget delete session will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `delete_session_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DeleteSessionRequest` Required. The proxied request to ConversationalSearchService.DeleteSession. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetDeleteSessionResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetDeleteSession` method.

## WidgetDisconnectConnectorRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetDisconnectConnector` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `data_connector` | `string` Required. The DataConnector to disconnect the calling end user from. The DataConnector resource name. Under `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService` the project number and location are erased, matching other WidgetService resource fields (e.g. `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetConfig.CollectionComponent.FIELDS.string.google.cloud.discoveryengine.v1alpha.WidgetConfig.CollectionComponent.name`); the service re-qualifies it with the widget's project and location before matching. Callers pass the widget-relative form: `collections/{collection}/dataConnector` (equivalently the full form `projects/{project}/locations/{location}/collections/{collection}/dataConnector`). This is the value the widget UI already holds for connected connectors, for both Enterprise and Business editions. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetDisconnectConnectorResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetDisconnectConnector` method.

## WidgetExecuteActionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetExecuteAction` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget homepage FetchDocuments will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `execute_action_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionRequest` Required. The proxied request to DataConnectorService.ExecuteAction. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetExecuteActionResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetExecuteAction` method.

| Fields ||
|---|---|
| `execute_action_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ExecuteActionResponse` The proxied response from DataConnectorService.ExecuteAction. |
| `u_token` | `string` The token in response. |

## WidgetGetSessionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetGetSession` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget get session will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `get_session_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.GetSessionRequest` Required. The proxied request to ConversationalSearchService.GetSession. For \[WidgetService.WidgetGetSession.get_session_request.name\], only session_id is required. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |
| `debug_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DebugParams` Optional. Debug params for the widget request. |

## WidgetGetSessionResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetGetSession` method.

| Fields ||
|---|---|
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` The proxied response from ConversationalSearchService.GetSession. |
| `u_token` | `string` The token in response. |
| `sherlog_url` | `string` The sherlog url for debugging. |

## WidgetHomepageFetchDocumentsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetHomepageFetchDocuments` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget homepage FetchDocuments will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `fetch_documents_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsRequest` Required. The request to get documents for Homepage. |

## WidgetHomepageFetchDocumentsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetHomepageFetchDocuments` method.

| Fields ||
|---|---|
| `fetch_documents_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.FetchDocumentsResponse` The response from FetchDocuments. |

## WidgetListSessionsRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetListSessions` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget list sessions will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `list_sessions_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsRequest` Required. The proxied request to ConversationalSearchService.ListSessions. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |
| `debug_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DebugParams` Optional. Debug params for the widget request. |

## WidgetListSessionsResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetListSessions` method.

| Fields ||
|---|---|
| `list_sessions_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.ListSessionsResponse` The proxied response from ConversationalSearchService.ListSessions. |
| `u_token` | `string` The token in response. |

## WidgetRemoveContextFileRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetRemoveContextFile` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget remove context file will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `remove_context_file_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileRequest` Required. The RemoveContextFileRequest request to perform removing context files. The session resource will be set as sanitized session name hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. The session of RemoveContextFile will be used for constructing session full resource name in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileRequest`. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetRemoveContextFileResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetRemoveContextFile` method.

| Fields ||
|---|---|
| `remove_context_file_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileResponse` RemoveContextFileResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.RemoveContextFileResponse`. |
| `u_token` | `string` The token in response. |

## WidgetSearchRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetSearch` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget search will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search. |
| `search_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchRequest` Required. The search request to perform search. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetSearchResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetSearch` method.

| Fields ||
|---|---|
| `search_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SearchResponse` The search response after performing search. |
| `u_token` | `string` The token in response. |

## WidgetSelectContextFilesRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetSelectContextFiles` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget select context files will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `select_context_files_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest` Required. The SelectContextFilesRequest request to perform adding context files. The session resource will be set as sanitized session name hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. The session of SelectContextFiles will be used for constructing session full resource name in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesRequest`. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetSelectContextFilesResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetSelectContextFiles` method.

| Fields ||
|---|---|
| `select_context_files_response` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesResponse` SelectContextFilesResponse returned from `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.SelectContextFilesResponse`. The session resource returned will be sanitized with hiding project and location information. Format: `collections/{collection}/engines/{engine}/sessions/{session_id}`. |
| `u_token` | `string` The token in response. |

## WidgetUpdateSessionRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetUpdateSession` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget update session will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
| `update_session_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UpdateSessionRequest` Required. The proxied request to ConversationalSearchService.UpdateSession. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetUpdateSessionResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetUpdateSession` method.

| Fields ||
|---|---|
| `session` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Session` The proxied response from ConversationalSearchService.UpdateSession. |
| `u_token` | `string` The token in response. |

## WidgetWriteUserEventRequest

Request message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetWriteUserEvent` method.

| Fields ||
|---|---|
| `location` | `string` Required. The location resource where widget write user event will be performed. Format: `locations/{location}` |
| `config_id` | `string` Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to write user event. |
| `write_user_event_request` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WriteUserEventRequest` Required. The user event write request. |
| `additional_params` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AdditionalParams` Required. Additional params for security and privacy enhancement. |

## WidgetWriteUserEventResponse

Response message for `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WidgetService.WidgetWriteUserEvent` method.

| Fields ||
|---|---|
| `u_token` | `string` The token in response. |

## WithdrawAgentRequest

Request message for the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentService.WithdrawAgent` method.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the Agent to withdraw. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` |

## WorkspaceConfig

Config to store data store type configuration for workspace data

| Fields ||
|---|---|
| `type` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.WorkspaceConfig.Type` The Google Workspace data source. |
| `dasher_customer_id` | `string` Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. |
| `super_admin_service_account` | `string` Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |
| `super_admin_email_address` | `string` Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |

## Type

Specifies the type of Workspace App supported by this DataStore

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Defaults to an unspecified Workspace type. |
| `GOOGLE_DRIVE` | Workspace Data Store contains Drive data |
| `GOOGLE_MAIL` | Workspace Data Store contains Mail data |
| `GOOGLE_SITES` | Workspace Data Store contains Sites data |
| `GOOGLE_CALENDAR` | Workspace Data Store contains Calendar data |
| `GOOGLE_CHAT` | Workspace Data Store contains Chat data |
| `GOOGLE_GROUPS` | Workspace Data Store contains Groups data |
| `GOOGLE_KEEP` | Workspace Data Store contains Keep data |
| `GOOGLE_PEOPLE` | Workspace Data Store contains People data |
| `GOOGLE_WORKSPACE` | Workspace Data Store contains all Workspace apps data |

## WorkspaceSettings

Workspace settings for the end user.

| Fields ||
|---|---|
| `workspace_access_enabled` | `bool` Whether an end user has workspace access enabled. |
| `customer_domain_valid` | `bool` Whether the calling user's customer domain matches the workspace data stores under this engine. |

## WriteAgentTrajectoryRequest

Request message for `UserEventService.WriteAgentTrajectory` method.

| Fields ||
|---|---|
| `parent` | `string` Required. The `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Engine` the trajectory belongs to, in the form `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`. Observability logging is gated on this engine's `ObservabilityConfig`: the trajectory is only logged (written as a JSON object to a fixed Google-internal GCS bucket) when observability is enabled for the engine, and content-bearing attributes are only included when sensitive logging is enabled. |
| `agent_trajectory` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.AgentTrajectory` Required. The agent trajectory to log. |

## WriteAgentTrajectoryResponse

Response message for `UserEventService.WriteAgentTrajectory` method.

| Fields ||
|---|---|
| `accepted_span_count` | `int32` The number of spans that were accepted for observability logging. |

## WriteUserEventRequest

Request message for WriteUserEvent method.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name. If the write user event action is applied in `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore` level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in `Location` level, for example, the event with `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.Document` across multiple `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.DataStore`, the format is: `projects/{project}/locations/{location}`. |
| `write_async` | `bool` If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. |
| `user_event` | `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rpc/google.cloud.discoveryengine.v1alpha#google.cloud.discoveryengine.v1alpha.UserEvent` Required. User event to write. |