Package google.cloud.discoveryengine.v1

索引

• AclConfigService（接口）
• AssistAnswerService（接口）
• AssistantService（接口）
• CmekConfigService（接口）
• CollectionService（接口）
• CompletionService（接口）
• ControlService（接口）
• ConversationalSearchService（接口）
• DataConnectorService（接口）
• DataStoreService（接口）
• DocumentService（接口）
• EngineService（接口）
• GroundedGenerationService（接口）
• IdentityMappingStoreService（接口）
• LicenseConfigService（接口）
• PodcastService（接口）
• ProjectService（接口）
• RankService（接口）
• RecommendationService（接口）
• SchemaService（接口）
• SearchService（接口）
• SearchTuningService（接口）
• ServingConfigService（接口）
• SessionService（接口）
• SiteSearchEngineService（接口）
• UserEventService（接口）
• UserLicenseService（接口）
• AclConfig（消息）
• ActionConfig（消息）
• AddContextFileRequest（消息）
• AddContextFileResponse（消息）
• AdvancedCompleteQueryRequest（消息）
• AdvancedCompleteQueryRequest.BoostSpec（消息）
• AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec（消息）
• AdvancedCompleteQueryRequest.SuggestionType（枚举）
• AdvancedCompleteQueryRequest.SuggestionTypeSpec（消息）
• AdvancedCompleteQueryResponse（消息）
• AdvancedCompleteQueryResponse.ContentSuggestion（消息）
• AdvancedCompleteQueryResponse.ContentSuggestion.ContentType（枚举）
• AdvancedCompleteQueryResponse.PersonSuggestion（消息）
• AdvancedCompleteQueryResponse.PersonSuggestion.PersonType（枚举）
• AdvancedCompleteQueryResponse.QuerySuggestion（消息）
• AdvancedCompleteQueryResponse.RecentSearchSuggestion（消息）
• AdvancedSiteSearchConfig（消息）
• AlertPolicyConfig（消息）
• AlertPolicyConfig.AlertEnrollment（消息）
• AlertPolicyConfig.AlertEnrollment.EnrollStates（枚举）
• AlertPolicyResourceConfig（消息）
• AlertPolicyResourceConfig.AlertEnrollment（消息）
• AlertPolicyResourceConfig.AlertEnrollment.EnrollState（枚举）
• AlloyDbSource（消息）
• Answer（消息）
• Answer.AnswerSkippedReason（枚举）
• Answer.Citation（消息）
• Answer.CitationSource（消息）
• Answer.GroundingSupport（消息）
• Answer.QueryUnderstandingInfo（消息）
• Answer.QueryUnderstandingInfo.QueryClassificationInfo（消息）
• Answer.QueryUnderstandingInfo.QueryClassificationInfo.Type（枚举）
• Answer.Reference（消息）
• Answer.Reference.ChunkInfo（消息）
• Answer.Reference.ChunkInfo.DocumentMetadata（消息）
• Answer.Reference.StructuredDocumentInfo（消息）
• Answer.Reference.UnstructuredDocumentInfo（消息）
• Answer.Reference.UnstructuredDocumentInfo.ChunkContent（消息）
• Answer.State（枚举）
• Answer.Step（消息）
• Answer.Step.Action（消息）
• Answer.Step.Action.Observation（消息）
• Answer.Step.Action.Observation.SearchResult（消息）
• Answer.Step.Action.Observation.SearchResult.ChunkInfo（消息）
• Answer.Step.Action.Observation.SearchResult.SnippetInfo（消息）
• Answer.Step.Action.SearchAction（消息）
• Answer.Step.State（枚举）
• AnswerGenerationSpec（消息）
• AnswerGenerationSpec.UserDefinedClassifierSpec（消息）
• AnswerQueryRequest（消息）
• AnswerQueryRequest.AnswerGenerationSpec（消息）
• AnswerQueryRequest.AnswerGenerationSpec.ModelSpec（消息）
• AnswerQueryRequest.AnswerGenerationSpec.PromptSpec（消息）
• AnswerQueryRequest.EndUserSpec（消息）
• AnswerQueryRequest.EndUserSpec.EndUserMetaData（消息）
• AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo（消息）
• AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo.DocumentMetadata（消息）
• AnswerQueryRequest.GroundingSpec（消息）
• AnswerQueryRequest.GroundingSpec.FilteringLevel（枚举）
• AnswerQueryRequest.QueryUnderstandingSpec（消息）
• AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec（消息）
• AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec.Type（枚举）
• AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec（消息）
• AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec（消息）
• AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec.ModelType（枚举）
• AnswerQueryRequest.RelatedQuestionsSpec（消息）
• AnswerQueryRequest.SafetySpec（消息）
• AnswerQueryRequest.SafetySpec.SafetySetting（消息）
• AnswerQueryRequest.SafetySpec.SafetySetting.HarmBlockThreshold（枚举）
• AnswerQueryRequest.SearchSpec（消息）
• AnswerQueryRequest.SearchSpec.SearchParams（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer（消息）
• AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment（消息）
• AnswerQueryResponse（消息）
• AssistAnswer（消息）
• AssistAnswer.AssistSkippedReason（枚举）
• AssistAnswer.CustomerPolicyEnforcementResult（消息）
• AssistAnswer.CustomerPolicyEnforcementResult.BannedPhraseEnforcementResult（消息）
• AssistAnswer.CustomerPolicyEnforcementResult.ModelArmorEnforcementResult（消息）
• AssistAnswer.CustomerPolicyEnforcementResult.PolicyEnforcementResult（消息）
• AssistAnswer.CustomerPolicyEnforcementResult.Verdict（枚举）
• AssistAnswer.Reply（消息）
• AssistAnswer.State（枚举）
• AssistRequest（消息）
• AssistRequest.AssistSkippingMode（枚举）
• AssistResponse（消息）
• AssistResponse.SessionInfo（消息）
• AssistUserMetadata（消息）
• Assistant（消息）
• Assistant.ActionInfo（消息）（已弃用）
• Assistant.ActionList（消息）（已弃用）
• Assistant.CustomerPolicy（消息）
• Assistant.CustomerPolicy.BannedPhrase（消息）
• Assistant.CustomerPolicy.BannedPhrase.BannedPhraseMatchType（枚举）
• Assistant.CustomerPolicy.ModelArmorConfig（消息）
• Assistant.CustomerPolicy.ModelArmorConfig.FailureMode（枚举）
• Assistant.GenerationConfig（消息）
• Assistant.GenerationConfig.SystemInstruction（消息）
• Assistant.ToolInfo（消息）
• Assistant.ToolList（消息）
• Assistant.WebGroundingType（枚举）
• AssistantContent（消息）
• AssistantContent.Blob（消息）
• AssistantContent.CodeExecutionResult（消息）
• AssistantContent.CodeExecutionResult.Outcome（枚举）
• AssistantContent.ExecutableCode（消息）
• AssistantContent.File（消息）
• AssistantGroundedContent（消息）
• AssistantGroundedContent.ContentMetadata（消息）
• AssistantGroundedContent.ContentMetadata.ContentKind（枚举）
• AssistantGroundedContent.TextGroundingMetadata（消息）
• AssistantGroundedContent.TextGroundingMetadata.Reference（消息）
• AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata（消息）
• AssistantGroundedContent.TextGroundingMetadata.Segment（消息）
• BAPConfig（消息）
• BAPConfig.ConnectorMode（枚举）
• BatchCreateTargetSiteMetadata（消息）
• BatchCreateTargetSitesRequest（消息）
• BatchCreateTargetSitesResponse（消息）
• BatchGetDocumentsMetadataRequest（消息）
• BatchGetDocumentsMetadataRequest.FhirMatcher（消息）
• BatchGetDocumentsMetadataRequest.Matcher（消息）
• BatchGetDocumentsMetadataRequest.UrisMatcher（消息）
• BatchGetDocumentsMetadataResponse（消息）
• BatchGetDocumentsMetadataResponse.DocumentMetadata（消息）
• BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue（消息）
• BatchGetDocumentsMetadataResponse.State（枚举）
• BatchUpdateUserLicensesMetadata（消息）
• BatchUpdateUserLicensesRequest（消息）
• BatchUpdateUserLicensesRequest.InlineSource（消息）
• BatchUpdateUserLicensesResponse（消息）
• BatchVerifyTargetSitesMetadata（消息）
• BatchVerifyTargetSitesRequest（消息）
• BatchVerifyTargetSitesResponse（消息）
• BigQuerySource（消息）
• BigtableOptions（消息）
• BigtableOptions.BigtableColumn（消息）
• BigtableOptions.BigtableColumnFamily（消息）
• BigtableOptions.Encoding（枚举）
• BigtableOptions.Type（枚举）
• BigtableSource（消息）
• CheckGroundingRequest（消息）
• CheckGroundingResponse（消息）
• CheckGroundingResponse.CheckGroundingFactChunk（消息）
• CheckGroundingResponse.Claim（消息）
• CheckGroundingSpec（消息）
• Chunk（消息）
• Chunk.AnnotationMetadata（消息）
• Chunk.ChunkMetadata（消息）
• Chunk.DocumentMetadata（消息）
• Chunk.PageSpan（消息）
• Chunk.StructureType（枚举）
• Chunk.StructuredContent（消息）
• Citation（消息）
• CitationMetadata（消息）
• CloudSqlSource（消息）
• CmekConfig（消息）
• CmekConfig.NotebookLMState（枚举）
• CmekConfig.State（枚举）
• CollectUserEventRequest（消息）
• Collection（消息）
• CompleteQueryRequest（消息）
• CompleteQueryResponse（消息）
• CompleteQueryResponse.QuerySuggestion（消息）
• CompletionInfo（消息）
• CompletionSuggestion（消息）
• Condition（消息）
• Condition.QueryTerm（消息）
• Condition.TimeRange（消息）
• ConnectorType（枚举）
• ContactDetails（消息）
• Control（消息）
• Control.BoostAction（消息）
• Control.BoostAction.InterpolationBoostSpec（消息）
• Control.BoostAction.InterpolationBoostSpec.AttributeType（枚举）
• Control.BoostAction.InterpolationBoostSpec.ControlPoint（消息）
• Control.BoostAction.InterpolationBoostSpec.InterpolationType（枚举）
• Control.FilterAction（消息）
• Control.PromoteAction（消息）
• Control.RedirectAction（消息）
• Control.SynonymsAction（消息）
• Conversation（消息）
• Conversation.State（枚举）
• ConversationContext（消息）
• ConversationMessage（消息）
• ConverseConversationRequest（消息）
• ConverseConversationResponse（消息）
• CreateAssistantRequest（消息）
• CreateControlRequest（消息）
• CreateConversationRequest（消息）
• CreateDataStoreMetadata（消息）
• CreateDataStoreRequest（消息）
• CreateDocumentRequest（消息）
• CreateEngineMetadata（消息）
• CreateEngineRequest（消息）
• CreateIdentityMappingStoreRequest（消息）
• CreateLicenseConfigRequest（消息）
• CreateSchemaMetadata（消息）
• CreateSchemaRequest（消息）
• CreateSessionRequest（消息）
• CreateSitemapMetadata（消息）
• CreateSitemapRequest（消息）
• CreateTargetSiteMetadata（消息）
• CreateTargetSiteRequest（消息）
• CustomAttribute（消息）
• CustomTuningModel（消息）
• CustomTuningModel.ModelState（枚举）
• DataConnector（消息）
• DataConnector.BlockingReason（枚举）
• DataConnector.ConnectorMode（枚举）
• DataConnector.EndUserConfig（消息）
• DataConnector.FederatedConfig（消息）
• DataConnector.RealtimeSyncConfig（消息）
• DataConnector.RealtimeSyncConfig.StreamingError（消息）
• DataConnector.RealtimeSyncConfig.StreamingError.StreamingErrorReason（枚举）
• DataConnector.SourceEntity（消息）
• DataConnector.State（枚举）
• DataConnector.SyncMode（枚举）
• DataStore（消息）
• DataStore.BillingEstimation（消息）
• DataStore.ConfigurableBillingApproach（枚举）
• DataStore.ContentConfig（枚举）
• DataStore.ServingConfigDataStore（消息）
• DeleteAssistantRequest（消息）
• DeleteCmekConfigMetadata（消息）
• DeleteCmekConfigRequest（消息）
• DeleteCollectionMetadata（消息）
• DeleteCollectionRequest（消息）
• DeleteControlRequest（消息）
• DeleteConversationRequest（消息）
• DeleteDataStoreMetadata（消息）
• DeleteDataStoreRequest（消息）
• DeleteDocumentRequest（消息）
• DeleteEngineMetadata（消息）
• DeleteEngineRequest（消息）
• DeleteIdentityMappingStoreMetadata（消息）
• DeleteIdentityMappingStoreRequest（消息）
• DeleteSchemaMetadata（消息）
• DeleteSchemaRequest（消息）
• DeleteSessionRequest（消息）
• DeleteSitemapMetadata（消息）
• DeleteSitemapRequest（消息）
• DeleteTargetSiteMetadata（消息）
• DeleteTargetSiteRequest（消息）
• DestinationConfig（消息）
• DestinationConfig.Destination（消息）
• DisableAdvancedSiteSearchMetadata（消息）
• DisableAdvancedSiteSearchRequest（消息）
• DisableAdvancedSiteSearchResponse（消息）
• Document（消息）
• Document.AclInfo（消息）
• Document.AclInfo.AccessRestriction（消息）
• Document.Content（消息）
• Document.IndexStatus（消息）
• DocumentInfo（消息）
• DocumentProcessingConfig（消息）
• DocumentProcessingConfig.ChunkingConfig（消息）
• DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig（消息）
• DocumentProcessingConfig.ParsingConfig（消息）
• DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig（消息）
• DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig（消息）
• DocumentProcessingConfig.ParsingConfig.OcrParsingConfig（消息）
• DoubleList（消息）
• EnableAdvancedSiteSearchMetadata（消息）
• EnableAdvancedSiteSearchRequest（消息）
• EnableAdvancedSiteSearchResponse（消息）
• Engine（消息）
• Engine.AppType（枚举）
• Engine.ChatEngineConfig（消息）
• Engine.ChatEngineConfig.AgentCreationConfig（消息）
• Engine.ChatEngineMetadata（消息）
• Engine.CommonConfig（消息）
• Engine.ConfigurableBillingApproach（枚举）
• Engine.FeatureState（枚举）
• Engine.MediaRecommendationEngineConfig（消息）
• Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig（消息）
• Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig（消息）
• Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig（消息）
• Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig（消息）
• Engine.MediaRecommendationEngineConfig.TrainingState（枚举）
• Engine.SearchEngineConfig（消息）
• FactChunk（消息）
• FetchDomainVerificationStatusRequest（消息）
• FetchDomainVerificationStatusResponse（消息）
• FetchSitemapsRequest（消息）
• FetchSitemapsRequest.Matcher（消息）
• FetchSitemapsRequest.UrisMatcher（消息）
• FetchSitemapsResponse（消息）
• FetchSitemapsResponse.SitemapMetadata（消息）
• FhirStoreSource（消息）
• FirestoreSource（消息）
• GcsSource（消息）
• GetAclConfigRequest（消息）
• GetAnswerRequest（消息）
• GetAssistAnswerRequest（消息）
• GetAssistantRequest（消息）
• GetCmekConfigRequest（消息）
• GetControlRequest（消息）
• GetConversationRequest（消息）
• GetDataConnectorRequest（消息）
• GetDataStoreRequest（消息）
• GetDocumentRequest（消息）
• GetEngineRequest（消息）
• GetIdentityMappingStoreRequest（消息）
• GetLicenseConfigRequest（消息）
• GetSchemaRequest（消息）
• GetSessionRequest（消息）
• GetSiteSearchEngineRequest（消息）
• GetTargetSiteRequest（消息）
• GroundingFact（消息）
• HarmCategory（枚举）
• HealthcareFhirConfig（消息）
• IdentityMappingEntry（消息）
• IdentityMappingEntryOperationMetadata（消息）
• IdentityMappingStore（消息）
• IdentityScheduleConfig（消息）
• IdpConfig（消息）
• IdpConfig.ExternalIdpConfig（消息）
• IdpConfig.IdpType（枚举）
• ImportCompletionSuggestionsMetadata（消息）
• ImportCompletionSuggestionsRequest（消息）
• ImportCompletionSuggestionsRequest.InlineSource（消息）
• ImportCompletionSuggestionsResponse（消息）
• ImportDocumentsMetadata（消息）
• ImportDocumentsRequest（消息）
• ImportDocumentsRequest.InlineSource（消息）
• ImportDocumentsRequest.ReconciliationMode（枚举）
• ImportDocumentsResponse（消息）
• ImportErrorConfig（消息）
• ImportIdentityMappingsRequest（消息）
• ImportIdentityMappingsRequest.InlineSource（消息）
• ImportIdentityMappingsResponse（消息）
• ImportSuggestionDenyListEntriesMetadata（消息）
• ImportSuggestionDenyListEntriesRequest（消息）
• ImportSuggestionDenyListEntriesRequest.InlineSource（消息）
• ImportSuggestionDenyListEntriesResponse（消息）
• ImportUserEventsMetadata（消息）
• ImportUserEventsRequest（消息）
• ImportUserEventsRequest.InlineSource（消息）
• ImportUserEventsResponse（消息）
• IndustryVertical（枚举）
• Interval（消息）
• LicenseConfig（消息）
• LicenseConfig.State（枚举）
• ListAssistantsRequest（消息）
• ListAssistantsResponse（消息）
• ListCmekConfigsRequest（消息）
• ListCmekConfigsResponse（消息）
• ListControlsRequest（消息）
• ListControlsResponse（消息）
• ListConversationsRequest（消息）
• ListConversationsResponse（消息）
• ListCustomModelsRequest（消息）
• ListCustomModelsResponse（消息）
• ListDataStoresRequest（消息）
• ListDataStoresResponse（消息）
• ListDocumentsRequest（消息）
• ListDocumentsResponse（消息）
• ListEnginesRequest（消息）
• ListEnginesResponse（消息）
• ListIdentityMappingStoresRequest（消息）
• ListIdentityMappingStoresResponse（消息）
• ListIdentityMappingsRequest（消息）
• ListIdentityMappingsResponse（消息）
• ListSchemasRequest（消息）
• ListSchemasResponse（消息）
• ListSessionsRequest（消息）
• ListSessionsResponse（消息）
• ListTargetSitesRequest（消息）
• ListTargetSitesResponse（消息）
• ListUserLicensesRequest（消息）
• ListUserLicensesResponse（消息）
• MediaInfo（消息）
• PageInfo（消息）
• PanelInfo（消息）
• Principal（消息）
• Project（消息）
• Project.CustomerProvidedConfig（消息）
• Project.CustomerProvidedConfig.NotebooklmConfig（消息）
• Project.CustomerProvidedConfig.NotebooklmConfig.ModelArmorConfig（消息）
• Project.ServiceTerms（消息）
• Project.ServiceTerms.State（枚举）
• ProvisionProjectMetadata（消息）
• ProvisionProjectRequest（消息）
• ProvisionProjectRequest.SaasParams（消息）
• PurgeCompletionSuggestionsMetadata（消息）
• PurgeCompletionSuggestionsRequest（消息）
• PurgeCompletionSuggestionsResponse（消息）
• PurgeDocumentsMetadata（消息）
• PurgeDocumentsRequest（消息）
• PurgeDocumentsRequest.InlineSource（消息）
• PurgeDocumentsResponse（消息）
• PurgeErrorConfig（消息）
• PurgeIdentityMappingsRequest（消息）
• PurgeIdentityMappingsRequest.InlineSource（消息）
• PurgeSuggestionDenyListEntriesMetadata（消息）
• PurgeSuggestionDenyListEntriesRequest（消息）
• PurgeSuggestionDenyListEntriesResponse（消息）
• PurgeUserEventsMetadata（消息）
• PurgeUserEventsRequest（消息）
• PurgeUserEventsResponse（消息）
• Query（消息）
• RankRequest（消息）
• RankResponse（消息）
• RankingRecord（消息）
• RecommendRequest（消息）
• RecommendResponse（消息）
• RecommendResponse.RecommendationResult（消息）
• RecrawlUrisMetadata（消息）
• RecrawlUrisRequest（消息）
• RecrawlUrisResponse（消息）
• RecrawlUrisResponse.FailureInfo（消息）
• RecrawlUrisResponse.FailureInfo.FailureReason（消息）
• RecrawlUrisResponse.FailureInfo.FailureReason.CorpusType（枚举）
• Reply（消息）
• SafetyRating（消息）
• SafetyRating.HarmProbability（枚举）
• SafetyRating.HarmSeverity（枚举）
• Schema（消息）
• SearchAddOn（枚举）
• SearchInfo（消息）
• SearchLinkPromotion（消息）
• SearchRequest（消息）
• SearchRequest.BoostSpec（消息）
• SearchRequest.BoostSpec.ConditionBoostSpec（消息）
• SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec（消息）
• SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType（枚举）
• SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint（消息）
• SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType（枚举）
• SearchRequest.ContentSearchSpec（消息）
• SearchRequest.ContentSearchSpec.ChunkSpec（消息）
• SearchRequest.ContentSearchSpec.ExtractiveContentSpec（消息）
• SearchRequest.ContentSearchSpec.SearchResultMode（枚举）
• SearchRequest.ContentSearchSpec.SnippetSpec（消息）
• SearchRequest.ContentSearchSpec.SummarySpec（消息）
• SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec（消息）
• SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec（消息）
• SearchRequest.DataStoreSpec（消息）
• SearchRequest.DisplaySpec（消息）
• SearchRequest.DisplaySpec.MatchHighlightingCondition（枚举）
• SearchRequest.FacetSpec（消息）
• SearchRequest.FacetSpec.FacetKey（消息）
• SearchRequest.ImageQuery（消息）
• SearchRequest.NaturalLanguageQueryUnderstandingSpec（消息）
• SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior（枚举）
• SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition（枚举）
• SearchRequest.QueryExpansionSpec（消息）
• SearchRequest.QueryExpansionSpec.Condition（枚举）
• SearchRequest.RankingExpressionBackend（枚举）
• SearchRequest.RelevanceScoreSpec（消息）
• SearchRequest.RelevanceThreshold（枚举）
• SearchRequest.SearchAsYouTypeSpec（消息）
• SearchRequest.SearchAsYouTypeSpec.Condition（枚举）
• SearchRequest.SessionSpec（消息）
• SearchRequest.SpellCorrectionSpec（消息）
• SearchRequest.SpellCorrectionSpec.Mode（枚举）
• SearchResponse（消息）
• SearchResponse.Facet（消息）
• SearchResponse.Facet.FacetValue（消息）
• SearchResponse.QueryExpansionInfo（消息）
• SearchResponse.SearchResult（消息）
• SearchResponse.SearchResult.RankSignals（消息）
• SearchResponse.SearchResult.RankSignals.CustomSignal（消息）
• SearchResponse.SessionInfo（消息）
• SearchResponse.Summary（消息）
• SearchResponse.Summary.Citation（消息）
• SearchResponse.Summary.CitationMetadata（消息）
• SearchResponse.Summary.CitationSource（消息）
• SearchResponse.Summary.Reference（消息）
• SearchResponse.Summary.Reference.ChunkContent（消息）
• SearchResponse.Summary.SafetyAttributes（消息）
• SearchResponse.Summary.SummarySkippedReason（枚举）
• SearchResponse.Summary.SummaryWithMetadata（消息）
• SearchTier（枚举）
• SearchUseCase（枚举）
• ServingConfig（消息）
• ServingConfig.GenericConfig（消息）
• ServingConfig.MediaConfig（消息）
• Session（消息）
• Session.State（枚举）
• Session.Turn（消息）
• SetUpDataConnectorMetadata（消息）
• SetUpDataConnectorRequest（消息）
• SingleRegionKey（消息）
• SiteSearchEngine（消息）
• SiteVerificationInfo（消息）
• SiteVerificationInfo.SiteVerificationState（枚举）
• Sitemap（消息）
• SolutionType（枚举）
• SpannerSource（消息）
• StreamAssistRequest（消息）
• StreamAssistRequest.AgentsSpec（消息）
• StreamAssistRequest.AgentsSpec.AgentSpec（消息）
• StreamAssistRequest.GenerationSpec（消息）
• StreamAssistRequest.ToolsSpec（消息）
• StreamAssistRequest.ToolsSpec.ImageGenerationSpec（消息）
• StreamAssistRequest.ToolsSpec.VertexAiSearchSpec（消息）
• StreamAssistRequest.ToolsSpec.VideoGenerationSpec（消息）
• StreamAssistRequest.ToolsSpec.WebGroundingSpec（消息）
• StreamAssistResponse（消息）
• StreamAssistResponse.SessionInfo（消息）
• SubscriptionTerm（枚举）
• SubscriptionTier（枚举）
• SuggestionDenyListEntry（消息）
• SuggestionDenyListEntry.MatchOperator（枚举）
• TargetSite（消息）
• TargetSite.FailureReason（消息）
• TargetSite.FailureReason.QuotaFailure（消息）
• TargetSite.IndexingStatus（枚举）
• TargetSite.Type（枚举）
• Tenant（消息）
• TextInput（消息）
• TrainCustomModelMetadata（消息）
• TrainCustomModelRequest（消息）
• TrainCustomModelRequest.GcsTrainingInput（消息）
• TrainCustomModelResponse（消息）
• TransactionInfo（消息）
• UpdateAclConfigRequest（消息）
• UpdateAssistantRequest（消息）
• UpdateCmekConfigMetadata（消息）
• UpdateCmekConfigRequest（消息）
• UpdateControlRequest（消息）
• UpdateConversationRequest（消息）
• UpdateDataConnectorRequest（消息）
• UpdateDataStoreRequest（消息）
• UpdateDocumentRequest（消息）
• UpdateEngineRequest（消息）
• UpdateLicenseConfigRequest（消息）
• UpdateSchemaMetadata（消息）
• UpdateSchemaRequest（消息）
• UpdateServingConfigRequest（消息）
• UpdateSessionRequest（消息）
• UpdateTargetSiteMetadata（消息）
• UpdateTargetSiteRequest（消息）
• UserEvent（消息）
• UserInfo（消息）
• UserLicense（消息）
• UserLicense.LicenseAssignmentState（枚举）
• WorkspaceConfig（消息）
• WorkspaceConfig.Type（枚举）
• WriteUserEventRequest（消息）

AclConfigService

用于管理 ACL 配置的服务。

GetAclConfig
rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig) 获取 AclConfig。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.aclConfigs.get 如需了解详情，请参阅 IAM 文档。

UpdateAclConfig
rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig) 用于客户项目位置的默认 ACL 配置。更新只会反映到新的数据存储区。现有数据存储区仍将使用旧值。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.aclConfigs.update 如需了解详情，请参阅 IAM 文档。

AssistAnswerService

用于查询 AssistAnswer 资源的服务。

GetAssistAnswer
rpc GetAssistAnswer(GetAssistAnswerRequest) returns (AssistAnswer) 获取 AssistAnswer。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistAnswers.get 如需了解详情，请参阅 IAM 文档。

AssistantService

用于管理 Google 助理配置和为用户提供帮助的服务。

AddContextFile

rpc AddContextFile(AddContextFileRequest) returns (AddContextFileResponse) 上传上下文文件，以用作会话中辅助调用的来源。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.addContextFile 如需了解详情，请参阅 IAM 文档。

Assist
rpc Assist(AssistRequest) returns (AssistResponse) 协助用户进行查询。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistants.assist 如需了解详情，请参阅 IAM 文档。

CreateAssistant
rpc CreateAssistant(CreateAssistantRequest) returns (Assistant) 创建 Assistant。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.assistants.create 如需了解详情，请参阅 IAM 文档。

DeleteAssistant
rpc DeleteAssistant(DeleteAssistantRequest) returns (Empty) 删除 Assistant。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistants.delete 如需了解详情，请参阅 IAM 文档。

GetAssistant
rpc GetAssistant(GetAssistantRequest) returns (Assistant) 获取 Assistant。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistants.get 如需了解详情，请参阅 IAM 文档。

ListAssistants

rpc ListAssistants(ListAssistantsRequest) returns (ListAssistantsResponse) 列出 Engine 下的所有 Assistant。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.assistants.list 如需了解详情，请参阅 IAM 文档。

StreamAssist
rpc StreamAssist(StreamAssistRequest) returns (StreamAssistResponse) 以流式方式协助用户进行查询。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistants.assist 如需了解详情，请参阅 IAM 文档。

UpdateAssistant
rpc UpdateAssistant(UpdateAssistantRequest) returns (Assistant) 更新 Assistant 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.assistants.update 如需了解详情，请参阅 IAM 文档。

CmekConfigService

用于管理与 CMEK 相关的任务的服务

DeleteCmekConfig
rpc DeleteCmekConfig(DeleteCmekConfigRequest) returns (Operation) 取消配置 CmekConfig。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。

GetCmekConfig
rpc GetCmekConfig(GetCmekConfigRequest) returns (CmekConfig) 获取 CmekConfig。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.cmekConfigs.get 如需了解详情，请参阅 IAM 文档。

ListCmekConfigs
rpc ListCmekConfigs(ListCmekConfigsRequest) returns (ListCmekConfigsResponse) 列出项目中的所有 CmekConfig。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.cmekConfigs.list 如需了解详情，请参阅 IAM 文档。

UpdateCmekConfig
rpc UpdateCmekConfig(UpdateCmekConfigRequest) returns (Operation) 为客户项目的某个位置预配 CMEK 密钥。此方法还会对提供的 cmekConfig 进行位置验证，以确保密钥有效且可在所选位置使用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.cmekConfigs.update 如需了解详情，请参阅 IAM 文档。

CollectionService

用于管理 Collection 的服务。

DeleteCollection
rpc DeleteCollection(DeleteCollectionRequest) returns (Operation) 删除 Collection。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.collections.delete 如需了解详情，请参阅 IAM 文档。

CompletionService

用于自动补全的服务。

AdvancedCompleteQuery

rpc AdvancedCompleteQuery(AdvancedCompleteQueryRequest) returns (AdvancedCompleteQueryResponse) 使用高级关键字建议补全用户输入的内容。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/cloud_search.query https://www.googleapis.com/auth/discoveryengine.complete_query https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 completionConfig 资源的以下 IAM 权限： discoveryengine.completionConfigs.completeQuery 如需了解详情，请参阅 IAM 文档。

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) 使用关键字建议补全指定的用户输入内容。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 dataStore 资源的以下 IAM 权限： discoveryengine.dataStores.completeQuery 如需了解详情，请参阅 IAM 文档。

ImportCompletionSuggestions
rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest) returns (Operation) 导入 DataStore 的 CompletionSuggestion。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。

ImportSuggestionDenyListEntries

rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest) returns (Operation) 导入 DataStore 的所有 SuggestionDenyListEntry。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.suggestionDenyListEntries.import 如需了解详情，请参阅 IAM 文档。

PurgeCompletionSuggestions
rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest) returns (Operation) 永久删除 DataStore 的所有 CompletionSuggestion。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。

PurgeSuggestionDenyListEntries

rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest) returns (Operation) 永久删除 DataStore 的所有 SuggestionDenyListEntry。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.suggestionDenyListEntries.purge 如需了解详情，请参阅 IAM 文档。

ControlService

用于对控制执行 CRUD 操作的服务。借助控件，可以在投放路径中实现自定义逻辑。控制变量需要附加到服务配置，才能在请求期间被考虑。

CreateControl
rpc CreateControl(CreateControlRequest) returns (Control) 创建控制变量。 默认情况下，一个数据存储区最多允许 1,000 个控制变量。您可以提交申请来调整此限制。如果要创建的 Control 已存在，则返回 ALREADY_EXISTS 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.controls.create 如需了解详情，请参阅 IAM 文档。

DeleteControl
rpc DeleteControl(DeleteControlRequest) returns (Empty) 删除控制变量。 如果要删除的 Control 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.controls.delete 如需了解详情，请参阅 IAM 文档。

GetControl
rpc GetControl(GetControlRequest) returns (Control) 获取控件。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.controls.get 如需了解详情，请参阅 IAM 文档。

ListControls
rpc ListControls(ListControlsRequest) returns (ListControlsResponse) 按父级 DataStore 列出所有控制变量。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.controls.list 如需了解详情，请参阅 IAM 文档。

UpdateControl
rpc UpdateControl(UpdateControlRequest) returns (Control) 更新控制变量。 Control 操作类型无法更改。如果要更新的 Control 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.controls.update 如需了解详情，请参阅 IAM 文档。

ConversationalSearchService

用于对话式搜索的服务。

AnswerQuery
rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) 回答查询方法。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 servingConfig 资源的以下 IAM 权限： discoveryengine.servingConfigs.answer 如需了解详情，请参阅 IAM 文档。

ConverseConversation
rpc ConverseConversation(ConverseConversationRequest) returns (ConverseConversationResponse) 进行对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.conversations.converse 如需了解详情，请参阅 IAM 文档。

CreateConversation
rpc CreateConversation(CreateConversationRequest) returns (Conversation) 创建对话。 如果要创建的 Conversation 已存在，则返回 ALREADY_EXISTS 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.conversations.create 如需了解详情，请参阅 IAM 文档。

CreateSession
rpc CreateSession(CreateSessionRequest) returns (Session) 创建会话。 如果要创建的 Session 已存在，则返回 ALREADY_EXISTS 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sessions.create 如需了解详情，请参阅 IAM 文档。

DeleteConversation
rpc DeleteConversation(DeleteConversationRequest) returns (Empty) 删除对话。 如果要删除的 Conversation 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.conversations.delete 如需了解详情，请参阅 IAM 文档。

DeleteSession
rpc DeleteSession(DeleteSessionRequest) returns (Empty) 删除会话。 如果要删除的 Session 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.delete 如需了解详情，请参阅 IAM 文档。

GetAnswer
rpc GetAnswer(GetAnswerRequest) returns (Answer) 获取回答。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.answers.get 如需了解详情，请参阅 IAM 文档。

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) 获取对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.conversations.get 如需了解详情，请参阅 IAM 文档。

GetSession
rpc GetSession(GetSessionRequest) returns (Session) 获取会话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.get 如需了解详情，请参阅 IAM 文档。

ListConversations
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) 按父级 DataStore 列出所有对话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.conversations.list 如需了解详情，请参阅 IAM 文档。

ListSessions
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) 按父级 DataStore 列出所有会话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sessions.list 如需了解详情，请参阅 IAM 文档。

StreamAnswerQuery

rpc StreamAnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) 回答查询方法（流式）。 它接受一个 AnswerQueryRequest，并在流中返回多个 AnswerQueryResponse 消息。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 servingConfig 资源的以下 IAM 权限： discoveryengine.servingConfigs.answer 如需了解详情，请参阅 IAM 文档。

UpdateConversation
rpc UpdateConversation(UpdateConversationRequest) returns (Conversation) 更新对话。 Conversation 操作类型无法更改。如果要更新的 Conversation 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.conversations.update 如需了解详情，请参阅 IAM 文档。

UpdateSession
rpc UpdateSession(UpdateSessionRequest) returns (Session) 更新会话。 Session 操作类型无法更改。如果要更新的 Session 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.update 如需了解详情，请参阅 IAM 文档。

DataConnectorService

用于数据连接器管理的 Service。

GetDataConnector

rpc GetDataConnector(GetDataConnectorRequest) returns (DataConnector) 获取 DataConnector。DataConnector 是每个 Collection 的单例资源。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.dataConnectors.get 如需了解详情，请参阅 IAM 文档。

SetUpDataConnector

rpc SetUpDataConnector(SetUpDataConnectorRequest) returns (Operation) 创建 Collection 并为其设置 DataConnector。如需在设置后停止 DataConnector，请使用 CollectionService.DeleteCollection 方法。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.locations.setUpDataConnector 如需了解详情，请参阅 IAM 文档。

UpdateDataConnector

rpc UpdateDataConnector(UpdateDataConnectorRequest) returns (DataConnector) 更新 DataConnector。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.dataConnectors.update 如需了解详情，请参阅 IAM 文档。

DataStoreService

用于管理 DataStore 配置的服务。

CreateDataStore
rpc CreateDataStore(CreateDataStoreRequest) returns (Operation) 创建 DataStore。 DataStore 用于存储 Documents。如需将这些文档用于搜索或推荐用例，则需要单独创建 Engine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.dataStores.create 如需了解详情，请参阅 IAM 文档。

DeleteDataStore
rpc DeleteDataStore(DeleteDataStoreRequest) returns (Operation) 删除 DataStore。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.dataStores.delete 如需了解详情，请参阅 IAM 文档。

GetDataStore
rpc GetDataStore(GetDataStoreRequest) returns (DataStore) 获取 DataStore。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.dataStores.get 如需了解详情，请参阅 IAM 文档。

ListDataStores
rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse) 列出与项目关联的所有 DataStore。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.dataStores.list 如需了解详情，请参阅 IAM 文档。

UpdateDataStore
rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore) 更新 DataStore 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.dataStores.update 如需了解详情，请参阅 IAM 文档。

DocumentService

用于提取客户网站的 Document 信息的服务。

BatchGetDocumentsMetadata

rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest) returns (BatchGetDocumentsMetadataResponse) 获取 Document 的索引新鲜度元数据。仅支持网站搜索。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.documents.batchGetDocumentsMetadata 如需了解详情，请参阅 IAM 文档。

CreateDocument
rpc CreateDocument(CreateDocumentRequest) returns (Document) 创建 Document。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.documents.create 如需了解详情，请参阅 IAM 文档。

DeleteDocument
rpc DeleteDocument(DeleteDocumentRequest) returns (Empty) 删除 Document。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.documents.delete 如需了解详情，请参阅 IAM 文档。

GetDocument
rpc GetDocument(GetDocumentRequest) returns (Document) 获取 Document。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.documents.get 如需了解详情，请参阅 IAM 文档。

ImportDocuments
rpc ImportDocuments(ImportDocumentsRequest) returns (Operation) 批量导入多个 Document。请求处理可以是同步的。创建不存在的商品。 注意：部分 Document 可能已成功更新。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.documents.import 如需了解详情，请参阅 IAM 文档。

ListDocuments
rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) 获取 Document 的列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.documents.list 如需了解详情，请参阅 IAM 文档。

PurgeDocuments

rpc PurgeDocuments(PurgeDocumentsRequest) returns (Operation) 永久删除分支中的所有选定 Document。 此过程是异步的。此操作可能需要数小时才能完成，具体取决于要删除的 Document 数量。在删除操作完成之前，DocumentService.GetDocument 或 DocumentService.ListDocuments 可能会继续返回一些 Document。 如需获取要删除的 Document 列表，请将 PurgeDocumentsRequest.force 设置为 false。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.documents.purge 如需了解详情，请参阅 IAM 文档。

UpdateDocument
rpc UpdateDocument(UpdateDocumentRequest) returns (Document) 更新 Document。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.documents.update 如需了解详情，请参阅 IAM 文档。

EngineService

用于管理 Engine 配置的服务。

CreateEngine
rpc CreateEngine(CreateEngineRequest) returns (Operation) 创建 Engine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.engines.create 如需了解详情，请参阅 IAM 文档。

DeleteEngine
rpc DeleteEngine(DeleteEngineRequest) returns (Operation) 删除 Engine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.engines.delete 如需了解详情，请参阅 IAM 文档。

GetEngine
rpc GetEngine(GetEngineRequest) returns (Engine) 获取 Engine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.engines.get 如需了解详情，请参阅 IAM 文档。

ListEngines
rpc ListEngines(ListEnginesRequest) returns (ListEnginesResponse) 列出与项目关联的所有 Engine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.engines.list 如需了解详情，请参阅 IAM 文档。

UpdateEngine
rpc UpdateEngine(UpdateEngineRequest) returns (Engine) 更新 Engine 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.engines.update 如需了解详情，请参阅 IAM 文档。

GroundedGenerationService

用于接地生成的服务。

CheckGrounding
rpc CheckGrounding(CheckGroundingRequest) returns (CheckGroundingResponse) 执行接地检查。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 groundingConfig 资源的以下 IAM 权限： discoveryengine.groundingConfigs.check 如需了解详情，请参阅 IAM 文档。

IdentityMappingStoreService

用于管理身份映射存储区的服务。

CreateIdentityMappingStore
rpc CreateIdentityMappingStore(CreateIdentityMappingStoreRequest) returns (IdentityMappingStore) 创建新的身份映射存储区。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.identityMappingStores.create 如需了解详情，请参阅 IAM 文档。

DeleteIdentityMappingStore
rpc DeleteIdentityMappingStore(DeleteIdentityMappingStoreRequest) returns (Operation) 删除身份映射存储区。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.identityMappingStores.delete 如需了解详情，请参阅 IAM 文档。

GetIdentityMappingStore
rpc GetIdentityMappingStore(GetIdentityMappingStoreRequest) returns (IdentityMappingStore) 获取身份映射存储区。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.identityMappingStores.get 如需了解详情，请参阅 IAM 文档。

ImportIdentityMappings
rpc ImportIdentityMappings(ImportIdentityMappingsRequest) returns (Operation) 将身份映射条目列表导入到身份映射存储区。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 identityMappingStore 资源的以下 IAM 权限： discoveryengine.identityMappingStores.importIdentityMappings 如需了解详情，请参阅 IAM 文档。

ListIdentityMappingStores
rpc ListIdentityMappingStores(ListIdentityMappingStoresRequest) returns (ListIdentityMappingStoresResponse) 列出所有身份映射存储区。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.identityMappingStores.list 如需了解详情，请参阅 IAM 文档。

ListIdentityMappings
rpc ListIdentityMappings(ListIdentityMappingsRequest) returns (ListIdentityMappingsResponse) 列出身份映射存储区中的身份映射。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 identityMappingStore 资源的以下 IAM 权限： discoveryengine.identityMappingStores.listIdentityMappings 如需了解详情，请参阅 IAM 文档。

PurgeIdentityMappings
rpc PurgeIdentityMappings(PurgeIdentityMappingsRequest) returns (Operation) 从身份映射存储区中清除指定的身份映射条目或所有身份映射条目。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 identityMappingStore 资源的以下 IAM 权限： discoveryengine.identityMappingStores.purgeIdentityMappings 如需了解详情，请参阅 IAM 文档。

LicenseConfigService

用于管理许可配置相关资源的服务。

CreateLicenseConfig
rpc CreateLicenseConfig(CreateLicenseConfigRequest) returns (LicenseConfig) 创建 LicenseConfig 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.licenseConfigs.create 如需了解详情，请参阅 IAM 文档。

GetLicenseConfig
rpc GetLicenseConfig(GetLicenseConfigRequest) returns (LicenseConfig) 获取 LicenseConfig。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.licenseConfigs.get 如需了解详情，请参阅 IAM 文档。

UpdateLicenseConfig
rpc UpdateLicenseConfig(UpdateLicenseConfigRequest) returns (LicenseConfig) 更新 LicenseConfig 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.licenseConfigs.update 如需了解详情，请参阅 IAM 文档。

PodcastService

用于管理 Podcast 配置的服务。

ProjectService

用于对 Project 执行操作的服务。

ProvisionProject
rpc ProvisionProject(ProvisionProjectRequest) returns (Operation) 预配项目资源。在此过程中，相关系统将进行准备和初始化。 调用者必须阅读数据使用条款，并可以选择在请求中指定同意该服务条款。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.projects.provision 如需了解详情，请参阅 IAM 文档。

RankService

用于对文本记录进行排名的服务。

排名
rpc Rank(RankRequest) returns (RankResponse) 根据给定的输入查询对文本记录列表进行排名。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 rankingConfig 资源的以下 IAM 权限： discoveryengine.rankingConfigs.rank 如需了解详情，请参阅 IAM 文档。

RecommendationService

用于提供建议的服务。

推荐
rpc Recommend(RecommendRequest) returns (RecommendResponse) 进行推荐，这需要情境用户事件。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 servingConfig 资源的以下 IAM 权限： discoveryengine.servingConfigs.recommend 如需了解详情，请参阅 IAM 文档。

SchemaService

用于管理 Schema 的服务。

CreateSchema
rpc CreateSchema(CreateSchemaRequest) returns (Operation) 创建 Schema。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.schemas.create 如需了解详情，请参阅 IAM 文档。

DeleteSchema
rpc DeleteSchema(DeleteSchemaRequest) returns (Operation) 删除 Schema。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.schemas.delete 如需了解详情，请参阅 IAM 文档。

GetSchema
rpc GetSchema(GetSchemaRequest) returns (Schema) 获取 Schema。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.schemas.get 如需了解详情，请参阅 IAM 文档。

ListSchemas
rpc ListSchemas(ListSchemasRequest) returns (ListSchemasResponse) 获取 Schema 的列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.schemas.list 如需了解详情，请参阅 IAM 文档。

UpdateSchema
rpc UpdateSchema(UpdateSchemaRequest) returns (Operation) 更新 Schema。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.schemas.update 如需了解详情，请参阅 IAM 文档。

SearchService

用于搜索的服务。

搜索
rpc Search(SearchRequest) returns (SearchResponse) 执行搜索。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 servingConfig 资源的以下 IAM 权限： discoveryengine.servingConfigs.search 如需了解详情，请参阅 IAM 文档。

SearchLite

rpc SearchLite(SearchRequest) returns (SearchResponse) 执行搜索。与 SearchService.Search 方法类似，但属于精简版，允许使用 API 密钥进行身份验证，无需进行 OAuth 和 IAM 检查。 此方法仅支持公开网站搜索。如果指定了与公开网站搜索无关的数据存储区和引擎，则会返回 FAILED_PRECONDITION 错误。 此方法可用于轻松完成初始配置，而无需实现身份验证后端。不过，强烈建议使用 SearchService.Search，并进行必要的 OAuth 和 IAM 检查，以提供更好的数据安全性。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。

SearchTuningService

用于搜索调参的服务。

ListCustomModels
rpc ListCustomModels(ListCustomModelsRequest) returns (ListCustomModelsResponse) 获取所有自定义模型的列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 dataStore 资源的以下 IAM 权限： discoveryengine.dataStores.listCustomModels 如需了解详情，请参阅 IAM 文档。

TrainCustomModel
rpc TrainCustomModel(TrainCustomModelRequest) returns (Operation) 训练自定义模型。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 dataStore 资源的以下 IAM 权限： discoveryengine.dataStores.trainCustomModel 如需了解详情，请参阅 IAM 文档。

ServingConfigService

用于执行与 ServingConfig 相关的操作的服务。

UpdateServingConfig
rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) 更新 ServingConfig。 如果 ServingConfig 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.servingConfigs.update 如需了解详情，请参阅 IAM 文档。

SessionService

用于管理会话和与会话相关的资源的服务。

CreateSession

rpc CreateSession(CreateSessionRequest) returns (Session) 创建会话。 如果要创建的 Session 已存在，则返回 ALREADY_EXISTS 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sessions.create 如需了解详情，请参阅 IAM 文档。

DeleteSession

rpc DeleteSession(DeleteSessionRequest) returns (Empty) 删除会话。 如果要删除的 Session 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.delete 如需了解详情，请参阅 IAM 文档。

GetSession
rpc GetSession(GetSessionRequest) returns (Session) 获取会话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.get 如需了解详情，请参阅 IAM 文档。

ListSessions

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) 按父级 DataStore 列出所有会话。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sessions.list 如需了解详情，请参阅 IAM 文档。

UpdateSession

rpc UpdateSession(UpdateSessionRequest) returns (Session) 更新会话。 Session 操作类型无法更改。如果要更新的 Session 不存在，则返回 NOT_FOUND 错误。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sessions.update 如需了解详情，请参阅 IAM 文档。

SiteSearchEngineService

用于管理网站搜索相关资源的服务。

BatchCreateTargetSites
rpc BatchCreateTargetSites(BatchCreateTargetSitesRequest) returns (Operation) 批量创建 TargetSite。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.targetSites.batchCreate 如需了解详情，请参阅 IAM 文档。

BatchVerifyTargetSites
rpc BatchVerifyTargetSites(BatchVerifyTargetSitesRequest) returns (Operation) 验证目标网站的所有权和有效性。此 API 会发送网站搜索引下所有目标网站以供验证。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.batchVerifyTargetSites 如需了解详情，请参阅 IAM 文档。

CreateSitemap
rpc CreateSitemap(CreateSitemapRequest) returns (Operation) 创建 Sitemap。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sitemaps.create 如需了解详情，请参阅 IAM 文档。

CreateTargetSite
rpc CreateTargetSite(CreateTargetSiteRequest) returns (Operation) 创建 TargetSite。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.targetSites.create 如需了解详情，请参阅 IAM 文档。

DeleteSitemap
rpc DeleteSitemap(DeleteSitemapRequest) returns (Operation) 删除 Sitemap。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.sitemaps.delete 如需了解详情，请参阅 IAM 文档。

DeleteTargetSite
rpc DeleteTargetSite(DeleteTargetSiteRequest) returns (Operation) 删除 TargetSite。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.targetSites.delete 如需了解详情，请参阅 IAM 文档。

DisableAdvancedSiteSearch
rpc DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest) returns (Operation) 从高级网站搜索降级为基本网站搜索。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 siteSearchEngine 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.disableAdvancedSiteSearch 如需了解详情，请参阅 IAM 文档。

EnableAdvancedSiteSearch
rpc EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest) returns (Operation) 从基本网站搜索升级为高级网站搜索。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 siteSearchEngine 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.enableAdvancedSiteSearch 如需了解详情，请参阅 IAM 文档。

FetchDomainVerificationStatus

rpc FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest) returns (FetchDomainVerificationStatusResponse) 返回目标网站列表及其域名验证状态。目前，此方法只能在具有 BASIC_SITE_SEARCH 状态的数据存储区下调用。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 siteSearchEngine 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.fetchDomainVerificationStatus 如需了解详情，请参阅 IAM 文档。

FetchSitemaps
rpc FetchSitemaps(FetchSitemapsRequest) returns (FetchSitemapsResponse) 在 DataStore 中提取 Sitemap。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.sitemaps.fetch 如需了解详情，请参阅 IAM 文档。

GetSiteSearchEngine
rpc GetSiteSearchEngine(GetSiteSearchEngineRequest) returns (SiteSearchEngine) 获取 SiteSearchEngine。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.get 如需了解详情，请参阅 IAM 文档。

GetTargetSite
rpc GetTargetSite(GetTargetSiteRequest) returns (TargetSite) 获取 TargetSite。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.targetSites.get 如需了解详情，请参阅 IAM 文档。

ListTargetSites
rpc ListTargetSites(ListTargetSitesRequest) returns (ListTargetSitesResponse) 获取 TargetSite 的列表。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.targetSites.list 如需了解详情，请参阅 IAM 文档。

RecrawlUris
rpc RecrawlUris(RecrawlUrisRequest) returns (Operation) 针对 URI 列表请求按需重新抓取。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 siteSearchEngine 资源的以下 IAM 权限： discoveryengine.siteSearchEngines.recrawlUris 如需了解详情，请参阅 IAM 文档。

UpdateTargetSite
rpc UpdateTargetSite(UpdateTargetSiteRequest) returns (Operation) 更新 TargetSite。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 name 资源的以下 IAM 权限： discoveryengine.targetSites.update 如需了解详情，请参阅 IAM 文档。

UserEventService

用于将网站上的最终用户操作提取到 Discovery Engine API 的服务。

CollectUserEvent

rpc CollectUserEvent(CollectUserEventRequest) returns (HttpBody) 从浏览器写入单个用户事件。由于浏览器限制向第三方网域发送 POST 请求，因此这里使用 GET 请求。 此方法仅供 Discovery Engine API JavaScript Pixel 和 Google 跟踪代码管理器使用。用户不应直接调用此方法。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。

ImportUserEvents

rpc ImportUserEvents(ImportUserEventsRequest) returns (Operation) 批量导入用户事件。请求处理可能是同步的。系统会跳过已存在的活动。使用此方法可回填历史用户事件。 Operation.response 的类型为 ImportResponse。请注意，可能只有部分商品成功插入。Operation.metadata 的类型为 ImportMetadata。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.userEvents.import 如需了解详情，请参阅 IAM 文档。

PurgeUserEvents

rpc PurgeUserEvents(PurgeUserEventsRequest) returns (Operation) 永久删除指定过滤条件所指定的所有用户事件。此操作可能需要数小时或数天才能完成，具体取决于过滤条件指定的事件数量。如需测试过滤器，请先使用 list 命令。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.userEvents.purge 如需了解详情，请参阅 IAM 文档。

WriteUserEvent
rpc WriteUserEvent(WriteUserEventRequest) returns (UserEvent) 写入单个用户事件。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.userEvents.create 如需了解详情，请参阅 IAM 文档。

UserLicenseService

用于管理用户许可的服务。

BatchUpdateUserLicenses
rpc BatchUpdateUserLicenses(BatchUpdateUserLicensesRequest) returns (Operation) 更新用户许可。此方法用于批量向用户分配/取消分配许可。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.userStores.batchUpdateUserLicenses 如需了解详情，请参阅 IAM 文档。

ListUserLicenses
rpc ListUserLicenses(ListUserLicensesRequest) returns (ListUserLicensesResponse) 列出用户许可。 授权范围 需要以下 OAuth 范围之一： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 如需了解详情，请参阅 Authentication Overview。 IAM 权限 需要拥有 parent 资源的以下 IAM 权限： discoveryengine.userStores.listUserLicenses 如需了解详情，请参阅 IAM 文档。

AclConfig

访问权限控制配置。

字段
name	string 不可变。ACL 配置的完整资源名称。格式：projects/{project}/locations/{location}/aclConfig。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
idp_config	IdpConfig 身份提供方配置。

ActionConfig

支持连接器操作的信息。

字段
is_action_configured	bool 仅限输出。连接器包含必要的参数，并且已配置为支持操作。
service_name	string 可选。表示用于连接到数据源的 instance_uri 的 Service Directory 资源名称 (projects/*/locations/*/namespaces/*/services/*)，在 DataConnector.params 中定义。 启用 VPC Service Controls 后，此字段为必填字段。
use_static_secrets	bool 可选。是否为连接器使用静态密文。如果为 true，则会忽略 action_params 中提供的 Secret。
联合字段 action_config_params。支持操作所需的参数，采用（键，值）对格式。系统将从 Secret Manager 读取格式为 projects/*/[locations/*/]secrets/*/versions/* 的字符串值。 支持 OAuth 的来源（即 gmail、google_calendar、jira、workday、salesforce、confluence）的必需参数： 键：client_id 值：类型为 STRING。服务提供商用于标识应用的客户端 ID。 键：client_secret 值：类型为 STRING。由应用的授权服务器生成的客户端密钥。action_config_params 只能是下列其中一项：
action_params	Struct 可选。采用结构化 JSON 格式的操作参数。
json_action_params	string 可选。采用 JSON 字符串格式的操作参数。

AddContextFileRequest

针对 AssistantService.AddContextFile 方法的请求。

字段
name	string 必需。会话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} 如果将 - 指定为会话 ID，系统会创建一个具有自动生成的 ID 的新会话。
file_name	string 必需。文件的名称。
mime_type	string 可选。文件的内容类型，请参阅 https://www.iana.org/assignments/media-types/media-types.xhtml。 如果数据源未提供内容类型，则此字段为必需字段。
联合字段 file。文件的内容。file 只能是下列其中一项：
file_contents	bytes 内嵌提供文件内容。

AddContextFileResponse

对 AssistantService.AddContextFile 方法的响应。

字段
session	string 会话的名称，可以是提供的名称，也可以是新创建的名称。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
file_id	string 上传文件的 ID。
token_count (deprecated)	int64 此项已弃用！ 已弃用：此字段不会针对所有文件类型进行设置，最终将被移除。 文件长度（以 token 为单位）。

AdvancedCompleteQueryRequest

CompletionService.AdvancedCompleteQuery 方法的请求消息。 。

字段
completion_config	string 必需。执行补全操作的父级 dataStore 或引擎资源名称的 completion_config，例如 projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig。
query	string 必需。用于提取建议的 typeahead 输入。长度上限为 128 个字符。 对于大多数建议类型，查询不能为空。如果为空，则返回 INVALID_ARGUMENT 错误。例外情况是，当 suggestion_types 仅包含 RECENT_SEARCH 类型时，查询可以为空字符串。此功能称为“零前缀”功能，可返回用户最近搜索过的查询（如果查询为空）。
query_model	string 指定自动补全查询模型，仅适用于 QUERY SuggestionType。此设置会替换 Cloud 控制台的“配置”>“自动补全”部分中指定的任何模型。目前支持的值： document - 使用根据用户导入的文档生成的建议。 search-history - 使用根据 SearchService.Search API 调用的过往历史记录生成的建议。如果 Search API 没有流量，请勿使用此功能。 user-event - 使用根据用户导入的搜索事件生成的建议。 document-completable - 使用直接从用户导入的标记为“可补全”的文档字段中提取的建议。 默认值： document 是常规数据存储区的默认模型。 search-history 是网站搜索数据存储区的默认模型。
user_pseudo_id	string 用于跟踪访问者的唯一标识符。例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录或退出网站，此唯一标识符不应发生变化。 此字段不应具有固定值，例如 unknown_visitor。 此标识符应与 UserEvent.user_pseudo_id 和 SearchRequest.user_pseudo_id 相同。 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符
user_info	UserInfo 可选。有关最终用户的信息。 此信息应与 UserEvent.user_info 和 SearchRequest.user_info 中的标识符信息相同。
include_tail_suggestions	bool 指示在没有与完整查询匹配的建议时是否应返回尾部建议。即使设置为 true，如果存在与完整查询匹配的建议，系统也会返回这些建议，而不会返回尾部建议。
boost_spec	BoostSpec 可选。用于提升符合条件的建议的规范。
suggestion_types[]	SuggestionType 可选。要返回的建议类型。如果为空或未指定，则返回搜索查询建议。目前仅支持一种建议类型。
suggestion_type_specs[]	SuggestionTypeSpec 可选。每种建议类型的规范。
experiment_ids[]	string 可选。相应请求的实验 ID。

BoostSpec

用于根据建议的条件提升建议的规范。

字段
condition_boost_specs[]	ConditionBoostSpec 条件加权规范。如果建议符合规范中的多个条件，则系统会应用并以非线性方式组合这些规范中的提升值。规格数量上限为 20。 注意：目前仅支持语言条件加权。

ConditionBoostSpec

加推适用于符合条件的建议。

字段
condition	string 用于指定加权条件的表达式。语法与过滤表达式语法相同。目前，唯一支持的条件是 BCP-47 语言代码列表。 示例： 如需提升 en 或 fr 语言的建议效果，请执行以下操作：(lang_code: ANY("en", "fr"))
boost	float 升位的强度，应介于 [-1, 1] 之间。设为负值代表降位。默认值为 0.0。 设置为 1.0 可大幅提升建议的排名。不过，这并不一定意味着最佳结果会是升位后的建议。 设置为 -1.0 会大幅降低建议的排名。不过，系统仍可能会显示其他相关建议。 设置为 0.0 表示不应用任何提升。系统会忽略提升条件。

SuggestionType

要返回的建议类型。

枚举
SUGGESTION_TYPE_UNSPECIFIED	默认值。
QUERY	返回查询建议。
PEOPLE	返回人员建议。
CONTENT	返回内容建议。
RECENT_SEARCH	返回最近的搜索建议。
GOOGLE_WORKSPACE	返回 Google Workspace 建议。

SuggestionTypeSpec

每种建议类型的规范。

字段
suggestion_type	SuggestionType 可选。建议类型。
max_suggestions	int32 可选。每种建议类型要返回的建议数量上限。

AdvancedCompleteQueryResponse

CompletionService.AdvancedCompleteQuery 方法的响应消息。

字段
query_suggestions[]	QuerySuggestion 匹配的查询建议的结果。结果列表已排序，第一个结果是热门建议。
tail_match_triggered	bool 如果返回的建议均为长尾建议，则为 True。 若要触发尾部匹配，请求中的 include_tail_suggestions 必须为 true，并且不得有与完整查询匹配的建议。
people_suggestions[]	PersonSuggestion 匹配的人员建议的结果。结果列表会按顺序排列，第一个结果是热门建议。
content_suggestions[]	ContentSuggestion 匹配内容建议的结果。结果列表会按顺序排列，第一个结果是热门建议。
recent_search_suggestions[]	RecentSearchSuggestion 匹配的“近期搜索”建议的结果。结果列表会按顺序排列，第一个结果是热门建议。

ContentSuggestion

建议作为内容。

字段
suggestion	string 查询的建议。
content_type	ContentType 内容建议的类型。
document	Document 建议中的文档数据片段。系统只会填充部分字段。
data_store	string 相应建议所属的数据存储区的名称。
score	double 每个建议的分数。得分介于 [0, 1] 范围内。
icon_uri	string 内容建议的图标 URI。
destination_uri	string 内容建议的目标 URI。

ContentType

针对内容建议返回的内容类型。

枚举
CONTENT_TYPE_UNSPECIFIED	默认值。
GOOGLE_WORKSPACE	建议来自 Google Workspace 来源。
THIRD_PARTY	建议来自第三方来源。

PersonSuggestion

建议的联系人。

字段
suggestion	string 查询的建议。
person_type	PersonType 人员的类型。
document	Document 建议中的文档数据片段。仅填充了部分字段。
data_store	string 相应建议所属的数据存储区的名称。
score	double 每个建议的分数。得分介于 [0, 1] 范围内。
display_photo_uri	string 联系人建议的照片 URI。
destination_uri	string 人员建议的目标 URI。

PersonType

基于来源的人员类型。

枚举
PERSON_TYPE_UNSPECIFIED	默认值。
CLOUD_IDENTITY	建议来自 GOOGLE_IDENTITY 源。
THIRD_PARTY_IDENTITY	建议来自 THIRD_PARTY_IDENTITY 源。

QuerySuggestion

以搜索查询的形式显示建议。

字段
suggestion	string 查询的建议。
completable_field_paths[]	string 如果建议是从可补全字段生成的，则作为此建议来源的唯一文档字段路径。 此字段仅针对可完成文档的模型进行填充。
data_store[]	string 相应建议所属的数据存储区的名称。
score	double 每个建议的分数。得分介于 [0, 1] 范围内。

RecentSearchSuggestion

根据近期搜索记录生成的建议。

字段
suggestion	string 查询的建议。
recent_search_time	Timestamp 最近一次重新归档的时间。
score	double 每个建议的分数。得分介于 [0, 1] 范围内。

AdvancedSiteSearchConfig

高级网站搜索的配置数据。

字段
disable_initial_index	bool 如果设置为 true，则为 DataStore 停用初始索引编制。
disable_automatic_refresh	bool 如果设置为 true，则会为 DataStore 停用自动刷新。

AlertPolicyConfig

连接器级提醒配置。

字段
alert_policy_name	string 不可变。AlertPolicy 的完全限定资源名称。
alert_enrollments[]	AlertEnrollment 可选。每项提醒的注册状态。

AlertEnrollment

提醒注册状态。

字段
alert_id	string 不可变。提醒的 ID。
enroll_state	EnrollStates 必需。客户的注册状态。

EnrollStates

相应提醒的注册状态枚举。

枚举
ENROLL_STATES_UNSPECIFIED	默认值。适用于未对提醒政策做出回应的客户。
ENROLLED	客户已注册此政策。
DECLINED	客户拒绝了此政策。

AlertPolicyResourceConfig

资源级提醒配置。使用位置：* UserLicense * EngineUserData 数据连接器中的 AlertPolicyConfig 用途相同。没有简单的迁移方法。

字段
alert_policy	string 不可变。AlertPolicy 的完全限定资源名称。
alert_enrollments[]	AlertEnrollment 可选。每项提醒的注册状态。
contact_details[]	ContactDetails 可选。每项提醒政策的联系人详细信息。
language_code	string 可选。用于通知的语言代码

AlertEnrollment

提醒注册状态。

字段
alert_id	string 不可变。提醒的 ID。
enroll_state	EnrollState 必需。客户的注册状态。
notification_params	map<string, string> 可选。用于实例化通知的参数。用于在注册时触发的通知。不存储。* Gemini Business 欢迎电子邮件。* Gemini Business 用户邀请电子邮件。

EnrollState

相应提醒的注册状态枚举。

枚举
ENROLL_STATE_UNSPECIFIED	默认值。适用于未对提醒政策做出回应的客户。
ENROLLED	客户已注册此政策。
DECLINED	客户拒绝了此政策。

AlloyDbSource

AlloyDB 源导入数据。

字段
project_id	string 包含 AlloyDB 源的项目 ID。长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
location_id	string 必需。要从中复制数据的 AlloyDB 位置，长度限制为 256 个字符。
cluster_id	string 必需。要从中复制数据的 AlloyDB 集群，长度限制为 256 个字符。
database_id	string 必需。要从中复制数据的 AlloyDB 数据库，长度限制为 256 个字符。
table_id	string 必需。要从中复制数据的 AlloyDB 表，长度限制为 256 个字符。
gcs_staging_dir	string 用于导入操作的中间 Cloud Storage 目录，长度限制为 2,000 个字符。如果要将 AlloyDB 内容导出至特定 Cloud Storage 目录，则可以指定。 确保 AlloyDB 服务账号具有必要的 Cloud Storage 管理员权限，以便访问指定的 Cloud Storage 目录。

答案

定义答案。

字段
name	string 不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state	State 答案生成的状态。
answer_text	string 文本答案。
citations[]	Citation 引用。
grounding_supports[]	GroundingSupport 可选。接地支持。
references[]	Reference 参考。
related_questions[]	string 建议的相关问题。
steps[]	Step 回答生成步骤。
query_understanding_info	QueryUnderstandingInfo 查询理解信息。
answer_skipped_reasons[]	AnswerSkippedReason 其他跳过回答的原因。这提供了忽略的案例的原因。如果未跳过任何内容，则不会设置此字段。
create_time	Timestamp 仅限输出。回答创建时间戳。
complete_time	Timestamp 仅限输出。回答完成时间戳。
safety_ratings[]	SafetyRating 可选。安全等级。
grounding_score	double 一个介于 [0, 1] 之间的分数，用于描述答案与参考块的关联程度。

AnswerSkippedReason

一个用于表示回答跳过原因的枚举。

枚举
ANSWER_SKIPPED_REASON_UNSPECIFIED	默认值。未指定跳过回答的原因。
ADVERSARIAL_QUERY_IGNORED	忽略了对抗性查询的案例。
NON_ANSWER_SEEKING_QUERY_IGNORED	不寻求答案的查询（不区分大小写） 如果查询是闲聊，Google 会跳过回答。
OUT_OF_DOMAIN_QUERY_IGNORED	网域外查询忽略了大小写。 如果没有高度相关的搜索结果，Google 会跳过回答。
POTENTIAL_POLICY_VIOLATION	可能违反政策的情况。 如果检测到潜在的违规情况，Google 会跳过回答。包括可能包含暴力或有害内容的内容。
NO_RELEVANT_CONTENT	无相关内容的情况。 如果检索到的搜索结果中没有相关内容，Google 会跳过回答。
JAIL_BREAKING_QUERY_IGNORED	越狱查询忽略了大小写。 例如，“以竞争对手公司 CEO 的语气回复”。如果查询被归类为越狱查询，Google 会跳过回答。
CUSTOMER_POLICY_VIOLATION	客户政策违规支持请求。 如果检测到违反客户政策的情况，Google 会跳过摘要。政策由客户定义。
NON_ANSWER_SEEKING_QUERY_IGNORED_V2	不寻求答案的查询（忽略大小写）。 如果查询没有明确的意图，Google 会跳过回答。
LOW_GROUNDED_ANSWER	低接地程度的回答示例。 如果无法生成有理有据的回答，Google 会跳过该回答。
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED	用户定义的查询分类（忽略大小写）。 如果查询被归类为用户定义的查询类别，Google 会跳过回答。
UNHELPFUL_ANSWER	无用回答示例。 如果答案无用，Google 会跳过该答案。这可能是由多种因素造成的，包括但不限于：问题无法回答、答案与问题无关，或者答案格式不正确。

引用

细分的引用信息。

字段
start_index	int64 索引表示分段的起始位置，以字节（UTF-8 Unicode）为单位。如果存在多字节字符（例如非 ASCII 字符），则索引测量值会大于字符串长度。
end_index	int64 归因区段的结束时间（不含）。以字节（UTF-8 Unicode）为单位。如果存在多字节字符（例如非 ASCII 字符），则索引测量值会大于字符串长度。
sources[]	CitationSource 归因细分的引用来源。

CitationSource

引用来源。

字段
reference_id	string 引用来源的 ID。

GroundingSupport

为 answer_text 中的声明提供事实依据支持。

字段
start_index	int64 必需。索引表示声明的起始位置，以字节（UTF-8 Unicode）为单位。
end_index	int64 必需。声明的结束时间（不含）。
sources[]	CitationSource 可选。相应声明的引用来源。
grounding_score	double 一个介于 [0, 1] 之间的分数，用于描述特定声明的依据程度。值越高，表示参考块对声明的支持程度越高。
grounding_check_required	bool 表示相应声明需要进行事实依据检查。如果系统认为此声明不需要归因/依据检查，则此字段设置为 false。在这种情况下，系统不会对声明进行事实依据检查，因此不会返回 grounding_score、sources。

QueryUnderstandingInfo

查询理解信息。

字段
query_classification_info[]	QueryClassificationInfo 查询分类信息。

QueryClassificationInfo

查询分类信息。

字段
type	Type 查询分类类型。
positive	bool 分类输出。

类型

查询分类类型。

枚举
TYPE_UNSPECIFIED	未指定查询分类类型。
ADVERSARIAL_QUERY	对抗性查询分类类型。
NON_ANSWER_SEEKING_QUERY	非寻求答案的查询分类类型，用于闲聊。
JAIL_BREAKING_QUERY	越狱查询分类类型。
NON_ANSWER_SEEKING_QUERY_V2	非寻求答案的查询分类类型，表示没有明确的意图。
USER_DEFINED_CLASSIFICATION_QUERY	用户定义的查询分类类型。

参考文档

参考。

字段
联合字段 content。搜索结果内容。content 只能是下列其中一项：
unstructured_document_info	UnstructuredDocumentInfo 非结构化文档信息。
chunk_info	ChunkInfo 分块信息。
structured_document_info	StructuredDocumentInfo 结构化文档信息。

ChunkInfo

分块信息。

字段
chunk	string 块资源名称。
content	string 块状文本内容。
document_metadata	DocumentMetadata 文档元数据。
relevance_score	float 相应块与给定查询的相关性。值范围为 0.0（完全不相关）到 1.0（完全相关）。此值仅供参考。由于模型重新训练或实现的更改，此值可能会根据同一查询和块随时更改。

DocumentMetadata

文档元数据。

字段
document	string 文档资源名称。
uri	string 相应文档的 URI。
title	string 标题。
page_identifier	string 网页标识符。
struct_data	Struct 文档的结构化 JSON 元数据。它会根据搜索结果中块的结构数据进行填充。

StructuredDocumentInfo

结构化搜索信息。

字段
document	string 文档资源名称。
struct_data	Struct 结构化搜索数据。
title	string 仅限输出。文档的标题。
uri	string 仅限输出。相应文档的 URI。

UnstructuredDocumentInfo

非结构化文档信息。

字段
document	string 文档资源名称。
uri	string 相应文档的 URI。
title	string 标题。
chunk_contents[]	ChunkContent 从文档内容派生的引用块内容列表。
struct_data	Struct 文档的结构化 JSON 元数据。它会根据搜索结果中块的结构数据进行填充。

ChunkContent

分块内容。

字段
content	string 块状文本内容。
page_identifier	string 网页标识符。
relevance_score	float 相应块与给定查询的相关性。值范围为 0.0（完全不相关）到 1.0（完全相关）。此值仅供参考。由于模型重新训练或实现的更改，此值可能会根据同一查询和块随时更改。

州

答案生成状态的枚举。

枚举
STATE_UNSPECIFIED	未知。
IN_PROGRESS	目前正在生成回答。
FAILED	目前无法生成回答。
SUCCEEDED	已成功生成答案。
STREAMING	目前正在生成回答。

步骤

步骤信息。

字段
state	State 相应步骤的状态。
description	string 相应步骤的说明。
thought	string 相应步骤的想法。
actions[]	Action 操作。

操作

操作。

字段
observation	Observation 观察。
联合字段 action。操作。action 只能是下列其中一项：
search_action	SearchAction 搜索操作。

观察

观察。

字段
search_results[]	SearchResult 搜索操作观察到的搜索结果，可以是摘要信息或块信息，具体取决于用户设置的引用类型。

SearchResult

字段
document	string 文档资源名称。
uri	string 相应文档的 URI。
title	string 标题。
snippet_info[]	SnippetInfo 如果 citation_type 为 DOCUMENT_LEVEL_CITATION，则填充文档级摘要。
chunk_info[]	ChunkInfo 如果 citation_type 为 CHUNK_LEVEL_CITATION 且启用了块模式，则填充块信息。
struct_data	Struct 数据表示法。相应文档的结构化 JSON 数据。它会根据文档或搜索结果中的块的结构化数据进行填充。

ChunkInfo

分块信息。

字段
chunk	string 块资源名称。
content	string 块状文本内容。
relevance_score	float 相应块与给定查询的相关性。值范围为 0.0（完全不相关）到 1.0（完全相关）。此值仅供参考。由于模型重新训练或实现的更改，此值可能会根据同一查询和块随时更改。

SnippetInfo

代码段信息。

字段
snippet	string 摘要内容。
snippet_status	string 由搜索团队定义的摘要的状态。

SearchAction

搜索操作。

字段
query	string 要搜索的查询。

州

相应步骤的状态枚举。

枚举
STATE_UNSPECIFIED	未知。
IN_PROGRESS	相应步骤目前正在进行中。
FAILED	相应步骤目前失败。
SUCCEEDED	相应步骤已成功完成。

AnswerGenerationSpec

答案生成规范。

字段
user_defined_classifier_spec	UserDefinedClassifierSpec 可选。用户指定分类器规范的规范。

UserDefinedClassifierSpec

用户定义分类器的规范。

字段
enable_user_defined_classifier	bool 可选。是否启用并包含用户定义的分类器。
preamble	string 可选。要用于用户定义的分类器的序言。
model_id	string 可选。要用于用户定义分类器的模型 ID。
task_marker	string 可选。要用于用户定义分类器的任务标记。
top_p	double 可选。要用于用户定义分类器的 top-p 值。
top_k	int64 可选。要用于用户定义分类器的 top-k 值。
temperature	double 可选。要用于用户定义分类器的温度值。
seed	int32 可选。要用于用户定义分类器的种子值。

AnswerQueryRequest

ConversationalSearchService.AnswerQuery 方法的请求消息。

字段
serving_config	string 必需。搜索服务配置的资源名称，例如 projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config 或 projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config。此字段用于标识服务配置名称，即用于执行搜索的一组模型。
query	Query 必需。当前用户查询。
session	string 会话资源名称。不需要。 如果未设置会话字段，则 API 处于无会话模式。 我们支持自动会话模式：用户可以使用通配符 - 作为会话 ID。系统会自动生成并分配新的 ID。
safety_spec	SafetySpec 模型规范。
related_questions_spec	RelatedQuestionsSpec 相关问题规范。
grounding_spec	GroundingSpec 可选。接地规范。
answer_generation_spec	AnswerGenerationSpec 回答生成规范。
search_spec	SearchSpec 搜索规范。
query_understanding_spec	QueryUnderstandingSpec 查询理解规范。
asynchronous_mode (deprecated)	bool 此项已弃用！ 已弃用：此字段已弃用。将支持 Streaming Answer API。 异步模式控制。 如果已启用，则返回的响应将包含回答/会话资源名称，但不包含最终答案。API 用户需要通过调用 ConversationalSearchService.GetAnswer 或 ConversationalSearchService.GetSession 方法进行轮询，以获取回答/会话的最新状态。
user_pseudo_id	string 用于跟踪访问者的唯一标识符。例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录或退出网站，此唯一标识符不应发生变化。 此字段不应具有固定值，例如 unknown_visitor。 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅 Google Cloud 文档。
end_user_spec	EndUserSpec 可选。最终用户规范。

AnswerGenerationSpec

回答生成规范。

字段
model_spec	ModelSpec 回答生成模型规范。
prompt_spec	PromptSpec 回答生成提示规范。
include_citations	bool 指定是否在回答中包含引用元数据。默认值为 false。
answer_language_code	string 回答的语言代码。使用 BCP47 定义的语言标记。注意：这是一项实验性功能。
ignore_adversarial_query	bool 指定是否过滤掉对抗性查询。默认值为 false。 Google 采用搜索查询分类来检测对抗性查询。如果搜索查询被归类为对抗性查询，则不会返回任何答案。例如，用户可能会询问有关公司负面评论的问题，或者提交旨在生成不安全且违反政策的输出内容的查询。如果此字段设置为 true，我们会跳过为对抗性查询生成答案，而是返回回退消息。
ignore_non_answer_seeking_query	bool 指定是否过滤掉非寻求答案的查询。默认值为 false。 Google 会采用搜索查询分类来检测寻求答案的查询。如果搜索查询被归类为非答案寻求型查询，则不会返回任何答案。如果此字段设置为 true，我们会跳过为非寻求答案的查询生成答案，而是返回回退消息。
ignore_jail_breaking_query	bool 可选。指定是否过滤掉越狱查询。默认值为 false。 Google 采用搜索查询分类来检测越狱查询。如果搜索查询被归类为越狱查询，则不会返回摘要。用户可能会在查询中添加指令，以更改回答的语气、风格、语言、内容，或要求模型扮演其他实体，例如“以竞争对手公司 CEO 的语气回答”。如果此字段设置为 true，我们会跳过为越狱查询生成摘要，而是返回回退消息。
ignore_low_relevant_content	bool 指定是否过滤掉相关性较低的查询。 如果此字段设置为 false，则无论搜索结果的相关性如何，都会使用所有搜索结果来生成答案。如果设置为 true 或未设置，行为将由服务自动确定。

ModelSpec

回答生成模型规范。

字段
model_version	string 模型版本。如果未设置，则使用默认的稳定模型。允许的值包括：stable、preview。

PromptSpec

回答生成提示规范。

字段
preamble	string 自定义序言。

EndUserSpec

最终用户规范。

字段
end_user_metadata[]	EndUserMetaData 可选。最终用户元数据。

EndUserMetaData

最终用户元数据。

字段
联合字段 content。搜索结果内容。content 只能是下列其中一项：
chunk_info	ChunkInfo 分块信息。

ChunkInfo

分块信息。

字段
content	string 块状文本内容。不得超过 8000 个字符。
document_metadata	DocumentMetadata 当前块中相应文档的元数据。

DocumentMetadata

文档元数据包含当前块的文档信息。

字段
title	string 文档的标题。

GroundingSpec

接地规范。

字段
include_grounding_supports	bool 可选。指定是否在回答中包含 grounding_supports。默认值为 false。 当此字段设置为 true 时，返回的答案将具有 grounding_score，并且将包含每个声明的 GroundingSupports。
filtering_level	FilteringLevel 可选。指定是否启用基于事实依据得分的过滤功能，以及在哪一级别启用。

FilteringLevel

根据回答依据进行过滤的级别。

枚举
FILTERING_LEVEL_UNSPECIFIED	默认情况下不设置过滤条件
FILTERING_LEVEL_LOW	根据较低的阈值过滤答案。
FILTERING_LEVEL_HIGH	根据高阈值过滤答案。

QueryUnderstandingSpec

查询理解规范。

字段
query_classification_spec	QueryClassificationSpec 查询分类规范。
query_rephraser_spec	QueryRephraserSpec 查询改述器规范。
disable_spell_correction	bool 可选。是否停用拼写检查。默认值为 false。

QueryClassificationSpec

查询分类规范。

字段
types[]	Type 已启用查询分类类型。

类型

查询分类类型。

枚举
TYPE_UNSPECIFIED	未指定查询分类类型。
ADVERSARIAL_QUERY	对抗性查询分类类型。
NON_ANSWER_SEEKING_QUERY	非寻求答案的查询分类类型，用于闲聊。
JAIL_BREAKING_QUERY	越狱查询分类类型。
NON_ANSWER_SEEKING_QUERY_V2	非寻求答案的查询分类类型，表示没有明确的意图。
USER_DEFINED_CLASSIFICATION_QUERY	用户定义的查询分类类型。

QueryRephraserSpec

查询改述器规范。

字段
disable	bool 停用查询改写器。
max_rephrase_steps	int32 重新表述步骤数上限。最多 5 个步骤。如果未设置或设置为小于 1 的值，则默认设置为 1。
model_spec	ModelSpec 可选。查询改述器模型规范。

ModelSpec

查询改述器模型规范。

字段
model_type	ModelType 可选。已启用查询改述器模型类型。如果未设置，则默认使用 LARGE。

ModelType

查询重述器类型。目前仅支持单跳 (max_rephrase_steps = 1) 模型选择。对于多跳（max_rephrase_steps > 1），只有一个默认模型。

枚举
MODEL_TYPE_UNSPECIFIED	未指定模型类型。
SMALL	小型查询重述模型。Gemini 1.0 XS 模型。
LARGE	大型查询改述模型。Gemini 1.0 Pro 模型。

RelatedQuestionsSpec

相关问题规范。

字段
enable	bool 如果为 true，则启用相关问题功能。

SafetySpec

安全规范。有两种使用情形：1. 仅设置了 safety_spec.enable 时，系统将为所有类别应用 BLOCK_LOW_AND_ABOVE 阈值。2. 当设置了 safety_spec.enable 且设置了部分 safety_settings 时，仅应用指定的 safety_settings。

字段
enable	bool 在回答响应中启用安全过滤。默认值为 false。
safety_settings[]	SafetySetting 可选。安全设置。只有当 safety_spec.enable 为 true 时，此设置才有效。

SafetySetting

安全设置。

字段
category	HarmCategory 必需。危害类别。
threshold	HarmBlockThreshold 必需。有害内容屏蔽阈值。

HarmBlockThreshold

用于屏蔽的基于概率的阈值级别。

枚举
HARM_BLOCK_THRESHOLD_UNSPECIFIED	未指定的有害屏蔽阈值。
BLOCK_LOW_AND_ABOVE	屏蔽低阈值及以上的内容（即屏蔽较多的内容）。
BLOCK_MEDIUM_AND_ABOVE	屏蔽中等阈值及以上。
BLOCK_ONLY_HIGH	仅屏蔽高阈值内容（即屏蔽较少的内容）。
BLOCK_NONE	全部不屏蔽。
OFF	关闭安全过滤条件。

SearchSpec

搜索规范。

字段
联合字段 input。用于控制搜索行为的搜索参数。或者提供搜索结果列表以生成答案。input 只能是下列其中一项：
search_params	SearchParams 搜索参数。
search_result_list	SearchResultList 搜索结果列表。

SearchParams

搜索参数。

字段
max_return_results	int32 要返回的搜索结果数。默认值为 10。
filter	string 过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。此参数将用于过滤搜索结果，可能会影响回答响应。 如果此字段无法识别，则返回 INVALID_ARGUMENT。 Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“name”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")' 如需详细了解过滤（包括语法和过滤运算符），请参阅过滤
boost_spec	BoostSpec 提升规范，以提升搜索结果中某些文档的排名，这可能会影响回答查询响应。如需详细了解热推，请参阅热推
order_by	string 返回文档的顺序。可以按 Document 对象中的字段对文档进行排序。如果按相关性排序，则将其留空。order_by 表达式区分大小写。如需详细了解排序，请参阅排序 如果此字段无法识别，则返回 INVALID_ARGUMENT。
search_result_mode	SearchResultMode 指定搜索结果模式。如果未指定，搜索结果模式默认为 DOCUMENTS。请参阅解析和分块文档
data_store_specs[]	DataStoreSpec 用于定义在搜索调用中要过滤的数据存储区以及这些数据存储区的配置。仅在引擎具有多个 dataStore 的使用情形下考虑此参数。对于引擎中的单个 dataStore，它们应使用顶层的规范。

SearchResultList

搜索结果列表。

字段
search_results[]	SearchResult 搜索结果。

SearchResult

搜索结果。

字段
联合字段 content。搜索结果内容。content 只能是下列其中一项：
unstructured_document_info	UnstructuredDocumentInfo 非结构化文档信息。
chunk_info	ChunkInfo 分块信息。

ChunkInfo

分块信息。

字段
chunk	string 块资源名称。
content	string 块状文本内容。
document_metadata	DocumentMetadata 当前块中相应文档的元数据。

DocumentMetadata

文档元数据包含当前块的文档信息。

字段
uri	string 文档的 URI。
title	string 文档的标题。

UnstructuredDocumentInfo

非结构化文档信息。

字段
document	string 文档资源名称。
uri	string 相应文档的 URI。
title	string 标题。
document_contexts[]	DocumentContext 文档上下文列表。该内容将用于生成回答。这应该是文档的主要内容，可以很长且很全面。
extractive_segments[]	ExtractiveSegment 提取式细分列表。
extractive_answers[] (deprecated)	ExtractiveAnswer 此项已弃用！ 已弃用：此字段已弃用，不会对答案生成产生任何影响。请改用 document_contexts 和 extractive_segments 字段。抽样答案列表。

DocumentContext

文档上下文。

字段
page_identifier	string 网页标识符。
content	string 用于生成答案的文档内容。

ExtractiveAnswer

提取式回答。指南

字段
page_identifier	string 网页标识符。
content	string 提取式答案内容。

ExtractiveSegment

提取式片段。指南：仅当 document_contexts 为空时，回答生成才会使用它。这应该是较短的摘要。

字段
page_identifier	string 网页标识符。
content	string 提取式片段内容。

AnswerQueryResponse

ConversationalSearchService.AnswerQuery 方法的响应消息。

字段
answer	Answer 回答资源对象。如果 AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps 大于 1，请使用 Answer.name 通过 ConversationalSearchService.GetAnswer API 获取回答信息。
session	Session 会话资源对象。仅当 AnswerQueryRequest 请求中设置了会话字段且该字段有效时，此字段才可用。
answer_query_token	string 用于日志记录的全局唯一 ID。

AssistAnswer

AssistAnswer 资源，AssistResponse 的主要组成部分。

字段
name	string 不可变。标识符。AssistAnswer 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
state	State 答案生成的状态。
replies[]	Reply 助理的回答。
assist_skipped_reasons[]	AssistSkippedReason 未接听辅助通话的原因。
customer_policy_enforcement_result	CustomerPolicyEnforcementResult 可选。该字段包含有关各种政策检查结果的信息，例如违禁短语或 Model Armor 检查。仅当因违反政策而跳过辅助通话时，系统才会填充此字段。

AssistSkippedReason

未接听辅助通话的可能原因。

枚举
ASSIST_SKIPPED_REASON_UNSPECIFIED	默认值。未指定跳过原因。
NON_ASSIST_SEEKING_QUERY_IGNORED	助理忽略了查询，因为该查询似乎不是在寻求答案。
CUSTOMER_POLICY_VIOLATION	由于违反了客户政策（例如，查询或回答中包含禁用短语），助理忽略了查询或拒绝回答。

CustomerPolicyEnforcementResult

客户政策执行结果。包含各种政策检查的结果，例如违禁短语或 Model Armor 检查。

字段
verdict	Verdict 客户政策违规处置的最终判决。如果只有一项政策阻止了处理，则判决为“阻止”。
policy_results[]	PolicyEnforcementResult 客户政策执行结果。仅当因违反政策而跳过辅助调用时填充。它包含阻止查询处理的过滤条件的结果。

BannedPhraseEnforcementResult

针对违禁短语政策的客户政策执行结果。

字段
banned_phrases[]	string 查询或回答中发现的违禁短语。

ModelArmorEnforcementResult

Model Armor 政策的客户政策强制执行结果。

字段
联合字段 result。Model Armor 政策结果。result 只能是下列其中一项：
model_armor_violation	string 发现的 Model Armor 违规行为。
error	Status 如果政策强制执行因某种原因而失败，Model Armor 返回的错误。

PolicyEnforcementResult

单个政策类型的客户政策执行结果。

字段
联合字段 enforcement_result。特定政策类型的结果。可以是错误，也可以是有关政策违规处置结果的详细信息。enforcement_result 只能是下列其中一项：
banned_phrase_enforcement_result	BannedPhraseEnforcementResult 禁止用语政策的政策执行结果。
model_armor_enforcement_result	ModelArmorEnforcementResult Model Armor 政策的政策强制执行结果。

判定

客户政策违规处置的判决。

枚举
UNSPECIFIED	未知值。
ALLOW	没有违反政策。
BLOCK	处理因违反客户政策而被阻止。

回复

辅助调用多部分响应的一部分。

字段
联合字段 reply。助理回答的替代方案。reply 只能是下列其中一项：
grounded_content	AssistantGroundedContent 助理可能提供的接地回答文本或媒体。

州

答案生成的状态。

枚举
STATE_UNSPECIFIED	未知。
IN_PROGRESS	辅助操作正在进行中。
FAILED	辅助操作失败。
SUCCEEDED	辅助操作已成功完成。
SKIPPED	已跳过辅助操作。

AssistRequest

针对 AssistantService.Assist 方法的请求。

字段
name	string 必需。Assistant 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
query	Query 可选。当前用户查询。 仅当提供 file_ids 时才支持空查询。在这种情况下，系统会根据这些上下文文件生成回答。
session	string 可选。用于请求的会话。如果指定了此参数，助理可以访问对话记录，并且查询和回答会存储在对话记录中。 如果将 - 指定为会话 ID，或将其留空，系统会创建一个新会话并自动生成 ID。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assist_skipping_mode	AssistSkippingMode 可选。确定助理不会回答查询的情况。如果跳过回答，原因将列在 AssistResponse.answer 中的 AssistAnswer.assist_skipped_reasons 内。
file_ids[]	string 可选。用于回答请求的文件 ID。上传文件时，其 ID 会在 AddContextFileResponse.file_id 中返回。
user_metadata	AssistUserMetadata 可选。发起查询的用户的相关信息。

AssistSkippingMode

辅助请求可用的跳过行为。

枚举
ASSIST_SKIPPING_MODE_UNSPECIFIED	默认值。如果查询不是寻求帮助，则可以跳过回答。
REQUEST_ASSIST	请求 Google 助理回答。如果查询未通过政策检查，系统仍可能会跳过回答。

AssistResponse

对 AssistantService.Assist 方法的响应。

字段
answer	AssistAnswer 针对查询生成的 AssistAnswer 资源。
session_info	SessionInfo 会话信息。
assist_token	string 用于标识当前请求-响应对的全局唯一 ID。用于反馈和支持。

SessionInfo

有关会话的信息。

字段
session	string 新生成的会话或继续的会话的名称。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
query_id	string 与此辅助 API 调用对应的查询 ID。一个会话可以包含多个对话轮次，每个对话轮次都有一个唯一的查询 ID。 通过在 Assist API 调用中指定会话名称和此查询 ID，辅助请求会在相应搜索调用的搜索结果上下文中进行。

AssistUserMetadata

请求的用户元数据。

字段
time_zone	string 可选。IANA 时区，例如 Europe/Budapest。
preferred_language_code	string 可选。如果语言检测失败，用于回答的首选语言。还用作操作创建的错误消息的语言，无论语言检测结果如何。

Google 助理

Discovery Engine Assistant 资源。

字段
name	string 不可变。助理的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 它必须是采用 UTF-8 编码的字符串，长度限制为 1024 个字符。
display_name	string 必需。助理的显示名称。 必须是采用 UTF-8 编码的字符串，长度限制为 128 个字符。
description	string 可选。其他信息的说明。预计会显示在配置界面上，而不是显示给助理的用户。
generation_config	GenerationConfig 可选。用于生成助理回答的配置。
google_search_grounding_enabled (deprecated)	bool 此项已弃用！ 可选。已弃用。请改用 web_grounding_type。
web_grounding_type	WebGroundingType 可选。要使用的网页接地类型。
enabled_actions (deprecated)	map<string, ActionList> 此项已弃用！ 可选。已弃用：将改为使用 enabled_tools。相应助理上已启用的操作。键是连接器名称，例如“projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector”。值包含针对连接器实例的管理员启用操作。管理员可以选择性地针对其在项目中创建的任何连接器实例启用多项操作。例如 {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabled_tools	map<string, ToolList> 可选。注意：尚未实现。请改用 enabled_actions。相应助理上已启用的工具。键是连接器名称，例如“projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector”。值包含针对连接器实例的管理员启用工具。管理员可以选择性地在项目中创建的任何连接器实例上启用多个工具。例如 {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customer_policy	CustomerPolicy 可选。Google 助理的客户政策。

ActionInfo

此项已弃用！

已弃用：将替换为 ToolInfo。用于标识操作的信息。

字段
action_name	string 由 DataConnectorService.QueryAvailableActions 定义的操作的名称。
action_display_name	string 操作的显示名称。

ActionList

此项已弃用！

已弃用：将替换为 ToolList。连接器上已启用的操作

字段
action_info[]	ActionInfo 包含相应操作信息的行动列表。

CustomerPolicy

客户为助理定义的政策。

字段
banned_phrases[]	BannedPhrase 可选。禁用短语列表。
model_armor_config	ModelArmorConfig 可选。用于清理用户提示和助理回答的 Model Armor 配置。

BannedPhrase

客户自定义的违禁短语的定义。用户查询或 LLM 回答中不得出现违禁短语，否则系统会拒绝回答。

字段
phrase	string 必需。要禁止的原始字符串内容。
match_type	BannedPhraseMatchType 可选。违禁短语的匹配类型。
ignore_diacritics	bool 可选。如果值为 true，则在匹配违禁短语时忽略变音符号（例如，重音符号、元音变音）。例如，“cafe”会与“café”匹配。

BannedPhraseMatchType

禁用短语的匹配方法。

枚举
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED	默认值为 SIMPLE_STRING_MATCH。
SIMPLE_STRING_MATCH	如果禁止的短语作为确切的子字符串出现在文本中的任何位置，则匹配成功。
WORD_BOUNDARY_STRING_MATCH	只有当文本中找到的模式被字词分隔符包围时，禁止使用的短语才会匹配。词组本身可能仍包含字词分隔符。

ModelArmorConfig

客户定义的 Model Armor 模板的配置，用于清理用户提示和助理回答。

字段
user_prompt_template	string 可选。用于清理用户提示的 Model Armor 模板的资源名称。格式：projects/{project}/locations/{location}/templates/{template_id} 如果未指定，则不会对用户提示进行清理。
response_template	string 可选。用于清理助理回答的 Model Armor 模板的资源名称。格式：projects/{project}/locations/{location}/templates/{template_id} 如果未指定，则不会对 Google 助理的回答进行清理。
failure_mode	FailureMode 可选。定义 Model Armor 清理的失败模式。

FailureMode

确定 Model Armor 无法处理请求时的行为。

枚举
FAILURE_MODE_UNSPECIFIED	未指定的故障模式，默认行为为 FAIL_CLOSED。
FAIL_OPEN	如果 Model Armor 处理失败，允许继续执行该请求，而无需进行任何更改。
FAIL_CLOSED	如果 Model Armor 处理失败，则拒绝该请求。

GenerationConfig

用于生成助理回答的配置。

字段
system_instruction	SystemInstruction 系统指令，也称为 LLM 调用的提示序言。另请参阅 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions
default_language	string 用于生成助理回答的默认语言。使用 ISO 639-1 语言代码，例如 en。如果未指定，系统将自动检测语言。

SystemInstruction

系统指令，也称为 LLM 调用的提示序言。

字段
additional_system_instruction	string 可选。将添加到默认系统指令的其他系统指令。

ToolInfo

用于标识工具的信息。

字段
tool_name	string 工具的名称，由 DataConnectorService.QueryAvailableActions 定义。注意：DataConnectorService API 中使用的是 action，但它们与此处的 tool 相同。
tool_display_name	string 工具的显示名称。

ToolList

连接器上已启用的工具

字段
tool_info[]	ToolInfo 包含相应工具信息的工具列表。

WebGroundingType

要使用的网页接地类型。

枚举
WEB_GROUNDING_TYPE_UNSPECIFIED	默认的未指定设置。这与“已停用”相同。
WEB_GROUNDING_TYPE_DISABLED	网页接地已停用。
WEB_GROUNDING_TYPE_GOOGLE_SEARCH	“依托 Google 搜索进行接地”已启用。
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH	已启用依托企业网络搜索的接地功能。

AssistantContent

多模态内容。

字段
role	string 内容的制作方。可以是“model”或“user”。
thought	bool 可选。表示相应部分是否由模型生成。
联合字段 data。包含的数据。data 只能是下列其中一项：
text	string 内嵌文本。
inline_data	Blob 内嵌二进制数据。
file	File 文件，例如音频摘要。
executable_code	ExecutableCode 模型生成的旨在执行的代码。
code_execution_result	CodeExecutionResult 执行 ExecutableCode 的结果。

Blob

内嵌 blob。

字段
mime_type	string 必需。生成的数据的媒体类型 (MIME 类型)。
data	bytes 必需。原始字节。

CodeExecutionResult

执行 ExecutableCode 的结果。

字段
outcome	Outcome 必需。代码执行结果。
output	string 可选。如果代码执行成功，则包含 stdout；否则包含 stderr 或其他说明。

结果

代码执行的可能结果的枚举。

枚举
OUTCOME_UNSPECIFIED	未指定状态。请勿使用此值。
OUTCOME_OK	代码已成功执行完毕。
OUTCOME_FAILED	代码执行完毕，但失败了。stderr 应包含原因。
OUTCOME_DEADLINE_EXCEEDED	代码执行时间过长，已被取消。可能存在部分输出，也可能不存在。

ExecutableCode

由模型生成且旨在由模型执行的代码。

字段
code	string 必需。代码内容。目前仅支持 Python。

文件

文件，例如音频摘要。

字段
mime_type	string 必需。文件的媒体类型 (MIME 类型)。
file_id	string 必需。文件 ID。

AssistantGroundedContent

一段内容，可能还包括其依据信息。

并非所有内容都需要接地。“当然，我很乐意为您搜索。”之类的短语不需要接地。

字段
content	AssistantContent 内容。
citation_metadata	CitationMetadata 生成内容的来源提供方信息。另请参阅 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
content_metadata	ContentMetadata 可选。内容的元数据。目前仅用于研究助理的回答。
联合字段 metadata。各种模态的 grounding 元数据。目前仅支持文本。metadata 只能是下列其中一项：
text_grounding_metadata	TextGroundingMetadata 基于文本来源的依据的元数据。

ContentMetadata

内容的元数据。

字段
content_kind	ContentKind 内容的类型。显示相应内容属于研究助理回答的哪个部分。
content_id	string 内容的 ID。用于将研究问题与答案相关联。例如，研究问题的答案的各个部分将与问题具有相同的 content_id。

ContentKind

可能的内容种类。目前仅用于区分研究助理完整回答中的各个部分。

枚举
CONTENT_KIND_UNSPECIFIED	未知。
RESEARCH_PLAN	研究计划。
RESEARCH_QUESTION	研究问题。
RESEARCH_ANSWER	研究回答。
RESEARCH_REPORT	研究报告。
RESEARCH_AUDIO_SUMMARY	研究音频摘要。

TextGroundingMetadata

文本来源的依据详细信息。

字段
segments[]	Segment 文本部分的基础信息。
references[]	Reference 已接地文本的参考信息。

参考文档

参考内容和相关文档元数据。

字段
content	string 参考文本内容。
document_metadata	DocumentMetadata 文档元数据。

DocumentMetadata

文档元数据。

字段
document	string 文档资源名称。
uri	string 相应文档的 URI。它可能包含重定向到实际网站的网址。
title	string 标题。
page_identifier	string 网页标识符。
domain	string 文档 URI 中的域名。请注意，uri 字段可能包含重定向到实际网站的网址，在这种情况下，该字段将包含目标网站的域名。
mime_type	string 文档的 MIME 类型。https://www.iana.org/assignments/media-types/media-types.xhtml。

细分

文本段的接地信息。

字段
start_index	int64 从零开始的索引，用于指示分段的起始位置，以 UTF-8 字符串的字节数来衡量（即，以多个字节编码的字符的长度大于 1）。
end_index	int64 分段的结束时间（不含）。
reference_indices[]	int32 细分的参考资料。
grounding_score	float 细分的得分。
text	string 文本段本身。

BAPConfig

BAP 连接器的配置。

字段
supported_connector_modes[]	ConnectorMode 必需。关联的 BAP 连接支持的连接器模式。
enabled_actions[]	string 可选。关联的 BAP 连接上启用的操作。

ConnectorMode

此 BAP 连接器支持的用例。

枚举
CONNECTOR_MODE_UNSPECIFIED	未指定连接器模式。
DATA_INGESTION	用于数据注入的连接器。
ACTIONS	用于操作的连接器
END_USER_AUTHENTICATION	用于最终用户身份验证的连接器。

BatchCreateTargetSiteMetadata

与 SiteSearchEngineService.BatchCreateTargetSites 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

BatchCreateTargetSitesRequest

SiteSearchEngineService.BatchCreateTargetSites 方法的请求消息。

字段
parent	string 必需。所有正在创建的 TargetSite 共享的父资源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。CreateBookRequest 消息中的父字段必须为空或与此字段匹配。
requests[]	CreateTargetSiteRequest 必需。指定要创建的资源的请求消息。一个批次最多可以创建 20 个 TargetSite。

BatchCreateTargetSitesResponse

SiteSearchEngineService.BatchCreateTargetSites 方法的响应消息。

字段
target_sites[]	TargetSite 已创建 TargetSites。

BatchGetDocumentsMetadataRequest

DocumentService.BatchGetDocumentsMetadata 方法的请求消息。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。
matcher	Matcher 必需。Document 的匹配器。

FhirMatcher

按 FHIR 资源名称匹配 Document 的匹配器。

字段
fhir_resources[]	string 必需。要匹配的 FHIR 资源。格式：projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Document 的匹配器。目前支持按确切 URI 进行匹配。

字段
联合字段 matcher。Document 的匹配器。matcher 只能是下列其中一项：
uris_matcher	UrisMatcher 按确切 URI 进行匹配的匹配器。
fhir_matcher	FhirMatcher 按 FHIR 资源名称进行匹配。

UrisMatcher

按确切 URI 匹配 Document 的匹配器。

字段
uris[]	string 要匹配的确切 URI。

BatchGetDocumentsMetadataResponse

DocumentService.BatchGetDocumentsMetadata 方法的响应消息。

字段
documents_metadata[]	DocumentMetadata Document 的元数据。

DocumentMetadata

Document 的元数据。

字段
matcher_value	MatcherValue 用于匹配 Document 的匹配器的值。
state	State 相应文档的状态。
last_refreshed_time	Timestamp Document上次编入索引时的时间戳。
data_ingestion_source	string Document 的数据注入源。 允许的值为： batch：通过 Batch API 提取的数据，例如 ImportDocuments。 streaming 通过 Streaming API 提取的数据，例如FHIR 流式传输。

MatcherValue

用于匹配 Document 的匹配器的值。

字段
联合字段 matcher_value。用于匹配 Document 的匹配器的值。matcher_value 只能是下列其中一项：
uri	string 如果按 URI 匹配，则为 Document 的 URI。
fhir_resource	string 格式：projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

州

Document 的状态。

枚举
STATE_UNSPECIFIED	切勿设置。
INDEXED	Document 已编入索引。
NOT_IN_TARGET_SITE	由于 Document 的 URI 不在 TargetSite 中，因此系统不会为其编制索引。
NOT_IN_INDEX	“Document”未编入索引。

BatchUpdateUserLicensesMetadata

与 UserLicenseService.BatchUpdateUserLicenses 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 成功更新的用户许可数。
failure_count	int64 未能成功更新的用户许可数量。

BatchUpdateUserLicensesRequest

UserLicenseService.BatchUpdateUserLicenses 方法的请求消息。

字段
parent	string 必需。父 [UserStore][] 资源名称，格式为：projects/{project}/locations/{location}/userStores/{user_store_id}。
delete_unassigned_user_licenses	bool 可选。如果为 true，则当用户许可移除关联的许可配置时，系统会删除该用户许可。默认值为 false，表示用户许可将更新为未分配状态。
联合字段 source。必需。输入的来源。source 只能是下列其中一项：
inline_source	InlineSource 文档嵌入的输入内容的内嵌来源。

InlineSource

BatchUpdateUserLicenses 方法的输入配置的内嵌来源。

字段
user_licenses[]	UserLicense 必需。要更新的用户许可的列表。每个用户许可都必须具有有效的 UserLicense.user_principal。
update_mask	FieldMask 可选。要更新的字段列表。

BatchUpdateUserLicensesResponse

UserLicenseService.BatchUpdateUserLicenses 方法的响应消息。

字段
user_licenses[]	UserLicense 已成功更新 UserLicenses。
error_samples[]	Status 处理请求时遇到的错误示例。

BatchVerifyTargetSitesMetadata

与 SiteSearchEngineService.BatchVerifyTargetSites 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

BatchVerifyTargetSitesRequest

SiteSearchEngineService.BatchVerifyTargetSites 方法的请求消息。

字段
parent	string 必需。所有待验证 TargetSite 共享的父资源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

BatchVerifyTargetSitesResponse

此类型没有字段。

SiteSearchEngineService.BatchVerifyTargetSites 方法的响应消息。

BigQuerySource

BigQuery 源导入数据。

字段
project_id	string 包含 BigQuery 源的项目 ID 或项目编号。长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
dataset_id	string 必需。要从中复制数据的 BigQuery 数据集，长度限制为 1,024 个字符。
table_id	string 必需。要从中复制数据的 BigQuery 表，长度限制为 1,024 个字符。
gcs_staging_dir	string 用于导入操作的中间 Cloud Storage 目录，长度限制为 2,000 个字符。如果要将 BigQuery 内容导出至特定 Cloud Storage 目录，则可以指定。
data_schema	string 从来源解析数据时要使用的架构。 支持的用户事件导入值： user_event（默认）：每行一个 UserEvent。 支持的文档导入值： document（默认）：每行一个 Document 格式。每个文档都必须具有有效的 Document.id 以及 Document.json_data 或 Document.struct_data。 custom：每行一条自定义数据，格式任意，但要符合数据存储区的 Schema 定义。此功能只能由“宽泛”数据存储区垂直行业使用。
联合字段 partition。BigQuery 表分区信息。如果 BigQuery 表未分区，请将此字段留空。partition 只能是下列其中一项：
partition_date	Date BigQuery 时间分区表的 _PARTITIONDATE，采用 YYYY-MM-DD 格式。

BigtableOptions

包含支持导入的信息的 Bigtable Options 对象。

字段
key_field_name	string 用于在文档中保存行键值的字段名称。名称必须与模式 [a-zA-Z0-9][a-zA-Z0-9-_]* 匹配。
families	map<string, BigtableColumnFamily> 从列族名称到包含给定列族的列族级信息的对象的映射。如果此映射中不存在某个家庭，系统会忽略该家庭。

BigtableColumn

Bigtable 的列。

字段
qualifier	bytes 必需。列的限定符。如果无法使用 utf-8 进行解码，请改用 base-64 编码的字符串。
field_name	string 要在文档中用于此列的字段名称。名称必须与模式 [a-zA-Z0-9][a-zA-Z0-9-_]* 匹配。如果未设置，系统会尽最大努力从限定符字节中解析该值。不过，由于命名模式不同，可能会发生字段名称冲突，导致解析行为不确定。
encoding	Encoding 当类型不是 STRING 时，值的编码模式。可接受的编码值包括： TEXT：表示值是字母数字文本字符串。 BINARY：表示值是使用 HBase Bytes.toBytes 系列函数进行编码的。您可以在 columns 中列出特定列并为其指定编码，以覆盖此设置。
type	Type 相应列族中的值类型。如果将编码值设置为 BINARY，则预期使用 HBase Bytes.toBytes 函数对值进行编码。

BigtableColumnFamily

Bigtable 的列族。

字段
field_name	string 要在文档中用于相应列族的字段名称。名称必须与模式 [a-zA-Z0-9][a-zA-Z0-9-_]* 匹配。如果未设置，系统会尽最大努力从字体族名称中解析出该值。不过，由于命名模式不同，可能会发生字段名称冲突，导致解析行为不确定。
encoding	Encoding 当类型不是 STRING 时，值的编码模式。可接受的编码值包括： TEXT：表示值是字母数字文本字符串。 BINARY：表示值是使用 HBase Bytes.toBytes 系列函数进行编码的。您可以在 columns 中列出特定列并为其指定编码，以覆盖此设置。
type	Type 相应列族中的值类型。如果将编码值设置为 BINARY，则预期使用 HBase Bytes.toBytes 函数对值进行编码。
columns[]	BigtableColumn 包含每个列的列级信息的对象列表。如果某个列未在此列表中，则会被忽略。

编码

Bigtable 列或列族的编码模式。

枚举
ENCODING_UNSPECIFIED	未指定编码。
TEXT	文本编码。
BINARY	二进制编码。

类型

Bigtable 列或列族中的值类型。如果将编码值设置为 BINARY，则预期这些值会使用 HBase Bytes.toBytes 函数进行编码。

枚举
TYPE_UNSPECIFIED	类型未指定。
STRING	字符串类型。
NUMBER	数值类型。
INTEGER	整数类型。
VAR_INTEGER	可变长度整数类型。
BIG_NUMERIC	BigDecimal 类型。
BOOLEAN	布尔值类型。
JSON	JSON 类型。

BigtableSource

用于导入数据的 Cloud Bigtable 来源。

字段
project_id	string 包含 Bigtable 源的项目 ID。长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
instance_id	string 必需。需要导入的 Cloud Bigtable 的实例 ID。
table_id	string 必需。需要导入的 Cloud Bigtable 的表 ID。
bigtable_options	BigtableOptions 必需。包含将数据解析为类型化结构时所需信息的 Bigtable 选项。例如，列类型注释。

CheckGroundingRequest

GroundedGenerationService.CheckGrounding 方法的请求消息。

字段
grounding_config	string 必需。基础配置的资源名称，例如 projects/*/locations/global/groundingConfigs/default_grounding_config。
answer_candidate	string 要检查的候选答案。长度上限为 4096 个令牌。
facts[]	GroundingFact 用于事实依据检查的事实列表。我们最多支持 200 个事实。
grounding_spec	CheckGroundingSpec 基础检查的配置。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅 Google Cloud 文档。

CheckGroundingResponse

GroundedGenerationService.CheckGrounding 方法的响应消息。

字段
cited_chunks[]	FactChunk 答案候选对象中所有声明中引用的事实列表。这些答案是从请求中提供的事实信息推导出来的。
cited_facts[]	CheckGroundingFactChunk 答案候选对象中所有声明中引用的事实列表。这些答案是从请求中提供的事实信息推导出来的。
claims[]	Claim 回答候选对象中所有版权主张的声明文本和引用信息。
support_score	float 输入答案候选的支持得分。得分越高，提供的证据支持的声明比例就越高。返回响应时，系统始终会设置此字段。

CheckGroundingFactChunk

用于基础检查的事实块。

字段
chunk_text	string 事实块的文本内容。长度不得超过 1 万个字符。

声明

答案候选方案中声明的文本和引用信息。

字段
claim_text	string 回答候选对象中声明的文本。无论是否找到引用或反向引用，始终提供。
citation_indices[]	int32 一个索引（指向“cited_chunks”）列表，用于指定与相应声明关联的引用。例如，[1,3,4] 表示 cited_chunks[1]、cited_chunks[3]、cited_chunks[4] 是支持相应声明的事实依据。引用事实表明相应声明有事实依据。
start_pos	int32 位置（以字节为单位），用于指示回答候选方案中声明的起始位置。请注意，此属性的单位不是字符，因此在界面中呈现时必须考虑到某些字符可能占用多个字节。例如，如果声明文本包含非 ASCII 字符，则以字符（取决于编程语言）和字节（不取决于编程语言）为单位测量的起始位置和结束位置会有所不同。
end_pos	int32 位置（以字节为单位），表示答案候选对象中声明的结束位置（不含边界值）。请注意，此属性值不是以字符数来衡量的，因此必须按原样呈现。例如，如果声明文本包含非 ASCII 字符，则以字符（取决于编程语言）和字节（不取决于编程语言）为单位测量的起始位置和结束位置会有所不同。
grounding_check_required	bool 表示相应声明需要进行事实依据检查。如果系统认为此声明不需要归因/依据检查，则此字段将设置为 false。在这种情况下，系统未对声明进行事实依据检查，因此不应返回 citation_indices。
score	double 回答候选方案中声明的置信度得分，范围为 [0, 1]。仅当 CheckGroundingRequest.grounding_spec.enable_claim_level_score 为 true 时，才会设置此字段。

CheckGroundingSpec

接地检查的规范。

字段
citation_threshold	double 用于确定回答候选对象中的声明是否必须引用事实的阈值（介于 [0,1] 之间）。选择较高的阈值会获得较少但非常强的引用，而选择较低的阈值可能会获得更多但相对较弱的引用。如果未设置，阈值将默认为 0.6。
enable_claim_level_score	bool 用于在回答中启用声明级事实依据得分的控制标志。

块

块会捕获以块模式推荐或搜索的商品的所有原始元数据信息。

字段
name	string 块的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
id	string 当前块的唯一块 ID。
content	string 内容是文档中的字符串（已解析的内容）。
document_metadata	DocumentMetadata 当前块中相应文档的元数据。
derived_struct_data	Struct 仅限输出。此字段为 OUTPUT_ONLY。它包含原始输入文档中没有的派生数据。
page_span	PageSpan 块的页面跨度。
chunk_metadata	ChunkMetadata 仅限输出。当前块的元数据。
data_urls[]	string 仅限输出。如果当前块包含图片，则为图片数据网址。数据网址由四部分组成：前缀 (data:)、指示数据类型的 MIME 类型、可选的 base64 令牌（如果是非文本数据）和数据本身：data:[][;base64],
annotation_contents[]	string 仅限输出。如果当前块包含注释，则为注释内容。
annotation_metadata[]	AnnotationMetadata 仅限输出。注解元数据包含当前块中的结构化内容。
relevance_score	double 仅限输出。表示基于相似性的相关性得分。得分越高，表示块的相关性越高。得分介于 [-1.0, 1.0] 范围内。仅在 SearchResponse 上填充。

AnnotationMetadata

注解元数据包含当前块中的结构化内容。

字段
structured_content	StructuredContent 仅限输出。结构化内容信息。
image_id	string 仅限输出。如果结构化内容基于图片，则提供图片 ID。

ChunkMetadata

当前块的元数据。此字段仅在 SearchService.Search API 上填充。

字段
previous_chunks[]	Chunk 当前块的前几个块。该数量由 SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks 控制。此字段仅在 SearchService.Search API 上填充。
next_chunks[]	Chunk 当前块的后续块。该数量由 SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks 控制。此字段仅在 SearchService.Search API 上填充。

DocumentMetadata

文档元数据包含当前块的文档信息。

字段
uri	string 文档的 URI。
title	string 文档的标题。
mime_type	string 文档的 MIME 类型。https://www.iana.org/assignments/media-types/media-types.xhtml。
struct_data	Struct 数据表示法。相应文档的结构化 JSON 数据。它应符合已注册的 Schema，否则会抛出 INVALID_ARGUMENT 错误。

PageSpan

块的页面跨度。

字段
page_start	int32 块的起始网页。
page_end	int32 块的结束页面。

StructureType

定义可提取的结构化内容类型。

枚举
STRUCTURE_TYPE_UNSPECIFIED	默认值。
SHAREHOLDER_STRUCTURE	股东结构。
SIGNATURE_STRUCTURE	签名结构。
CHECKBOX_STRUCTURE	复选框结构。

StructuredContent

结构化内容信息。

字段
structure_type	StructureType 仅限输出。结构化内容的结构类型。
content	string 仅限输出。结构化内容的内容。

引用

内容来源信息。

字段
start_index	int32 仅限输出。内容中的起始索引。
end_index	int32 仅限输出。内容中的结束索引。
uri	string 仅限输出。相应提供方信息的网址参考。
title	string 仅限输出。提供方信息的标题。
license	string 仅限输出。提供方信息的许可。
publication_date	Date 仅限输出。提供方信息的发布日期。

CitationMetadata

一段内容的一组来源提供方信息。

字段
citations[]	Citation 仅限输出。引用列表。

CloudSqlSource

Cloud SQL 源导入数据。

字段
project_id	string 包含 Cloud SQL 源的项目 ID。长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
instance_id	string 必需。要从中复制数据的 Cloud SQL 实例，长度限制为 256 个字符。
database_id	string 必需。要从中复制数据的 Cloud SQL 数据库，长度限制为 256 个字符。
table_id	string 必需。要从中复制数据的 Cloud SQL 表，长度限制为 256 个字符。
gcs_staging_dir	string 用于导入操作的中间 Cloud Storage 目录，长度限制为 2,000 个字符。如果要将 Cloud SQL 内容导出至特定 Cloud Storage 目录，则可以指定。 确保 Cloud SQL 服务账号具有必要的 Cloud Storage 管理员权限，以便访问指定的 Cloud Storage 目录。
offload	bool 无服务器导出选项。启用此选项会产生额外费用。如需了解详情，请点击此处。

CmekConfig

用于通过 Cloud KMS 密钥启用 CMEK 数据加密的配置。

字段
name	string 必需。CmekConfig 的名称，格式为 projects/{project}/locations/{location}/cmekConfig 或 projects/{project}/locations/{location}/cmekConfigs/{cmek_config}。
kms_key	string 必需。将用于加密资源 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 的 KMS 密钥资源名称。
kms_key_version	string 仅限输出。将用于加密资源 <kms_key>/cryptoKeyVersions/{keyVersion} 的 KMS 密钥版本资源名称。
state	State 仅限输出。CmekConfig 的状态。
is_default	bool 仅限输出。客户的默认 CmekConfig。
last_rotation_timestamp_micros	int64 仅限输出。上次密钥轮替的时间戳。
single_region_keys[]	SingleRegionKey 可选。某些 VAIS 功能所需的单区域 CMEK。
notebooklm_state	NotebookLMState 仅限输出。NotebookLM 语料库是否已准备就绪，可供使用。

NotebookLMState

NotebookLM 的状态。

枚举
NOTEBOOK_LM_STATE_UNSPECIFIED	NotebookLM 状态未知。
NOTEBOOK_LM_NOT_READY	NotebookLM 尚未准备就绪。
NOTEBOOK_LM_READY	NotebookLM 已准备就绪，可以开始使用了。
NOTEBOOK_LM_NOT_ENABLED	NotebookLM 未启用。

州

CmekConfig 的状态。

枚举
STATE_UNSPECIFIED	CmekConfig 状态未知。
CREATING	正在创建 CmekConfig。
ACTIVE	CmekConfig 可与 DataStore 搭配使用。
KEY_ISSUE	CmekConfig 不可用，很可能是因为 KMS 密钥已被撤消。
DELETING	CmekConfig 正在删除。
DELETE_FAILED	CmekConfig 删除流程失败。
UNUSABLE	CmekConfig 不可用，很可能是由于某些内部问题。
ACTIVE_ROTATING	KMS 密钥版本正在轮替。
DELETED	KMS 密钥已被软删除。系统最终会应用某种清理政策。
EXPIRED	KMS 密钥已过期，这意味着该密钥已停用 30 天以上。客户可以调用 DeleteCmekConfig 将状态更改为 DELETED。

CollectUserEventRequest

针对 CollectUserEvent 方法的请求消息。

字段
parent	string 必需。父级资源名称。如果收集用户事件操作应用于 DataStore 级别，则格式为：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。如果收集用户事件操作应用于 Location 级，例如，具有 Document 的事件跨多个 DataStore，则格式为：projects/{project}/locations/{location}。
user_event	string 必需。网址编码的 UserEvent proto，长度上限为 2,000,000 个字符。
uri	string 网址（包括 CGI 参数，但不包括哈希片段），长度上限为 5,000 个字符。这通常比引荐来源网址更有用，因为许多浏览器仅针对第三方请求发送网域。
ets	int64 事件时间戳（以毫秒为单位）。这样可以防止浏览器缓存其他方面相同的 GET 请求。名称已缩写，以减少载荷字节数。

集合

集合是一个容器，用于配置资源和对一组 DataStore 的访问权限。

字段
name	string 不可变。集合的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
display_name	string 必需。集合显示名称。 此字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
create_time	Timestamp 仅限输出。Collection 的创建时间戳。

CompleteQueryRequest

CompletionService.CompleteQuery 方法的请求消息。

字段
data_store	string 必需。执行补全操作的父数据存储区资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。
query	string 必需。用于提取建议的 typeahead 输入。长度上限为 128 个字符。
query_model	string 指定自动补全数据模型。此设置会替换 Cloud 控制台的“配置”>“自动补全”部分中指定的任何模型。目前支持的值： document - 使用根据用户导入的文档生成的建议。 search-history - 使用根据 SearchService.Search API 调用的过往历史记录生成的建议。如果 Search API 没有流量，请勿使用此功能。 user-event - 使用根据用户导入的搜索事件生成的建议。 document-completable - 使用直接从用户导入的标记为“可补全”的文档字段中提取的建议。 默认值： document 是常规数据存储区的默认模型。 search-history 是网站搜索数据存储区的默认模型。
user_pseudo_id	string 用于跟踪访问者的唯一标识符。例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录或退出网站，此唯一标识符不应发生变化。 此字段不应具有固定值，例如 unknown_visitor。 此标识符应与 UserEvent.user_pseudo_id 和 SearchRequest.user_pseudo_id 相同。 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
include_tail_suggestions	bool 指示在没有与完整查询匹配的建议时是否应返回尾部建议。即使设置为 true，如果存在与完整查询匹配的建议，系统也会返回这些建议，而不会返回尾部建议。

CompleteQueryResponse

CompletionService.CompleteQuery 方法的响应消息。

字段
query_suggestions[]	QuerySuggestion 匹配的查询建议的结果。结果列表已排序，第一个结果是热门建议。
tail_match_triggered	bool 如果返回的建议均为长尾建议，则为 True。 若要触发尾部匹配，请求中的 include_tail_suggestions 必须为 true，并且不得有与完整查询匹配的建议。

QuerySuggestion

以搜索查询的形式显示建议。

字段
suggestion	string 查询的建议。
completable_field_paths[]	string 如果建议是从可补全字段生成的，则作为此建议来源的唯一文档字段路径。 此字段仅针对可完成文档的模型进行填充。

CompletionInfo

详细的完成信息，包括完成情况归因令牌和点击完成信息。

字段
selected_suggestion	string 已选择最终用户 CompleteQueryResponse.QuerySuggestion.suggestion。
selected_position	int32 最终用户选择的 CompleteQueryResponse.QuerySuggestion.suggestion 位置，从 0 开始。

CompletionSuggestion

从客户处导入的自动补全建议。

字段
suggestion	string 必需。建议文字。
language_code	string 相应建议的 BCP-47 语言代码。
group_id	string 如果两个建议具有相同的 groupId，则不会一起返回。而是返回排名较高的那个。这可用于去除语义上相同的建议。
group_score	double 相应建议在其所属群组中的得分。
alternative_phrases[]	string 相应建议的替代匹配短语。
联合字段 ranking_info。相应建议的排名指标。ranking_info 只能是下列其中一项：
global_score	double 相应建议的全局得分。控制此建议的评分 / 排名方式。
frequency	int64 相应建议的频率。当没有得分时，将用于对建议进行排名。

条件

定义在允许某种行为之前要检查的情况

字段
query_terms[]	QueryTerm 仅搜索要与查询匹配的字词列表。如果已设置 Condition.query_regex，则无法设置此字段。 最多 10 个查询字词。
active_time_range[]	TimeRange 指定条件处于有效状态的时间范围。 最多 10 个时间范围。
query_regex	string 可选。用于匹配整个搜索查询的查询正则表达式。如果已设置 Condition.query_terms，则无法设置此字段。仅支持基本网站搜索广告投放控制。

QueryTerm

搜索请求查询的匹配器

字段
value	string 要匹配的具体查询值 必须采用小写形式，必须采用 UTF-8 编码。如果 full_match 为 true，则最多可以包含 3 个以空格分隔的字词。不得为空字符串。长度上限为 5,000 个字符。
full_match	bool 搜索查询是否需要与查询字词完全匹配。

TimeRange

用于时间相关条件。

字段
start_time	Timestamp 时间范围的开始时间。 范围包含边界值。
end_time	Timestamp 时间范围的结束时间。 范围包含边界值。必须是将来的时间。

ConnectorType

连接器的类型。

枚举
CONNECTOR_TYPE_UNSPECIFIED	默认值。
THIRD_PARTY	第三方连接器到第三方应用的连接器。
GCP_FHIR	数据连接器用于在 FHIR 存储区和 VAIS 数据存储区之间建立连接。
BIG_QUERY	BigQuery 连接器。
GCS	Google Cloud Storage 连接器。
GOOGLE_MAIL	Gmail 连接器。
GOOGLE_CALENDAR	Google 日历连接器。
GOOGLE_DRIVE	Google 云端硬盘连接器。
NATIVE_CLOUD_IDENTITY	由 People API 提供支持的用于人员搜索的原生 Cloud Identity 连接器。
THIRD_PARTY_FEDERATED	联合连接器是一种不提取数据的第三方连接器，搜索功能由第三方应用的 API 提供支持。
THIRD_PARTY_EUA	用于最终用户身份验证功能的连接器。
GCNV	Google Cloud NetApp Volumes 连接器。

ContactDetails

存储在资源级别的联系信息。如果项目级和资源级联系信息均已填写，则资源级联系信息将覆盖项目级联系信息。

字段
email_address	string 可选。联系人的电子邮件地址。

控制

定义在提供服务期间采用的条件行为。必须附加到 ServingConfig 才能在投放时考虑。允许的操作取决于 SolutionType。

字段
name	string 不可变。完全限定名称 projects/*/locations/global/dataStore/*/controls/*
display_name	string 必需。直观易懂的名称。界面视图中使用的标识符。 必须是 UTF-8 编码的字符串。长度限制为 128 个字符。否则，系统会抛出 INVALID ARGUMENT 错误。
associated_serving_config_ids[]	string 仅限输出。此控件所附加到的所有 ServingConfig ID 的列表。更改后，最多可能需要 10 分钟才能更新。
solution_type	SolutionType 必需。不可变。控制变量所属的解决方案。 必须与资源的垂直行业兼容。否则，系统会抛出 INVALID ARGUMENT 错误。
use_cases[]	SearchUseCase 指定控制变量的应用场景。影响可设置哪些条件字段。仅适用于 SOLUTION_TYPE_SEARCH。目前，每个控制变量只允许一个用例。当 solution_type 为 SolutionType.SOLUTION_TYPE_SEARCH 时，必须设置此字段。
conditions[]	Condition 确定关联操作的触发时间。 省略此属性可始终应用相应操作。目前，只能指定一个条件。否则，系统会抛出 INVALID ARGUMENT 错误。
联合字段 action。操作受行业和解决方案限制 必需。action 只能是下列其中一项：
boost_action	BoostAction 定义了提升型控制变量
filter_action	FilterAction 定义了过滤类型的控件，目前不受 Recommendation 支持
redirect_action	RedirectAction 定义重定向类型的控制变量。
synonyms_action	SynonymsAction 将一组字词视为彼此的同义词。
promote_action	PromoteAction 根据预定义的触发查询来推广特定链接。

BoostAction

调整返回列表中的商品顺序。

字段
boost (deprecated)	float 此项已弃用！ 升位的强度，应介于 [-1, 1] 之间。设为负值代表降位。默认值为 0.0（无操作）。
filter	string 必需。指定要对哪些商品应用加推。 如果未提供过滤条件，系统将提升所有产品（无操作）。语法文档：https://cloud.google.com/retail/docs/filter-and-order。长度上限为 5,000 个字符。否则，系统会抛出 INVALID ARGUMENT 错误。
data_store	string 必需。指定可以使用该控件增强哪些数据存储区的文档。完整的数据存储区名称，例如 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
联合字段 boost_spec。基于常量值提升或自定义排名的提升规范。boost_spec 只能是下列其中一项：
fixed_boost	float 可选。升位的强度，应介于 [-1, 1] 之间。设为负值代表降位。默认值为 0.0（无操作）。
interpolation_boost_spec	InterpolationBoostSpec 可选。基于客户定义的属性值的自定义排名的复杂规范。

InterpolationBoostSpec

基于客户指定属性值的自定义排名规范。与上述简单的（条件、提升）组合相比，它可提供更多用于自定义排名的控制变量。

字段
field_name	string 可选。将用于确定加权幅度的字段的名称。
attribute_type	AttributeType 可选。用于确定加推幅度的属性类型。属性值可以从指定 field_name 的字段值派生而来。对于数值，这很简单，即 attribute_value = numerical_field_value。不过，对于新鲜度，attribute_value = (time.now() - datetime_field_value)。
interpolation_type	InterpolationType 可选。要应用于连接下列控制点的插值类型。
control_points[]	ControlPoint 可选。用于定义曲线的控制点。单调函数（通过上面的 interpolation_type 定义）会通过此处列出的控制点。

AttributeType

要应用自定义排名的属性（或函数）。

枚举
ATTRIBUTE_TYPE_UNSPECIFIED	未指定 AttributeType。
NUMERICAL	数值字段的值将用于动态更新加推量。在这种情况下，控制点的 attribute_value（即 x 值）将是指定了 boost_amount 的数值字段的实际值。
FRESHNESS	对于新鲜度使用情形，属性值将是当前时间与指定日期时间字段中的日期之间的时长。该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。此格式的模式为：[nD][T[nH][nM][nS]]。例如，5D、3DT12H30M、T24H。

ControlPoint

用于定义曲线的控制点。通过这些控制点定义的曲线只能单调递增或递减（可以包含常量值）。

字段
attribute_value	string 可选。可以是以下值之一：1. 数值字段值。2. 新鲜度时长规范：该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。此格式的模式为：[nD][T[nH][nM][nS]]。
boost_amount	float 可选。如果 attribute_value 的计算结果为上述指定的值，则用于提升得分的值（介于 -1 到 1 之间）。

InterpolationType

要应用的插值类型。默认值为线性（分段线性）。

枚举
INTERPOLATION_TYPE_UNSPECIFIED	未指定插值类型。在这种情况下，它会默认设置为线性。
LINEAR	系统将应用分段线性插值。

FilterAction

指定哪些商品可包含在结果中。使用与提升相同的过滤条件。

字段
filter	string 必需。要应用于匹配条件结果的过滤条件。 必需的语法文档：https://cloud.google.com/retail/docs/filter-and-order。长度上限为 5,000 个字符。否则，系统会抛出 INVALID ARGUMENT 错误。
data_store	string 必需。指定可以使用该控件过滤哪些数据存储区的文档。完整的数据存储区名称，例如 projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

根据某些触发查询来推广特定链接。

示例：当用户搜索 shoe 关键字时，宣传鞋店链接。链接可以位于关联的数据存储区之外。

字段
data_store	string 必需。相应促销活动所关联的数据存储区。
search_link_promotion	SearchLinkPromotion 必需。附加到相应操作的促销活动。

RedirectAction

将买家重定向到所提供的 URI。

字段
redirect_uri	string 必需。买家将被重定向到的 URI。 必需。URI 的长度必须小于或等于 2000 个字符。否则，系统会抛出 INVALID ARGUMENT 错误。

SynonymsAction

创建一组将互为同义词的字词。

示例：“happy”也会被视为“glad”，“glad”也会被视为“happy”。

字段
synonyms[]	string 定义一组同义词。最多可以指定 100 个同义词。必须指定至少 2 个同义词。否则，系统会抛出 INVALID ARGUMENT 错误。

对话

外部对话 proto 定义。

字段
name	string 不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* 或 projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*。
state	State 对话的状态。
user_pseudo_id	string 用于跟踪用户的唯一标识符。
messages[]	ConversationMessage 对话消息。
start_time	Timestamp 仅限输出。对话开始的时间。
end_time	Timestamp 仅限输出。对话结束的时间。

州

对话状态的枚举。

枚举
STATE_UNSPECIFIED	未知。
IN_PROGRESS	对话目前处于打开状态。
COMPLETED	对话已结束。

ConversationContext

定义对话的上下文

字段
context_documents[]	string 用户当前看到的文档列表。它包含文档资源引用。
active_document	string 用户当前打开的有效文档。它包含文档资源引用。

ConversationMessage

定义对话消息。

字段
create_time	Timestamp 仅限输出。消息创建时间戳。
联合字段 message。 message 只能是下列其中一项：
user_input	TextInput 用户文本输入。
reply	Reply 搜索回复。

ConverseConversationRequest

ConversationalSearchService.ConverseConversation 方法的请求消息。

字段
name	string 必需。要获取的对话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}。使用 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/- 激活自动会话模式，该模式会在 ConverseConversation 会话中自动创建新对话。
query	TextInput 必需。当前用户输入。
serving_config	string 要使用的服务配置的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} 如果未设置，系统将使用默认的投放配置。
conversation	Conversation 仅供自动会话使用的对话。系统会自动为自动会话中的对话分配新名称，因此会忽略名称字段。
safe_search	bool 是否开启安全搜索功能。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅 Google Cloud 文档。
summary_spec	SummarySpec 用于配置响应中返回的摘要的规范。
filter	string 过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。此参数将用于过滤搜索结果，可能会影响摘要响应。 如果此字段无法识别，则返回 INVALID_ARGUMENT。 Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“名称”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")' 如需详细了解过滤（包括语法和过滤运算符），请参阅过滤
boost_spec	BoostSpec 用于提升搜索结果中某些文档的权重，这可能会影响对话响应。如需详细了解热推，请参阅热推

ConverseConversationResponse

ConversationalSearchService.ConverseConversation 方法的响应消息。

字段
reply	Reply 对当前查询的回答。
conversation	Conversation 更新后的对话，包括回答。
search_results[]	SearchResult 搜索结果。

CreateAssistantRequest

针对 AssistantService.CreateAssistant 方法的请求。

字段
parent	string 必需。父级资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
assistant	Assistant 必需。要创建的 Assistant。
assistant_id	string 必需。要用于 Assistant 的 ID，该 ID 将成为 Assistant 资源名称的最后一个组成部分。 此字段必须符合 RFC-1034 的要求，且长度上限为 63 个字符。

CreateControlRequest

针对 CreateControl 方法的请求。

字段
parent	string 必需。父数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} 或 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。
control	Control 必需。要创建的控制变量。
control_id	string 必需。要用于控制变量的 ID，该 ID 将成为控制变量资源名称的最后一个组成部分。 此值必须介于 1 到 63 个字符之间。有效字符为 /[az][0-9]-_/.

CreateConversationRequest

对 CreateConversation 方法的请求。

字段
parent	string 必需。父数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
conversation	Conversation 必需。要创建的对话。

CreateDataStoreMetadata

与 DataStoreService.CreateDataStore 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

CreateDataStoreRequest

对 DataStoreService.CreateDataStore 方法的请求。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection}。
data_store	DataStore 必需。要创建的 DataStore。
data_store_id	string 必需。要用于 DataStore 的 ID，该 ID 将成为 DataStore 资源名称的最后一个组成部分。 此字段必须符合 RFC-1034 标准，且长度上限为 63 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
create_advanced_site_search	bool 一个布尔值标志，用于指示用户是否想要直接为网站搜索创建高级数据存储区。如果数据存储区未配置为网站搜索（GENERIC 行业和 PUBLIC_WEBSITE content_config），系统会忽略此标志。
skip_default_schema_creation	bool 一个布尔值标志，用于指示是否跳过数据存储区的默认架构创建。只有在确定默认架构与您的使用情形不兼容时，才启用此标志。 如果设置为 true，您必须先为数据存储区手动创建架构，然后才能提取任何文档。 如果指定了 data_store.starting_schema，则无法指定此标志。
联合字段 cmek_options。DataStore 的 CMEK 选项。如果为项目设置了默认 CmekConfig，则设置此字段会替换该默认 CmekConfig。cmek_options 只能是下列其中一项：
cmek_config_name	string 用于保护相应 DataStore 的 CmekConfig 的资源名称。
disable_cmek	bool 没有 CMEK 保护的 DataStore。如果为项目设置了默认 CmekConfig，设置此字段也会替换默认 CmekConfig。

CreateDocumentRequest

DocumentService.CreateDocument 方法的请求消息。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。
document	Document 必需。要创建的 Document。
document_id	string 必需。要用于 Document 的 ID，将成为 Document.name 的最终组成部分。 如果调用方没有创建 Document 的权限，无论该 Document 是否存在，都会返回 PERMISSION_DENIED 错误。 此字段在具有相同 parent 的所有 Document 中必须是唯一的。否则，系统将返回 ALREADY_EXISTS 错误。 此字段必须符合 RFC-1034 标准，长度上限为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。

CreateEngineMetadata

与 EngineService.CreateEngine 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

CreateEngineRequest

对 EngineService.CreateEngine 方法的请求。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection}。
engine	Engine 必需。要创建的 Engine。
engine_id	string 必需。要用于 Engine 的 ID，该 ID 将成为 Engine 资源名称的最后一个组成部分。 此字段必须符合 RFC-1034 标准，且长度上限为 63 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。

CreateIdentityMappingStoreRequest

IdentityMappingStoreService.CreateIdentityMappingStore 的请求消息

字段
parent	string 必需。父级集合资源名称，例如 projects/{project}/locations/{location}。
identity_mapping_store_id	string 必需。要创建的身份映射存储区的 ID。 ID 只能包含字母（a-z、A-Z）、数字 (0-9)、下划线 (_) 和连字符 (-)，长度上限为 63 个字符。
identity_mapping_store	IdentityMappingStore 必需。要创建的身份映射存储区。
联合字段 cmek_options。身份映射存储区的 CMEK 选项。如果为项目设置了默认 CmekConfig，则设置此字段会替换该默认 CmekConfig。cmek_options 只能是下列其中一项：
cmek_config_name	string 用于保护相应身份映射存储区的 CmekConfig 的资源名称。
disable_cmek	bool 不含 CMEK 保护的身份映射存储区。如果为项目设置了默认 CmekConfig，设置此字段也会替换默认 CmekConfig。

CreateLicenseConfigRequest

LicenseConfigService.CreateLicenseConfig 方法的请求消息。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}。
license_config	LicenseConfig 必需。要创建的 LicenseConfig。
license_config_id	string 可选。要用于 LicenseConfig 的 ID，该 ID 将成为 LicenseConfig 资源名称的最后一个组成部分。我们使用层级（产品版本）名称作为许可配置 ID，例如 search 或 search_and_assistant。

CreateSchemaMetadata

创建架构 LRO 的元数据。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

CreateSchemaRequest

SchemaService.CreateSchema 方法的请求消息。

字段
parent	string 必需。父级数据存储区资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。
schema	Schema 必需。要创建的 Schema。
schema_id	string 必需。要用于 Schema 的 ID，将成为 Schema.name 的最终组成部分。 此字段应符合 RFC-1034 标准，长度上限为 63 个字符。

CreateSessionRequest

针对 CreateSession 方法的请求。

字段
parent	string 必需。父数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
session	Session 必需。要创建的会话。

CreateSitemapMetadata

与 SiteSearchEngineService.CreateSitemap 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

CreateSitemapRequest

SiteSearchEngineService.CreateSitemap 方法的请求消息。

字段
parent	string 必需。SiteSearchEngine 的父级资源名称，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。
sitemap	Sitemap 必需。要创建的 Sitemap。

CreateTargetSiteMetadata

与 SiteSearchEngineService.CreateTargetSite 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

CreateTargetSiteRequest

SiteSearchEngineService.CreateTargetSite 方法的请求消息。

字段
parent	string 必需。TargetSite 的父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。
target_site	TargetSite 必需。要创建的 TargetSite。

CustomAttribute

未在资源中明确建模的自定义属性，例如 UserEvent。

字段
text[]	string 相应自定义属性的文本值。例如，当键为“color”时，值为 ["yellow", "green"]。 不允许使用空字符串。否则，系统将返回 INVALID_ARGUMENT 错误。 应仅设置 CustomAttribute.text 和 CustomAttribute.numbers 中的一项。否则，系统将返回 INVALID_ARGUMENT 错误。
numbers[]	double 相应自定义属性的数值。例如，当键为“lengths_cm”时，值为 [2.3, 15.4]。 应仅设置 CustomAttribute.text 和 CustomAttribute.numbers 中的一项。否则，系统将返回 INVALID_ARGUMENT 错误。

CustomTuningModel

用于描述自定义调优模型的元数据。

字段
name	string 必需。模型的完全限定资源名称。 格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}。 型号必须是字母数字字符串，长度上限为 40 个字符。
display_name	string 模型的显示名称。
model_version	int64 模型的版本。
model_state	ModelState 模型所处的状态（例如 TRAINING 或 TRAINING_FAILED）。
create_time (deprecated)	Timestamp 此项已弃用！ 已弃用：模型创建时的时间戳。
training_start_time	Timestamp 模型训练启动的时间戳。
metrics	map<string, double> 已训练模型的指标。
error_message	string 目前，仅当模型状态为 INPUT_VALIDATION_FAILED 时，系统才会填充此字段。

ModelState

模型的状态。

枚举
MODEL_STATE_UNSPECIFIED	默认值。
TRAINING_PAUSED	模型处于暂停训练状态。
TRAINING	模型目前正在训练中。
TRAINING_COMPLETE	模型已成功完成训练。
READY_FOR_SERVING	模型已准备好进行部署。
TRAINING_FAILED	模型训练失败。
NO_IMPROVEMENT	模型训练已成功完成，但指标未得到改善。
INPUT_VALIDATION_FAILED	输入数据验证失败。模型训练未开始。

DataConnector

管理与Collection下分组的所有数据存储区的外部数据源的连接。它是 Collection 的单例资源。初始化仅通过 DataConnectorService.SetUpDataConnector 方法支持，该方法将创建一个新的 Collection 并初始化其 DataConnector。

字段
name	string 仅限输出。数据连接器的完整资源名称。格式：projects/*/locations/*/collections/*/dataConnector。
state	State 仅限输出。连接器的状态。
data_source	string 必需。数据源的名称。支持的值：salesforce、jira、confluence、bigquery。
remove_param_keys[]	string 可选。指定要从“params”字段中移除的键。仅当 UpdateDataConnectorRequest 中的“update_mask”包含“params”时，此属性才处于有效状态。如果某个键同时位于“remove_param_keys”中，并且存在于请求的“params”字段中，则删除操作优先。
refresh_interval	Duration 必需。数据同步的刷新间隔。如果将时长设置为 0，数据将实时同步。尚不支持流式传输功能。最小值为 30 分钟，最大值为 7 天。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用。
next_sync_time	DateTime 定义下一次数据同步的预定时间。此字段需要小时、分钟和来自 IANA 时区数据库的时区。当数据连接器的刷新间隔超过 1 天时，系统会使用此时间标准。如果未指定小时或分钟，我们会假设同步时间为 0:00。用户必须提供时区，以避免出现歧义。
entities[]	SourceEntity 要注入的已连接数据源中的实体列表。
create_time	Timestamp 仅限输出。DataConnector 的创建时间戳。
latest_pause_time	Timestamp 仅限输出。相应 DataConnector 最近一次暂停的时间戳，会影响数据同步等所有功能。暂停连接器会产生以下影响：- 所有功能（包括数据同步）都会停止。- 系统会取消所有正在进行的数据同步作业。- 系统不会安排或触发任何未来的数据同步运行。
last_sync_time	Timestamp 仅限输出。仅适用于定期连接器，指上次完成数据同步的时间。
update_time	Timestamp 仅限输出。上次更新 DataConnector 时的时间戳。
errors[]	Status 仅限输出。初始化或最新连接器运行中的错误。
sync_mode	SyncMode 数据连接器支持的数据同步模式。
kms_key_name	string 仅限输入。用于保护此连接器管理的数据存储区的 KMS 密钥。 必须针对需要遵守 CMEK 组织政策保护的请求进行设置。 如果设置了此字段并成功处理，则此连接器创建的 DataStore 将受到 KMS 密钥的保护。
destination_configs[]	DestinationConfig 可选。用于连接到第三方服务的任何目标目的地。
action_state	State 仅限输出。操作连接器的状态。这反映了操作连接器是正在初始化、处于活动状态还是遇到了错误。
action_config	ActionConfig 可选。用于使连接器支持操作的操作配置。
end_user_config	EndUserConfig 可选。专门用于 EUA 连接器的任何参数和凭据。
federated_config	FederatedConfig 可选。专门用于支持联合模式的混合连接器的任何参数和凭据。仅当连接器为混合连接器且我们想要启用 FEDERATED 模式时，才应设置此字段。
connector_modes[]	ConnectorMode 可选。为此连接器启用的模式。默认状态为 CONNECTOR_MODE_UNSPECIFIED。
static_ip_enabled	bool 可选。客户是否已为此连接器启用静态 IP 地址。
static_ip_addresses[]	string 仅限输出。相应连接器使用的静态 IP 地址。
blocking_reasons[]	BlockingReason 仅限输出。在连接器开始同步数据之前必须完成的用户操作。
identity_refresh_interval (deprecated)	Duration 此项已弃用！ 用于同步此连接器提取的文档的访问控制列表信息的刷新间隔。如果未设置，系统会以 30 分钟的默认间隔刷新访问权限控制列表。身份刷新间隔时间最短为 30 分钟，最长为 7 天。
identity_schedule_config	IdentityScheduleConfig 身份数据同步运行的配置。此属性包含刷新间隔，用于同步此连接器提取的文档的访问控制列表信息。
private_connectivity_project_id	string 仅限输出。与专用连接连接器关联的租户项目 ID。必须将此项目列入许可名单，连接器才能正常运行。
bap_config	BAPConfig 可选。用于建立 BAP 连接的配置。
connector_type	ConnectorType 仅限输出。连接器的类型。每个来源只能映射到一种类型。例如，salesforce、confluence 和 jira 具有 THIRD_PARTY 连接器类型。一旦由系统设置，便无法更改。
realtime_state	State 仅限输出。实时同步状态
alert_policy_configs[]	AlertPolicyConfig 可选。连接器级提醒配置。
realtime_sync_config	RealtimeSyncConfig 可选。实时同步的配置。
acl_enabled	bool 可选。连接器是否将使用 ACL 配置创建。目前，此字段仅影响 Cloud Storage 和 BigQuery 连接器。
create_eua_saas	bool 可选。是否在 SaaS 中创建了最终用户身份验证连接器。
auto_run_disabled	bool 可选。指示连接器是否已停用自动运行。可用于暂停定期同步和实时同步。更新：随着 incremental_sync_disabled 的推出，auto_run_disabled 仅用于暂停/停用完整同步
incremental_sync_disabled	bool 可选。指示相应连接器是否已暂停增量同步。此属性与 auto_run_disabled 无关。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用，即设置为 true。
incremental_refresh_interval	Duration 可选。专门针对增量数据同步的刷新间隔。如果未设置，增量同步将使用环境变量中的默认值（设置为 3 小时）。最小值为 30 分钟，最大值为 7 天。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用。
hybrid_ingestion_disabled	bool 可选。如果连接器是混合连接器，则确定在创建连接器期间是否启用了提取功能并预配了相应资源。如果连接器不是混合连接器，则系统会忽略此字段。
联合字段 data_connector_params。以（键，值）对的形式访问来源所需的参数。系统将从 Secret Manager 读取格式为 projects/*/[locations/*/]secrets/*/versions/* 的字符串值。 所有数据源的必需参数： 键：instance_uri 值：类型为 STRING。用于访问数据源的 URI。 支持 OAuth 的来源（即 salesforce）的必需参数： 键：client_id 值：类型为 STRING。第三方服务提供商用于标识您的应用的客户端 ID。 键：client_secret 值：类型为 STRING。由第三方授权服务器生成的客户端密钥。 键：access_token 值：类型为 STRING。供 UCS 访问受保护资源的 OAuth 令牌。 键：refresh_token 值：类型为 STRING。UCS 的 OAuth 刷新令牌，用于在没有用户互动的情况下获取新的访问令牌。 支持基本 API 令牌身份验证（即 jira、confluence）的来源的必需参数： 键：user_account 值：类型为 STRING。包含来源的用户名或电子邮件地址。 键：api_token 值：类型为 STRING。为源账号生成的 API 令牌，用于在任何需要使用密码的地方进行身份验证。 示例： { "instance_uri": "https://xxx.atlassian.net", "user_account": "[e-mail]", "api_token": "test-token" } 用于指定要使用的授权类型的可选参数，以支持多种授权类型： 键：auth_type 值：类型为 STRING。数据源的授权类型。支持的值：BASIC_AUTH、OAUTH、OAUTH_ACCESS_TOKEN、OAUTH_TWO_LEGGED、OAUTH_JWT_BEARER、OAUTH_PASSWORD_GRANT、JWT、API_TOKEN、FEDERATED_CREDENTIAL。data_connector_params 只能是下列其中一项：
params	Struct 结构化 JSON 格式的必需数据连接器参数。
json_params	string 必需的数据连接器参数（采用 JSON 字符串格式）。

BlockingReason

在连接器开始同步数据之前必须完成的用户操作。

枚举
BLOCKING_REASON_UNSPECIFIED	默认值。
ALLOWLIST_STATIC_IP	连接器要求客户将静态 IP 列入许可名单。
ALLOWLIST_IN_SERVICE_ATTACHMENT	连接器要求客户在其服务连接中将我们的项目列入许可名单。
ALLOWLIST_SERVICE_ACCOUNT	连接器要求客户将其项目中的服务账号列入许可名单。

ConnectorMode

为此连接器启用的模式。INGESTION、ACTIONS、FEDERATED 或 EUA

枚举
CONNECTOR_MODE_UNSPECIFIED	未指定连接器模式。
DATA_INGESTION	用于数据注入的连接器。
ACTIONS	用于执行操作的连接器。
FEDERATED	用于联合搜索的连接器。
EUA	用于最终用户身份验证的连接器。
FEDERATED_AND_EUA	用于联合搜索和最终用户身份验证的混合连接器。

EndUserConfig

专门用于 EUA 连接器的任何参数和凭据。

字段
additional_params	Struct 可选。EUA 所需的任何其他参数。
tenant	Tenant 可选。连接器所连接的租户项目。
联合字段 auth_config。EUA 连接器的身份验证配置。auth_config 只能是下列其中一项：
auth_params	Struct 可选。特定于 EUA 连接器的任何身份验证参数。
json_auth_params	string 可选。JSON 字符串格式的任何特定于 EUA 连接器的身份验证参数。

FederatedConfig

专门用于支持联合模式的混合连接器的任何参数和凭据。

字段
additional_params	Struct 可选。联合学习所需的任何其他参数。
联合字段 auth_config。联合连接器的身份验证配置。auth_config 只能是下列其中一项：
auth_params	Struct 可选。特定于联合连接器的任何身份验证参数。
json_auth_params	string 可选。JSON 字符串格式的任何特定于联合连接器的身份验证参数。

RealtimeSyncConfig

实时同步的配置，用于存储实时同步的其他参数。

字段
webhook_uri	string 可选。连接器的网络钩子网址，用于为实时同步指定其他参数。
realtime_sync_secret	string 可选。用于 webhook Secret 的 Secret Manager Secret 的 ID。
streaming_error	StreamingError 可选。流式传输错误详情。

StreamingError

流式传输错误详情。

字段
streaming_error_reason	StreamingErrorReason 可选。流式传输错误。
error	Status 可选。错误详情。

StreamingErrorReason

广泛的流式传输错误类型。

枚举
STREAMING_ERROR_REASON_UNSPECIFIED	未指定流式传输错误原因。
STREAMING_SETUP_ERROR	为实时同步设置资源时出错。
STREAMING_SYNC_ERROR	为连接器运行实时同步时遇到了一些错误。
INGRESS_ENDPOINT_REQUIRED	在专用连接中设置实时同步时，必须提供入站流量端点。

SourceEntity

表示数据源中的实体。例如，Salesforce 中的 Account 对象。

字段
entity_name	string 实体的名称。各数据源支持的值： Salesforce：Lead、Opportunity、Contact、Account、Case、Contract、Campaign Jira：Issue Confluence：Content、Space
key_property_mappings	map<string, string> 用于编制索引的属性。键：字段名称。值：要将字段映射到的关键属性，例如 title 和 description。支持的密钥属性： title：数据记录的标题。这会显示在搜索结果中。 description：数据记录的说明。这会显示在搜索结果中。
data_store	string 仅限输出。源实体的关联数据存储区的完整资源名称。格式：projects/*/locations/*/collections/*/dataStores/*。当连接器通过 DataConnectorService.SetUpDataConnector 方法初始化时，系统会自动为每个源实体创建 DataStore。
starting_schema	Schema 可选。要用于从此 SourceEntity 创建的 DataStore 的起始架构。如果未设置，系统将使用默认的垂直专业化架构。 此字段仅供 [SetUpDataConnector][] API 使用，如果在其他 API 中使用，则会被忽略。此字段将从所有 API 响应（包括 [GetDataConnector][] API）中省略。如需检索 DataStore 的架构，请改用 SchemaService.GetSchema API。 系统会根据有关架构的某些规则验证所提供的架构。如需了解详情，请参阅此文档。
healthcare_fhir_config	HealthcareFhirConfig 可选。HEALTHCARE_FHIR 垂直领域的配置。
联合字段 entity_params。实体的参数，用于简化数据注入。例如，对于 BigQuery 连接器： 键：document_id_column 值：类型为 STRING。列 ID 的值。entity_params 只能是下列其中一项：
params	Struct 实体的参数，用于以结构化 JSON 格式帮助实现数据注入。
json_params	string 实体的参数，用于以 JSON 字符串格式简化数据注入。

州

连接器的状态。

枚举
STATE_UNSPECIFIED	默认值。
CREATING	正在设置连接器。
ACTIVE	连接器已成功设置，正在等待下一次同步运行。
FAILED	连接器处于错误状态。如需了解错误详情，请参阅 DataConnector.errors。如果该错误无法修复，则可以通过 [CollectionService.DeleteCollection] API 删除 DataConnector。
RUNNING	连接器正在积极同步数据源中的记录。
WARNING	连接器已完成同步运行，但遇到了一些非严重错误。
INITIALIZATION_FAILED	连接器初始化失败。潜在原因包括运行时错误或异步流水线中的问题，导致请求无法到达下游服务（某些连接器类型除外）。
UPDATING	连接器正在更新。

SyncMode

定义数据连接器支持的数据同步模式。

枚举
PERIODIC	连接器会根据 refresh_interval 定期同步数据。将其与 auto_run_disabled 搭配使用，可暂停定期同步，或指示进行一次性同步。
STREAMING	数据将实时同步。
UNSPECIFIED	不注入数据的连接器将具有此值

DataStore

DataStore 在 DataStore 级别捕获全局设置和配置。

字段
name	string 不可变。标识符。数据存储区的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
display_name	string 必需。数据存储区显示名。 此字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
industry_vertical	IndustryVertical 不可变。数据存储区注册的行业垂直领域。
solution_types[]	SolutionType 数据存储区注册的解决方案。每种 industry_vertical 的可用解决方案： MEDIA：SOLUTION_TYPE_RECOMMENDATION 和 SOLUTION_TYPE_SEARCH。 SITE_SEARCH：系统会自动注册 SOLUTION_TYPE_SEARCH。其他解决方案无法加入。
default_schema_id	string 仅限输出。与此数据存储区关联的默认 Schema 的 ID。
content_config	ContentConfig 不可变。数据存储区的内容配置。如果未设置此字段，服务器行为将默认为 ContentConfig.NO_CONTENT。
create_time	Timestamp 仅限输出。DataStore 的创建时间戳。
advanced_site_search_config	AdvancedSiteSearchConfig 可选。高级网站搜索的配置。
kms_key_name	string 仅限输入。创建时用于保护此 DataStore 的 KMS 密钥。 必须针对需要遵守 CMEK 组织政策保护的请求进行设置。 如果此字段已设置并成功处理，则 DataStore 将受 cmek_config 字段中指示的 KMS 密钥保护。
cmek_config	CmekConfig 仅限输出。DataStore 的 CMEK 相关信息。
billing_estimation	BillingEstimation 仅限输出。用于结算的数据大小估算。
acl_enabled	bool 不可变。DataStore 中的数据是否具有 ACL 信息。如果设置为 true，则源数据必须具有 ACL。当通过 DocumentService.ImportDocuments 方法提取数据时，系统会提取 ACL。 当为 DataStore 启用 ACL 时，无法通过调用 DocumentService.GetDocument 或 DocumentService.ListDocuments 来访问 Document。 目前，ACL 仅在 GENERIC 行业垂直领域中支持，且内容配置为非 PUBLIC_WEBSITE。
workspace_config	WorkspaceConfig 用于存储工作区数据的数据存储区类型配置的配置。当 DataStore.content_config 设置为 DataStore.ContentConfig.GOOGLE_WORKSPACE 时，必须设置此参数。
document_processing_config	DocumentProcessingConfig 文档理解和丰富功能的配置。
starting_schema	Schema 在配置 DataStore 时要使用的起始架构。如果未设置，系统将使用默认的垂直专业化架构。 此字段仅供 CreateDataStore API 使用，如果用于其他 API，则会被忽略。此字段将从所有 API 响应（包括 CreateDataStore API）中省略。如需检索 DataStore 的架构，请改用 SchemaService.GetSchema API。 系统会根据有关架构的某些规则验证所提供的架构。如需了解详情，请参阅此文档。
healthcare_fhir_config	HealthcareFhirConfig 可选。HEALTHCARE_FHIR 垂直领域的配置。
serving_config_data_store	ServingConfigDataStore 可选。在 DataStore 级层存储投放配置。
identity_mapping_store	string 不可变。关联的 IdentityMappingStore 的完全限定资源名称。此字段只能针对具有 THIRD_PARTY 或 GSUITE IdP 的 acl_enabled DataStore 进行设置。格式：projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}。
is_infobot_faq_data_store	bool 可选。如果设置，则此 DataStore 为 Infobot FAQ DataStore。
configurable_billing_approach	ConfigurableBillingApproach 可选。可配置结算方式的配置。请参阅

BillingEstimation

每个数据存储区的数据大小估计值。

字段
structured_data_size	int64 结构化数据的数据大小（以字节为单位）。
unstructured_data_size	int64 非结构化数据的数据大小（以字节为单位）。
website_data_size	int64 网站的数据大小（以字节为单位）。
structured_data_update_time	Timestamp 结构化数据的上次更新时间戳。
unstructured_data_update_time	Timestamp 非结构化数据的上次更新时间戳。
website_data_update_time	Timestamp 网站的上次更新时间戳。

ConfigurableBillingApproach

可配置结算方式的配置。

枚举
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED	默认值。适用于 Spark 和非 Spark 不可配置的结算方式。
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE	对于非嵌入存储空间，使用订阅基础费用 + 超额使用费结算方式来结算索引核心费用。
CONFIGURABLE_CONSUMPTION_EMBEDDING	使用按用量付费的嵌入式存储空间加购项。

ContentConfig

数据存储区的内容配置。

枚举
CONTENT_CONFIG_UNSPECIFIED	默认值。
NO_CONTENT	仅包含没有任何 Document.content 的文档。
CONTENT_REQUIRED	仅包含具有 Document.content 的文档。
PUBLIC_WEBSITE	数据存储区用于公开网站搜索。
GOOGLE_WORKSPACE	数据存储区用于工作区搜索。工作区数据存储区的详细信息在 WorkspaceConfig 中指定。

ServingConfigDataStore

在 DataStore 级别存储有关服务配置的信息。

字段
disabled_for_serving	bool 可选。如果设置为 true，则 DataStore 将无法用于处理搜索请求。

DeleteAssistantRequest

对 AssistantService.DeleteAssistant 方法的请求消息。

字段
name	string 必需。Assistant 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 如果调用方没有删除 Assistant 的权限，无论该 Assistant 是否存在，系统都会返回 PERMISSION_DENIED 错误。 如果要删除的 Assistant 不存在，则返回 NOT_FOUND 错误。

DeleteCmekConfigMetadata

与 CmekConfigService.DeleteCmekConfig 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteCmekConfigRequest

CmekConfigService.DeleteCmekConfig 方法的请求消息。

字段
name	string 必需。要删除的 CmekConfig 的资源名称，例如 projects/{project}/locations/{location}/cmekConfigs/{cmek_config}。

DeleteCollectionMetadata

与 [CollectionService.UpdateCollection][] 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteCollectionRequest

CollectionService.DeleteCollection 方法的请求消息。

字段
name	string 必需。集合的完整资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}。

DeleteControlRequest

针对 DeleteControl 方法的请求。

字段
name	string 必需。要删除的控制变量的资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

针对 DeleteConversation 方法的请求。

字段
name	string 必需。要删除的对话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

与 DataStoreService.DeleteDataStore 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteDataStoreRequest

DataStoreService.DeleteDataStore 方法的请求消息。

字段
name	string 必需。DataStore 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。 如果调用方没有删除 DataStore 的权限，无论该 DataStore 是否存在，系统都会返回 PERMISSION_DENIED 错误。 如果要删除的 DataStore 不存在，则返回 NOT_FOUND 错误。

DeleteDocumentRequest

DocumentService.DeleteDocument 方法的请求消息。

字段
name	string 必需。Document 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}。 如果调用方没有删除 Document 的权限，无论该 Document 是否存在，系统都会返回 PERMISSION_DENIED 错误。 如果要删除的 Document 不存在，则返回 NOT_FOUND 错误。

DeleteEngineMetadata

与 EngineService.DeleteEngine 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteEngineRequest

EngineService.DeleteEngine 方法的请求消息。

字段
name	string 必需。Engine 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。 如果调用方没有删除 Engine 的权限，无论该 Engine 是否存在，系统都会返回 PERMISSION_DENIED 错误。 如果要删除的 Engine 不存在，则返回 NOT_FOUND 错误。

DeleteIdentityMappingStoreMetadata

与 IdentityMappingStoreService.DeleteIdentityMappingStore 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteIdentityMappingStoreRequest

IdentityMappingStoreService.DeleteIdentityMappingStore 的请求消息

字段
name	string 必需。要删除的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

DeleteSchema LRO 的元数据。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteSchemaRequest

SchemaService.DeleteSchema 方法的请求消息。

字段
name	string 必需。架构的完整资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}。

DeleteSessionRequest

针对 DeleteSession 方法的请求。

字段
name	string 必需。要删除的会话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

与 SiteSearchEngineService.DeleteSitemap 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteSitemapRequest

SiteSearchEngineService.DeleteSitemap 方法的请求消息。

字段
name	string 必需。Sitemap 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}。 如果调用者无权访问 Sitemap（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 Sitemap 不存在，则返回 NOT_FOUND 错误。

DeleteTargetSiteMetadata

与 SiteSearchEngineService.DeleteTargetSite 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DeleteTargetSiteRequest

SiteSearchEngineService.DeleteTargetSite 方法的请求消息。

字段
name	string 必需。TargetSite 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}。 如果调用者无权访问 TargetSite（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 TargetSite 不存在，则返回 NOT_FOUND 错误。

DestinationConfig

定义用于连接到第三方来源的目标端点。

字段
key	string 可选。连接器支持的唯一目的地标识符。
destinations[]	Destination 可选。相应密钥对应的目标平台。
联合字段 destination_config_params。相应目标配置的其他参数。destination_config_params 只能是下列其中一项：
params	Struct 可选。此目标配置的其他参数（采用结构化 JSON 格式）。
json_params	string 此目标配置的其他参数（采用 JSON 字符串格式）。

目的地

定义目标端点

字段
port	int32 可选。目的地接受的目标端口号。
联合字段 destination。端点目的地。destination 只能是下列其中一项：
host	string 可公开路由的主机。

DisableAdvancedSiteSearchMetadata

与 SiteSearchEngineService.DisableAdvancedSiteSearch 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

DisableAdvancedSiteSearchRequest

SiteSearchEngineService.DisableAdvancedSiteSearch 方法的请求消息。

字段
site_search_engine	string 必需。SiteSearchEngine 的完整资源名称，例如 projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine。

DisableAdvancedSiteSearchResponse

此类型没有字段。

SiteSearchEngineService.DisableAdvancedSiteSearch 方法的响应消息。

文档

文档会捕获要推荐或搜索的商品的所有原始元数据信息。

字段
name	string 不可变。文档的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
id	string 不可变。相应文档的标识符。 ID 应符合 RFC-1034 标准，长度限制为 128 个字符。
schema_id	string 位于同一数据存储区中的架构的标识符。
content	Content 与此文档相关联的非结构化数据。内容只能设置，并且如果相应文档位于 CONTENT_REQUIRED 数据存储区下，则必须设置。
parent_document_id	string 父文档的标识符。目前最多支持两级文档层次结构。 ID 应符合 RFC-1034 标准，长度上限为 63 个字符。
derived_struct_data	Struct 仅限输出。此字段为 OUTPUT_ONLY。它包含原始输入文档中没有的派生数据。
acl_info	AclInfo 文档的访问权限控制信息。
index_time	Timestamp 仅限输出。上次将相应文档编入索引的时间。如果设置了此字段，则可以在搜索结果中返回相应文档。 此字段为 OUTPUT_ONLY。如果未填充此字段，则表示相应文档从未编入索引。
index_status	IndexStatus 仅限输出。相应文档的索引状态。 如果文档已成功编入索引，则会填充 index_time 字段。 否则，如果因错误而未将文档编入索引，则会填充 error_samples 字段。 否则，如果文档的索引编制正在进行中，则会填充 pending_message 字段。
联合字段 data。数据表示法。应提供 struct_data 或 json_data，否则会抛出 INVALID_ARGUMENT 错误。data 只能是下列其中一项：
struct_data	Struct 相应文档的结构化 JSON 数据。它应符合已注册的 Schema，否则会抛出 INVALID_ARGUMENT 错误。
json_data	string 相应文档的 JSON 字符串表示形式。它应符合已注册的 Schema，否则会抛出 INVALID_ARGUMENT 错误。

AclInfo

文档的 ACL 信息。

字段
readers[]	AccessRestriction 文档的读者。

AccessRestriction

AclRestriction，用于对复杂的继承限制进行建模。

示例：对“同时允许”继承进行建模，其中用户需要拥有父文档的访问权限才能访问子文档。

文档层次结构 - Space_S --> Page_P。

读者：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 限制。{ "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" } ], } ] } }

字段
principals[]	Principal 主账号列表。
idp_wide	bool 身份提供方中的所有用户。

内容

与此文档相关联的非结构化数据。

字段
mime_type	string 内容的 MIME 类型。支持的类型： application/pdf（PDF，目前仅支持原生 PDF） text/html (HTML) text/plain (TXT) application/xml 或 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) 仅当数据存储区中启用了布局解析器时，才支持以下类型： image/bmp (BMP) image/gif (GIF) image/jpeg (JPEG) image/png (PNG) image/tiff (TIFF) 请参阅 https://www.iana.org/assignments/media-types/media-types.xhtml。
联合字段 content。非结构化文档的内容。content 只能是下列其中一项：
raw_bytes	bytes 内容，以字节流的形式表示。长度上限为 1,000,000 字节（1 MB / ~0.95 MiB）。 注意：与所有 bytes 字段一样，此字段在协议缓冲区中以纯二进制形式表示，在 JSON 中以 base64 编码的字符串形式表示。例如，abc123!?$*&()'-=@~ 在 JSON 中应表示为 YWJjMTIzIT8kKiYoKSctPUB+。请参阅 https://developers.google.com/protocol-buffers/docs/proto3#json。
uri	string 相应内容的 URI。仅支持 Cloud Storage URI（例如 gs://bucket-name/path/to/file）。对于基于文本的格式，文件大小上限为 2.5 MB；对于其他格式，文件大小上限为 200 MB。

IndexStatus

相应文档的索引状态。

字段
index_time	Timestamp 相应文档的编入索引时间。如果此字段已填充，则表示相应文档已编入索引。
error_samples[]	Status 为文档编制索引时遇到的错误示例。如果此字段已填充，则表示相应文档因存在错误而未编入索引。
pending_message	string 不可变。此消息表示文档索引正在进行中。如果此字段已填充，则表示文档索引处于待处理状态。

DocumentInfo

与用户事件关联的详细文档信息。

字段
promotion_ids[]	string 与相应文档关联的促销活动 ID。目前，此字段最多只能包含一个 ID。
joined	bool 仅限输出。所引用的文档是否可在数据存储区中找到。
联合字段 document_descriptor。关联的 Document 的必需描述符。 如果指定了 id，则在通过存储的 Document 进行注释时，将使用 {location}、{collection_id}、{data_store_id} 和 {branch_id} 的默认值。 如果指定了 name，则在对存储的 Document 进行注释时，将使用为 {location}、{collection_id}、{data_store_id} 和 {branch_id} 提供的（允许使用默认）值。document_descriptor 只能是下列其中一项：
id	string Document 资源 ID。
name	string Document 资源的完整名称，格式为：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
uri	string Document URI - 仅允许用于网站数据存储区。
quantity	int32 与用户事件关联的文档数量。默认为 1。 例如，如果 add-to-cart 事件涉及同一文档的两个数量，则此字段为 2。 对于以下事件类型的事件，此参数为必需参数： add-to-cart purchase
conversion_value	float 可选。与相应文档关联的转化价值。如果 UserEvent.event_type 为“conversion”，则必须设置此参数。 例如，值 1000 表示用户在查看文档上花费了 1000 秒，而这属于 watch 转化类型。

DocumentProcessingConfig

DataStore 的单例资源。如果在创建 DataStore 时该字段为空，且 DataStore 设置为 DataStore.ContentConfig.CONTENT_REQUIRED，则默认解析器将默认使用数字解析器。

字段
name	string 文档处理配置的完整资源名称。格式：projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig。
chunking_config	ChunkingConfig 分块模式是否已启用。
default_parsing_config	ParsingConfig 默认文档解析器的配置。如果未指定，我们将按默认 DigitalParsingConfig 进行配置，并且默认解析配置将应用于文档解析的所有文件类型。
parsing_config_overrides	map<string, ParsingConfig> 从文件类型到覆盖默认解析配置的映射（基于文件类型）。支持的密钥： pdf：替换 PDF 文件的解析配置，支持数字解析、OCR 解析或布局解析。 html：替换 HTML 文件的解析配置，仅支持数字解析和布局解析。 docx：替换 DOCX 文件的解析配置，仅支持数字解析和布局解析。 pptx：替换 PPTX 文件的解析配置，仅支持数字解析和布局解析。 xlsm：替换 XLSM 文件的解析配置，仅支持数字解析和布局解析。 xlsx：替换 XLSX 文件的解析配置，仅支持数字解析和布局解析。

ChunkingConfig

分块配置的配置。

字段
联合字段 chunk_mode。用于定义分块行为的其他配置。chunk_mode 只能是下列其中一项：
layout_based_chunking_config	LayoutBasedChunkingConfig 基于布局的分块的配置。

LayoutBasedChunkingConfig

基于布局的分块的配置。

字段
chunk_size	int32 每个块的令牌大小限制。 支持的值：100-500（含）。默认值：500。
include_ancestor_headings	bool 是否在从文档中间部分创建的分块中附加不同级别的标题，以防止丢失上下文。 默认值：False。

ParsingConfig

应用于特定类型的文档解析器的相关配置。

字段
联合字段 type_dedicated_config。文档处理类型的配置。type_dedicated_config 只能是下列其中一项：
digital_parsing_config	DigitalParsingConfig 已应用于数字解析器的配置。
ocr_parsing_config	OcrParsingConfig 应用于 OCR 解析器的配置。目前，此功能仅适用于 PDF 文件。
layout_parsing_config	LayoutParsingConfig 应用于布局解析器的配置。

DigitalParsingConfig

此类型没有字段。

文档的数字化解析配置。

LayoutParsingConfig

文档的布局解析配置。

字段
enable_table_annotation	bool 可选。如果为 true，系统会在解析期间，将基于 LLM 的注解添加到表格。
enable_image_annotation	bool 可选。如果为 true，系统会在解析期间，将基于 LLM 的注解添加到图片。
structured_content_types[]	string 可选。包含要从文档中提取的必需结构类型。支持的值： shareholder-structure
exclude_html_elements[]	string 可选。要从已解析的内容中排除的 HTML 元素的列表。
exclude_html_classes[]	string 可选。要从解析的内容中排除的 HTML 类列表。
exclude_html_ids[]	string 可选。要从已解析的内容中排除的 HTML ID 列表。
enable_get_processed_document	bool 可选。如果为 true，则处理后的文档将可用于 GetProcessedDocument API。

OcrParsingConfig

文档的 OCR 解析配置。

字段
enhanced_document_elements[] (deprecated)	string 此项已弃用！ [已弃用] 此字段已弃用。如需使用其他增强型文档元素处理功能，请切换到 layout_parsing_config。
use_native_text	bool 如果为 true，则在包含原生文本的网页上使用原生文本，而不是 OCR 文本。

DoubleList

双精度列表。

字段
values[]	double 双精度值。

EnableAdvancedSiteSearchMetadata

与 SiteSearchEngineService.EnableAdvancedSiteSearch 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

EnableAdvancedSiteSearchRequest

SiteSearchEngineService.EnableAdvancedSiteSearch 方法的请求消息。

字段
site_search_engine	string 必需。SiteSearchEngine 的完整资源名称，例如 projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine。

EnableAdvancedSiteSearchResponse

此类型没有字段。

SiteSearchEngineService.EnableAdvancedSiteSearch 方法的响应消息。

引擎

描述 Engine 的训练和部署参数的元数据。

字段
name	string 不可变。标识符。引擎的完全限定资源名称。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine} 引擎应为 1-63 个字符，有效字符为 /[a-z0-9][a-z0-9-_]*/。否则，系统会返回 INVALID_ARGUMENT 错误。
display_name	string 必需。引擎的显示名称。应采用人类可读懂的格式。UTF-8 编码的字符串，长度上限为 1024 个字符。
create_time	Timestamp 仅限输出。创建推荐引擎时的时间戳。
update_time	Timestamp 仅限输出。上次更新 Recommendation Engine 时的时间戳。
data_store_ids[]	string 可选。与此引擎关联的数据存储区。 对于 SOLUTION_TYPE_SEARCH 和 SOLUTION_TYPE_RECOMMENDATION 类型的引擎，它们最多只能与一个数据存储区相关联。 如果 solution_type 为 SOLUTION_TYPE_CHAT，则可以在此处关联同一 Collection 中的多个 DataStore。 请注意，在 CreateEngineRequest 中使用时，必须提供一个 DataStore ID，因为系统会使用它进行必要的初始化。
solution_type	SolutionType 必需。引擎的解决方案。
industry_vertical	IndustryVertical 可选。引擎注册的行业纵向市场。引擎行业垂直领域的限制基于 DataStore：引擎上的垂直领域必须与链接到引擎的 DataStore 的垂直领域相匹配。
common_config	CommonConfig 指定引擎元数据的通用配置规范。
app_type	AppType 可选。不可变。相应引擎资源所代表的应用类型。注意：这是一个独立于现有行业垂直领域或解决方案类型的新概念。
disable_analytics	bool 可选。是否针对在此引擎上执行的搜索停用分析功能。
features	map<string, FeatureState> 可选。供引擎选择启用或停用功能的特征配置。支持的密钥： *：所有功能，如果存在，则忽略所有其他功能状态设置。 agent-gallery no-code-agent-builder prompt-gallery model-selector notebook-lm people-search people-search-org-chart bi-directional-audio feedback session-sharing personalization-memory disable-agent-sharing disable-image-generation disable-video-generation disable-onedrive-upload disable-talk-to-content disable-google-drive-upload
configurable_billing_approach	ConfigurableBillingApproach 可选。可配置结算方式的配置。
联合字段 engine_config。定义引擎行为的其他配置规范。engine_config 只能是下列其中一项：
chat_engine_config	ChatEngineConfig 聊天引擎的配置。仅在 solution_type 为 SOLUTION_TYPE_CHAT 时适用。
search_engine_config	SearchEngineConfig 搜索引擎的配置。仅在 solution_type 为 SOLUTION_TYPE_SEARCH 时适用。
media_recommendation_engine_config	MediaRecommendationEngineConfig 媒体引擎的配置。仅适用于具有 solution_type SOLUTION_TYPE_RECOMMENDATION 和 IndustryVertical.MEDIA 垂直行业的数据存储区。
联合字段 engine_metadata。用于监控引擎状态的引擎元数据。engine_metadata 只能是下列其中一项：
chat_engine_metadata	ChatEngineMetadata 仅限输出。有关 Chat Engine 的其他信息。仅在 solution_type 为 SOLUTION_TYPE_CHAT 时适用。

AppType

引擎的应用。

枚举
APP_TYPE_UNSPECIFIED	所有未指定的应用。
APP_TYPE_INTRANET	用于内网搜索和 Agentspace 的应用类型。

ChatEngineConfig

聊天引擎的配置。

字段
agent_creation_config	AgentCreationConfig 用于生成与此引擎关联的 Dialogflow 代理的配置。 请注意，这些配置由 Dialogflow 服务一次性使用并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。
dialogflow_agent_to_link	string 要与此 Chat Engine 关联的现有 Dialogflow 代理的资源名称。客户可以提供 agent_creation_config 来创建代理，也可以提供将代理与 Chat 引擎相关联的代理名称。 格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。 请注意，dialogflow_agent_to_link 由 Dialogflow 服务一次性消耗并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。在创建 Engine 后，使用 ChatEngineMetadata.dialogflow_agent 进行实际的代理关联。
allow_cross_region	bool 可选。如果该标志设置为 true，则允许代理和引擎位于不同的位置；否则，代理和引擎必须位于同一位置。该标志默认设置为 false。 请注意，allow_cross_region 由 EngineService.CreateEngine 一次性消耗并传递给 EngineService.CreateEngine。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。

AgentCreationConfig

用于生成 Dialogflow 代理的配置。

请注意，这些配置由 Dialogflow 服务一次性使用并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。

字段
business	string 代理人所代表的公司、组织或其他实体的名称。用于知识连接器 LLM 提示和知识搜索。
default_language_code	string 必需。代理的默认语言，采用语言代码的形式表示。请参阅语言支持以获取当前支持的语言代码列表。
time_zone	string 必需。根据时区数据库确定的代理时区，例如 America/New_York、Europe/Paris。
location	string 创建代理时使用的代理位置，支持的值：global/us/eu。如果未提供，美国引擎将默认使用 us-central-1 创建代理；欧盟引擎将默认使用 eu-west-1 创建代理。

ChatEngineMetadata

聊天引擎的其他信息。此消息中的字段仅限输出。

字段
dialogflow_agent	string 此 Chat Engine 所引用的 Dialogflow 代理的资源名称。 格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。

CommonConfig

引擎的常见配置。

字段
company_name	string 与引擎关联的公司、企业或实体的名称。设置此项有助于改进 LLM 相关功能。

ConfigurableBillingApproach

可配置结算方式的配置。

枚举
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED	默认值。适用于 Spark 和非 Spark 不可配置的结算方式。一般价格模式。
CONFIGURABLE_BILLING_APPROACH_ENABLED	结算方式遵循客户指定的配置。

FeatureState

引擎的功能状态。

枚举
FEATURE_STATE_UNSPECIFIED	未指定功能状态。
FEATURE_STATE_ON	此功能已开启，可供使用。
FEATURE_STATE_OFF	该功能已关闭，无法使用。

MediaRecommendationEngineConfig

媒体推荐引擎的其他配置规范。

字段
type	string 必需。引擎类型。例如，recommended-for-you。 此字段与 optimization_objective 一起描述了用于控制引擎训练和服务的引擎元数据。 目前支持的值：recommended-for-you、others-you-may-like、more-like-this、most-popular-items。
optimization_objective	string 优化目标。例如，cvr。 此字段与 optimization_objective 一起描述了用于控制引擎训练和服务的引擎元数据。 目前支持的值：ctr、cvr。 如果未指定，我们会根据引擎类型选择默认值。默认值取决于建议类型： recommended-for-you => ctr others-you-may-like => ctr
optimization_objective_config	OptimizationObjectiveConfig 以 cvr 为优化目标的自定义阈值的名称和值。对于 target_field watch-time，target_field_value 必须是一个整数值，表示介于 (0, 86400]（不包括 0，包括 86400）之间的媒体进度时间（以秒为单位）（例如，90）。对于 target_field watch-percentage，target_field_value 必须是介于 (0, 1.0] 之间的有效浮点值（不含 0，含 1.0）（例如，0.5）。
training_state	TrainingState 引擎所处的训练状态（例如 TRAINING 或 PAUSED）。 由于运行服务的部分费用取决于训练频率，因此可以使用此参数来确定何时训练引擎，以便控制费用。如果未指定：CreateEngine 方法的默认值为 TRAINING。UpdateEngine 方法的默认值是保持状态与之前相同。
engine_features_config	EngineFeaturesConfig 可选。其他引擎功能配置。

EngineFeaturesConfig

所选引擎类型的更多功能配置。

字段
联合字段 type_dedicated_config。应用于特定类型的媒体建议引擎的相关功能配置。type_dedicated_config 只能是下列其中一项：
recommended_for_you_config	RecommendedForYouFeatureConfig 建议的引擎功能配置。
most_popular_config	MostPopularFeatureConfig 最受欢迎的引擎功能配置。

MostPopularFeatureConfig

创建“最受欢迎”引擎所需的功能配置。

字段
time_window_days	int64 在训练和预测时查询引擎的时间窗口。只能是正整数。该值表示过去 X 天的事件。目前是 most-popular-items 引擎的必需参数。

OptimizationObjectiveConfig

针对 cvr optimization_objective 的自定义阈值。

字段
target_field	string 必需。要定位的字段的名称。目前支持的值：watch-percentage、watch-time。
target_field_value_float	float 必需。要应用于目标的阈值（例如，0.5）。

RecommendedForYouFeatureConfig

用于创建 recommended-for-you 引擎的其他功能配置。

字段
context_event_type	string 在预测时查询引擎所用的事件类型。如果设置为 generic，则在引擎训练中，只有 view-item、media-play 和 media-complete 会用作 context-event。如果设置为 view-home-page，则 view-home-page 还将用作 context-events，此外还会用作 view-item、media-play 和 media-complete。目前支持 recommended-for-you 引擎。目前支持的值：view-home-page、generic。

TrainingState

引擎的训练状态。

枚举
TRAINING_STATE_UNSPECIFIED	未指定训练状态。
PAUSED	引擎训练已暂停。
TRAINING	引擎正在训练。

SearchEngineConfig

搜索引擎的配置。

字段
search_tier	SearchTier 相应引擎的搜索功能层级。 不同层级的价格可能不同。如需了解详情，请参阅价格文档。 如果未指定，则默认为 SearchTier.SEARCH_TIER_STANDARD。
search_add_ons[]	SearchAddOn 相应搜索引擎启用的插件。

FactChunk

Fact Chunk。

字段
chunk_text	string 事实块的文本内容。长度不得超过 1 万个字符。
source	string 检索相应事实块的来源。如果它是从请求中提供的 GroundingFacts 中检索到的，则此字段将包含检索到此块的具体事实的索引。
index	int32 相应块的索引。目前仅用于流式模式。
source_metadata	map<string, string> 来源参考的更精细信息。
uri	string 来源的 URI。
title	string 来源的标题。
domain	string 来源的网域。

FetchDomainVerificationStatusRequest

SiteSearchEngineService.FetchDomainVerificationStatus 方法的请求消息。

字段
site_search_engine	string 必需。我们从中获取所有域名验证状态的网站搜索引擎资源。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。
page_size	int32 请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。 如果此字段为负数，系统会返回 INVALID_ARGUMENT 错误。
page_token	string 从之前的 FetchDomainVerificationStatus 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 FetchDomainVerificationStatus 的所有其他参数必须与提供页面令牌的调用匹配。

FetchDomainVerificationStatusResponse

SiteSearchEngineService.FetchDomainVerificationStatus 方法的响应消息。

字段
target_sites[]	TargetSite 包含网站验证状态的 TargetSite 列表。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
total_size	int32 与请求匹配的商品总数。此字段始终会填充在响应中。

FetchSitemapsRequest

SiteSearchEngineService.FetchSitemaps 方法的请求消息。

字段
parent	string 必需。SiteSearchEngine 的父级资源名称，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。
matcher	Matcher 可选。如果指定，则提取匹配的 Sitemap。如果未指定，则提取 DataStore 中的所有 Sitemap。

Matcher

Sitemap 的匹配器。目前仅支持 URI 匹配器。

字段
联合字段 matcher。Sitemap 的匹配器。matcher 只能是下列其中一项：
uris_matcher	UrisMatcher 按站点地图 URI 进行匹配。

UrisMatcher

用于按 URI 匹配 Sitemap 的匹配器。

字段
uris[]	string Sitemap URI。

FetchSitemapsResponse

SiteSearchEngineService.FetchSitemaps 方法的响应消息。

字段
sitemaps_metadata[]	SitemapMetadata 已提取的 Sitemap 的列表。

SitemapMetadata

包含 Sitemap 及其元数据。

字段
sitemap	Sitemap Sitemap。

FhirStoreSource

Cloud FhirStore 源导入数据。

字段
fhir_store	string 必需。要从中导入数据的 FHIR 存储区的完整资源名称，格式为 projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}。
gcs_staging_dir	string 用于导入操作的中间 Cloud Storage 目录，长度限制为 2,000 个字符。如果要将 FhirStore 内容导出至特定 Cloud Storage 目录，则可以指定。
resource_types[]	string 要导入的 FHIR 资源类型。资源类型应是所有受支持的 FHIR 资源类型的子集。如果为空，则默认为所有受支持的 FHIR 资源类型。
update_from_latest_predefined_schema	bool 可选。是否将 DataStore 架构更新为最新的预定义架构。 如果为 true，则会更新 DataStore 架构，以纳入自上次导入以来添加的所有 FHIR 字段或资源类型，并从 FHIR 存储区导入相应的 FHIR 资源。 请注意，此字段不能与 resource_types 结合使用。应在初始导入后使用。

FirestoreSource

从中导入数据的 Firestore 源。

字段
project_id	string Cloud SQL 源所在的项目 ID，长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
database_id	string 必需。要从中复制数据的 Firestore 数据库，长度限制为 256 个字符。
collection_id	string 必需。要从中复制数据的 Firestore 集合（或实体），长度限制为 1,500 个字符。
gcs_staging_dir	string 用于导入操作的中间 Cloud Storage 目录，长度限制为 2,000 个字符。如果要将 Firestore 内容导出至特定 Cloud Storage 目录，则可以指定。 确保 Firestore 服务账号具有必要的 Cloud Storage 管理员权限，以便访问指定的 Cloud Storage 目录。

GcsSource

输入内容的 Cloud Storage 位置。

字段
input_uris[]	string 必需。输入文件的 Cloud Storage URI。每个 URI 最多可包含 2,000 个字符。URI 可以与完整对象路径（例如 gs://bucket/directory/object.json）匹配，也可以与匹配一个或多个文件的模式（例如 gs://bucket/directory/*.json）匹配。 一个请求最多可包含 100 个文件（如果 data_schema 为 content，则最多可包含 10 万个文件）。每个文件的大小上限为 2 GB（如果 data_schema 为 content，则上限为 100 MB）。
data_schema	string 从来源解析数据时要使用的架构。 支持的文档导入值： document（默认）：每行一个 JSON Document。每个文档都必须具有有效的 Document.id。 content：非结构化数据（例如 PDF、HTML）。input_uris 匹配的每个文件都会成为一个文档，其 ID 设置为 SHA256(URI) 的前 128 位（以十六进制字符串形式编码）。 custom：每行一个自定义数据 JSON，采用符合数据存储区定义的 Schema 的任意格式。此功能只能由“宽泛”数据存储区垂直行业使用。 csv：一个 CSV 文件，其标头符合数据存储区的已定义 Schema。标题后的每个条目都会作为文档导入。此功能只能由“宽泛”数据存储区垂直行业使用。 支持的用户事件导入值： user_event（默认）：每行一个 JSON UserEvent。

GetAclConfigRequest

针对 GetAclConfigRequest 方法的请求消息。

字段
name	string 必需。AclConfig 的资源名称，例如 projects/*/locations/*/aclConfig。 如果调用者无权访问 AclConfig（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。

GetAnswerRequest

对 GetAnswer 方法的请求。

字段
name	string 必需。要获取的回答的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

对 AssistAnswerService.GetAssistAnswer 方法的请求消息。

字段
name	string 必需。AssistAnswer 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

对 AssistantService.GetAssistant 方法的请求消息。

字段
name	string 必需。Assistant 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

针对 GetCmekConfigRequest 方法的请求消息。

字段
name	string 必需。CmekConfig 的资源名称，例如 projects/*/locations/*/cmekConfig 或 projects/*/locations/*/cmekConfigs/*。 如果调用者无权访问 CmekConfig（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。

GetControlRequest

针对 GetControl 方法的请求。

字段
name	string 必需。要获取的控制变量的资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

针对 GetConversation 方法的请求。

字段
name	string 必需。要获取的对话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

对 DataConnectorService.GetDataConnector 方法的请求。

字段
name	string 必需。DataConnector 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataConnector。 如果调用者无权访问 DataConnector（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 DataConnector 不存在，则返回 NOT_FOUND 错误。

GetDataStoreRequest

DataStoreService.GetDataStore 方法的请求消息。

字段
name	string 必需。DataStore 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。 如果调用者无权访问 DataStore（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 DataStore 不存在，则返回 NOT_FOUND 错误。

GetDocumentRequest

DocumentService.GetDocument 方法的请求消息。

字段
name	string 必需。Document 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}。 如果调用方没有访问 Document 的权限（无论该 Document 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 Document 不存在，则返回 NOT_FOUND 错误。

GetEngineRequest

EngineService.GetEngine 方法的请求消息。

字段
name	string 必需。Engine 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。

GetIdentityMappingStoreRequest

IdentityMappingStoreService.GetIdentityMappingStore 的请求消息

字段
name	string 必需。要获取的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

LicenseConfigService.GetLicenseConfig 方法的请求消息。

字段
name	string 必需。LicenseConfig 的完整资源名称，例如 projects/{project}/locations/{location}/licenseConfigs/*。 如果调用者无权访问 LicenseConfig（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 LicenseConfig 不存在，则返回 NOT_FOUND 错误。

GetSchemaRequest

SchemaService.GetSchema 方法的请求消息。

字段
name	string 必需。架构的完整资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}。

GetSessionRequest

对 GetSession 方法的请求。

字段
name	string 必需。要获取的会话的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}
include_answer_details	bool 可选。如果设置为 true，则返回完整会话，包括所有回答详情。

GetSiteSearchEngineRequest

SiteSearchEngineService.GetSiteSearchEngine 方法的请求消息。

字段
name	string 必需。SiteSearchEngine 的资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。 如果调用者无权访问 [SiteSearchEngine]，无论该 [SiteSearchEngine] 是否存在，系统都会返回 PERMISSION_DENIED 错误。

GetTargetSiteRequest

SiteSearchEngineService.GetTargetSite 方法的请求消息。

字段
name	string 必需。TargetSite 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}。 如果调用者无权访问 TargetSite（无论其是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果请求的 TargetSite 不存在，则返回 NOT_FOUND 错误。

GroundingFact

基本事实。

字段
fact_text	string 事实的文本内容。长度不得超过 1 万个字符。
attributes	map<string, string> 与事实相关联的属性。常见属性包括 source（指明事实的来源）、author（指明事实的作者）等。

HarmCategory

将屏蔽内容的有害类别。

枚举
HARM_CATEGORY_UNSPECIFIED	未指定有害类别。
HARM_CATEGORY_HATE_SPEECH	有害类别为仇恨言论。
HARM_CATEGORY_DANGEROUS_CONTENT	有害类别为危险内容。
HARM_CATEGORY_HARASSMENT	有害类别为骚扰。
HARM_CATEGORY_SEXUALLY_EXPLICIT	有害类别为露骨色情内容。
HARM_CATEGORY_CIVIC_INTEGRITY	有害类别为公民诚信。

HealthcareFhirConfig

针对 HEALTHCARE_FHIR 垂直行业的数据存储区配置。

字段
enable_configurable_schema	bool 是否为 HEALTHCARE_FHIR 纵向启用可配置的架构。 如果设置为 true，则可以扩展预定义的医疗保健 FHIR 架构，以实现更自定义的搜索和过滤。
enable_static_indexing_for_batch_ingestion	bool 是否为 HEALTHCARE_FHIR 批次提取启用静态索引。 如果设置为 true，批量提取将以静态索引模式处理，这种模式速度较慢，但能够处理更大的量。

IdentityMappingEntry

用于将外部身份映射到内部身份的身份映射条目。

字段
external_identity	string 必需。客户身份提供方之外的身份。外部身份的长度上限为 100 个字符。
联合字段 identity_provider_id。联合字段 identity_provider_id。身份提供商 ID 可以是用户或群组。identity_provider_id 只能是下列其中一项：
user_id	string 用户标识符。对于 Google Workspace 用户账号，user_id 应该是 Google Workspace 用户电子邮件地址。对于非 Google 身份提供方，user_id 是在 workforcepool 配置期间配置的映射用户标识符。
group_id	string 群组标识符。对于 Google Workspace 用户账号，group_id 应该是 Google Workspace 群组电子邮件地址。对于非 Google 身份提供方，group_id 是在 workforcepool 配置期间配置的映射群组标识符。

IdentityMappingEntryOperationMetadata

针对 IdentityMappingStoreService.ImportIdentityMappings 和 IdentityMappingStoreService.PurgeIdentityMappings 的 IdentityMappingEntry LongRunningOperation 元数据

字段
success_count	int64 成功处理的 IdentityMappingEntry 的数量。
failure_count	int64 未能成功处理的 IdentityMappingEntry 的数量。
total_count	int64 处理的 IdentityMappingEntry 总数。

IdentityMappingStore

包含身份映射条目的身份映射存储区。

字段
name	string 不可变。身份映射存储区的完整资源名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}。此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
kms_key_name	string 仅限输入。在创建时用于保护此身份映射存储区的 KMS 密钥。 必须针对需要遵守 CMEK 组织政策保护的请求进行设置。 如果此字段已设置并成功处理，则身份映射存储区将受 cmek_config 字段中指示的 KMS 密钥保护。
cmek_config	CmekConfig 仅限输出。身份映射存储区的 CMEK 相关信息。

IdentityScheduleConfig

身份数据同步运行的配置。

字段
refresh_interval	Duration 可选。用于同步此连接器提取的文档的访问控制列表信息的刷新间隔。如果未设置，系统会以 30 分钟的默认间隔刷新访问权限控制列表。身份刷新间隔时间最短为 30 分钟，最长为 7 天。
next_sync_time	DateTime 可选。数据连接器下一次数据同步预计开始的时间（世界协调时间 [UTC]）。客户只能指定小时和分钟来安排数据同步。当数据连接器的刷新间隔超过 1 天时，系统会使用此时间标准。

IdpConfig

身份提供方配置。

字段
idp_type	IdpType 已配置身份提供方类型。
external_idp_config	ExternalIdpConfig 外部身份提供方配置。

ExternalIdpConfig

第三方 IDP 配置。

字段
workforce_pool_name	string 员工池名称。示例：“locations/global/workforcePools/pool_id”

IdpType

身份提供方类型。

枚举
IDP_TYPE_UNSPECIFIED	默认值。未启用 ACL 搜索。
GSUITE	Google 第一方提供商。
THIRD_PARTY	第三方提供商。

ImportCompletionSuggestionsMetadata

与 ImportCompletionSuggestions 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 成功导入的 CompletionSuggestion 数量。
failure_count	int64 未能成功导入的 CompletionSuggestion 的数量。

ImportCompletionSuggestionsRequest

CompletionService.ImportCompletionSuggestions 方法的请求消息。

字段
parent	string 必需。要为其导入客户自动补全建议的父数据存储区资源名称。 遵循格式 projects/*/locations/*/collections/*/dataStores/*
error_config	ImportErrorConfig 导入期间发生错误的所需位置。
联合字段 source。自动补全建议的来源。source 只能是下列其中一项：
inline_source	InlineSource 建议条目的内嵌来源。
gcs_source	GcsSource 输入内容所在的 Cloud Storage 位置。
bigquery_source	BigQuerySource BigQuery 输入源。

InlineSource

CompletionSuggestions 的内嵌来源。

字段
suggestions[]	CompletionSuggestion 必需。要导入的所有拒绝名单条目的列表。最多 1,000 项。

ImportCompletionSuggestionsResponse

CompletionService.ImportCompletionSuggestions 方法的响应。如果长时间运行的操作已完成，则当操作成功时，此消息会由 google.longrunning.Operations.response 字段返回。

字段
error_samples[]	Status 处理请求时遇到的错误示例。
error_config	ImportErrorConfig 导入期间发生错误的所需位置。

ImportDocumentsMetadata

与 ImportDocuments 操作的进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 已成功处理的条目数。
failure_count	int64 处理时遇到错误的条目数。
total_count	int64 已处理的条目总数。

ImportDocumentsRequest

针对导入方法的请求消息。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。需要创建/更新权限。
error_config	ImportErrorConfig 导入期间发生错误的所需位置。
reconciliation_mode	ReconciliationMode 现有文档与要导入的文档之间的调和模式。默认值为 ReconciliationMode.INCREMENTAL。
update_mask	FieldMask 指示要更新所提供的导入文档中的哪些字段。如果未设置，则默认更新所有字段。
auto_generate_ids	bool 是否在缺少 ID 的情况下自动为文档生成 ID。 如果设置为 true，系统会根据载荷的哈希自动生成 Document.id，但多次导入期间 ID 可能不一致。在这种情况下，强烈建议使用 ReconciliationMode.FULL 以避免内容重复。如果未设置或设置为 false，则必须使用 id_field 指定 Document.id，否则，没有 ID 的文档将无法导入。 支持的数据源： GcsSource。GcsSource.data_schema 必须为 custom 或 csv。否则，系统会抛出 INVALID_ARGUMENT 错误。 BigQuerySource。BigQuerySource.data_schema 必须为 custom 或 csv。否则，系统会抛出 INVALID_ARGUMENT 错误。 SpannerSource。 CloudSqlSource。 FirestoreSource。 BigtableSource。
id_field	string 该字段用于指明要用作文档唯一 ID 的 ID 字段或列。 对于 GcsSource，它是 JSON 字段的键。例如，JSON 的 my_id 为 {"my_id": "some_uuid"}。对于其他用户，这可能是存储唯一 ID 的表的列名。 JSON 字段或表格列的值用作 Document.id。JSON 字段或表列必须为字符串类型，并且值必须设置为符合 RFC-1034 的有效字符串，长度为 1-63 个字符。否则，没有有效 ID 的文档将无法导入。 仅当 auto_generate_ids 未设置或设置为 false 时，才设置此字段。否则，系统会抛出 INVALID_ARGUMENT 错误。 如果未设置，则在从允许的数据源导入时使用默认值 _id。 支持的数据源： GcsSource。GcsSource.data_schema 必须为 custom 或 csv。否则，系统会抛出 INVALID_ARGUMENT 错误。 BigQuerySource。BigQuerySource.data_schema 必须为 custom 或 csv。否则，系统会抛出 INVALID_ARGUMENT 错误。 SpannerSource。 CloudSqlSource。 BigtableSource。
force_refresh_content	bool 可选。是否强制刷新文档的非结构化内容。 如果设置为 true，则无论引用内容是否已更新，系统都会刷新文档的内容部分。
联合字段 source。必需。输入的来源。source 只能是下列其中一项：
inline_source	InlineSource 文档的输入内容的内嵌来源。
gcs_source	GcsSource 输入内容所在的 Cloud Storage 位置。
bigquery_source	BigQuerySource BigQuery 输入源。
fhir_store_source	FhirStoreSource FhirStore 输入源。
spanner_source	SpannerSource Spanner 输入源。
cloud_sql_source	CloudSqlSource Cloud SQL 输入源。
firestore_source	FirestoreSource Firestore 输入源。
alloy_db_source	AlloyDbSource AlloyDB 输入源。
bigtable_source	BigtableSource Cloud Bigtable 输入源。

InlineSource

ImportDocuments 方法的输入配置的内嵌来源。

字段
documents[]	Document 必需。要更新/创建的文档的列表。每个文档都必须具有有效的 Document.id。建议最多 100 项。

ReconciliationMode

指明如何将导入的文档与之前创建或导入的现有文档进行协调。

枚举
RECONCILIATION_MODE_UNSPECIFIED	默认值为 INCREMENTAL。
INCREMENTAL	插入新文档或更新现有文档。
FULL	计算差异并替换整个文档数据集。如果现有文档不在来源位置，则可能会被删除。使用此模式时，目标数据集不会出现任何停机时间。任何应保持不变或应更新的文档在操作运行期间都会继续提供。

ImportDocumentsResponse

ImportDocumentsRequest 的回答。如果长时间运行的操作已完成，并且操作成功，则 google.longrunning.Operations.response 字段会返回此消息。

字段
error_samples[]	Status 处理请求时遇到的错误示例。
error_config	ImportErrorConfig 如果设置，则在请求中回显完整错误的 destination。

ImportErrorConfig

与导入相关的错误的配置。

字段
联合字段 destination。必需。错误目的地。destination 只能是下列其中一项：
gcs_prefix	string 导入错误的 Cloud Storage 前缀。此参数必须是现有的空 Cloud Storage 目录。导入错误会以 JSON 编码的 google.rpc.Status 消息形式写入此目录中的分片文件，每行一个错误。

ImportIdentityMappingsRequest

IdentityMappingStoreService.ImportIdentityMappings 的请求消息

字段
identity_mapping_store	string 必需。要将身份映射条目导入到的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
联合字段 source。输入的来源。source 只能是下列其中一项：
inline_source	InlineSource 用于导入身份映射条目的内嵌来源。

InlineSource

用于导入身份映射条目的内嵌来源。

字段
identity_mapping_entries[]	IdentityMappingEntry 一次最多可导入 10,000 个条目

ImportIdentityMappingsResponse

IdentityMappingStoreService.ImportIdentityMappings 的响应消息

字段
error_samples[]	Status 处理请求时遇到的错误示例。

ImportSuggestionDenyListEntriesMetadata

与 ImportSuggestionDenyListEntries 操作的进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

ImportSuggestionDenyListEntriesRequest

CompletionService.ImportSuggestionDenyListEntries 方法的请求消息。

字段
parent	string 必需。要为其导入禁止名单条目的父数据存储区资源名称。遵循“projects/*/locations/*/collections/*/dataStores/*”模式。
联合字段 source。更新后的 SuggestionDenyList 的来源。source 只能是下列其中一项：
inline_source	InlineSource 建议拒绝名单条目的输入内容的内嵌来源。
gcs_source	GcsSource 输入内容所在的 Cloud Storage 位置。 只能指定 1 个包含要导入的所有条目的文件。对于自动填充建议拒绝列表条目导入，支持的值 gcs_source.schema 为： suggestion_deny_list（默认）：每行一个 JSON [SuggestionDenyListEntry]。

InlineSource

SuggestionDenyListEntry 的内嵌来源。

字段
entries[]	SuggestionDenyListEntry 必需。要导入的所有拒绝名单条目的列表。最多 1,000 项。

ImportSuggestionDenyListEntriesResponse

CompletionService.ImportSuggestionDenyListEntries 方法的响应消息。

字段
error_samples[]	Status 处理请求时遇到的错误示例。
imported_entries_count	int64 成功导入的拒绝名单条目数。
failed_entries_count	int64 未能成功导入的拒绝名单条目数。

ImportUserEventsMetadata

与导入操作进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 已成功处理的条目数。
failure_count	int64 处理时遇到错误的条目数。

ImportUserEventsRequest

针对 ImportUserEvents 请求的消息。

字段
parent	string 必需。父级 DataStore 资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
error_config	ImportErrorConfig 导入期间发生错误的所需位置。无法针对内嵌用户事件导入进行设置。
联合字段 source。必需 - 用户事件数据的所需输入源。source 只能是下列其中一项：
inline_source	InlineSource UserEvents 的输入内容的内嵌来源。
gcs_source	GcsSource 输入内容所在的 Cloud Storage 位置。
bigquery_source	BigQuerySource BigQuery 输入源。

InlineSource

ImportUserEvents 方法的输入配置的内嵌来源。

字段
user_events[]	UserEvent 必需。要导入的用户事件的列表。建议最多 1 万件商品。

ImportUserEventsResponse

对 ImportUserEventsRequest 的响应。如果长时间运行的操作成功，则 google.longrunning.Operations.response 字段会返回此消息。

字段
error_samples[]	Status 处理请求时遇到的错误示例。
error_config	ImportErrorConfig 如果请求中设置了此字段，则会回显完整错误的接收方。
joined_events_count	int64 通过完整现有文档导入的用户事件数。
unjoined_events_count	int64 已导入的用户事件数量，但现有分支中未找到相应文档信息。

IndustryVertical

与 DataStore 关联的行业纵向市场。

枚举
INDUSTRY_VERTICAL_UNSPECIFIED	未设置时使用的值。
GENERIC	不特定于任何垂直行业的文档的通用垂直行业。
MEDIA	媒体行业。
HEALTHCARE_FHIR	医疗保健 FHIR 垂直领域。

间隔

浮点区间。

字段
联合字段 min。区间的下限。如果未设置任何 min 字段，则下限为负无穷大。 此字段的值不得大于 max。否则，系统会返回 INVALID_ARGUMENT 错误。min 只能是下列其中一项：
minimum	double 包含在范围内的下限。
exclusive_minimum	double 不含下限。
联合字段 max。区间的上限。如果未设置任何 max 字段，则上限为正无穷大。 此字段不得小于最小值。否则，系统将返回 INVALID_ARGUMENT 错误。max 只能是下列其中一项：
maximum	double 包含上限。
exclusive_maximum	double 不含上限。

LicenseConfig

有关用户许可的信息。

字段
name	string 不可变。标识符。许可配置的完全限定资源名称。格式：projects/{project}/locations/{location}/licenseConfigs/{license_config}
license_count	int64 必需。已购买的许可数量。
subscription_tier	SubscriptionTier 必需。许可配置的订阅层级信息。
state	State 仅限输出。许可配置的状态。
auto_renew	bool 可选。许可配置是否应在达到结束日期时自动续订。
start_date	Date 必需。开始日期。
end_date	Date 可选。计划的结束日期。
subscription_term	SubscriptionTerm 必需。订阅期。
free_trial	bool 可选。许可配置是否适用于免费试用。
alert_policy_resource_config	AlertPolicyResourceConfig 可选。相应许可配置的提醒政策配置。
gemini_bundle	bool 仅限输出。许可配置是否适用于 Gemini 套餐。

州

许可配置状态枚举。

枚举
STATE_UNSPECIFIED	默认值。许可配置不存在。
ACTIVE	许可配置有效且正在使用。
EXPIRED	许可配置已过期。
NOT_STARTED	许可配置尚未开始，且其开始日期是将来的日期。

ListAssistantsRequest

对 AssistantService.ListAssistants 方法的请求消息。

字段
parent	string 必需。父级资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
page_size	int32 要返回的 Assistant 数量上限。如果未指定，则默认为 100。允许的最大值为 1000；任何高于该值的值都会强制转换为 1000。
page_token	string 从之前的 AssistantService.ListAssistants 调用接收的页面令牌 ListAssistantsResponse.next_page_token。利用其进行后续页面检索。 进行分页时，提供给 ListAssistants 的所有其他参数必须与提供页面令牌的调用匹配。

ListAssistantsResponse

AssistantService.ListAssistants 方法的响应消息。

字段
assistants[]	Assistant 客户的所有 Assistant。
next_page_token	string 可作为 ListAssistantsRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListCmekConfigsRequest

CmekConfigService.ListCmekConfigs 方法的请求消息。

字段
parent	string 必需。父级位置资源名称，例如 projects/{project}/locations/{location}。 如果调用者没有列出相应位置下的 CmekConfig 的权限，无论是否存在 CmekConfig，系统都会返回 PERMISSION_DENIED 错误。

ListCmekConfigsResponse

CmekConfigService.ListCmekConfigs 方法的响应消息。

字段
cmek_configs[]	CmekConfig 客户的所有 CmekConfig。

ListControlsRequest

对 ListControls 方法的请求。

字段
parent	string 必需。数据存储区资源名称。格式：projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} 或 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。
page_size	int32 可选。页面中结果的数量上限。如果未指定，则默认为 50。允许的最大值为 1000。
page_token	string 可选。从之前的 ListControls 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 可选。要应用于列表结果的过滤条件。支持的功能： 如果未设置 filter，则列出父分支下的所有商品。目前不支持此字段。

ListControlsResponse

ListControls 方法的响应。

字段
controls[]	Control 给定数据存储区的所有控制变量。
next_page_token	string 分页令牌，如果未返回，则表示最后一页。

ListConversationsRequest

对 ListConversations 方法的请求。

字段
parent	string 必需。数据存储区资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
page_size	int32 页面中结果的数量上限。如果未指定，则默认为 50。允许的最大值为 1000。
page_token	string 从之前的 ListConversations 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 要应用于列表结果的过滤条件。支持的特征包括：user_pseudo_id、state。 示例：“user_pseudo_id = some_id”
order_by	string 以英文逗号分隔的排序依据字段列表，按升序排序。在字段名称后使用“desc”表示降序。支持的字段： * update_time * create_time * conversation_name 示例：“update_time desc”“create_time”

ListConversationsResponse

ListConversations 方法的响应。

字段
conversations[]	Conversation 给定数据存储区的所有对话。
next_page_token	string 分页令牌，如果未返回，则表示最后一页。

ListCustomModelsRequest

SearchTuningService.ListCustomModels 方法的请求消息。

字段
data_store	string 必需。父级数据存储区的资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。此字段用于标识要从中提取模型的数据存储区。

ListCustomModelsResponse

SearchTuningService.ListCustomModels 方法的响应消息。

字段
models[]	CustomTuningModel 自定义调优模型列表。

ListDataStoresRequest

DataStoreService.ListDataStores 方法的请求消息。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}。 如果调用者没有列出相应位置下的 DataStore 的权限，无论相应数据存储区是否存在，系统都会返回 PERMISSION_DENIED 错误。
page_size	int32 要返回的 DataStore 数量上限。如果未指定，则默认为 10。允许的最大值为 50。大于 50 的值将强制转换为 50。 如果此字段为负数，则返回 INVALID_ARGUMENT。
page_token	string 从之前的 DataStoreService.ListDataStores 调用接收的页面令牌 ListDataStoresResponse.next_page_token。利用其进行后续页面检索。 进行分页时，提供给 DataStoreService.ListDataStores 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统会返回 INVALID_ARGUMENT 错误。
filter	string 按解决方案类型过滤。例如：filter = 'solution_type:SOLUTION_TYPE_SEARCH'

ListDataStoresResponse

DataStoreService.ListDataStores 方法的响应消息。

字段
data_stores[]	DataStore 客户的所有 DataStore。
next_page_token	string 可作为 ListDataStoresRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListDocumentsRequest

DocumentService.ListDocuments 方法的请求消息。

字段
parent	string 必需。父分支资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。使用 default_branch 作为分支 ID，以列出默认分支下的文档。 如果调用者无权列出相应分支下的 Document，无论该分支是否存在，系统都会返回 PERMISSION_DENIED 错误。
page_size	int32 要返回的 Document 数量上限。如果未指定，则默认为 100。允许的最大值为 1000。大于 1000 的值会设置为 1000。 如果此字段为负数，则返回 INVALID_ARGUMENT 错误。
page_token	string 从之前的 DocumentService.ListDocuments 调用接收的页面令牌 ListDocumentsResponse.next_page_token。利用其进行后续页面检索。 进行分页时，提供给 DocumentService.ListDocuments 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统将返回 INVALID_ARGUMENT 错误。

ListDocumentsResponse

DocumentService.ListDocuments 方法的响应消息。

字段
documents[]	Document Document。
next_page_token	string 可作为 ListDocumentsRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListEnginesRequest

EngineService.ListEngines 方法的请求消息。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}。
page_size	int32 可选。不受支持。
page_token	string 可选。不受支持。
filter	string 可选。按解决方案类型过滤。例如：solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

EngineService.ListEngines 方法的响应消息。

字段
engines[]	Engine 客户的所有 Engine。
next_page_token	string 不受支持。

ListIdentityMappingStoresRequest

IdentityMappingStoreService.ListIdentityMappingStores 的请求消息

字段
parent	string 必需。要列出的身份映射存储区的父级。格式：projects/{project}/locations/{location}。
page_size	int32 要返回的 IdentityMappingStore 数量上限。如果未指定，则默认为 100。允许的最大值为 1000。大于 1000 的值会强制转换为 1000。
page_token	string 从之前的 ListIdentityMappingStores 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListIdentityMappingStores 的所有其他参数必须与提供页面令牌的调用匹配。

ListIdentityMappingStoresResponse

IdentityMappingStoreService.ListIdentityMappingStores 的响应消息

字段
identity_mapping_stores[]	IdentityMappingStore 身份映射存储区。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListIdentityMappingsRequest

IdentityMappingStoreService.ListIdentityMappings 的请求消息

字段
identity_mapping_store	string 必需。要列出身份映射条目的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
page_size	int32 要返回的 IdentityMapping 数量上限。如果未指定，则默认为 2000。允许的最大值为 10000。大于 10000 的值会强制转换为 10000。
page_token	string 从之前的 ListIdentityMappings 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListIdentityMappings 的所有其他参数必须与提供页面令牌的调用匹配。

ListIdentityMappingsResponse

IdentityMappingStoreService.ListIdentityMappings 的响应消息

字段
identity_mapping_entries[]	IdentityMappingEntry 身份映射条目。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListSchemasRequest

SchemaService.ListSchemas 方法的请求消息。

字段
parent	string 必需。父级数据存储区资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。
page_size	int32 要返回的 Schema 数量上限。服务返回的值可能小于此值。 如果未指定，则最多返回 100 个 Schema。 最大值为 1000；大于 1000 的值会设置为 1000。
page_token	string 从之前的 SchemaService.ListSchemas 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 SchemaService.ListSchemas 的所有其他参数必须与提供页面令牌的调用匹配。

ListSchemasResponse

SchemaService.ListSchemas 方法的响应消息。

字段
schemas[]	Schema Schema。
next_page_token	string 可作为 ListSchemasRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListSessionsRequest

针对 ListSessions 方法的请求。

字段
parent	string 必需。数据存储区资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
page_size	int32 页面中结果的数量上限。如果未指定，则默认为 50。允许的最大值为 1000。
page_token	string 从之前的 ListSessions 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 要过滤的字段的逗号分隔列表，采用 EBNF 语法。 支持的字段包括： user_pseudo_id state display_name starred is_pinned labels create_time update_time 示例： 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"
order_by	string 以英文逗号分隔的排序依据字段列表，按升序排序。在字段名称后使用“desc”表示降序。 支持的字段： update_time create_time session_name is_pinned 示例： update_time desc create_time is_pinned desc,update_time desc：先按 is_pinned 列出会议，然后按 update_time 列出会议。

ListSessionsResponse

对 ListSessions 方法的响应。

字段
sessions[]	Session 给定数据存储区的所有会话。
next_page_token	string 分页令牌，如果未返回，则表示最后一页。

ListTargetSitesRequest

SiteSearchEngineService.ListTargetSites 方法的请求消息。

字段
parent	string 必需。父级站内搜索引擎资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。 如果调用者无权列出相应站内搜索引擎下的 TargetSite，无论此分支是否存在，系统都会返回 PERMISSION_DENIED 错误。
page_size	int32 请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，服务器将选择合适的默认值。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。 如果此字段为负数，系统会返回 INVALID_ARGUMENT 错误。
page_token	string 从之前的 ListTargetSites 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListTargetSites 的所有其他参数必须与提供页面令牌的调用匹配。

ListTargetSitesResponse

SiteSearchEngineService.ListTargetSites 方法的响应消息。

字段
target_sites[]	TargetSite TargetSite 的列表。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
total_size	int32 与请求匹配的商品总数。此字段始终会填充在响应中。

ListUserLicensesRequest

UserLicenseService.ListUserLicenses 的请求消息。

字段
parent	string 必需。父 [UserStore][] 资源名称，格式为：projects/{project}/locations/{location}/userStores/{user_store_id}。
page_size	int32 可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定，则默认为 10。最大值为 50；大于 50 的值会强制转换为 50。 如果此字段为负数，系统会返回 INVALID_ARGUMENT 错误。
page_token	string 可选。从之前的 ListUserLicenses 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 ListUserLicenses 的所有其他参数必须与提供页面令牌的调用匹配。
filter	string 可选。列表请求的过滤条件。 支持的字段： license_assignment_state 示例： license_assignment_state = ASSIGNED 以列出已分配的用户许可。 license_assignment_state = NO_LICENSE 列出未获得许可的用户。 license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN 列出尝试登录但未分配许可的用户。 license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN 可过滤掉尝试登录但未分配许可的用户。

ListUserLicensesResponse

UserLicenseService.ListUserLicenses 的响应消息。

字段
user_licenses[]	UserLicense 客户的所有 UserLicense。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

MediaInfo

媒体特有的用户事件信息。

字段
media_progress_duration	Duration 媒体进度时间（以秒为单位，如果适用）。例如，如果最终用户已播放 90 秒的视频，则 MediaInfo.media_progress_duration.seconds 应设置为 90。
media_progress_percentage	float 媒体进度应仅使用相对于媒体总长度的 media_progress_duration 来计算。 此值必须介于 [0, 1.0] 之间（含）。 如果这不是播放，或者无法计算进度（例如，正在进行的直播），则应取消设置此字段。

PageInfo

详细的网页信息。

字段
pageview_id	string 网页浏览的唯一 ID。 对于从同一网页浏览触发的所有用户事件，此值应保持不变。例如，当用户浏览商品详情页面时，可能会触发多个事件。所有这些事件的 pageview_id 属性应保持一致，以便将它们正确地归为一组。 如果使用 JavaScript Pixel 和 Google 跟踪代码管理器进行客户端事件报告，系统会自动填充此值。
page_category	string 与类别页面关联的最具体类别。 如需表示类别的完整路径，请使用“>”符号分隔不同的层次结构。如果“>”是类别名称的一部分，请将其替换为其他字符。 类别页面包括销售页面或促销页面等特殊页面。例如，特惠促销页面的类别层次结构可能为："pageCategory" : "Sales > 2017 Black Friday Deals"。 对于 view-category-page 事件为必需参数。其他事件类型不应设置此字段。否则，系统将返回 INVALID_ARGUMENT 错误。
uri	string 用户当前网页的完整网址 (window.location.href)。 如果使用 JavaScript Pixel 和 Google 跟踪代码管理器进行客户端事件报告，系统会自动填充此值。长度上限为 5,000 个字符。
referrer_uri	string 当前网页的引荐来源网址。 如果使用 JavaScript Pixel 和 Google 跟踪代码管理器进行客户端事件报告，系统会自动填充此值。不过，某些浏览器隐私权限制可能会导致此字段为空。

PanelInfo

与用户事件关联的详细面板信息。

字段
panel_id	string 必需。面板 ID。
display_name	string 面板的显示名称。
documents[]	DocumentInfo 可选。与相应面板关联的文档 ID。
panel_position	int32 面板的有序位置（如果与其他面板一起向用户显示）。如果设置了此字段，则还必须设置 total_panels。
total_panels	int32 向用户展示的面板总数（包括当前面板）。如果设置了 panel_position，则必须设置此参数。

主账号

用户或群组的主账号标识符。

字段
联合字段 principal。联合字段 principal。主账号可以是用户或群组。principal 只能是下列其中一项：
user_id	string 用户标识符。对于 Google Workspace 用户账号，user_id 应该是 Google Workspace 用户电子邮件地址。对于非 Google 身份提供方用户账号，user_id 是在员工池配置期间配置的映射用户标识符。
group_id	string 群组标识符。对于 Google Workspace 用户账号，group_id 应该是 Google Workspace 群组电子邮件地址。对于非 Google 身份提供方用户账号，group_id 是在 workforcepool 配置期间配置的映射群组标识符。
external_entity_id	string 对于客户身份提供方中不存在的第三方应用身份。

项目

服务中 Google Cloud 项目的元数据和配置。

字段
name	string 仅限输出。项目的完整资源名称，例如 projects/{project}。请注意，在发出请求时，项目编号和项目 ID 均可接受，但服务器始终会以项目编号的形式做出响应。
create_time	Timestamp 仅限输出。相应项目创建时的时间戳。
provision_completion_time	Timestamp 仅限输出。相应项目成功完成预配的时间戳。空值表示相应项目仍在预配中，尚未准备就绪，无法使用。
service_terms_map	map<string, ServiceTerms> 仅限输出。服务条款地图。键是 ServiceTerms 的 id。
customer_provided_config	CustomerProvidedConfig 可选。客户提供的配置。

CustomerProvidedConfig

客户提供的配置。

字段
notebooklm_config	NotebooklmConfig 可选。NotebookLM 设置的配置。

NotebooklmConfig

NotebookLM 的配置。

字段
model_armor_config	ModelArmorConfig 用于清理用户提示和 LLM 回答的 Model Armor 配置。

ModelArmorConfig

客户定义的 Model Armor 模板的配置，用于清理用户提示和 LLM 回答。

字段
user_prompt_template	string 可选。用于清理用户提示的 Model Armor 模板的资源名称。格式：projects/{project}/locations/{location}/templates/{template_id}。如果未指定，系统不会对用户提示进行清理。
response_template	string 可选。用于清理 LLM 回答的 Model Armor 模板的资源名称。格式：projects/{project}/locations/{location}/templates/{template_id}。如果未指定，则不会对 LLM 回答进行清理。

ServiceTerms

有关服务条款的元数据。

字段
id	string 相应服务条款的唯一标识符。可用的条款： GA_DATA_USE_TERMS：数据使用条款。如果将此值用作 id，则可接受的 version 值为 2022-11-23。
version	string 服务条款的版本字符串。如需了解可接受的值，请参阅上文针对 id 的注释。
state	State 项目是否已接受/拒绝服务条款，或者是否仍处于待处理状态。
accept_time	Timestamp 项目上次同意服务条款的时间。
decline_time	Timestamp 项目上次拒绝或撤消服务条款协议的时间。

州

协议中规定了此服务条款。

枚举
STATE_UNSPECIFIED	枚举的默认值。此值实际上并未被使用。
TERMS_ACCEPTED	项目已同意服务条款。
TERMS_PENDING	项目尚待审核并接受服务条款。
TERMS_DECLINED	相应项目已拒绝或撤消服务条款协议。

ProvisionProjectMetadata

此类型没有字段。

与项目配置操作关联的元数据。

ProvisionProjectRequest

对 ProjectService.ProvisionProject 方法的请求。

字段
name	string 必需。Project 的完整资源名称，例如 projects/{project_id_or_number}。
accept_data_use_terms	bool 必需。设置为 true 可指定调用方已阅读并愿意同意数据使用条款。
data_use_terms_version	string 必需。调用方已阅读并希望同意的数据使用条款的版本。 可接受的版本为 2022-11-23，此值可能会随时间而变化。
saas_params	SaasParams 可选。Agentspace 的参数。

SaasParams

Agentspace 的参数。

字段
accept_biz_qos	bool 可选。设置为 true，以指定调用方已阅读并愿意同意 [Terms for Agent Space quality of service]。
is_biz	bool 可选。指示当前请求是否针对 Biz 版（= true），否则为 false。

PurgeCompletionSuggestionsMetadata

与 PurgeCompletionSuggestions 操作的进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

PurgeCompletionSuggestionsRequest

CompletionService.PurgeCompletionSuggestions 方法的请求消息。

字段
parent	string 必需。要清除补全建议的父数据存储区资源名称。遵循“projects/*/locations/*/collections/*/dataStores/*”模式。

PurgeCompletionSuggestionsResponse

CompletionService.PurgeCompletionSuggestions 方法的响应消息。

字段
purge_succeeded	bool 补全建议是否已成功清除。
error_samples[]	Status 处理请求时遇到的错误示例。

PurgeDocumentsMetadata

与 PurgeDocuments 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 已成功删除的条目数。
failure_count	int64 处理时遇到错误的条目数。
ignored_count	int64 因未找到条目而被忽略的条目数。

PurgeDocumentsRequest

DocumentService.PurgeDocuments 方法的请求消息。

字段
parent	string 必需。父级资源名称，例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}。
filter	string 必需。过滤要清除的匹配文档。目前唯一支持的值是 *（所有商品）。
error_config	PurgeErrorConfig 在清除期间发生的错误的预期位置。
force	bool 实际执行清除操作。如果 force 设置为 false，则返回预期的完全清除计数，但不删除任何文档。
联合字段 source。用于根据文档 ID 清除文档的所需输入源。source 只能是下列其中一项：
gcs_source	GcsSource 输入内容所在的 Cloud Storage 位置。支持的 data_schema：* document_id：每行一个有效的 Document.id。
inline_source	InlineSource 用于清除的输入内容的内嵌来源。

InlineSource

DocumentService.PurgeDocuments 方法的输入配置的内嵌来源。

字段
documents[]	string 必需。要清除的文档的完整资源名称列表。格式为 projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*。建议最多 100 项。

PurgeDocumentsResponse

针对 DocumentService.PurgeDocuments 方法的响应消息。如果长时间运行的操作成功完成，则 google.longrunning.Operations.response 字段会返回此消息。

字段
purge_count	int64 因相应操作而清除的文档总数。
purge_sample[]	string 将要删除的文档名称示例。仅当 force 设置为 false 时填充。系统最多会返回 100 个名称，并且这些名称是随机选择的。

PurgeErrorConfig

与清除相关错误的清除目标配置。

字段
联合字段 destination。必需。错误目的地。destination 只能是下列其中一项：
gcs_prefix	string 用于清除错误的 Cloud Storage 前缀。此参数必须是现有的空 Cloud Storage 目录。清除错误会写入此目录中的分片文件，每行一个，以 JSON 编码的 google.rpc.Status 消息的形式写入。

PurgeIdentityMappingsRequest

IdentityMappingStoreService.PurgeIdentityMappings 的请求消息

字段
identity_mapping_store	string 必需。要从中清除身份映射条目的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
filter	string 过滤要清除的匹配身份映射。可用于过滤的字段包括：* update_time：采用 ISO 8601“zulu”格式。* external_id 示例： 删除在某个时间范围内更新的所有身份映射：update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z" 删除指定 external_id 的所有身份映射：external_id = "id1" 删除身份映射存储区中的所有身份映射：* 过滤字段之间采用隐式 AND 关系。不应与来源一起使用。如果同时提供这两个参数，则会抛出错误。
联合字段 source。输入的来源。source 只能是下列其中一项：
inline_source	InlineSource 要从中清除身份映射条目的内嵌来源。
force	bool 实际执行清除操作。如果 force 设置为 false，则返回预期的完全清除计数，但不删除任何身份映射。此字段仅支持使用过滤条件进行清除。对于输入源，系统会忽略此字段，并清除数据，无论此字段的值为何。

InlineSource

要从中清除身份映射条目的内嵌来源。

字段
identity_mapping_entries[]	IdentityMappingEntry 一次最多可清除 10,000 个条目

PurgeSuggestionDenyListEntriesMetadata

与 PurgeSuggestionDenyListEntries 操作的进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

PurgeSuggestionDenyListEntriesRequest

CompletionService.PurgeSuggestionDenyListEntries 方法的请求消息。

字段
parent	string 必需。要为其导入禁止名单条目的父数据存储区资源名称。遵循“projects/*/locations/*/collections/*/dataStores/*”模式。

PurgeSuggestionDenyListEntriesResponse

CompletionService.PurgeSuggestionDenyListEntries 方法的响应消息。

字段
purge_count	int64 已清除的建议拒绝名单条目数。
error_samples[]	Status 处理请求时遇到的错误示例。

PurgeUserEventsMetadata

与 PurgeUserEvents 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
success_count	int64 已成功删除的条目数。
failure_count	int64 处理时遇到错误的条目数。

PurgeUserEventsRequest

针对 PurgeUserEvents 方法的请求消息。

字段
parent	string 必需。创建相应事件时所用目录的资源名称。格式为 projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}。
filter	string 必需。用于指定要删除的事件的过滤条件字符串，长度上限为 5,000 个字符。适合过滤的字段包括： eventType：用双引号括起来的 UserEvent.event_type 字符串。 eventTime：采用 ISO 8601“zulu”格式。 userPseudoId：双引号字符串。如果指定此字段，则系统会删除与某个访问者关联的所有事件。 userId：双引号字符串。如果指定此字段，则系统会删除与某个用户关联的所有事件。 注意：此 API 仅支持清除最多 30 天的数据。 示例： 删除某个时间范围内的所有活动：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" 删除某个时间范围内的特定 eventType：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search" 删除特定时间范围内特定访问者的所有事件：eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024" 删除 DataStore 中过去 30 天的事件：* 过滤字段之间采用隐式 AND 关系。
force	bool 目前不支持 force 字段。完全清除用户事件请求会永久删除所有可清除的事件。开发完成后：如果 force 设置为 false，该方法会返回预期的完全清除计数，但不删除任何用户事件。如果请求中未包含此字段，则此字段将默认为 false。

PurgeUserEventsResponse

PurgeUserEventsRequest 的响应。如果长时间运行的操作成功完成，则 google.longrunning.Operations.response 字段会返回此消息。

字段
purge_count	int64 因相应操作而被清除的事件总数。

查询

定义用户输入的查询。

字段
query_id	string 仅限输出。查询的唯一 ID。
联合字段 content。查询内容。content 只能是下列其中一项：
text	string 纯文本。

RankRequest

RankService.Rank 方法的请求消息。

字段
ranking_config	string 必需。排名服务配置的资源名称，例如 projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config。
model	string 要使用的模型的标识符。它是以下之一： semantic-ranker-512@latest：语义排名模型，最大输入 token 大小为 512。 如果未指定，则默认设置为 semantic-ranker-512@latest。
top_n	int32 要返回的结果数。如果未设置或不大于零，则返回所有结果。
query	string 要使用的查询。
records[]	RankingRecord 必需。要进行排名的记录列表。
ignore_record_details_in_response	bool 如果为 true，则响应将仅包含记录 ID 和得分。默认值为 false，响应将包含记录详细信息。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅 Google Cloud 文档。

RankResponse

RankService.Rank 方法的响应消息。

字段
records[]	RankingRecord 按分数降序排序的记录列表。

RankingRecord

针对 RankService.Rank 方法的记录消息。

字段
id	string 用于表示记录的唯一 ID。
title	string 记录的标题。默认为空。应至少设置 title 或 content 中的一个，否则会抛出 INVALID_ARGUMENT 错误。
content	string 记录的内容。默认为空。应至少设置 title 或 content 中的一个，否则会抛出 INVALID_ARGUMENT 错误。
score	float 相应记录基于给定查询和所选模型的得分。得分将四舍五入到小数点后 2 位。如果得分接近 0，则会四舍五入为 0.0001，以避免返回未设置的值。

RecommendRequest

针对 Recommend 方法的请求消息。

字段
serving_config	string 必需。ServingConfig 的完整资源名称：projects/*/locations/global/collections/*/engines/*/servingConfigs/* 或 projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* 在创建商品推荐引擎的同时，系统还会创建一个默认的服务配置。引擎 ID 用作默认投放配置的 ID。例如，对于引擎 projects/*/locations/global/collections/*/engines/my-engine，您可以针对 RecommendationService.Recommend 请求使用 projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine。
user_event	UserEvent 必需。有关用户的背景信息、用户正在查看的内容以及用户触发 Recommend 请求所采取的操作。请注意，此用户事件详细信息不会被提取到 userEvent 日志中。因此，需要单独的 userEvent 写入请求才能记录事件。 请勿为不同的用户将 UserEvent.user_pseudo_id 或 UserEvent.user_info.user_id 设置为相同的固定 ID。如果您尝试接收非个性化推荐（不建议这样做；这会对模型性能产生负面影响），请将 UserEvent.user_pseudo_id 设置为随机唯一 ID，并使 UserEvent.user_info.user_id 保持未设置状态。
page_size	int32 页面中结果的数量上限。将此属性设置为所需的推荐结果数量。如果为零，服务会选择合理的默认值。允许的最大值为 100。大于 100 的值设置为 100。
filter	string 用于限制建议结果的过滤条件，长度上限为 5,000 个字符。目前，仅支持针对 filter_tags 属性的过滤表达式。 示例： (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) 如果 params 字段下的 attributeFilteringSyntax 设置为 true，则系统会预期出现基于属性的表达式，而不是上述基于标记的语法。示例： (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) 如果您的过滤条件屏蔽了所有结果，则 API 会返回常规（未过滤）的热门文档。如果您只希望获得与过滤条件完全匹配的结果，请在 RecommendRequest.params 中将 strictFiltering 设置为 true，这样系统会返回空结果。 请注意，无论过滤条件如何选择，API 都不会返回 storageStatus 为 EXPIRED 或 DELETED 的 Document。
validate_only	bool 针对此推荐查询使用仅验证模式。如果设置为 true，则使用返回任意文档 ID 的虚假模型。请注意，仅验证模式应仅用于测试 API，或在模型未准备就绪时使用。
params	map<string, Value> 建议的其他网域专用参数。 允许的值： returnDocument：布尔值。如果设置为 true，则在 RecommendResponse.RecommendationResult.document 中返回关联的 Document 对象。 returnScore：布尔值。如果设置为 true，则会在 RecommendResponse.RecommendationResult.metadata 中设置与每个返回的 Document 对应的推荐得分。给定的得分表示在给定用户情境和历史记录的情况下，文档转化的概率。 strictFiltering：布尔值。默认值为 true。如果设置为 false，则当过滤条件屏蔽所有建议结果时，服务会返回通用的（未过滤的）热门文档，而不是返回空结果。 diversityLevel：字符串。默认值为空。如果设置为非空，则必须是以下值之一： no-diversity low-diversity medium-diversity high-diversity auto-diversity 这可提供请求级控制，并根据文档类别调整推荐结果。 attributeFilteringSyntax：布尔值。默认值为 false。如果设置为 true，则根据新的基于属性的语法来解读 filter 字段。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅标签的要求。

RecommendResponse

针对 Recommend 方法的响应消息。

字段
results[]	RecommendationResult 推荐文档的列表。该顺序表示排名（从最相关的文档到最不相关的文档）。
attribution_token	string 唯一的归因令牌。这应包含在此建议生成的 UserEvent 日志中，以便准确归因推荐模型效果。
missing_ids[]	string 请求中缺少与所请求的 ServingConfig 关联的默认分支的文档的 ID。
validate_only	bool 如果设置了 RecommendRequest.validate_only，则为 true。

RecommendationResult

RecommendationResult 表示包含关联元数据的通用推荐结果。

字段
id	string 推荐文档的资源 ID。
document	Document 如果 RecommendRequest.params 中 returnDocument 设置为 true，则进行设置。
metadata	map<string, Value> 其他文档元数据或注释。 可能的值： score：建议得分（双精度值）。如果 RecommendRequest.params 中的 returnScore 设置为 true，则设置此字段。

RecrawlUrisMetadata

与 SiteSearchEngineService.RecrawlUris 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。
invalid_uris[]	string 请求中格式无效的唯一 URI。样本数量上限为 1000。
invalid_uris_count	int32 请求中格式无效的唯一 URI 的总数。
noindex_uris[]	string 没有索引元标记的 URI。样本数量上限为 1000。
noindex_uris_count	int32 没有索引元标记的 URI 总数。
uris_not_matching_target_sites[]	string 请求中与 DataStore 中的任何 TargetSite 都不匹配的唯一 URI，仅与尚未完全编入索引的 TargetSite 或类型为 EXCLUDE 的 TargetSite 匹配。样本数量上限为 1000。
uris_not_matching_target_sites_count	int32 与任何 TargetSites 都不匹配的 URI 总数。
valid_uris_count	int32 请求中不在 invalid_uris 中的唯一 URI 总数。
success_count	int32 截至目前已抓取的 URI 总数。
pending_count	int32 尚未抓取的 URI 总数。
quota_exceeded_count	int32 因索引资源不足而被拒绝的 URI 总数。

RecrawlUrisRequest

SiteSearchEngineService.RecrawlUris 方法的请求消息。

字段
site_search_engine	string 必需。SiteSearchEngine 的完整资源名称，例如 projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine。
uris[]	string 必需。要抓取的 URI 列表。最多支持 1 万个 URI，否则会抛出 INVALID_ARGUMENT 错误。每个 URI 都应与 site_search_engine 中的至少一个 TargetSite 相匹配。
site_credential	string 可选。用于抓取的凭据 ID。

RecrawlUrisResponse

SiteSearchEngineService.RecrawlUris 方法的响应消息。

字段
failure_samples[]	FailureInfo 最多 10 个 failed_uris 的样本的详细信息。
failed_uris[]	string 在 LRO 终止之前未被抓取的 URI。

FailureInfo

有关特定 URI 无法被抓取的原因的详细信息。每个 FailureInfo 都包含一个 FailureReason（针对每个 CorpusType）。

字段
uri	string 未能成功抓取的 URI。
failure_reasons[]	FailureReason 按语料库类型（例如桌面设备、移动设备）列出的失败原因。

FailureReason

有关特定 CorpusType 的抓取失败原因的详细信息，例如，桌面版和移动版抓取可能会因不同的原因而失败。

字段
corpus_type	CorpusType DESKTOP、MOBILE 或 CORPUS_TYPE_UNSPECIFIED。
error_message	string 相应 URI 未被抓取的原因。

CorpusType

失败的抓取操作的 CorpusType。

枚举
CORPUS_TYPE_UNSPECIFIED	默认值。
DESKTOP	表示对网页桌面版进行的抓取尝试。
MOBILE	表示对网页移动版的抓取尝试。

回复

定义向用户发送的回复消息。

字段
summary	Summary 基于搜索结果的摘要。

SafetyRating

与生成的内容对应的安全等级。

字段
category	HarmCategory 仅限输出。危害类别。
probability	HarmProbability 仅限输出。内容中的有害概率级别。
probability_score	float 仅限输出。有害概率得分。
severity	HarmSeverity 仅限输出。内容中的危害严重程度级别。
severity_score	float 仅限输出。有害程度得分。
blocked	bool 仅限输出。表示相应内容是否因该分级而被过滤掉。

HarmProbability

内容中的有害概率级别。

枚举
HARM_PROBABILITY_UNSPECIFIED	未指定有害概率。
NEGLIGIBLE	危害程度可忽略不计。
LOW	低程度的伤害。
MEDIUM	中等程度的危害。
HIGH	高程度的伤害。

HarmSeverity

危害严重程度。

枚举
HARM_SEVERITY_UNSPECIFIED	未指定有害程度。
HARM_SEVERITY_NEGLIGIBLE	可忽略的伤害严重程度。
HARM_SEVERITY_LOW	伤害严重程度较低。
HARM_SEVERITY_MEDIUM	中等程度的危害严重程度。
HARM_SEVERITY_HIGH	伤害严重程度较高。

架构

定义一种文档数据的结构和布局。

字段
name	string 不可变。架构的完整资源名称，格式为 projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
联合字段 schema。架构表示法。应提供 struct_schema 或 json_schema，否则会抛出 INVALID_ARGUMENT 错误。schema 只能是下列其中一项：
struct_schema	Struct 架构的结构化表示形式。
json_schema	string 架构的 JSON 表示形式。

SearchAddOn

可为搜索提供额外功能的插件。

枚举
SEARCH_ADD_ON_UNSPECIFIED	未指定枚举时的默认值。此功能无法使用。
SEARCH_ADD_ON_LLM	大语言模型加购项。

SearchInfo

详细的搜索信息。

字段
search_query	string 用户的搜索查询。 如需查看定义，请参阅 SearchRequest.query。 该值必须是采用 UTF-8 编码的字符串，长度上限为 5,000 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。 对于 search 事件，至少需要 search_query 和 PageInfo.page_category 其中之一。其他事件类型不应设置此字段。否则，系统将返回 INVALID_ARGUMENT 错误。
order_by	string 返回商品的顺序（如果适用）。 如需了解定义和语法，请参阅 SearchRequest.order_by。 该值必须是采用 UTF-8 编码的字符串，长度上限为 1,000 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。 只能为 search 事件设置此字段。其他事件类型不应设置此字段。否则，系统将返回 INVALID_ARGUMENT 错误。
offset	int32 一个整数，用于指定分页的当前偏移量（API 视为相关的商品的从 0 开始的起始位置）。 如需查看定义，请参阅 SearchRequest.offset。 如果此字段为负数，则返回 INVALID_ARGUMENT。 只能为 search 事件设置此字段。其他事件类型不应设置此字段。否则，系统将返回 INVALID_ARGUMENT 错误。

SearchLinkPromotion

促销活动 proto 包含用于显示促销活动的 URI 和其他帮助信息。

字段
title	string 必需。促销活动的标题。长度上限：160 个字符。
uri	string 可选。用户想要推广的网页的网址。必须为网站搜索设置。对于其他垂直行业，此属性是可选的。
document	string 可选。用户想要推广的 Document。对于网站搜索，请保持未设置状态，仅填充 URI。可与 URI 一起设置。
image_uri	string 可选。促销缩略图网址。
description	string 可选。宣传广告的内容描述。长度上限：200 个字符。
enabled	bool 可选。对于与附加了相应促销活动的服务控件的父级相关联的任何服务配置，系统都会返回已启用的促销活动。 此标志仅用于基本网站搜索。

SearchRequest

SearchService.Search 方法的请求消息。

字段
serving_config	string 必需。搜索服务配置的资源名称，例如 projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config 或 projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config。此字段用于标识服务配置名称，即用于执行搜索的一组模型。
branch	string 分支资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0。 使用 default_branch 作为分支 ID 或将此字段留空，以搜索默认分支下的文档。
query	string 原始搜索查询。
image_query	ImageQuery 原始图片查询。
page_size	int32 要返回的 Document 数量上限。允许的最大值取决于数据类型。如果值高于最大值，系统会强制将其转换为最大值。 具有基本索引的网站：默认值为 10，最大值为 25。 采用高级索引编制的网站：默认 25，最大 50。 其他：默认值为 50，最大值为 100。 如果此字段为负数，则返回 INVALID_ARGUMENT。
page_token	string 从之前的 SearchService.Search 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时，提供给 SearchService.Search 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统将返回 INVALID_ARGUMENT 错误。
offset	int32 一个从 0 开始的整数，用于指定搜索结果中当前偏移量（即 API 视为相关的 Document 的起始结果位置）。仅在 page_token 未设置时才考虑使用此字段。 如果此字段为负数，则返回 INVALID_ARGUMENT。 较大的偏移量可能会被限制在合理的阈值范围内。
one_box_page_size	int32 OneBox 中返回的结果数上限。此设置分别适用于每种 OneBox 类型。默认值为 10。
data_store_specs[]	DataStoreSpec 用于定义要搜索的特定 DataStore 以及这些数据存储区的配置。仅当 Engine 具有多个数据存储区时，系统才会考虑此参数。对于具有单个数据存储区的引擎，应使用直接位于 SearchRequest 下的规范。
filter	string 过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。 如果此字段无法识别，则返回 INVALID_ARGUMENT。 Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“名称”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")' 如需详细了解过滤（包括语法和过滤运算符），请参阅过滤
canonical_filter	string 用户在搜索页上未勾选任何过滤条件的情况下执行搜索时应用的默认过滤条件。 当需要进行查询扩展等质量改进时，应用于每个搜索请求的过滤条件。如果查询的结果数量不足，系统将使用此过滤条件来确定是否启用查询扩展流程。原始过滤条件仍将用于扩大搜索范围的查询。强烈建议使用此字段，以实现高搜索质量。 如需详细了解过滤条件语法，请参阅 SearchRequest.filter。
order_by	string 返回文档的顺序。可以按 Document 对象中的字段对文档进行排序。如果按相关性排序，则将其留空。order_by 表达式区分大小写。 如需详细了解如何对网站搜索结果进行排序，请参阅对网页搜索结果进行排序。如需详细了解如何对医疗保健搜索结果进行排序，请参阅对医疗保健搜索结果进行排序。如果此字段无法识别，则返回 INVALID_ARGUMENT。
user_info	UserInfo 有关最终用户的信息。强烈建议使用，以便进行分析和个性化定制。UserInfo.user_agent 用于推断 device_type 以进行分析。
language_code	string BCP-47 语言代码，例如“en-US”或“sr-Latn”。如需了解详情，请参阅标准字段。此字段有助于更好地解读查询。如果未指定值，系统会自动检测查询语言代码，但检测结果可能不准确。
facet_specs[]	FacetSpec 分面搜索的分面规范。如果为空，则不返回任何分面。 最多允许 100 个值。否则，系统将返回 INVALID_ARGUMENT 错误。
boost_spec	BoostSpec 提升规范以提升特定文档。如需详细了解热推，请参阅热推
params	map<string, Value> 其他搜索参数。 仅限公开网站搜索，支持的值包括： user_country_code：字符串。默认值为空。如果设置为非空值，则会根据所提供的位置限制或提升结果。例如 user_country_code: "au" 如需查看可用代码，请参阅国家/地区代码 search_type：double。默认值为空。根据值启用非网页搜索。唯一有效的非默认值为 1，用于启用图片搜索。例如 search_type: 1
query_expansion_spec	QueryExpansionSpec 用于指定查询扩展发生条件的查询扩展规范。
spell_correction_spec	SpellCorrectionSpec 拼写校正规范，用于指定拼写校正生效的模式。
user_pseudo_id	string 用于跟踪访问者的唯一标识符。例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录或退出网站，此唯一标识符不应发生变化。 此字段不应具有固定值，例如 unknown_visitor。 此标识符应与 UserEvent.user_pseudo_id 和 CompleteQueryRequest.user_pseudo_id 相同 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
content_search_spec	ContentSearchSpec 用于配置内容搜索行为的规范。
ranking_expression	string 可选。排名表达式用于控制检索到的文档的自定义排名。这会替换 ServingConfig.ranking_expression。语法和支持的功能取决于 ranking_expression_backend 值。如果未提供 ranking_expression_backend，则默认为 RANK_BY_EMBEDDING。 如果未提供 ranking_expression_backend 或将其设置为 RANK_BY_EMBEDDING，则应为单个函数或多个以“+”连接的函数。 ranking_expression = function, { " + ", function }; 支持的函数： double * relevance_score double * dotProduct(embedding_field_path) 函数变量： relevance_score：预定义的关键字，用于衡量查询与文档之间的相关性。 embedding_field_path：与查询嵌入向量搭配使用的文档嵌入字段。 dotProduct：embedding_field_path 与查询嵌入向量之间的嵌入函数。 排名表达式示例： 如果文档具有嵌入字段 doc_embedding，则排名表达式可以是 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)。 如果 ranking_expression_backend 设置为 RANK_BY_FORMULA，则支持以下表达式类型（以及使用 + 或 * 运算符链接的这些类型的组合）： double signal log(signal) exp(signal) rr(signal, double > 0) - 倒数排名转换，第二个实参为分母常数。 is_nan(signal) - 如果信号为 NaN，则返回 0；否则返回 1。 fill_nan(signal1, signal2 | double) - 如果 signal1 为 NaN，则返回 signal2 | double，否则返回 signal1。 以下是一些使用支持的排名表达式类型的排名公式示例： 0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score) -- 主要按 keyword_similarity_score 的对数进行排名，并进行少量 semantic_smilarity_score 调整。 0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score) - 按 semantic_similarity_score 的指数进行排名，如果值为 NaN，则用 0 填充该值；如果 semantic_similarity_score 为 NaN，则向最终得分添加常量 0.3 调整。 0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16) - 主要按 keyword_similarity_score 的倒数排名进行排名，并对 semantic_smilarity_score 的倒数排名进行小幅调整。 支持以下信号： semantic_similarity_score：使用 Google 专有模型生成的嵌入计算出的语义相似度调整值。此分数用于确定搜索查询与文档的语义相似度。 keyword_similarity_score：关键字匹配调整使用 Best Match 25 (BM25) 排名函数。此得分使用概率模型计算，用于估计文档与给定查询的相关概率。 relevance_score：一种语义相关性调整，使用 Google 专有模型来确定用户查询在文档内容上下文中的含义和意图。 pctr_rank：预测的转化率调整值，用作排名依据。预测的点击率 (pCTR) 可从用户角度衡量搜索结果的相关性和吸引力。pCTR 越高，表明相应结果越有可能满足用户的查询和意图，因此是排名的一项重要信号。 freshness_rank：以排名形式表示的新鲜度调整 document_age：自文档上次更新以来经过的时间（以小时为单位），一个浮点数（例如，0.25 表示 15 分钟）。 topicality_rank：主题性调整（以排名形式）。使用 Google 专有模型来确定查询与文档之间基于关键字的重叠程度。 base_rank：结果的默认排名
ranking_expression_backend	RankingExpressionBackend 可选。用于排名表达式评估的后端。
safe_search	bool 是否开启安全搜索功能。此功能仅支持网站搜索。
user_labels	map<string, string> 应用于资源的用户标签必须符合以下要求： 每项资源可以有多个标签，但不能超过 64 个。 每个标签都必须采用键值对形式。 键至少有 1 个字符，最多有 63 个字符，且不能为空。值可以为空，且最多包含 63 个字符。 键和值只能包含小写字母、数字字符、下划线和短划线。所有字符必须使用 UTF-8 编码，允许使用国际字符。 标签的键部分必须是唯一的。不过，您可以将同一个键用于多个资源。 键必须以小写字母或国际字符开头。 如需了解详情，请参阅 Google Cloud 文档。
natural_language_query_understanding_spec	NaturalLanguageQueryUnderstandingSpec 可选。自然语言查询理解功能的配置，例如从查询中提取结构化字段过滤条件。如需了解详情，请参阅此文档。如果未指定 naturalLanguageQueryUnderstandingSpec，则不会进行额外的自然语言查询理解。
search_as_you_type_spec	SearchAsYouTypeSpec “即输即搜”配置。仅支持 IndustryVertical.MEDIA 类别。
display_spec	DisplaySpec 可选。显示功能（例如搜索结果中的匹配项突出显示）的配置。
session	string 会话资源名称。可选。 会话允许用户进行多轮 /search API 调用，或在 /search API 调用和 /answer API 调用之间进行协调。 示例 1（多轮 /search API 调用）：使用在第一次调用中生成的会话 ID 调用 /search API。在此示例中，系统会在查询排名中考虑之前的搜索查询。也就是说，如果第一个查询是“Alphabet 在 2022 年的表现如何？”，如果上一个查询是“Alphabet 在 2022 年的表现如何？”，而当前查询是“2023 年呢？”，则当前查询会被解读为“Alphabet 在 2023 年的表现如何？”。 示例 2（/search API 调用与 /answer API 调用之间的协调）：使用在第一次调用中生成的会话 ID 调用 /answer API。在此示例中，答案生成是在第一次搜索调用返回的搜索结果的上下文中进行的。 多轮搜索功能目前处于非公开正式版阶段。在正式向公众发布此功能之前，请使用 v1alpha 或 v1beta 版本。或者，通过 Google 支持团队申请加入许可名单。
session_spec	SessionSpec 会话规范。 仅当设置了 session 时才能使用。
relevance_threshold	RelevanceThreshold 搜索结果的相关性阈值。 默认采用 Google 定义的阈值，在精确率和召回率之间取得平衡，既能提供高度准确的结果，又能全面覆盖相关信息。 此功能不支持医疗保健搜索。
relevance_score_spec	RelevanceScoreSpec 可选。用于返回相关性得分的规范。

BoostSpec

提升规范以提升特定文档。

字段
condition_boost_specs[]	ConditionBoostSpec 条件加权规范。如果文档符合规范中的多个条件，则这些规范中的提升分数都会应用，并以非线性的方式进行组合。规格数量上限为 20。

ConditionBoostSpec

加权适用于符合条件的文档。

字段
condition	string 用于指定加权条件的表达式。语法和支持的字段与过滤表达式相同。如需了解详细的语法和限制，请参阅 SearchRequest.filter。 示例： 如需提高文档 ID 为“doc_1”或“doc_2”且颜色为“红色”或“蓝色”的文档的得分，请使用以下查询：(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
boost	float 条件升位的强度，应介于 [-1, 1] 之间。设为负值代表降位。默认值为 0.0。 设置为 1.0 可大幅提升文档的排名。但并不一定意味着升位后的文档在任何时候都会显示在结果最上方，或者其他文档会被排除。即使没有符合条件的商品，系统仍会显示结果。此外，与搜索查询明显更相关的搜索结果仍会优先于您非常关注但不相关的文档。 设置为 -1.0 会大幅降低相应文档的排名。不过，可能仍会显示深度相关的结果。该文档需要努力争取才能获得相当高的排名，但并非完全无法获得排名。 设置为 0.0 表示不应用任何提升。系统会忽略提升条件。只能设置（条件、升压）组合或下面的 boost_control_spec。如果两者都已设置，系统会忽略全局提升，并应用更精细的 boost_control_spec。
boost_control_spec	BoostControlSpec 基于客户定义的属性值的自定义排名的复杂规范。

BoostControlSpec

基于客户指定属性值的自定义排名规范。与上述简单的（条件、提升）组合相比，它可提供更多用于自定义排名的控制变量。

字段
field_name	string 将用于确定加权幅度的字段的名称。
attribute_type	AttributeType 用于确定加推幅度的属性类型。属性值可以从指定 field_name 的字段值派生而来。对于数值，这很简单，即 attribute_value = numerical_field_value。不过，对于新鲜度，attribute_value = (time.now() - datetime_field_value)。
interpolation_type	InterpolationType 要应用于连接下列控制点的插值类型。
control_points[]	ControlPoint 用于定义曲线的控制点。单调函数（通过上面的 interpolation_type 定义）会通过此处列出的控制点。

AttributeType

要应用自定义排名的属性（或函数）。

枚举
ATTRIBUTE_TYPE_UNSPECIFIED	未指定 AttributeType。
NUMERICAL	数值字段的值将用于动态更新加推量。在这种情况下，控制点的 attribute_value（即 x 值）将是指定了 boost_amount 的数值字段的实际值。
FRESHNESS	对于新鲜度使用情形，属性值将是当前时间与指定日期时间字段中的日期之间的时长。该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。此格式的模式为：[nD][T[nH][nM][nS]]。例如，5D、3DT12H30M、T24H。

ControlPoint

用于定义曲线的控制点。通过这些控制点定义的曲线只能单调递增或递减（可以包含常量值）。

字段
attribute_value	string 可以是以下值之一：1. 数值字段值。2. 新鲜度时长规范：该值必须采用 XSD dayTimeDuration 值（ISO 8601 时长值的受限子集）的格式。此格式的模式为：[nD][T[nH][nM][nS]]。
boost_amount	float 如果 attribute_value 的计算结果为上述指定的值，则用于提升得分的值（介于 -1 到 1 之间）。

InterpolationType

要应用的插值类型。默认值为线性（分段线性）。

枚举
INTERPOLATION_TYPE_UNSPECIFIED	未指定插值类型。在这种情况下，它会默认设置为线性。
LINEAR	系统将应用分段线性插值。

ContentSearchSpec

用于配置内容搜索行为的规范。

字段
snippet_spec	SnippetSpec 如果未指定 snippetSpec，则搜索响应中不包含摘要。
summary_spec	SummarySpec 如果未指定 summarySpec，则搜索响应中不会包含摘要。
extractive_content_spec	ExtractiveContentSpec 如果未提供 extractive_content_spec，则搜索响应中不会包含提取式答案。
search_result_mode	SearchResultMode 指定搜索结果模式。如果未指定，搜索结果模式默认为 DOCUMENTS。
chunk_spec	ChunkSpec 指定要从搜索响应中返回的块规范。仅在 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS 时可用

ChunkSpec

指定要从搜索响应中返回的块规范。仅在 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS 时可用

字段
num_previous_chunks	int32 要返回的当前块之前块的数量。允许的最大值为 3。如果未指定，则不会返回任何之前的块。
num_next_chunks	int32 当前块要返回的后续块的数量。允许的最大值为 3。如果未指定，则不会返回任何后续块。

ExtractiveContentSpec

用于配置搜索响应中提取内容的规范。

字段
max_extractive_answer_count	int32 每个搜索结果中返回的提取式答案数量上限。 提取式答案是指从原始文档中提取的逐字逐句的答案，可针对搜索查询提供精准且符合上下文的回答。 如果匹配答案的数量小于 max_extractive_answer_count，则返回所有答案。否则，返回 max_extractive_answer_count。 每个 SearchResult 最多返回 5 个答案。
max_extractive_segment_count	int32 每个搜索结果中返回的提取段落数上限。仅在 DataStore 设置为 DataStore.ContentConfig.CONTENT_REQUIRED 或 DataStore.solution_types 为 SOLUTION_TYPE_CHAT 时应用。 提取式片段是从原始文档中提取的与搜索查询相关的文本片段，通常比提取式答案更详细。然后，该片段可用作 LLM 的输入，以生成摘要和答案。 如果匹配的片段数小于 max_extractive_segment_count，则返回所有片段。否则，返回 max_extractive_segment_count。
return_extractive_segment_score	bool 指定是否返回每个搜索结果中提取式片段的置信度得分。此功能仅适用于新的数据存储区或已列入许可名单的数据存储区。如需将您的数据存储区列入许可名单，请与您的客户工程师联系。默认值为 false。
num_previous_segments	int32 指定是否还包含每个所选细分的相邻细分。在每个所选片段之前最多返回 num_previous_segments 个片段。
num_next_segments	int32 在每个所选片段之后最多返回 num_next_segments 个片段。

SearchResultMode

指定搜索结果模式。如果未指定，搜索结果模式默认为 DOCUMENTS。

枚举
SEARCH_RESULT_MODE_UNSPECIFIED	默认值。
DOCUMENTS	返回搜索结果中的文档。
CHUNKS	返回搜索结果中的块。仅在指定 DocumentProcessingConfig.chunking_config 时可用。

SnippetSpec

用于配置搜索响应中的摘要的规范。

字段
max_snippet_count (deprecated)	int32 此项已弃用！ [已弃用] 此字段已弃用。如需控制代码段返回，请使用 return_snippet 字段。为了实现向后兼容，如果 max_snippet_count > 0，我们将返回摘要。
reference_only (deprecated)	bool 此项已弃用！ [已弃用] 此字段已弃用，不会对代码段产生任何影响。
return_snippet	bool 如果为 true，则返回代码段。如果无法生成摘要，我们会返回“No snippet is available for this page.”。系统还会返回包含 SUCCESS 或 NO_SNIPPET_AVAILABLE 的 snippet_status。

SummarySpec

用于配置搜索响应中返回的摘要的规范。

字段
summary_result_count	int32 用于生成摘要的热门结果数量。如果返回的结果数量少于 summaryResultCount，则系统会根据所有结果生成摘要。 最多可以使用 10 个文档模式的结果或 50 个块模式的结果来生成摘要。当 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS 时，系统会使用块模式。
include_citations	bool 指定是否在摘要中包含引用。默认值为 false。 如果此字段设置为 true，摘要将包含内嵌引用编号。 包含引文的摘要示例： BigQuery 是 Google Cloud 的全代管式无服务器企业数据仓库 [1]。BigQuery 支持所有类型的数据，可在多种云环境上运行，并在统一平台中内置了丰富的机器学习和商业智能功能 [2, 3]。 引用编号是指返回的搜索结果，从 1 开始编入索引。例如，[1] 表示相应句子归因于第一个搜索结果。[2, 3] 表示相应句子归因于第二个和第三个搜索结果。
ignore_adversarial_query	bool 指定是否过滤掉对抗性查询。默认值为 false。 Google 采用搜索查询分类来检测对抗性查询。如果搜索查询被归类为对抗性查询，则不会返回摘要。例如，用户可能会询问有关公司负面评论的问题，或者提交旨在生成不安全且违反政策的输出内容的查询。如果此字段设置为 true，我们会跳过为对抗性查询生成摘要，而是返回后备消息。
ignore_non_summary_seeking_query	bool 指定是否过滤掉非总结性查询。默认值为 false。 Google 采用搜索查询分类技术来检测寻求摘要的查询。如果搜索查询被归类为非摘要寻求查询，则不会返回摘要。例如，why is the sky blue 和 Who is the best soccer player in the world? 是寻求摘要的查询，但 SFO airport 和 world cup 2026 不是。它们很可能是导航查询。如果此字段设置为 true，我们会跳过为非总结寻求查询生成总结，而是返回回退消息。
ignore_low_relevant_content	bool 指定是否过滤掉相关性较低的查询。默认值为 false。 如果此字段设置为 false，则无论搜索结果的相关性如何，都会使用所有搜索结果来生成答案。如果设置为 true，只有搜索结果相关性较高的查询才会生成回答。
ignore_jail_breaking_query	bool 可选。指定是否过滤掉越狱查询。默认值为 false。 Google 采用搜索查询分类来检测越狱查询。如果搜索查询被归类为越狱查询，则不会返回摘要。用户可能会在查询中添加指令，以更改回答的语气、风格、语言、内容，或要求模型扮演其他实体，例如“以竞争对手公司 CEO 的语气回答”。如果此字段设置为 true，我们会跳过为越狱查询生成摘要，而是返回回退消息。
model_prompt_spec	ModelPromptSpec 如果指定，则使用规范来修改提供给 LLM 的提示。
language_code	string 摘要的语言代码。使用 BCP47 定义的语言标记。注意：这是一项实验性功能。
model_spec	ModelSpec 如果指定了该参数，则该规范将用于修改提供给 LLM 的模型规范。
use_semantic_chunks	bool 如果为 true，则会根据热门搜索结果中最相关的块生成回答。此功能将有助于提高摘要质量。请注意，启用此功能后，并非所有热门搜索结果都会被引用并包含在参考列表中，因此引用来源索引仅指向参考列表中列出的搜索结果。

ModelPromptSpec

要与模型搭配使用的提示的规范。

字段
preamble	string 提示开头用于指示助理的文本。用户指南中提供了示例。

ModelSpec

模型的规范。

字段
version	string 用于生成摘要的模型版本。 支持的值包括： stable：字符串。未指定值时的默认值。使用正式版微调模型。如需了解详情，请参阅回答生成模型版本和生命周期。 preview：字符串。（公开预览版）使用预览版模型。如需了解详情，请参阅回答生成模型版本和生命周期。

DataStoreSpec

一种结构，用于定义要在搜索调用中过滤的数据存储区以及这些数据存储区的配置。否则，系统将返回 INVALID_ARGUMENT 错误。

字段
data_store	string 必需。DataStore 的完整资源名称，例如 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。路径必须包含项目编号，此字段不支持项目 ID。
filter	string 可选。用于过滤由 data_store 字段指定的数据存储区中的文档的过滤条件规范。如需详细了解过滤，请参阅过滤
boost_spec	BoostSpec 可选。提升规范以提升特定文档。如需详细了解热推，请参阅热推
custom_search_operators	string 可选。自定义搜索运算符，如果指定，将用于过滤工作区数据存储区中的结果。如需详细了解自定义搜索运算符，请参阅 SearchOperators。

DisplaySpec

指定要显示的特征，例如匹配项突出显示。

字段
match_highlighting_condition	MatchHighlightingCondition 应进行匹配突出显示的条件。

MatchHighlightingCondition

枚举，用于描述在何种条件下应突出显示匹配项。

枚举
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED	服务器行为与 MATCH_HIGHLIGHTING_DISABLED 相同。
MATCH_HIGHLIGHTING_DISABLED	停用所有文档中的匹配项突出显示功能。
MATCH_HIGHLIGHTING_ENABLED	在所有文档中启用匹配项突出显示功能。

FacetSpec

用于执行分面搜索的分面规范。

字段
facet_key	FacetKey 必需。分面键规范。
limit	int32 针对相应分面返回的分面值数量上限。如果未指定，则默认为 20。允许的最大值为 300。大于 300 的值会强制转换为 300。对于医疗保健搜索中的聚合，当 [FacetKey.key] 为“healthcare_aggregation_key”时，无论此处设置的值是多少，系统都会在内部将限制替换为 10,000。 如果此字段为负数，则返回 INVALID_ARGUMENT。
excluded_filter_keys[]	string 分面时要排除的键的列表。 默认情况下，除非 FacetKey.key 列在此字段中，否则不会从过滤条件中排除。 在此字段中列出构面键后，即使构面值被过滤出搜索结果，仍可显示为构面结果。使用此字段不会影响返回的搜索结果。 例如，假设有 100 个文档的颜色构面为“红色”，200 个文档的颜色构面为“蓝色”。包含过滤条件“color:ANY("Red")”且将“color”设为 FacetKey.key 的查询默认只会返回搜索结果中的“红色”文档，并且还会返回“红色”以及数量 100，作为唯一的颜色构面。虽然也有蓝色文档，但“蓝色”不会显示为可用的构面值。 如果“color”列在“excludedFilterKeys”中，则查询会返回构面值“Red”（数量为 100）和“Blue”（数量为 200），因为“color”键现在已从过滤条件中排除。由于此字段不会影响搜索结果，因此搜索结果仍会正确过滤，仅返回“红色”文档。 最多允许 100 个值。否则，系统将返回 INVALID_ARGUMENT 错误。
enable_dynamic_position	bool 为此分面启用动态位置。如果设置为 true，则系统会自动确定此分面在响应中所有分面中的位置。如果启用了动态分面，则会一起排序。如果设置为 false，则相应分面在响应中的位置与在请求中的位置相同，并且其排名高于启用动态位置的分面和所有动态分面。 例如，您可能希望始终在响应中返回评分分面，但不一定始终将评分分面显示在顶部。在这种情况下，您可以将 enable_dynamic_position 设置为 true，以便系统自动确定评分分面在响应中的位置。 再举一个例子，假设请求中包含以下方面： “rating”，enable_dynamic_position = true “价格”，enable_dynamic_position = false “品牌”，enable_dynamic_position = false 此外，您还启用了动态分面，这会生成分面 gender。然后，响应中各构面的最终顺序可以是（“价格”“品牌”“评分”“性别”），也可以是（“价格”“品牌”“性别”“评分”），具体取决于 API 如何对“性别”和“评分”构面进行排序。不过，请注意，“价格”和“品牌”始终排在第一位和第二位，因为它们的 enable_dynamic_position 为 false。

FacetKey

指定如何计算分面。

字段
key	string 必需。Document 对象中支持的文本和数值构面键，用于计算构面值。分面键区分大小写。
intervals[]	Interval 仅当值应分桶到区间时才设置。必须针对具有数值的分面进行设置。不得为具有文本值的 Facet 设置。间隔数上限为 30。
restricted_values[]	string 仅获取指定受限值的分面。仅支持文本字段。例如，假设“category”有三个值：“Action > 2022”“Action > 2021”和“Sci-Fi > 2022”。如果将“restricted_values”设置为“Action > 2022”，则“category”分面仅包含“Action > 2022”。仅支持文本字段。最多 10 个。
prefixes[]	string 仅获取以指定字符串前缀开头的分面值。例如，假设“category”有三个值：“Action > 2022”“Action > 2021”和“Sci-Fi > 2022”。如果将“prefixes”设置为“Action”，则“category”分面仅包含“Action > 2022”和“Action > 2021”。仅支持文本字段。最多 10 个。
contains[]	string 仅获取包含指定字符串的分面值。例如，假设“category”有三个值：“Action > 2022”“Action > 2021”和“Sci-Fi > 2022”。如果将“contains”设置为“2022”，则“category”分面仅包含“Action > 2022”和“Sci-Fi > 2022”。仅支持文本字段。最多 10 个。
case_insensitive	bool 如果为 true，则在获取带有前缀或包含的分面值时，分面键不区分大小写；否则为 false。
order_by	string 返回文档的顺序。 允许的值为： “count desc”，表示按 SearchResponse.Facet.values.count 降序排序。 “value desc”，表示按 SearchResponse.Facet.values.value 降序排序。仅适用于文本型多面搜索。 如果未设置，则文本值按自然顺序排序；数值区间按 FacetSpec.FacetKey.intervals 给定的顺序排序。

ImageQuery

指定图片查询输入。

字段
联合字段 image。 image 只能是下列其中一项：
image_bytes	string Base64 编码的图片字节。支持的图片格式：JPEG、PNG 和 BMP。

NaturalLanguageQueryUnderstandingSpec

用于为搜索请求启用自然语言理解功能的规范。

字段
filter_extraction_condition	FilterExtractionCondition 应提取过滤条件的条件。服务器行为默认为 DISABLED。
geo_search_query_detection_field_names[]	string 用于基于位置的过滤的字段名称，其中在自然语言搜索查询中检测到地理定位过滤条件。仅在 FilterExtractionCondition 设置为 ENABLED 时有效。 如果设置了此字段，它会替换 ServingConfig.geo_search_query_detection_field_names 中设置的字段名称。
extracted_filter_behavior	ExtractedFilterBehavior 可选。控制提取的过滤条件如何应用于搜索。默认行为取决于请求。对于单个数据存储区结构化搜索，默认值为 HARD_FILTER。对于多数据存储区搜索，默认行为是 SOFT_BOOST。基于地理位置的过滤条件始终作为硬过滤条件应用，并且 SOFT_BOOST 设置不会影响它们。仅当 [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] 设置为 FilterExtractionCondition.ENABLED 时，此字段才适用。
allowed_field_names[]	string 可选。可用于自然语言过滤条件提取的字段的许可名单。默认情况下，如果未指定此参数，则所有可编入索引的字段都符合自然语言过滤条件提取条件（但不保证会被使用）。如果 allowed_field_names 中指定了任何字段，则只有在架构中标记为可编制索引且在允许列表中指定的字段才符合自然语言过滤条件提取的条件。注意：多数据存储区搜索尚不支持此参数，系统会忽略此参数。

ExtractedFilterBehavior

一种枚举，用于描述如何将提取的过滤条件应用于搜索。

枚举
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED	EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED 将使用提取的过滤条件的默认行为。对于单个数据存储区搜索，默认应用为硬过滤条件。对于多数据存储区搜索，默认应用为软提升。
HARD_FILTER	将所有提取的过滤条件作为硬过滤条件应用于结果。未通过提取的过滤条件的结果将不会返回到结果集中。
SOFT_BOOST	将所有提取的过滤条件作为软加权应用。通过过滤条件的结果在结果集中的排名会提升。

FilterExtractionCondition

一种枚举，用于描述在何种条件下应进行过滤条件提取。

枚举
CONDITION_UNSPECIFIED	服务器行为默认为 DISABLED。
DISABLED	停用 NL 过滤条件提取。
ENABLED	启用 NL 过滤提取。

QueryExpansionSpec

用于确定在哪些条件下应进行查询扩展的规范。

字段
condition	Condition 应进行查询扩展的条件。默认为 Condition.DISABLED。
pin_unexpanded_results	bool 是否固定未展开的结果。如果此字段设置为 true，则未使用扩展功能的商品始终显示在搜索结果的顶部，然后才是使用扩展功能搜索到的商品。

条件

一种枚举，用于描述在何种条件下应进行查询扩展。

枚举
CONDITION_UNSPECIFIED	未指定查询扩展条件。在这种情况下，服务器行为默认为 Condition.DISABLED。
DISABLED	停用了查询扩展功能。即使 SearchResponse.total_size 为零，系统也只会使用确切的搜索查询。
AUTO	由 Search API 构建的自动查询扩展。

RankingExpressionBackend

用于排名表达式评估的后端。

枚举
RANKING_EXPRESSION_BACKEND_UNSPECIFIED	未指定/未知值的默认选项。
BYOE	已弃用：请改用 RANK_BY_EMBEDDING。按自定义嵌入模型进行排名，这是评估排名表达式的默认方式。旧版枚举选项，应改用 RANK_BY_EMBEDDING。 此项已弃用！
CLEARBOX	已弃用：请改用 RANK_BY_FORMULA。按自定义公式排名。旧版枚举选项，应改用 RANK_BY_FORMULA。 此项已弃用！
RANK_BY_EMBEDDING	按自定义嵌入模型进行排名，这是评估排名表达式的默认方式。
RANK_BY_FORMULA	按自定义公式排名。

RelevanceScoreSpec

用于返回文档相关性得分的规范。

字段
return_relevance_score	bool 可选。是否返回搜索结果的相关性得分。得分越高，文档与查询的相关性就越强。

RelevanceThreshold

搜索结果的相关性阈值。相关性阈值越高，显示的相关结果就越多，返回的结果数量就越少。

枚举
RELEVANCE_THRESHOLD_UNSPECIFIED	默认值。在这种情况下，服务器行为默认为 Google 定义的阈值。
LOWEST	最低相关性阈值。
LOW	相关性阈值较低。
MEDIUM	中等相关性阈值。
HIGH	相关性阈值较高。

SearchAsYouTypeSpec

在搜索请求中输入内容时进行搜索的规范。

字段
condition	Condition 即输即搜功能应在什么条件下运行。默认为 Condition.DISABLED。

条件

枚举，用于描述在何种条件下应进行“边输入边搜索”。

枚举
CONDITION_UNSPECIFIED	服务器行为默认为 Condition.DISABLED。
DISABLED	停用即输即搜功能。
ENABLED	启用即输即搜功能。
AUTO	在边输入边搜索模式和标准搜索模式之间自动切换，非常适合单 API 实现（例如，去抖动）。

SessionSpec

会话规范。

多轮搜索功能目前处于非公开正式版阶段。在正式向公众发布此功能之前，请使用 v1alpha 或 v1beta 版本。或者，通过 Google 支持团队申请加入许可名单。

字段
query_id	string 如果设置，搜索结果会存储到此查询 ID 指定的“轮次”。 示例：假设会话如下所示：session { name: ".../sessions/xxx" turns { query { text: "什么是 foo？" query_id: ".../questions/yyy" } answer: "Foo 是 ..." } turns { query { text: "那 bar 呢？" query_id: ".../questions/zzz" } } } 用户可以调用 /search API，并发送如下请求： session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } 然后，API 会存储与最后一轮对话关联的搜索结果。存储的搜索结果可供后续 /answer API 调用使用（指定会话 ID 和查询 ID）。此外，还可以使用相同的会话 ID 和查询 ID 并行调用 /search 和 /answer。
search_result_persistence_count	int32 要保留的热门搜索结果数量。持久性搜索结果可用于后续的 /answer API 调用。 此字段类似于 SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count 中的 summary_result_count 字段。 文档模式下最多 10 个结果，块模式下最多 50 个结果。

SpellCorrectionSpec

查询拼写更正的规范。

字段
mode	Mode 拼写更正功能替换原始搜索查询所采用的模式。默认值为 Mode.AUTO。

模式

用于描述应在何种模式下进行拼写更正的枚举。

枚举
MODE_UNSPECIFIED	未指定拼写校正模式。在这种情况下，服务器行为默认为 Mode.AUTO。
SUGGESTION_ONLY	搜索 API 会尝试查找拼写建议。如果找到建议，则将其放入 SearchResponse.corrected_query 中。拼写建议不会用作搜索查询。
AUTO	由 Search API 提供的自动拼写更正功能。如果找到更正后的查询，则搜索将基于该查询。

SearchResponse

SearchService.Search 方法的响应消息。

字段
results[]	SearchResult 匹配的文档列表。顺序表示排名。
facets[]	Facet 用户请求的分面结果。
total_size	int32 估算的匹配商品总数量，不考虑分页。分页返回的 results 数量可能少于匹配的 total_size 数量。
attribution_token	string 唯一的搜索令牌。此令牌应包含在相应搜索生成的 UserEvent 日志中，以便对搜索模型效果进行准确归因。这也有助于在客户支持场景中识别请求。
redirect_uri	string 客户自定义的重定向页面的 URI。如果触发了重定向操作，则不会执行搜索，并且响应中仅设置 redirect_uri 和 attribution_token。
next_page_token	string 可作为 SearchRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
corrected_query	string 包含拼写更正后的查询（如果找到）。如果拼写校正类型为 AUTOMATIC，则搜索结果基于 corrected_query。否则，系统会使用原始查询进行搜索。
summary	Summary 作为搜索结果的一部分的摘要。只有在设置了 SearchRequest.ContentSearchSpec.summary_spec 时，系统才会返回此字段。
query_expansion_info	QueryExpansionInfo 返回结果的查询扩展信息。
session_info	SessionInfo 会话信息。 仅当提供 SearchRequest.session 时才设置。如需了解详情，请参阅其说明。
search_link_promotions[]	SearchLinkPromotion 网站搜索的促销信息。

商品详情

一种分面结果。

字段
key	string 相应构面的键。例如 "colors" 或 "price"。 它与 SearchRequest.FacetSpec.FacetKey.key 相匹配。
values[]	FacetValue 相应字段的构面值。
dynamic_facet	bool 分面是否是动态生成的。

FacetValue

包含值名称及其数量的 Facet 值。

字段
count	int64 具有相应分面值的商品的数量。
联合字段 facet_value。包含值的 facet 值。facet_value 只能是下列其中一项：
value	string 相应构面的文本值，例如构面“颜色”的“黑色”。
interval	Interval 某个详情的区间值，例如“价格”详情的 [10, 20)。它与 SearchRequest.FacetSpec.FacetKey.intervals 相匹配。

QueryExpansionInfo

描述查询扩展的信息，包括是否已发生扩展。

字段
expanded_query	bool 一个布尔值，用于描述是否发生了查询扩展。
pinned_result_count	int64 固定结果的数量。只有在发生扩展且 SearchRequest.QueryExpansionSpec.pin_unexpanded_results 设置为 true 时，系统才会设置此字段。

SearchResult

表示搜索结果。

字段
id	string Document.id 的搜索结果。Document
document	Document 搜索响应中的文档数据代码段。仅填充标记为 retrievable 的字段。
chunk	Chunk 如果 SearchRequest.ContentSearchSpec.search_result_mode 设置为 CHUNKS，则搜索响应中的块数据。
model_scores	map<string, DoubleList> 仅限输出。Google 提供的可用得分。
rank_signals	RankSignals 可选。与结果关联的一组排名信号。

RankSignals

一组排名信号。

字段
default_rank	float 可选。结果的默认排名。
custom_signals[]	CustomSignal 可选。自定义 clearbox 信号的列表。
keyword_similarity_score	float 可选。关键字匹配调整。
relevance_score	float 可选。语义相关性调整。
semantic_similarity_score	float 可选。语义相似度调整。
pctr_rank	float 可选。预测的转化率调整幅度（以排名表示）。
topicality_rank	float 可选。主题性调整（以排名表示）。
document_age	float 可选。文档存在时间（以小时为单位）。
boosting_factor	float 可选。文档的组合自定义加权。

CustomSignal

以名称和值对表示的自定义 clearbox 信号。

字段
name	string 可选。信号的名称。
value	float 可选。表示排名信号的浮点值（例如，BM25 为 1.25）。

SessionInfo

有关会话的信息。

字段
name	string 会话名称。如果使用自动会话模式（当 SearchRequest.session 以“-”结尾时），此字段会保存新生成的会话名称。
query_id	string 与此搜索 API 调用对应的查询 ID。一个会话可以包含多个对话轮次，每个对话轮次都有一个唯一的查询 ID。 通过在 Answer API 调用中指定会话名称和此查询 ID，系统会在相应搜索调用的搜索结果上下文中生成回答。

摘要

由摘要规范指定的前 N 个搜索结果的摘要。

字段
summary_text	string 摘要内容。
summary_skipped_reasons[]	SummarySkippedReason 其他跳过摘要的原因。这提供了忽略的案例的原因。如果未跳过任何内容，则不会设置此字段。
safety_attributes	SafetyAttributes 安全属性类别及其关联置信度分数的集合。
summary_with_metadata	SummaryWithMetadata 包含元数据信息的摘要。

引用

细分的引用信息。

字段
start_index	int64 索引表示段的开头，以字节/Unicode 衡量。
end_index	int64 归因区段的结束时间（不含）。
sources[]	CitationSource 归因细分的引用来源。

CitationMetadata

引用元数据。

字段
citations[]	Citation 细分的引用。

CitationSource

引用来源。

字段
reference_index	int64 来自 SummaryWithMetadata.references 的文档参考索引。它是从 0 开始的索引，如果未明确设置 reference_index，则该值为零。

参考文档

文档参考。

字段
title	string 文档的标题。
document	string 必需。Document.name。所引用文档的完整资源名称，格式为 projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*。
uri	string 文档的 Cloud Storage 或 HTTP URI。
chunk_contents[]	ChunkContent 从文档内容派生的引用块内容列表。

ChunkContent

分块内容。

字段
content	string 块状文本内容。
page_identifier	string 网页标识符。

SafetyAttributes

安全属性类别及其关联的置信度分数。

字段
categories[]	string 与所生成内容关联的“安全属性”类别的显示名称。顺序与得分匹配。
scores[]	float 每个类别的置信度分数越高，表示置信度越高。顺序与类别匹配。

SummarySkippedReason

用于表示摘要跳过原因的枚举。

枚举
SUMMARY_SKIPPED_REASON_UNSPECIFIED	默认值。未指定跳过摘要的原因。
ADVERSARIAL_QUERY_IGNORED	忽略了对抗性查询的案例。 仅在 SummarySpec.ignore_adversarial_query 设置为 true 时使用。
NON_SUMMARY_SEEKING_QUERY_IGNORED	非摘要搜索查询忽略了大小写。 如果查询是闲聊，Google 会跳过摘要。仅在 SummarySpec.ignore_non_summary_seeking_query 设置为 true 时使用。
OUT_OF_DOMAIN_QUERY_IGNORED	网域外查询忽略了大小写。 如果没有高度相关的搜索结果，Google 会跳过摘要。例如，数据存储区包含有关公司 A 的事实，但用户查询的是有关公司 B 的问题。
POTENTIAL_POLICY_VIOLATION	可能违反政策的情况。 如果检测到潜在的违规情况，Google 会跳过摘要。包括可能包含暴力或有害内容的内容。
LLM_ADDON_NOT_ENABLED	LLM 加购项未启用情况。 如果未启用 LLM 插件，Google 会跳过摘要。
NO_RELEVANT_CONTENT	无相关内容的情况。 如果检索到的搜索结果中没有相关内容，Google 会跳过摘要。
JAIL_BREAKING_QUERY_IGNORED	越狱查询忽略了大小写。 例如，“以竞争对手公司 CEO 的语气回复”。仅在 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] 设置为 true 时使用。
CUSTOMER_POLICY_VIOLATION	客户政策违规支持请求。 如果检测到违反客户政策的情况，Google 会跳过摘要。政策由客户定义。
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2	不寻求答案的查询（忽略大小写）。 如果搜索查询没有明确的意图，Google 会跳过摘要。仅当 [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] 设置为 true 时使用。
TIME_OUT	超时情况。 如果超时，Google 会跳过摘要。

SummaryWithMetadata

包含元数据信息的摘要。

字段
summary	string 不含引用信息的摘要文本。
citation_metadata	CitationMetadata 给定摘要的引用元数据。
references[]	Reference 文档参考。

SearchTier

搜索功能层级。不同层级的价格可能不同。如需了解详情，请参阅价格文档。

枚举
SEARCH_TIER_UNSPECIFIED	未指定枚举时的默认值。此功能无法使用。
SEARCH_TIER_STANDARD	标准层级。
SEARCH_TIER_ENTERPRISE	Enterprise 层级。

SearchUseCase

定义 SolutionType 的进一步细分。专门适用于 SOLUTION_TYPE_SEARCH。

枚举
SEARCH_USE_CASE_UNSPECIFIED	未设置时使用的值。不会在 CSS 中发生。
SEARCH_USE_CASE_SEARCH	搜索用例。预期流量具有非空的 query。
SEARCH_USE_CASE_BROWSE	浏览使用情形。预期流量具有空的 query。

ServingConfig

配置用于生成服务时结果（例如搜索结果或推荐预测）的元数据。ServingConfig 在搜索和预测请求中传递，并生成结果。

字段
name	string 不可变。完全限定名称 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
display_name	string 必需。直观易懂的服务配置显示名称。在发现界面中使用。 此字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
solution_type	SolutionType 必需。不可变。指定服务配置可关联的解决方案类型。
model_id	string 在提供服务时要使用的模型的 ID。目前仅支持 RecommendationModel。可以更改，但只能更改为兼容的模型（例如，将“您可能喜欢的其他内容”点击率模型更改为“您可能喜欢的其他内容”转化率模型）。 当 SolutionType 为 SOLUTION_TYPE_RECOMMENDATION 时，必须设置此参数。
diversity_level	string 在推荐模型结果中使用的多样性程度，例如 medium-diversity 或 high-diversity。目前支持的值： no-diversity low-diversity medium-diversity high-diversity auto-diversity 如果未指定，我们会根据推荐模型类型选择默认值。默认值：no-diversity。 只有当 SolutionType 为 SOLUTION_TYPE_RECOMMENDATION 时才能设置此项。
ranking_expression	string 排名表达式用于控制检索到的文档的自定义排名。若要利用此功能，您需要进行文档嵌入。ServingConfig 中的排名表达式设置适用于由相应投放配置处理的所有搜索请求。不过，如果指定了 SearchRequest.ranking_expression，它会替换 ServingConfig 排名表达式。 排名表达式是单个函数或多个通过“+”连接的函数。 ranking_expression = function, { " + ", function }; 支持的函数： double * relevance_score double * dotProduct(embedding_field_path) 函数变量： relevance_score：预定义的关键字，用于衡量查询与文档之间的相关性。 embedding_field_path：与查询嵌入向量搭配使用的文档嵌入字段。 dotProduct：embedding_field_path 与查询嵌入向量之间的嵌入函数。 排名表达式示例： 如果文档具有嵌入字段 doc_embedding，则排名表达式可以是 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)。
create_time	Timestamp 仅限输出。ServingConfig 创建时间戳。
update_time	Timestamp 仅限输出。ServingConfig 更新时间戳。
filter_control_ids[]	string 在服务路径中使用的过滤条件控件。系统将应用所有触发的过滤条件控件。过滤条件控件必须与投放配置位于同一数据存储区中。最多 20 个过滤条件控件。
boost_control_ids[]	string 在服务路径中使用的提升控制变量。系统将应用所有触发的提升控制。提升控制变量必须与投放配置位于同一数据存储区中。最多 20 个提升控件。
redirect_control_ids[]	string 重定向控件的 ID。即使触发了多个重定向操作，也只会应用第一个触发的操作。规格数量上限为 100。 只有当 SolutionType 为 SOLUTION_TYPE_SEARCH 时才能设置此项。
synonyms_control_ids[]	string 条件同义词规范。如果多个同义词条件匹配，则列表中的所有匹配同义词控件都将执行。规格数量上限为 100。 只有当 SolutionType 为 SOLUTION_TYPE_SEARCH 时才能设置此项。
oneway_synonyms_control_ids[]	string 条件单向同义词规范。如果多个单向同义词条件匹配，系统将执行列表中的所有匹配的单向同义词控件。规格数量上限为 100。 只有当 SolutionType 为 SOLUTION_TYPE_SEARCH 时才能设置此项。
dissociate_control_ids[]	string 条件不关联规范。如果多个不关联条件匹配，则列表中的所有匹配的不关联控制变量都将执行。顺序无关紧要。规格数量上限为 100。 只有当 SolutionType 为 SOLUTION_TYPE_SEARCH 时才能设置此项。
replacement_control_ids[]	string 条件替换规范。按列表中的顺序应用。之前替换过的字词无法再次替换。规格数量上限为 100。 只有当 SolutionType 为 SOLUTION_TYPE_SEARCH 时才能设置此项。
ignore_control_ids[]	string 条件忽略规范。如果多个忽略条件匹配，系统将执行列表中的所有匹配的忽略控制变量。顺序无关紧要。规格数量上限为 100。
promote_control_ids[]	string 宣传规范的条件。 规格数量上限为 100。
answer_generation_spec	AnswerGenerationSpec 可选。答案生成规范。
联合字段 vertical_config。特定垂直行业的配置。vertical_config 只能是下列其中一项：
media_config	MediaConfig 投放配置的 MediaConfig。
generic_config	GenericConfig 投放配置的 GenericConfig。

GenericConfig

指定通用发现所需的配置。目前，我们支持：

• content_search_spec：常规内容搜索的配置。

字段
content_search_spec	ContentSearchSpec 指定内容搜索的预期行为。仅对启用内容搜索的数据存储区有效。

MediaConfig

指定媒体发现所需的配置。目前支持：

• demote_content_watched：观看过的内容降级阈值。客户可以指定是使用“降位已观看的内容”功能，还是使用“查看过的详情页面”功能。使用观看过的内容降级功能时，客户需要指定观看时长或百分比超过阈值，系统就会在推荐结果中降级相应内容。
• promote_fresh_content：新内容推广的截止天数。客户可以指定是否使用内容新鲜度提升功能。如果内容是在截止日期内发布的，则会在推荐结果中推广该内容。只有当 SolutionType 为 SOLUTION_TYPE_RECOMMENDATION 时才能设置此项。

字段
demotion_event_type	string 指定用于降级推荐结果的事件类型。目前支持的值： view-item：已观看内容。 media-play：开始/继续观看视频、播放歌曲等。 media-complete：已完成或在播放视频、歌曲等内容的过程中停止。 如果未设置，则不会应用观看记录降级。系统仍会应用内容新鲜度降级。
demote_content_watched_past_days	int32 可选。指定在降位观看过的内容时要回溯的天数。如果设置为 0 或未设置，则默认为最长 365 天。
content_freshness_cutoff_days	int32 指定用于推荐结果的内容新鲜度。如果内容发布时间已超过内容新鲜度截止天数，则会被降位。
联合字段 demote_content_watched。指定降级已观看内容的阈值，该阈值可以是百分比值，也可以是分钟值。必须为 media-complete 事件类型设置此值。demote_content_watched 只能是下列其中一项：
content_watched_percentage_threshold	float 指定降位的观看内容百分比阈值。阈值必须介于 [0, 1.0] 之间（含 0 和 1.0）。
content_watched_seconds_threshold	float 指定降位的观看内容时长阈值。

会话

外部会话 proto 定义。

字段
name	string 不可变。完全限定名称 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
display_name	string 可选。会话的显示名称。 此字段用于在界面中标识会话。默认情况下，显示名称是会话中的第一个轮次查询文本。
state	State 会话的状态。
user_pseudo_id	string 用于跟踪用户的唯一标识符。
turns[]	Turn 圈数。
labels[]	string 可选。会话的标签。可在 ListSessionsRequest 中设置为过滤条件。
start_time	Timestamp 仅限输出。会话开始的时间。
end_time	Timestamp 仅限输出。会话结束的时间。
is_pinned	bool 可选。会话是否已固定，已固定的会话将显示在会话列表顶部。

州

会话状态的枚举。

枚举
STATE_UNSPECIFIED	状态未指定。
IN_PROGRESS	会话目前处于开放状态。

Turn

表示一个对话轮次，包括用户的查询和服务的回答。

字段
query	Query 可选。用户查询。如果此轮只是重新生成对另一轮的回答，则可能不会设置
answer	string 可选。用户查询的回答的资源名称。 仅当在此轮中生成了答案（/answer API 调用）时才设置。
assist_answer	string 仅限输出。针对用户查询的 Google 助理回答的资源名称。 仅当在此轮对话中发生辅助调用（/assist API 调用）时才设置。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}。如需获取会话的所有 AssistAnswer，请将 GetSessionRequest.include_answer_details 设置为 true。或者，如需获取单个 AssistAnswer 资源，请使用 AssistAnswerService.GetAssistAnswer API。
detailed_answer	Answer 仅限输出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 设置为 true，则在获取回答查询会话时，系统会填充此字段。
detailed_assist_answer	AssistAnswer 仅限输出。在 ConversationalSearchService.GetSession API 中，如果 GetSessionRequest.include_answer_details 设置为 true，则在获取助理会话时，系统会填充此字段。
query_config	map<string, string> 可选。表示与查询配置相关的元数据，例如所用的 LLM 模型和版本、模型参数（温度、接地参数等）。前缀“google.”已预留给 Google 开发的功能。

SetUpDataConnectorMetadata

此类型没有字段。

DataConnectorService.SetUpDataConnector 方法的元数据。

SetUpDataConnectorRequest

对 DataConnectorService.SetUpDataConnector 方法的请求。

字段
parent	string 必需。Collection 的父级，采用 projects/{project}/locations/{location} 格式。
collection_id	string 必需。要用于 Collection 的 ID，该 ID 将成为 Collection 资源名称的最后一个组成部分。在 DataConnector 设置过程中，系统会创建一个新的 Collection。DataConnector 是 Collection 下的单例资源，用于管理 Collection 的所有 DataStore。 此字段必须符合 RFC-1034 标准，且长度上限为 63 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
collection_display_name	string 必需。Collection 的显示名称。 应为人类可读的字符串，用于在控制台信息中心内显示集合。UTF-8 编码的字符串，长度上限为 1024 个字符。
data_connector	DataConnector 必需。要在新创建的 Collection 中初始化的 DataConnector。

SingleRegionKey

单区域 CMEK 的元数据。

字段
kms_key	string 必需。将用于加密资源 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 的单区域 KMS 密钥资源名称。

SiteSearchEngine

SiteSearchEngine 会捕获数据存储区级网站搜索持久性配置。每个数据存储区都有一个单例值。

字段
name	string 网站搜索引擎的完全限定资源名称。格式：projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

高级网站搜索中目标网站的验证信息。

字段
site_verification_state	SiteVerificationState 网站验证状态，用于指明所有权和有效性。
verify_time	Timestamp 最新的网站验证时间。

SiteVerificationState

网站验证状态。

枚举
SITE_VERIFICATION_STATE_UNSPECIFIED	默认值为 VERIFIED。
VERIFIED	网站所有权已通过验证。
UNVERIFIED	网站所有权正在等待验证或验证失败。
EXEMPTED	免于验证的网站，例如面向所有人开放的公共网站。

站点地图

SiteSearchEngine 的站点地图。

字段
name	string 仅限输出。相应站点地图的完全限定资源名称。projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/* 后缀 sitemap_id 由系统生成。
create_time	Timestamp 仅限输出。相应站点地图的创建时间。
联合字段 feed。支持的 Feed 来源。feed 只能是下列其中一项：
uri	string 站点地图的公开 URI，例如 www.example.com/sitemap.xml。

SolutionType

解决方案的类型。

枚举
SOLUTION_TYPE_UNSPECIFIED	默认值。
SOLUTION_TYPE_RECOMMENDATION	用于 Recommendations AI。
SOLUTION_TYPE_SEARCH	用于 Discovery 搜索。
SOLUTION_TYPE_CHAT	用于与生成式 AI 智能体相关的应用场景。
SOLUTION_TYPE_GENERATIVE_CHAT	用于与生成式聊天代理相关的应用场景。仅用于生成式聊天引擎，关联的数据存储区必须注册 SOLUTION_TYPE_CHAT 解决方案。

SpannerSource

用于导入数据的 Spanner 源

字段
project_id	string 包含 Spanner 源的项目 ID。长度限制为 128 个字符。如果未指定，则继承父请求中的项目 ID。
instance_id	string 必需。源 Spanner 表的实例 ID。
database_id	string 必需。源 Spanner 表的数据库 ID。
table_id	string 必需。需要导入的 Spanner 数据库的表名称。
enable_data_boost	bool 是否在 Spanner 导出操作中应用数据加速。启用此选项会产生额外费用。如需了解详情，请点击此处。

StreamAssistRequest

针对 AssistantService.StreamAssist 方法的请求。

字段
name	string 必需。Assistant 的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
query	Query 可选。当前用户查询。 仅当提供 file_ids 时才支持空查询。在这种情况下，系统会根据这些上下文文件生成回答。
session	string 可选。用于请求的会话。如果指定了此参数，助理可以访问对话记录，并且查询和回答会存储在对话记录中。 如果将 - 指定为会话 ID，或将其留空，系统会创建一个新会话并自动生成 ID。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
user_metadata	AssistUserMetadata 可选。发起查询的用户的相关信息。
agents_spec	AgentsSpec 可选。用于处理请求的代理的规范。
tools_spec	ToolsSpec 可选。用于处理请求的工具的规范。
generation_spec	GenerationSpec 可选。请求的生成配置规范。

AgentsSpec

用于处理请求的代理的规范。

字段
agent_specs[]	AgentSpec 可选。用于处理请求的代理的规范。

AgentSpec

代理的规范。

字段
agent_id	string 必需。用于标识处理请求的代理资源的 ID。 此字段必须符合 RFC-1034 的要求，且长度上限为 63 个字符。

GenerationSpec

请求的助理生成规范。这样，您就可以在引擎级替换默认的生成配置。

字段
model_id	string 可选。用于生成式模型的 Vertex AI model_id。如果未设置，系统将使用默认的 Assistant 模型。

ToolsSpec

用于处理请求的工具的规范。

字段
vertex_ai_search_spec	VertexAiSearchSpec 可选。Vertex AI Search 工具的规范。
web_grounding_spec	WebGroundingSpec 可选。网络接地工具的规范。如果存在此字段，则启用基于网络搜索的接地。仅当 Assistant.web_grounding_type 为 [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] 或 [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] 时有效。
image_generation_spec	ImageGenerationSpec 可选。图片生成工具的规范。
video_generation_spec	VideoGenerationSpec 可选。视频生成工具的规范。

ImageGenerationSpec

此类型没有字段。

图片生成工具的规范。

VertexAiSearchSpec

Vertex AI Search 工具的规范。

字段
data_store_specs[]	DataStoreSpec 可选。用于定义搜索调用中要过滤的 DataStore 和这些数据存储区的配置。仅针对具有多个数据存储区的 Engine 进行考虑。
filter	string 可选。过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。过滤表达式区分大小写。 如果此字段无法识别，则返回 INVALID_ARGUMENT。 Vertex AI Search 中的过滤是通过将 LHS 过滤键映射到 Vertex AI Search 后端中定义的键属性来完成的，此映射由客户在其架构中定义。例如，媒体客户的架构中可能包含“名称”字段。在这种情况下，过滤条件将如下所示：filter --> name:'ANY("king kong")' 如需详细了解过滤（包括语法和过滤运算符），请参阅过滤

VideoGenerationSpec

此类型没有字段。

视频生成工具的规范。

WebGroundingSpec

此类型没有字段。

网络接地工具的规范。

StreamAssistResponse

对 AssistantService.StreamAssist 方法的响应。

字段
answer	AssistAnswer Assist answer 资源对象，包含助理针对用户查询给出的最终回答的部分内容。 如果当前响应未向之前发送的 AssistAnswer.replies 添加任何内容，则不存在。 观察 AssistAnswer.state 以确定是否需要更多部分。当状态为 IN_PROGRESS 时，每个响应中的 AssistAnswer.replies 字段都将包含要附加到之前响应中收到的回复的回复（回复片段）。AssistAnswer.name 不会填充。 如果状态为 SUCCEEDED、FAILED 或 SKIPPED，则响应为最终响应，且 AssistAnswer.name 将具有一个值。
session_info	SessionInfo 会话信息。仅包含在响应流的最终 StreamAssistResponse 中。
assist_token	string 用于标识当前请求和响应流的全局唯一 ID。用于反馈和支持。

SessionInfo

有关会话的信息。

字段
session	string 新生成的会话或继续的会话的名称。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}。

SubscriptionTerm

订阅期。LINT.IfChange

枚举
SUBSCRIPTION_TERM_UNSPECIFIED	默认值，请勿使用。
SUBSCRIPTION_TERM_ONE_MONTH	1 个月。
SUBSCRIPTION_TERM_ONE_YEAR	1 年。
SUBSCRIPTION_TERM_THREE_YEARS	3 年。

SubscriptionTier

订阅层级信息。

枚举
SUBSCRIPTION_TIER_UNSPECIFIED	默认值。
SUBSCRIPTION_TIER_SEARCH	搜索层级。搜索层级可以使用 VAIS 搜索功能和 NotebookLM 功能。
SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT	“搜索 + 助理”层级。搜索 + 助理层级可以使用 VAIS 搜索功能、NotebookLM 功能和助理功能。
SUBSCRIPTION_TIER_NOTEBOOK_LM	NotebookLM 方案。NotebookLM 是一种订阅层级，只能使用 NotebookLM 功能。
SUBSCRIPTION_TIER_FRONTLINE_WORKER	一线员工层级。
SUBSCRIPTION_TIER_AGENTSPACE_STARTER	Agentspace 入门版层级。
SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS	Agentspace Business 层级。
SUBSCRIPTION_TIER_ENTERPRISE	Enterprise 层级。
SUBSCRIPTION_TIER_EDU	教育机构层级。
SUBSCRIPTION_TIER_EDU_PRO	教育 Pro 版层级。
SUBSCRIPTION_TIER_EDU_EMERGING	教育版新兴市场层级。
SUBSCRIPTION_TIER_EDU_PRO_EMERGING	教育 Pro 版新兴市场层级。

SuggestionDenyListEntry

建议拒绝列表条目，用于标识要从建议中屏蔽的短语以及应用于该短语的操作。

字段
block_phrase	string 必需。要屏蔽的短语，以免系统提供相关建议。最多可包含 125 个字符。
match_operator	MatchOperator 必需。要为此短语应用的匹配运算符。是屏蔽确切词组，还是屏蔽包含此词组的任何建议。

MatchOperator

用于与生成的建议匹配的运算符。

枚举
MATCH_OPERATOR_UNSPECIFIED	默认值。不应使用
EXACT_MATCH	如果建议与 block_phrase 完全匹配，则屏蔽该建议。
CONTAINS	如果建议包含 block_phrase，则屏蔽该建议。

TargetSite

SiteSearchEngine 的目标网站。

字段
name	string 仅限输出。目标网站的完全限定资源名称。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} target_site_id 由系统生成。
provided_uri_pattern	string 必需。仅限输入。用户提供的 URI 模式，用于生成 generated_uri_pattern。
type	Type 目标网站的类型，例如，网站是要包含还是排除。
exact_match	bool 不可变。如果设置为 false，则会生成一个 uri_pattern，以包含地址中包含 provided_uri_pattern 的所有网页。如果设置为 true，系统会生成一个 uri_pattern，尝试与 provided_uri_pattern 完全匹配，或者在 provided_uri_pattern 是特定网址时仅与该特定网页匹配。provided_uri_pattern 始终会经过标准化处理，以生成供搜索引擎使用的 URI 模式。
generated_uri_pattern	string 仅限输出。这是根据 provided_uri_pattern 由系统生成的。
root_domain_uri	string 仅限输出。provided_uri_pattern 的根网域。
site_verification_info	SiteVerificationInfo 仅限输出。网站所有权和有效性验证状态。
indexing_status	IndexingStatus 仅限输出。索引编制状态。
update_time	Timestamp 仅限输出。目标网站的上次更新时间。
failure_reason	FailureReason 仅限输出。失败原因。

FailureReason

网站搜索索引编制失败原因。

字段
联合字段 failure。失败原因。failure 只能是下列其中一项：
quota_failure	QuotaFailure 由于配额不足，因此操作失败。

QuotaFailure

由于配额不足，因此操作失败。

字段
total_required_quota	int64 此数字用于估算相应项目成功完成索引编制所需的总配额。

IndexingStatus

目标网站的索引编制状态枚举。

枚举
INDEXING_STATUS_UNSPECIFIED	默认值为 SUCCEEDED。
PENDING	目标网站位于更新队列中，并将由索引流水线拾取。
FAILED	目标网站无法编入索引。
SUCCEEDED	目标网站已被编入索引。
DELETING	之前已编入索引的目标网站已被标记为待删除。此状态表示正在转换，最终结果为：1. 如果取消编入索引成功，则删除目标网站；2. 如果取消编入索引失败，则状态恢复为 SUCCEEDED。
CANCELLABLE	目标网站更改正在等待处理，但可以取消。
CANCELLED	目标网站更改已取消。

类型

可能的目标网站类型。

枚举
TYPE_UNSPECIFIED	此值未使用。在这种情况下，服务器行为默认为 Type.INCLUDE。
INCLUDE	包含目标网站。
EXCLUDE	排除目标网站。

租户

连接器来源的租户信息。这包括存储在 Credential 消息中的部分相同信息，但仅限于向用户提供可访问的租户列表所需的信息。

字段
id	string 租户的实例 ID。示例：Jira（“8594f221-9797-5f78-1fa4-485e198d7cd0”）、Slack（“T123456”）。
uri	string 租户的 URI（如果适用）。例如，Jira 实例的 URI 为 https://my-jira-instance.atlassian.net，而 Slack 租户没有 URI。
display_name	string 租户的可选显示名称，例如“我的 Slack 团队”。

TextInput

定义文本输入。

字段
input	string 文本输入。
context	ConversationContext 输入的对话上下文。

TrainCustomModelMetadata

与 TrainCustomModel 操作的进度相关的元数据。此值由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

TrainCustomModelRequest

SearchTuningService.TrainCustomModel 方法的请求消息。

字段
data_store	string 必需。数据存储区的资源名称，例如 projects/*/locations/global/collections/default_collection/dataStores/default_data_store。此字段用于标识要训练模型的数据存储区。
model_type	string 要训练的模型。支持的值包括： search-tuning：根据提供的数据对搜索系统进行微调。
error_config	ImportErrorConfig 数据注入和训练期间发生的错误的预期位置。
model_id	string 如果未提供，系统会生成一个 UUID。
联合字段 training_input。模型训练输入。training_input 只能是下列其中一项：
gcs_training_input	GcsTrainingInput Cloud Storage 训练输入。

GcsTrainingInput

Cloud Storage 训练数据输入。

字段
corpus_data_path	string 可与训练数据相关联的 Cloud Storage 语料库数据。数据路径格式为 gs://<bucket_to_data>/<jsonl_file_name>。以换行符分隔的 JSONL/NDJSON 文件。 对于搜索调优模型，每行应包含 _id、标题和文本。示例：{"_id": "doc1", title: "relevant doc", "text": "relevant text"}
query_data_path	string 可能与训练数据相关联的 GCS 查询数据。数据路径格式为 gs://<bucket_to_data>/<jsonl_file_name>。以换行符分隔的 JSONL/NDJSON 文件。 对于搜索调优模型，每行都应包含 _id 和文本。示例：{"_id": "query1", "text": "example query"}
train_data_path	string Cloud Storage 训练数据路径，其格式应为 gs://<bucket_to_data>/<tsv_file_name>。文件应为 TSV 格式。每行应包含 doc_id、query_id 和得分（数字）。 对于搜索调优模型，它应具有查询 ID、语料库 ID、得分作为 TSV 文件头。得分应为 [0, inf+) 中的数字。数字越大，相应配对的相关性就越强。示例： query-id\tcorpus-id\tscore query1\tdoc1\t1
test_data_path	string Cloud Storage 测试数据。与 train_data_path 相同的格式。如果未提供，系统将对 train_data_path 执行随机 80/20 训练/测试拆分。

TrainCustomModelResponse

TrainCustomModelRequest 的回答。此消息由 google.longrunning.Operations.response 字段返回。

字段
error_samples[]	Status 处理数据时遇到的一些错误示例。
error_config	ImportErrorConfig 如果设置，则在请求中回显完整错误的 destination。
model_status	string 经过训练的模型的状态。可能的值包括： bad-data：训练数据质量较差。 no-improvement：调整未提升性能。不会部署。 in-progress：模型训练作业创建正在进行中。 训练：模型正在积极训练。 评估：模型正在评估训练后的指标。 编入索引：模型训练指标已编入索引。 就绪：模型已准备就绪，可以投入使用。
metrics	map<string, double> 已训练模型的指标。
model_name	string CustomTuningModel 的完全限定名称。

TransactionInfo

交易是指整个购买交易。

字段
currency	string 必需。币种代码。请使用三个字符的 ISO-4217 代码。
transaction_id	string 交易 ID，长度限制为 128 个字符。
value	float 必需。与交易相关的非零总价值。此值可能包含运费、税费或其他要计入总价值的调整值。
tax	float 与交易相关的所有税费。
cost	float 与商品相关的所有费用。这些费用可以是制造成本、最终用户无需承担的运费或任何其他费用，因此： 利润 = value - tax - cost
discount_value	float 应用于相应交易的折扣总价值。此数字应从 TransactionInfo.value 中排除 例如，如果用户支付了 TransactionInfo.value 金额，则交易的名义（折扣前）价值为 TransactionInfo.value 和 TransactionInfo.discount_value 的总和 这意味着，无论折扣值是多少，利润的计算方式都相同，并且 TransactionInfo.discount_value 可以大于 TransactionInfo.value： 利润 = value - tax - cost

UpdateAclConfigRequest

针对 UpdateAclConfig 方法的请求消息。

字段
acl_config	AclConfig

UpdateAssistantRequest

对 AssistantService.UpdateAssistant 方法的请求消息。

字段
assistant	Assistant 必需。要更新的 Assistant。 Assistant 的 name 字段用于标识要更新的 Assistant。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 如果调用方没有更新 Assistant 的权限（无论该 Assistant 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果要更新的 Assistant 不存在，则返回 NOT_FOUND 错误。
update_mask	FieldMask 要更新的字段列表。

UpdateCmekConfigMetadata

与 CmekConfigService.UpdateCmekConfig 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

UpdateCmekConfigRequest

针对 UpdateCmekConfig 方法的请求消息。rpc。

字段
config	CmekConfig 必需。CmekConfig 资源。
set_default	bool 将以下 CmekConfig 设置为默认值，以便在未指定子资源的情况下使用。

UpdateControlRequest

针对 UpdateControl 方法的请求。

字段
control	Control 必需。要更新的控制变量。
update_mask	FieldMask 可选。指示要更新所提供的 Control 中的哪些字段。不支持以下操作： Control.name Control.solution_type 如果未设置或为空，系统会更新所有受支持的字段。

UpdateConversationRequest

针对 UpdateConversation 方法的请求。

字段
conversation	Conversation 必需。要更新的对话。
update_mask	FieldMask 指示要更新所提供的 Conversation 中的哪些字段。不支持以下操作： Conversation.name 如果未设置或为空，系统会更新所有受支持的字段。

UpdateDataConnectorRequest

DataConnectorService.UpdateDataConnector 方法的请求消息。

字段
data_connector	DataConnector 必需。要更新的 DataConnector。 如果调用方没有更新 DataConnector 的权限（无论该 DataConnector 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果 DataConnector 不存在，则返回 NOT_FOUND 错误。
update_mask	FieldMask 指示要更新所提供的 DataConnector 中的哪些字段。 支持的字段路径包括： 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 注意：对这些字段的支持情况可能因连接器类型而异。例如，并非所有连接器都支持 destination_configs。 如果提供不受支持或未知的字段路径，请求将返回 INVALID_ARGUMENT 错误。

UpdateDataStoreRequest

DataStoreService.UpdateDataStore 方法的请求消息。

字段
data_store	DataStore 必需。要更新的 DataStore。 如果调用方没有更新 DataStore 的权限（无论该 DataStore 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果要更新的 DataStore 不存在，则返回 NOT_FOUND 错误。
update_mask	FieldMask 指示要更新所提供的 DataStore 中的哪些字段。 如果提供不受支持或未知的字段，系统会返回 INVALID_STRING 错误。

UpdateDocumentRequest

DocumentService.UpdateDocument 方法的请求消息。

字段
document	Document 必需。要更新/创建的文档。 如果调用方没有更新 Document 的权限，无论该 Document 是否存在，都会返回 PERMISSION_DENIED 错误。 如果要更新的 Document 不存在且未设置 allow_missing，则返回 NOT_FOUND 错误。
allow_missing	bool 如果设置为 true 且未找到 Document，则系统会创建新的 Document。
update_mask	FieldMask 指示要更新所提供的导入“文档”中的哪些字段。如果未设置，则默认更新所有字段。

UpdateEngineRequest

EngineService.UpdateEngine 方法的请求消息。

字段
engine	Engine 必需。要更新的 Engine。 如果调用方没有更新 Engine 的权限（无论该 Engine 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果要更新的 Engine 不存在，则返回 NOT_FOUND 错误。
update_mask	FieldMask 指示要更新所提供的 Engine 中的哪些字段。 如果提供不受支持或未知的字段，系统会返回 INVALID_STRING 错误。

UpdateLicenseConfigRequest

LicenseConfigService.UpdateLicenseConfig 方法的请求消息。

字段
license_config	LicenseConfig 必需。要更新的 LicenseConfig。
update_mask	FieldMask 可选。指示要更新所提供的 LicenseConfig 中的哪些字段。 如果提供不受支持或未知的字段，系统会返回 INVALID_STRING 错误。

UpdateSchemaMetadata

UpdateSchema LRO 的元数据。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

UpdateSchemaRequest

SchemaService.UpdateSchema 方法的请求消息。

字段
schema	Schema 必需。要更新的 Schema。
allow_missing	bool 如果设置为 true，并且未找到 Schema，则系统会创建新的 Schema。在这种情况下，系统会忽略 update_mask。

UpdateServingConfigRequest

针对 UpdateServingConfig 方法的请求。

字段
serving_config	ServingConfig 必需。要更新的 ServingConfig。
update_mask	FieldMask 指示要更新所提供的 ServingConfig 中的哪些字段。不支持以下操作： ServingConfig.name 如果未设置，系统会更新所有受支持的字段。

UpdateSessionRequest

针对 UpdateSession 方法的请求。

字段
session	Session 必需。要更新的会话。
update_mask	FieldMask 指示要更新所提供的 Session 中的哪些字段。不支持以下操作： Session.name 如果未设置或为空，系统会更新所有受支持的字段。

UpdateTargetSiteMetadata

与 SiteSearchEngineService.UpdateTargetSite 操作的进度相关的元数据。此值将由 google.longrunning.Operation.metadata 字段返回。

字段
create_time	Timestamp 操作创建时间。
update_time	Timestamp 操作的上次更新时间。如果操作已完成，则这也是完成时间。

UpdateTargetSiteRequest

SiteSearchEngineService.UpdateTargetSite 方法的请求消息。

字段
target_site	TargetSite 必需。要更新的目标网站。如果调用方没有更新 TargetSite 的权限（无论该 TargetSite 是否存在），系统都会返回 PERMISSION_DENIED 错误。 如果要更新的 TargetSite 不存在，则返回 NOT_FOUND 错误。

UserEvent

UserEvent 会捕获 Discovery Engine API 需要了解的有关最终用户如何与您的网站互动的所有元数据信息。

字段
event_type	string 必需。用户事件类型。允许的值为： 通用值： search：搜索文档。 view-item：文档的详细页面视图。 view-item-list：面板或有序文档列表的视图。 view-home-page：首页视图。 view-category-page：类别页面的视图，例如“首页 > 男装 > 牛仔裤” 与零售相关的值： add-to-cart：将商品添加到购物车，例如在零售在线购物中 purchase：购买商品 媒体相关值： media-play：开始/继续观看视频、播放歌曲等。 media-complete：已完成或在播放视频、歌曲等内容的过程中停止。 自定义转化价值： conversion：客户定义的转化事件。
conversion_type	string 可选。转化类型。 如果 UserEvent.event_type 为 conversion，则必须提供此值。这是客户定义的转化名称，采用小写字母或数字，以“-”分隔，例如“watch”“good-visit”等。 如果 UserEvent.event_type 不是 conversion，请勿设置该字段。这会将自定义转化事件与 search、view-item 等预定义事件混合在一起。
user_pseudo_id	string 必需。用于跟踪访问者的唯一标识符。 例如，可以使用 HTTP Cookie 实现此目的，该 Cookie 应能够唯一标识单个设备上的访问者。如果访问者登录/退出网站，此唯一标识符不应发生变化。 请勿为不同用户将该字段设置为相同的固定 ID。这会将这些用户的事件历史记录混杂在一起，从而导致模型质量下降。 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。 该字段不应包含 PII 或用户数据。建议您为此字段使用 Google Analytics 客户端 ID。
engine	string Engine 资源名称，格式为 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。 可选。仅对于 Engine 生成的用户事件是必需的。例如，混合搜索中的用户事件。
data_store	string DataStore 资源的完整名称，格式为 projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。 可选。仅当无法通过 UserEvent.engine 或 UserEvent.documents 确定用户事件的数据存储区时才需要。如果在写入/导入/收集用户事件请求的父级中设置了数据存储区，则可以省略此字段。
event_time	Timestamp 仅 UserEventService.ImportUserEvents 方法需要此参数。用户事件发生时的时间戳。
user_info	UserInfo 有关最终用户的信息。
direct_user_request	bool 如果请求直接由最终用户发出，则应设置为 true，在这种情况下，可以从 HTTP 请求中填充 UserEvent.user_info.user_agent。 只有在 API 请求直接由最终用户（例如移动应用）发出时，才应设置此标志；如果网关或服务器正在处理和推送用户事件，则不应设置此标志。 在 UserEventService.CollectUserEvent 中使用 JavaScript 代码时，不应设置此属性。
session_id	string 用于跟踪访问者会话的唯一标识符，长度限制为 128 字节。会话是指最终用户在一段时间内的行为汇总。 填充 session_id 的一般准则： 如果用户在 30 分钟内没有任何活动，则应分配新的 session_id。 session_id 在用户之间应该是唯一的，建议使用 UUID 或添加 UserEvent.user_pseudo_id 作为前缀。
page_info	PageInfo 网页元数据，例如类别以及某些事件类型（例如 view-category-page）的其他关键信息。
attribution_token	string 用于将 API 响应归因于触发事件的用户操作的令牌。 强烈建议将此值用于因 RecommendationService.Recommend 而产生的用户事件。此字段可实现对推荐模型效果的准确归因。 该值必须是以下项之一： RecommendResponse.attribution_token 表示因 RecommendationService.Recommend 而产生的事件。 SearchResponse.attribution_token 表示因 SearchService.Search 而产生的事件。 借助此令牌，我们可以准确地将网页浏览或转化完成归因于相应事件以及包含此点击/购买产品的特定预测响应。如果用户点击建议结果中的商品 K，则将 RecommendResponse.attribution_token 作为网址参数传递给商品 K 的页面。在记录商品 K 的页面上的事件时，请将 RecommendResponse.attribution_token 记录到此字段。
filter	string 过滤器语法使用一种表达式语言，可根据要过滤文档的一个或多个字段构建过滤条件。 例如，对于 search 事件，关联的 SearchRequest 可能包含 SearchRequest.filter 中的过滤表达式，该表达式符合 https://google.aip.dev/160#filtering。 同样，对于从 RecommendRequest 生成的 view-item-list 事件，此字段可以直接从 RecommendRequest.filter 填充，并遵循 https://google.aip.dev/160#filtering。 该值必须是采用 UTF-8 编码的字符串，长度上限为 1,000 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
documents[]	DocumentInfo 与此用户事件相关联的 Document 的列表。 此字段为选填字段，但以下事件类型除外： view-item add-to-cart purchase media-play media-complete 在 search 事件中，此字段表示当前网页上返回给最终用户的文档（最终用户可能尚未完成整个网页的浏览）。当最终用户在分页/过滤/排序后（即使是针对同一查询）获得新网页时，我们希望获得具有不同 UserEvent.documents 的新 search 事件。
panel	PanelInfo 与相应用户事件相关联的面板元数据。
search_info	SearchInfo 与活动相关的SearchService.Search详细信息。 应为 search 事件设置此字段。
completion_info	CompletionInfo 与活动相关的CompletionService.CompleteQuery详细信息。 如果启用了自动补全功能，并且用户点击了搜索建议，则应为 search 事件设置此字段。
transaction_info	TransactionInfo 与相应用户事件关联的交易元数据（如有）。
tag_ids[]	string 相应用户事件所属的独立实验组的标识符列表。用于区分与不同实验设置关联的用户事件。
promotion_ids[]	string 如果相应事件与促销活动相关联，则为促销活动 ID。目前，此字段最多只能包含一个 ID。
attributes	map<string, CustomAttribute> 要纳入推荐模型中的额外用户事件特征。这些属性不得包含需要进一步解析或处理的数据，例如 JSON 或其他编码。 如果您为注入的用户事件提供自定义特性，则务必也在与预测请求关联的用户事件中添加这些特性。自定义特性的格式设置必须在导入事件和随预测请求提供的事件之间保持一致。这样，Discovery Engine API 便可在训练模型和提供预测时使用这些自定义特性，从而帮助提高推荐质量。 此字段需要满足以下所有条件，否则系统会返回 INVALID_ARGUMENT 错误： 键必须是 UTF-8 编码的字符串，长度限制为 5,000 个字符。 对于文本属性，最多允许 400 个值。不允许使用空值。每个值都必须是 UTF-8 编码的字符串，长度限制为 256 个字符。 对于数字属性，最多允许 400 个值。 对于商品推荐，额外的用户信息的一个示例是 traffic_channel，即用户到达网站的方式。用户可以直接访问网站，也可以通过 Google 搜索或其他方式访问网站。
media_info	MediaInfo 媒体专属信息。
panels[]	PanelInfo 可选。与相应活动相关联的面板的列表。用于网页级展示数据。

UserInfo

最终用户的信息。

字段
user_id	string 强烈建议已登录的用户使用。已登录用户的唯一标识符，例如用户名。不为匿名用户设置。 始终为此 ID 使用哈希值。 请勿为不同用户将该字段设置为相同的固定 ID。这会将这些用户的事件历史记录混杂在一起，从而导致模型质量下降。 该字段必须是 UTF-8 编码的字符串，长度限制为 128 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。
user_agent	string HTTP 标头中包含的用户代理。 该字段必须是 UTF-8 编码的字符串，长度上限为 1,000 个字符。否则，系统将返回 INVALID_ARGUMENT 错误。 如果使用 GTM 或 JavaScript 代码在 UserEventService.CollectUserEvent 中进行客户端事件报告，或者设置了 UserEvent.direct_user_request，则不应设置此属性。
time_zone	string 可选。IANA 时区，例如 Europe/Budapest。

UserLicense

管理员分配的用户许可信息。

字段
user_principal	string 必需。不可变。用户的用户正文，可以是电子邮件地址或其他正文标识符。该字段不可更改。 管理员根据用户正文分配许可。
user_profile	string 可选。用户个人资料。我们会使用用户的全名（名字 + 姓氏）作为用户个人资料。
license_assignment_state	LicenseAssignmentState 仅限输出。用户的许可分配状态。如果用户已分配许可配置，则用户登录时会分配相应许可；如果用户的许可分配状态为“未分配”或“未指定”，则不会将任何许可配置与该用户相关联；
license_config	string 可选。分配给用户的订阅(LicenseConfig) 的完整资源名称。
create_time	Timestamp 仅限输出。用户创建时间戳。
update_time	Timestamp 仅限输出。用户更新时间戳。
last_login_time	Timestamp 仅限输出。用户上次登录时间。如果用户尚未登录，此字段将为空。

LicenseAssignmentState

许可分配状态枚举。

枚举
LICENSE_ASSIGNMENT_STATE_UNSPECIFIED	默认值。
ASSIGNED	已为用户分配许可。
UNASSIGNED	未向用户分配许可。已弃用，已转换为 NO_LICENSE。
NO_LICENSE	未向用户分配许可。
NO_LICENSE_ATTEMPTED_LOGIN	用户尝试登录，但未向该用户分配许可。此状态仅用于用户首次尝试登录但无法获得许可的情况。已登录但无法获得许可的用户将被分配 NO_LICENSE 状态（许可可能已被管理员取消分配）。
BLOCKED	用户无法分配许可。

WorkspaceConfig

用于存储工作区数据的数据存储区类型配置的配置

字段
type	Type Google Workspace 数据源。
dasher_customer_id	string 模糊处理的 Dasher 客户 ID。
super_admin_service_account	string 可选。将用于生成访问令牌的工作区的超级用户服务账号。目前，我们仅将其用于原生 Google 云端硬盘连接器数据注入。
super_admin_email_address	string 可选。将用于生成访问令牌的工作区的超级管理员电子邮件地址。目前，我们仅将其用于原生 Google 云端硬盘连接器数据注入。

类型

指定相应 DataStore 支持的 Workspace 应用类型

枚举
TYPE_UNSPECIFIED	默认值为未指定的工作区类型。
GOOGLE_DRIVE	Workspace 数据存储区包含云端硬盘数据
GOOGLE_MAIL	Workspace 数据存储区包含 Google 邮件数据
GOOGLE_SITES	Workspace Data Store 包含 Google 协作平台数据
GOOGLE_CALENDAR	Workspace 数据存储区包含日历数据
GOOGLE_CHAT	Workspace Data Store 包含 Chat 数据
GOOGLE_GROUPS	Workspace 数据存储区包含 Google 群组数据
GOOGLE_KEEP	Workspace 数据存储区包含 Keep 数据
GOOGLE_PEOPLE	Workspace Data Store 包含人员数据

WriteUserEventRequest

针对 WriteUserEvent 方法的请求消息。

字段
parent	string 必需。父级资源名称。如果写入用户事件操作是在 DataStore 级别应用的，则格式为：projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}。如果“写入用户事件”操作应用于 Location 级，例如，具有 Document 的事件跨多个 DataStore，则格式为：projects/{project}/locations/{location}。
write_async	bool 如果设置为 true，则在验证后异步写入用户事件，并且 API 会在不等待写入的情况下做出响应。
user_event	UserEvent 必需。要写入的用户事件。