Index
AclConfigService
(interface)ChunkService
(interface)CmekConfigService
(interface)CompletionService
(interface)ControlService
(interface)ConversationalSearchService
(interface)DataStoreService
(interface)DocumentService
(interface)EngineService
(interface)EstimateBillingService
(interface)EvaluationService
(interface)GroundedGenerationService
(interface)MetricService
(interface)ProjectService
(interface)RankService
(interface)RecommendationService
(interface)RequirementService
(interface)SampleQueryService
(interface)SampleQuerySetService
(interface)SchemaService
(interface)SearchService
(interface)SearchTuningService
(interface)ServingConfigService
(interface)SiteSearchEngineService
(interface)UserEventService
(interface)WidgetConfigService
(interface)WidgetService
(interface)AclConfig
(message)AcquireAndStoreRefreshTokenRequest
(message)AcquireAndStoreRefreshTokenResponse
(message)AdditionalParams
(message)AdvancedCompleteQueryRequest
(message)AdvancedCompleteQueryRequest.BoostSpec
(message)AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec
(message)AdvancedCompleteQueryRequest.SuggestionType
(enum)AdvancedCompleteQueryResponse
(message)AdvancedCompleteQueryResponse.ContentSuggestion
(message)AdvancedCompleteQueryResponse.ContentSuggestion.ContentType
(enum)AdvancedCompleteQueryResponse.PersonSuggestion
(message)AdvancedCompleteQueryResponse.PersonSuggestion.PersonType
(enum)AdvancedCompleteQueryResponse.QuerySuggestion
(message)AdvancedCompleteQueryResponse.RecentSearchSuggestion
(message)AdvancedSiteSearchConfig
(message)AlloyDbSource
(message)Answer
(message)Answer.AnswerSkippedReason
(enum)Answer.Citation
(message)Answer.CitationSource
(message)Answer.QueryUnderstandingInfo
(message)Answer.QueryUnderstandingInfo.QueryClassificationInfo
(message)Answer.QueryUnderstandingInfo.QueryClassificationInfo.Type
(enum)Answer.Reference
(message)Answer.Reference.ChunkInfo
(message)Answer.Reference.ChunkInfo.DocumentMetadata
(message)Answer.Reference.StructuredDocumentInfo
(message)Answer.Reference.UnstructuredDocumentInfo
(message)Answer.Reference.UnstructuredDocumentInfo.ChunkContent
(message)Answer.State
(enum)Answer.Step
(message)Answer.Step.Action
(message)Answer.Step.Action.Observation
(message)Answer.Step.Action.Observation.SearchResult
(message)Answer.Step.Action.Observation.SearchResult.ChunkInfo
(message)Answer.Step.Action.Observation.SearchResult.SnippetInfo
(message)Answer.Step.Action.SearchAction
(message)Answer.Step.State
(enum)AnswerQueryRequest
(message)AnswerQueryRequest.AnswerGenerationSpec
(message)AnswerQueryRequest.AnswerGenerationSpec.ModelSpec
(message)AnswerQueryRequest.AnswerGenerationSpec.PromptSpec
(message)AnswerQueryRequest.GroundingSpec
(message)AnswerQueryRequest.GroundingSpec.FilteringLevel
(enum)AnswerQueryRequest.QueryUnderstandingSpec
(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec
(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec.Type
(enum)AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec
(message)AnswerQueryRequest.RelatedQuestionsSpec
(message)AnswerQueryRequest.SafetySpec
(message)AnswerQueryRequest.SearchSpec
(message)AnswerQueryRequest.SearchSpec.SearchParams
(message)AnswerQueryRequest.SearchSpec.SearchResultList
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer
(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment
(message)AnswerQueryResponse
(message)BatchCreateTargetSiteMetadata
(message)BatchCreateTargetSitesRequest
(message)BatchCreateTargetSitesResponse
(message)BatchGetDocumentsMetadataRequest
(message)BatchGetDocumentsMetadataRequest.FhirMatcher
(message)BatchGetDocumentsMetadataRequest.Matcher
(message)BatchGetDocumentsMetadataRequest.UrisMatcher
(message)BatchGetDocumentsMetadataResponse
(message)BatchGetDocumentsMetadataResponse.DocumentMetadata
(message)BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue
(message)BatchGetDocumentsMetadataResponse.State
(enum)BatchVerifyTargetSitesMetadata
(message)BatchVerifyTargetSitesRequest
(message)BatchVerifyTargetSitesResponse
(message)BigQuerySource
(message)BigtableOptions
(message)BigtableOptions.BigtableColumn
(message)BigtableOptions.BigtableColumnFamily
(message)BigtableOptions.Encoding
(enum)BigtableOptions.Type
(enum)BigtableSource
(message)CheckGroundingRequest
(message)CheckGroundingResponse
(message)CheckGroundingResponse.Claim
(message)CheckGroundingResponse.FactChunk
(message)CheckGroundingSpec
(message)CheckRequirementRequest
(message)CheckRequirementResponse
(message)CheckRequirementResponse.MetricQueryResult
(message)CheckRequirementResponse.RequirementResult
(enum)Chunk
(message)Chunk.ChunkMetadata
(message)Chunk.DocumentMetadata
(message)Chunk.PageSpan
(message)CloudSqlSource
(message)CmekConfig
(message)CmekConfig.State
(enum)CollectUserEventRequest
(message)CompleteQueryRequest
(message)CompleteQueryResponse
(message)CompleteQueryResponse.QuerySuggestion
(message)CompletionConfig
(message)CompletionConfig.EnableMode
(enum)CompletionInfo
(message)CompletionSuggestion
(message)Condition
(message)Condition.QueryTerm
(message)Condition.TimeRange
(message)Control
(message)Control.BoostAction
(message)Control.FilterAction
(message)Control.RedirectAction
(message)Control.SynonymsAction
(message)Conversation
(message)Conversation.State
(enum)ConversationContext
(message)ConversationMessage
(message)ConverseConversationRequest
(message)ConverseConversationResponse
(message)CrawlRateTimeSeries
(message)CreateControlRequest
(message)CreateConversationRequest
(message)CreateDataStoreMetadata
(message)CreateDataStoreRequest
(message)CreateDocumentRequest
(message)CreateEngineMetadata
(message)CreateEngineRequest
(message)CreateEvaluationMetadata
(message)CreateEvaluationRequest
(message)CreateSampleQueryRequest
(message)CreateSampleQuerySetRequest
(message)CreateSchemaMetadata
(message)CreateSchemaRequest
(message)CreateServingConfigRequest
(message)CreateSessionRequest
(message)CreateTargetSiteMetadata
(message)CreateTargetSiteRequest
(message)CustomAttribute
(message)CustomFineTuningSpec
(message)CustomTuningModel
(message)CustomTuningModel.ModelState
(enum)DataStore
(message)DataStore.BillingEstimation
(message)DataStore.ContentConfig
(enum)DataStore.ServingConfigDataStore
(message)DedicatedCrawlRateTimeSeries
(message)DeleteControlRequest
(message)DeleteConversationRequest
(message)DeleteDataStoreMetadata
(message)DeleteDataStoreRequest
(message)DeleteDocumentRequest
(message)DeleteEngineMetadata
(message)DeleteEngineRequest
(message)DeleteSampleQueryRequest
(message)DeleteSampleQuerySetRequest
(message)DeleteSchemaMetadata
(message)DeleteSchemaRequest
(message)DeleteServingConfigRequest
(message)DeleteSessionRequest
(message)DeleteTargetSiteMetadata
(message)DeleteTargetSiteRequest
(message)DisableAdvancedSiteSearchMetadata
(message)DisableAdvancedSiteSearchRequest
(message)DisableAdvancedSiteSearchResponse
(message)Document
(message)Document.AclInfo
(message)Document.AclInfo.AccessRestriction
(message)Document.Content
(message)Document.IndexStatus
(message)DocumentInfo
(message)DocumentProcessingConfig
(message)DocumentProcessingConfig.ChunkingConfig
(message)DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig
(message)DocumentProcessingConfig.ParsingConfig
(message)DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig
(message)DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
(message)DocumentProcessingConfig.ParsingConfig.OcrParsingConfig
(message)DoubleList
(message)EmbeddingConfig
(message)EnableAdvancedSiteSearchMetadata
(message)EnableAdvancedSiteSearchRequest
(message)EnableAdvancedSiteSearchResponse
(message)Engine
(message)Engine.ChatEngineConfig
(message)Engine.ChatEngineConfig.AgentCreationConfig
(message)Engine.ChatEngineMetadata
(message)Engine.CommonConfig
(message)Engine.MediaRecommendationEngineConfig
(message)Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig
(message)Engine.MediaRecommendationEngineConfig.TrainingState
(enum)Engine.RecommendationMetadata
(message)Engine.RecommendationMetadata.DataState
(enum)Engine.RecommendationMetadata.ServingState
(enum)Engine.SearchEngineConfig
(message)Engine.SimilarDocumentsEngineConfig
(message)EstimateDataSizeMetadata
(message)EstimateDataSizeRequest
(message)EstimateDataSizeRequest.FileDataSource
(message)EstimateDataSizeRequest.WebsiteDataSource
(message)EstimateDataSizeRequest.WebsiteDataSource.EstimatorUriPattern
(message)EstimateDataSizeResponse
(message)Evaluation
(message)Evaluation.EvaluationSpec
(message)Evaluation.EvaluationSpec.QuerySetSpec
(message)Evaluation.State
(enum)ExecuteActionRequest
(message)ExecuteActionRequest.AssistAnswerInfo
(message)ExecuteActionResponse
(message)FetchDocumentsRequest
(message)FetchDocumentsRequest.Type
(enum)FetchDocumentsResponse
(message)FetchDocumentsResponse.Result
(message)FetchDocumentsResponse.Result.DocumentType
(enum)FetchDomainVerificationStatusRequest
(message)FetchDomainVerificationStatusResponse
(message)FhirStoreSource
(message)FieldConfig
(message)FieldConfig.AdvancedSiteSearchDataSource
(enum)FieldConfig.CompletableOption
(enum)FieldConfig.DynamicFacetableOption
(enum)FieldConfig.FieldType
(enum)FieldConfig.FilterableOption
(enum)FieldConfig.IndexableOption
(enum)FieldConfig.RetrievableOption
(enum)FieldConfig.SearchableOption
(enum)FirestoreSource
(message)GcsSource
(message)GetAclConfigRequest
(message)GetAnswerRequest
(message)GetChunkRequest
(message)GetCmekConfigRequest
(message)GetCompletionConfigRequest
(message)GetControlRequest
(message)GetConversationRequest
(message)GetDataStoreRequest
(message)GetDocumentProcessingConfigRequest
(message)GetDocumentRequest
(message)GetEngineRequest
(message)GetEvaluationRequest
(message)GetProcessedDocumentRequest
(message)GetProcessedDocumentRequest.ProcessedDocumentFormat
(enum)GetProcessedDocumentRequest.ProcessedDocumentType
(enum)GetProjectRequest
(message)GetSampleQueryRequest
(message)GetSampleQuerySetRequest
(message)GetSchemaRequest
(message)GetServingConfigRequest
(message)GetSessionRequest
(message)GetSiteSearchEngineRequest
(message)GetTargetSiteRequest
(message)GetUriPatternDocumentDataRequest
(message)GetUriPatternDocumentDataResponse
(message)GroundingFact
(message)GuidedSearchSpec
(message)IdpConfig
(message)IdpConfig.ExternalIdpConfig
(message)IdpConfig.IdpType
(enum)ImportCompletionSuggestionsMetadata
(message)ImportCompletionSuggestionsRequest
(message)ImportCompletionSuggestionsRequest.InlineSource
(message)ImportCompletionSuggestionsResponse
(message)ImportDocumentsMetadata
(message)ImportDocumentsRequest
(message)ImportDocumentsRequest.InlineSource
(message)ImportDocumentsRequest.ReconciliationMode
(enum)ImportDocumentsResponse
(message)ImportErrorConfig
(message)ImportSampleQueriesMetadata
(message)ImportSampleQueriesRequest
(message)ImportSampleQueriesRequest.InlineSource
(message)ImportSampleQueriesResponse
(message)ImportSuggestionDenyListEntriesMetadata
(message)ImportSuggestionDenyListEntriesRequest
(message)ImportSuggestionDenyListEntriesRequest.InlineSource
(message)ImportSuggestionDenyListEntriesResponse
(message)ImportUserEventsMetadata
(message)ImportUserEventsRequest
(message)ImportUserEventsRequest.InlineSource
(message)ImportUserEventsResponse
(message)IndustryVertical
(enum)Interval
(message)LanguageInfo
(message)ListChunksRequest
(message)ListChunksResponse
(message)ListCmekConfigsRequest
(message)ListCmekConfigsResponse
(message)ListControlsRequest
(message)ListControlsResponse
(message)ListConversationsRequest
(message)ListConversationsResponse
(message)ListCustomModelsRequest
(message)ListCustomModelsResponse
(message)ListDataStoresRequest
(message)ListDataStoresResponse
(message)ListDocumentsRequest
(message)ListDocumentsResponse
(message)ListEnginesRequest
(message)ListEnginesResponse
(message)ListEvaluationResultsRequest
(message)ListEvaluationResultsResponse
(message)ListEvaluationResultsResponse.EvaluationResult
(message)ListEvaluationsRequest
(message)ListEvaluationsResponse
(message)ListSampleQueriesRequest
(message)ListSampleQueriesResponse
(message)ListSampleQuerySetsRequest
(message)ListSampleQuerySetsResponse
(message)ListSchemasRequest
(message)ListSchemasResponse
(message)ListServingConfigsRequest
(message)ListServingConfigsResponse
(message)ListSessionsRequest
(message)ListSessionsResponse
(message)ListTargetSitesRequest
(message)ListTargetSitesResponse
(message)LookupWidgetConfigRequest
(message)LookupWidgetConfigResponse
(message)MediaInfo
(message)NaturalLanguageQueryUnderstandingConfig
(message)NaturalLanguageQueryUnderstandingConfig.Mode
(enum)ObtainCrawlRateResponse
(message)ObtainCrawlRateResponse.State
(enum)OrganicCrawlRateTimeSeries
(message)PageInfo
(message)PanelInfo
(message)PauseEngineRequest
(message)Principal
(message)ProcessedDocument
(message)Project
(message)Project.ServiceTerms
(message)Project.ServiceTerms.State
(enum)ProvisionProjectMetadata
(message)ProvisionProjectRequest
(message)PurgeCompletionSuggestionsMetadata
(message)PurgeCompletionSuggestionsRequest
(message)PurgeCompletionSuggestionsResponse
(message)PurgeDocumentsMetadata
(message)PurgeDocumentsRequest
(message)PurgeDocumentsRequest.InlineSource
(message)PurgeDocumentsResponse
(message)PurgeErrorConfig
(message)PurgeSuggestionDenyListEntriesMetadata
(message)PurgeSuggestionDenyListEntriesRequest
(message)PurgeSuggestionDenyListEntriesResponse
(message)PurgeUserEventsMetadata
(message)PurgeUserEventsRequest
(message)PurgeUserEventsResponse
(message)QualityMetrics
(message)QualityMetrics.TopkMetrics
(message)Query
(message)RankRequest
(message)RankResponse
(message)RankingRecord
(message)RecommendRequest
(message)RecommendResponse
(message)RecommendResponse.RecommendationResult
(message)RecrawlUrisMetadata
(message)RecrawlUrisRequest
(message)RecrawlUrisResponse
(message)RecrawlUrisResponse.FailureInfo
(message)RecrawlUrisResponse.FailureInfo.FailureReason
(message)RecrawlUrisResponse.FailureInfo.FailureReason.CorpusType
(enum)Reply
(message)Reply.Reference
(message) (deprecated)ReportConsentChangeRequest
(message)ReportConsentChangeRequest.ConsentChangeAction
(enum)Requirement
(message)Requirement.MetricBinding
(message)Requirement.ThresholdBinding
(message)Requirement.ViolationSamplesBinding
(message)ResumeEngineRequest
(message)SampleQuery
(message)SampleQuery.QueryEntry
(message)SampleQuery.QueryEntry.Target
(message)SampleQuerySet
(message)Schema
(message)SearchAddOn
(enum)SearchInfo
(message)SearchRequest
(message)SearchRequest.BoostSpec
(message)SearchRequest.BoostSpec.ConditionBoostSpec
(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType
(enum)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint
(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType
(enum)SearchRequest.ContentSearchSpec
(message)SearchRequest.ContentSearchSpec.ChunkSpec
(message)SearchRequest.ContentSearchSpec.ExtractiveContentSpec
(message)SearchRequest.ContentSearchSpec.SearchResultMode
(enum)SearchRequest.ContentSearchSpec.SnippetSpec
(message)SearchRequest.ContentSearchSpec.SummarySpec
(message)SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec
(message)SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec
(message)SearchRequest.DataStoreSpec
(message)SearchRequest.EmbeddingSpec
(message)SearchRequest.EmbeddingSpec.EmbeddingVector
(message)SearchRequest.FacetSpec
(message)SearchRequest.FacetSpec.FacetKey
(message)SearchRequest.ImageQuery
(message)SearchRequest.NaturalLanguageQueryUnderstandingSpec
(message)SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition
(enum)SearchRequest.PersonalizationSpec
(message)SearchRequest.PersonalizationSpec.Mode
(enum)SearchRequest.QueryExpansionSpec
(message)SearchRequest.QueryExpansionSpec.Condition
(enum)SearchRequest.RelevanceThreshold
(enum)SearchRequest.SearchAsYouTypeSpec
(message)SearchRequest.SearchAsYouTypeSpec.Condition
(enum)SearchRequest.SessionSpec
(message)SearchRequest.SpellCorrectionSpec
(message)SearchRequest.SpellCorrectionSpec.Mode
(enum)SearchResponse
(message)SearchResponse.Facet
(message)SearchResponse.Facet.FacetValue
(message)SearchResponse.GeoSearchDebugInfo
(message)SearchResponse.GuidedSearchResult
(message)SearchResponse.GuidedSearchResult.RefinementAttribute
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.AndExpression
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraint
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint.Comparison
(enum)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.OrExpression
(message)SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.StringConstraint
(message)SearchResponse.OneBoxResult
(message)SearchResponse.OneBoxResult.OneBoxType
(enum)SearchResponse.QueryExpansionInfo
(message)SearchResponse.SearchResult
(message)SearchResponse.SessionInfo
(message)SearchResponse.Summary
(message)SearchResponse.Summary.Citation
(message)SearchResponse.Summary.CitationMetadata
(message)SearchResponse.Summary.CitationSource
(message)SearchResponse.Summary.Reference
(message)SearchResponse.Summary.Reference.ChunkContent
(message)SearchResponse.Summary.SafetyAttributes
(message)SearchResponse.Summary.SummarySkippedReason
(enum)SearchResponse.Summary.SummaryWithMetadata
(message)SearchTier
(enum)SearchUseCase
(enum)ServingConfig
(message)ServingConfig.GenericConfig
(message)ServingConfig.MediaConfig
(message)Session
(message)Session.State
(enum)Session.Turn
(message)SetUriPatternDocumentDataMetadata
(message)SetUriPatternDocumentDataRequest
(message)SetUriPatternDocumentDataResponse
(message)SiteSearchEngine
(message)SiteVerificationInfo
(message)SiteVerificationInfo.SiteVerificationState
(enum)SolutionType
(enum)SpannerSource
(message)SuggestionDenyListEntry
(message)SuggestionDenyListEntry.MatchOperator
(enum)TargetSite
(message)TargetSite.FailureReason
(message)TargetSite.FailureReason.QuotaFailure
(message)TargetSite.IndexingStatus
(enum)TargetSite.Type
(enum)TextInput
(message)TrainCustomModelMetadata
(message)TrainCustomModelRequest
(message)TrainCustomModelRequest.GcsTrainingInput
(message)TrainCustomModelResponse
(message)TransactionInfo
(message)TuneEngineMetadata
(message)TuneEngineRequest
(message)TuneEngineResponse
(message)UpdateAclConfigRequest
(message)UpdateCmekConfigMetadata
(message)UpdateCmekConfigRequest
(message)UpdateCompletionConfigRequest
(message)UpdateControlRequest
(message)UpdateConversationRequest
(message)UpdateDataStoreRequest
(message)UpdateDocumentProcessingConfigRequest
(message)UpdateDocumentRequest
(message)UpdateEngineRequest
(message)UpdateSampleQueryRequest
(message)UpdateSampleQuerySetRequest
(message)UpdateSchemaMetadata
(message)UpdateSchemaRequest
(message)UpdateServingConfigRequest
(message)UpdateSessionRequest
(message)UpdateTargetSiteMetadata
(message)UpdateTargetSiteRequest
(message)UserEvent
(message)UserInfo
(message)WidgetAcquireAndStoreRefreshTokenRequest
(message)WidgetAcquireAndStoreRefreshTokenResponse
(message)WidgetAdvancedCompleteQueryRequest
(message)WidgetAdvancedCompleteQueryResponse
(message)WidgetAnswerQueryRequest
(message)WidgetAnswerQueryResponse
(message)WidgetCompleteQueryRequest
(message)WidgetCompleteQueryResponse
(message)WidgetCompleteQueryResponse.WidgetQuerySuggestion
(message)WidgetConfig
(message)WidgetConfig.AccessSettings
(message)WidgetConfig.CollectionComponent
(message)WidgetConfig.DataStoreComponent
(message)WidgetConfig.DataStoreType
(enum)WidgetConfig.DataStoreUiConfig
(message)WidgetConfig.FacetField
(message)WidgetConfig.HomepageSetting
(message)WidgetConfig.HomepageSetting.Shortcut
(message)WidgetConfig.Image
(message)WidgetConfig.ResultDisplayType
(enum)WidgetConfig.UIComponentField
(message)WidgetConfig.UIComponentField.DeviceVisibility
(enum)WidgetConfig.UiBrandingSettings
(message)WidgetConfig.UiSettings
(message)WidgetConfig.UiSettings.GenerativeAnswerConfig
(message)WidgetConfig.UiSettings.InteractionType
(enum)WidgetConverseConversationRequest
(message)WidgetConverseConversationResponse
(message)WidgetExecuteActionRequest
(message)WidgetExecuteActionResponse
(message)WidgetHomepageFetchDocumentsRequest
(message)WidgetHomepageFetchDocumentsResponse
(message)WidgetSearchRequest
(message)WidgetSearchResponse
(message)WidgetWriteUserEventRequest
(message)WidgetWriteUserEventResponse
(message)WorkspaceConfig
(message)WorkspaceConfig.Type
(enum)WriteUserEventRequest
(message)
AclConfigService
Service for managing Acl Configuration.
GetAclConfig |
---|
Gets the
|
UpdateAclConfig |
---|
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
|
ChunkService
Service for displaying processed Chunk
information of the customer's unstructured data.
GetChunk |
---|
Gets a
|
ListChunks |
---|
Gets a list of
|
CmekConfigService
Service for managing CMEK related tasks
GetCmekConfig |
---|
Gets the
|
ListCmekConfigs |
---|
Lists all the
|
UpdateCmekConfig |
---|
Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
|
CompletionService
Service for Auto-Completion.
AdvancedCompleteQuery |
---|
Completes the user input with advanced keyword suggestions.
|
CompleteQuery |
---|
Completes the specified user input with keyword suggestions.
|
ImportCompletionSuggestions |
---|
Imports
|
ImportSuggestionDenyListEntries |
---|
Imports all
|
PurgeCompletionSuggestions |
---|
Permanently deletes all
|
PurgeSuggestionDenyListEntries |
---|
Permanently deletes all
|
ControlService
Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.
CreateControl |
---|
Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the
|
DeleteControl |
---|
Deletes a Control. If the
|
GetControl |
---|
Gets a Control.
|
ListControls |
---|
Lists all Controls by their parent
|
UpdateControl |
---|
Updates a Control.
|
ConversationalSearchService
Service for conversational search.
AnswerQuery |
---|
Answer query method.
|
ConverseConversation |
---|
Converses a conversation.
|
CreateConversation |
---|
Creates a Conversation. If the
|
CreateSession |
---|
Creates a Session. If the
|
DeleteConversation |
---|
Deletes a Conversation. If the
|
DeleteSession |
---|
Deletes a Session. If the
|
GetAnswer |
---|
Gets a Answer.
|
GetConversation |
---|
Gets a Conversation.
|
GetSession |
---|
Gets a Session.
|
ListConversations |
---|
Lists all Conversations by their parent
|
ListSessions |
---|
Lists all Sessions by their parent
|
UpdateConversation |
---|
Updates a Conversation.
|
UpdateSession |
---|
Updates a Session.
|
DataStoreService
Service for managing DataStore
configuration.
CreateDataStore |
---|
Creates a DataStore is for storing
|
DeleteDataStore |
---|
Deletes a
|
GetCompletionConfig |
---|
Gets a
|
GetDataStore |
---|
Gets a
|
GetDocumentProcessingConfig |
---|
Gets a
|
ListDataStores |
---|
Lists all the
|
UpdateCompletionConfig |
---|
Updates the
|
UpdateDataStore |
---|
Updates a
|
UpdateDocumentProcessingConfig |
---|
Updates the
|
DocumentService
Service for ingesting Document
information of the customer's website.
BatchGetDocumentsMetadata |
---|
Gets index freshness metadata for
|
CreateDocument |
---|
Creates a
|
DeleteDocument |
---|
Deletes a
|
GetDocument |
---|
Gets a
|
GetProcessedDocument |
---|
Gets the parsed layout information for a
|
ImportDocuments |
---|
Bulk import of multiple Note: It is possible for a subset of the
|
ListDocuments |
---|
Gets a list of
|
PurgeDocuments |
---|
Permanently deletes all selected This process is asynchronous. Depending on the number of To get a list of the
|
UpdateDocument |
---|
Updates a
|
EngineService
Service for managing Engine
configuration.
CreateEngine |
---|
Creates a
|
DeleteEngine |
---|
Deletes a
|
GetEngine |
---|
Gets a
|
ListEngines |
---|
Lists all the
|
PauseEngine |
---|
Pauses the training of an existing engine. Only applicable if
|
ResumeEngine |
---|
Resumes the training of an existing engine. Only applicable if
|
TuneEngine |
---|
Tunes an existing engine. Only applicable if
|
UpdateEngine |
---|
Updates an
|
EstimateBillingService
Service for managing billing estimations resources.
EstimateDataSize |
---|
Estimates the data size to be used by a customer.
|
EvaluationService
Service for managing Evaluation
s,
CreateEvaluation |
---|
Creates a Upon creation, the evaluation will be automatically triggered and begin execution.
|
GetEvaluation |
---|
Gets a
|
ListEvaluationResults |
---|
Gets a list of results for a given a
|
ListEvaluations |
---|
Gets a list of
|
GroundedGenerationService
Service for grounded generation.
CheckGrounding |
---|
Performs a grounding check.
|
MetricService
Service for metric management.
ProjectService
Service for operations on the Project
.
GetProject |
---|
Gets a
|
ProvisionProject |
---|
Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the Terms for data use, and optionally specify in request to provide consent to that service terms.
|
ReportConsentChange |
---|
Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update:
|
RankService
Service for ranking text records.
Rank |
---|
Ranks a list of text records based on the given input query.
|
RecommendationService
Service for making recommendations.
Recommend |
---|
Makes a recommendation, which requires a contextual user event.
|
RequirementService
Service for requirement management.
CheckRequirement |
---|
Check a particular requirement.
|
SampleQueryService
Service for managing SampleQuery
s,
CreateSampleQuery |
---|
Creates a
|
DeleteSampleQuery |
---|
Deletes a
|
GetSampleQuery |
---|
Gets a
|
ImportSampleQueries |
---|
Bulk import of multiple Note: It is possible for a subset of the
|
ListSampleQueries |
---|
Gets a list of
|
UpdateSampleQuery |
---|
Updates a
|
SampleQuerySetService
Service for managing SampleQuerySet
s,
CreateSampleQuerySet |
---|
Creates a
|
DeleteSampleQuerySet |
---|
Deletes a
|
GetSampleQuerySet |
---|
Gets a
|
ListSampleQuerySets |
---|
Gets a list of
|
UpdateSampleQuerySet |
---|
Updates a
|
SchemaService
Service for managing Schema
s.
CreateSchema |
---|
Creates a
|
DeleteSchema |
---|
Deletes a
|
GetSchema |
---|
Gets a
|
ListSchemas |
---|
Gets a list of
|
UpdateSchema |
---|
Updates a
|
SearchService
Service for search.
Search |
---|
Performs a search.
|
SearchLite |
---|
Performs a search. Similar to the Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use
|
SearchTuningService
Service for search tuning.
ListCustomModels |
---|
Gets a list of all the custom models.
|
TrainCustomModel |
---|
Trains a custom model.
|
ServingConfigService
Service for operations related to ServingConfig
.
CreateServingConfig |
---|
Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100
|
DeleteServingConfig |
---|
Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
GetServingConfig |
---|
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
ListServingConfigs |
---|
Lists all ServingConfigs linked to this dataStore.
|
UpdateServingConfig |
---|
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
SiteSearchEngineService
Service for managing site search related resources.
BatchCreateTargetSites |
---|
Creates
|
BatchVerifyTargetSites |
---|
Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
|
CreateTargetSite |
---|
Creates a
|
DeleteTargetSite |
---|
Deletes a
|
DisableAdvancedSiteSearch |
---|
Downgrade from advanced site search to basic site search.
|
EnableAdvancedSiteSearch |
---|
Upgrade from basic site search to advanced site search.
|
FetchDomainVerificationStatus |
---|
Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
|
GetSiteSearchEngine |
---|
Gets the
|
GetTargetSite |
---|
Gets a
|
GetUriPatternDocumentData |
---|
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
|
ListTargetSites |
---|
Gets a list of
|
RecrawlUris |
---|
Request on-demand recrawl for a list of URIs.
|
SetUriPatternDocumentData |
---|
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
|
UpdateTargetSite |
---|
Updates a
|
UserEventService
Service for ingesting end user actions on a website to Discovery Engine API.
CollectUserEvent |
---|
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
ImportUserEvents |
---|
Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
|
PurgeUserEvents |
---|
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
|
WriteUserEvent |
---|
Writes a single user event.
|
WidgetConfigService
Service for managing WidgetConfig
configuration.
WidgetService
Service for Widget.
LookupWidgetConfig |
---|
Gets the Widget Config using the uuid. If the call came from a logged in user, and user has Subscription Tier is
|
WidgetAcquireAndStoreRefreshToken |
---|
Proxy to DataConnectorService.AcquireAndStoreRefreshToken.
|
WidgetAdvancedCompleteQuery |
---|
Performs a user input completion with keyword suggestion in advanced mode. Similar to the
|
WidgetAnswerQuery |
---|
Answer query with Widget.
|
WidgetCompleteQuery |
---|
Performs a user input completion with keyword suggestion. Similar to the
|
WidgetConverseConversation |
---|
Converse a conversation with Widget.
|
WidgetExecuteAction |
---|
Proxy to DataConnectorService.ExecuteAction.
|
WidgetHomepageFetchDocuments |
---|
Fetch documents for Homepage with Widget.
|
WidgetSearch |
---|
Performs a search. Similar to the
|
WidgetStreamAnswerQuery |
---|
Streaming answer query with Widget.
|
WidgetWriteUserEvent |
---|
Writes a single user event from the browser with Widget.
|
AclConfig
Access Control Configuration.
Fields | |
---|---|
name |
Immutable. The full resource name of the acl configuration. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
idp_ |
Identity provider config. |
AcquireAndStoreRefreshTokenRequest
Request message for DataConnectorService.AcquireAndStoreRefreshToken
method.
Fields | |
---|---|
name |
Required. Connector resource. The connector name identifies the 3rd party system to use for authorization. It is also used as a key to store the refresh token. |
auth_code |
The authorization code to be exhanged for the refresh token. Deprecated. Use full_redirect_uri instead. |
scopes[] |
The scopes of the authorization code and the refresh token. |
full_ |
Required. The URI the user is redirected to after authorization, including all parameters. E.g., https://example.com/redir?code=5 |
AcquireAndStoreRefreshTokenResponse
This type has no fields.
Response message for DataConnectorService.AcquireAndStoreRefreshToken
method.
AdditionalParams
AdditionalParams message for WidgetService methods for security and privacy enhancement.
Fields | |
---|---|
token |
Token that used for non-human user check. |
AdvancedCompleteQueryRequest
Request message for CompletionService.AdvancedCompleteQuery
method. .
Fields | |
---|---|
completion_ |
Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as |
query |
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an |
query_ |
Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values:
Default values:
|
user_ |
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 |
user_ |
Optional. Information about the end user. This should be the same identifier information as |
include_ |
Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. |
boost_ |
Optional. Specification to boost suggestions matching the condition. |
suggestion_ |
Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. |
BoostSpec
Specification to boost suggestions based on the condtion of the suggestion.
Fields | |
---|---|
condition_ |
Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. |
ConditionBoostSpec
Boost applies to suggestions which match a condition.
Fields | |
---|---|
condition |
An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example:
|
boost |
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
SuggestionType
Suggestion type to return.
Enums | |
---|---|
SUGGESTION_TYPE_UNSPECIFIED |
Default value. |
QUERY |
Returns query suggestions. |
PEOPLE |
Returns people suggestions. |
CONTENT |
Returns content suggestions. |
RECENT_SEARCH |
Returns recent search suggestions. |
GOOGLE_WORKSPACE |
Returns Google Workspace suggestions. |
AdvancedCompleteQueryResponse
Response message for CompletionService.AdvancedCompleteQuery
method.
Fields | |
---|---|
query_ |
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. |
tail_ |
True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. |
people_ |
Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. |
content_ |
Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. |
recent_ |
Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. |
ContentSuggestion
Suggestions as content.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
content_ |
The type of the content suggestion. |
document |
The document data snippet in the suggestion. Only a subset of fields will be populated. |
data_ |
The name of the dataStore that this suggestion belongs to. |
ContentType
The type of the content returned for content suggestions.
Enums | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
Default value. |
GOOGLE_WORKSPACE |
The suggestion is from a Google Workspace source. |
THIRD_PARTY |
The suggestion is from a third party source. |
PersonSuggestion
Suggestions as people.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
person_ |
The type of the person. |
document |
The document data snippet in the suggestion. Only a subset of fields is populated. |
data_ |
The name of the dataStore that this suggestion belongs to. |
PersonType
The type of the person based on the source.
Enums | |
---|---|
PERSON_TYPE_UNSPECIFIED |
Default value. |
CLOUD_IDENTITY |
The suggestion is from a GOOGLE_IDENTITY source. |
THIRD_PARTY_IDENTITY |
The suggestion is from a THIRD_PARTY_IDENTITY source. |
QuerySuggestion
Suggestions as search queries.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
completable_ |
The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. |
data_ |
The name of the dataStore that this suggestion belongs to. |
RecentSearchSuggestion
Suggestions from recent search history.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
recent_ |
The time when this recent rearch happened. |
AdvancedSiteSearchConfig
Configuration data for advance site search.
Fields | |
---|---|
disable_ |
If set true, initial indexing is disabled for the DataStore. |
disable_ |
If set true, automatic refresh is disabled for the DataStore. |
AlloyDbSource
AlloyDB source import data from.
Fields | |
---|---|
project_ |
The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
location_ |
Required. The AlloyDB location to copy the data from with a length limit of 256 characters. |
cluster_ |
Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. |
database_ |
Required. The AlloyDB database to copy the data from with a length limit of 256 characters. |
table_ |
Required. The AlloyDB table to copy the data from with a length limit of 256 characters. |
gcs_ |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |
Answer
Defines an answer.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
state |
The state of the answer generation. |
answer_ |
The textual answer. |
citations[] |
Citations. |
references[] |
References. |
related_ |
Suggested related questions. |
steps[] |
Answer generation steps. |
query_ |
Query understanding information. |
answer_ |
Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. |
create_ |
Output only. Answer creation timestamp. |
complete_ |
Output only. Answer completed timestamp. |
AnswerSkippedReason
An enum for answer skipped reasons.
Enums | |
---|---|
ANSWER_SKIPPED_REASON_UNSPECIFIED |
Default value. The answer skipped reason is not specified. |
ADVERSARIAL_QUERY_IGNORED |
The adversarial query ignored case. |
NON_ANSWER_SEEKING_QUERY_IGNORED |
The non-answer seeking query ignored case Google skips the answer if the query is chit chat. |
OUT_OF_DOMAIN_QUERY_IGNORED |
The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results. |
POTENTIAL_POLICY_VIOLATION |
The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic. |
NO_RELEVANT_CONTENT |
The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results. |
JAIL_BREAKING_QUERY_IGNORED |
The jail-breaking query ignored case. For example, "Reply in the tone of a competing company's CEO". Google skips the answer if the query is classified as a jail-breaking query. |
CUSTOMER_POLICY_VIOLATION |
The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer. |
NON_ANSWER_SEEKING_QUERY_IGNORED_V2 |
The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent. |
LOW_GROUNDED_ANSWER |
The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated. |
Citation
Citation info for a segment.
Fields | |
---|---|
start_ |
Index indicates the start of the segment, measured in bytes (UTF-8 unicode). |
end_ |
End of the attributed segment, exclusive. |
sources[] |
Citation sources for the attributed segment. |
CitationSource
Citation source.
Fields | |
---|---|
reference_ |
ID of the citation source. |
QueryUnderstandingInfo
Query understanding information.
Fields | |
---|---|
query_ |
Query classification information. |
QueryClassificationInfo
Query classification information.
Fields | |
---|---|
type |
Query classification type. |
positive |
Classification output. |
Type
Query classification types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified query classification type. |
ADVERSARIAL_QUERY |
Adversarial query classification type. |
NON_ANSWER_SEEKING_QUERY |
Non-answer-seeking query classification type, for chit chat. |
JAIL_BREAKING_QUERY |
Jail-breaking query classification type. |
NON_ANSWER_SEEKING_QUERY_V2 |
Non-answer-seeking query classification type, for no clear intent. |
Reference
Reference.
Fields | |
---|---|
Union field content . Search result content. content can be only one of the following: |
|
unstructured_ |
Unstructured document information. |
chunk_ |
Chunk information. |
structured_ |
Structured document information. |
ChunkInfo
Chunk information.
Fields | |
---|---|
chunk |
Chunk resource name. |
content |
Chunk textual content. |
document_ |
Document metadata. |
relevance_ |
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |
DocumentMetadata
Document metadata.
Fields | |
---|---|
document |
Document resource name. |
uri |
URI for the document. |
title |
Title. |
page_ |
Page identifier. |
struct_ |
The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. |
StructuredDocumentInfo
Structured search information.
Fields | |
---|---|
document |
Document resource name. |
struct_ |
Structured search data. |
UnstructuredDocumentInfo
Unstructured document information.
Fields | |
---|---|
document |
Document resource name. |
uri |
URI for the document. |
title |
Title. |
chunk_ |
List of cited chunk contents derived from document content. |
struct_ |
The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. |
ChunkContent
Chunk content.
Fields | |
---|---|
content |
Chunk textual content. |
page_ |
Page identifier. |
relevance_ |
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |
State
Enumeration of the state of the answer generation.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unknown. |
IN_PROGRESS |
Answer generation is currently in progress. |
FAILED |
Answer generation currently failed. |
SUCCEEDED |
Answer generation has succeeded. |
Step
Step information.
Fields | |
---|---|
state |
The state of the step. |
description |
The description of the step. |
thought |
The thought of the step. |
actions[] |
Actions. |
Action
Action.
Fields | |
---|---|
observation |
Observation. |
Union field action . The action. action can be only one of the following: |
|
search_ |
Search action. |
Observation
Observation.
Fields | |
---|---|
search_ |
Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. |
SearchResult
Fields | |
---|---|
document |
Document resource name. |
uri |
URI for the document. |
title |
Title. |
snippet_ |
If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. |
chunk_ |
If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. |
struct_ |
Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. |
ChunkInfo
Chunk information.
Fields | |
---|---|
chunk |
Chunk resource name. |
content |
Chunk textual content. |
relevance_ |
The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. |
SnippetInfo
Snippet information.
Fields | |
---|---|
snippet |
Snippet content. |
snippet_ |
Status of the snippet defined by the search team. |
SearchAction
Search action.
Fields | |
---|---|
query |
The query to search. |
State
Enumeration of the state of the step.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unknown. |
IN_PROGRESS |
Step is currently in progress. |
FAILED |
Step currently failed. |
SUCCEEDED |
Step has succeeded. |
AnswerQueryRequest
Request message for ConversationalSearchService.AnswerQuery
method.
Fields | |
---|---|
serving_ |
Required. The resource name of the Search serving config, such as |
query |
Required. Current user query. |
session |
The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol |
safety_ |
Model specification. |
related_ |
Related questions specification. |
grounding_ |
Optional. Grounding specification. |
answer_ |
Answer generation specification. |
search_ |
Search specification. |
query_ |
Query understanding specification. |
asynchronous_mode |
Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling |
user_ |
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an |
user_ |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
AnswerGenerationSpec
Answer generation specification.
Fields | |
---|---|
model_ |
Answer generation model specification. |
prompt_ |
Answer generation prompt specification. |
include_ |
Specifies whether to include citation metadata in the answer. The default value is |
answer_ |
Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature. |
ignore_ |
Specifies whether to filter out adversarial queries. The default value is Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to |
ignore_ |
Specifies whether to filter out queries that are not answer-seeking. The default value is Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to |
ignore_ |
Optional. Specifies whether to filter out jail-breaking queries. The default value is Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to |
ignore_ |
Specifies whether to filter out queries that have low relevance. If this field is set to |
ModelSpec
Answer Generation Model specification.
Fields | |
---|---|
model_ |
Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. |
PromptSpec
Answer generation prompt specification.
Fields | |
---|---|
preamble |
Customized preamble. |
GroundingSpec
Grounding specification.
Fields | |
---|---|
include_ |
Optional. Specifies whether to include grounding_supports in the answer. The default value is When this field is set to |
filtering_ |
Optional. Specifies whether to enable the filtering based on grounding score and at what level. |
FilteringLevel
Level to filter based on answer grounding.
Enums | |
---|---|
FILTERING_LEVEL_UNSPECIFIED |
Default is no filter |
FILTERING_LEVEL_LOW |
Filter answers based on a low threshold. |
FILTERING_LEVEL_HIGH |
Filter answers based on a high threshold. |
QueryUnderstandingSpec
Query understanding specification.
Fields | |
---|---|
query_ |
Query classification specification. |
query_ |
Query rephraser specification. |
QueryClassificationSpec
Query classification specification.
Fields | |
---|---|
types[] |
Enabled query classification types. |
Type
Query classification types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified query classification type. |
ADVERSARIAL_QUERY |
Adversarial query classification type. |
NON_ANSWER_SEEKING_QUERY |
Non-answer-seeking query classification type, for chit chat. |
JAIL_BREAKING_QUERY |
Jail-breaking query classification type. |
NON_ANSWER_SEEKING_QUERY_V2 |
Non-answer-seeking query classification type, for no clear intent. |
QueryRephraserSpec
Query rephraser specification.
Fields | |
---|---|
disable |
Disable query rephraser. |
max_ |
Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. |
RelatedQuestionsSpec
Related questions specification.
Fields | |
---|---|
enable |
Enable related questions feature if true. |
SafetySpec
Safety specification.
Fields | |
---|---|
enable |
Enable the safety filtering on the answer response. It is false by default. |
SearchSpec
Search specification.
Fields | |
---|---|
Union field input . Search parameters to control the search behavior. Or provide search result list to generate answer. input can be only one of the following: |
|
search_ |
Search parameters. |
search_ |
Search result list. |
SearchParams
Search parameters.
Fields | |
---|---|
max_ |
Number of search results to return. The default value is 10. |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter |
boost_ |
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting |
order_ |
The order in which documents are returned. Documents can be ordered by a field in an If this field is unrecognizable, an |
search_ |
Specifies the search result mode. If unspecified, the search result mode defaults to |
custom_ |
Custom fine tuning configs. |
data_ |
Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. |
natural_ |
Optional. Specification to enable natural language understanding capabilities for search requests. |
SearchResultList
Search result list.
Fields | |
---|---|
search_ |
Search results. |
SearchResult
Search result.
Fields | |
---|---|
Union field content . Search result content. content can be only one of the following: |
|
unstructured_ |
Unstructured document information. |
chunk_ |
Chunk information. |
ChunkInfo
Chunk information.
Fields | |
---|---|
chunk |
Chunk resource name. |
content |
Chunk textual content. |
document_ |
Metadata of the document from the current chunk. |
DocumentMetadata
Document metadata contains the information of the document of the current chunk.
Fields | |
---|---|
uri |
Uri of the document. |
title |
Title of the document. |
UnstructuredDocumentInfo
Unstructured document information.
Fields | |
---|---|
document |
Document resource name. |
uri |
URI for the document. |
title |
Title. |
document_ |
List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive. |
extractive_ |
List of extractive segments. |
extractive_answers[] |
Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers. |
DocumentContext
Document context.
Fields | |
---|---|
page_ |
Page identifier. |
content |
Document content to be used for answer generation. |
ExtractiveAnswer
Extractive answer. Guide
Fields | |
---|---|
page_ |
Page identifier. |
content |
Extractive answer content. |
ExtractiveSegment
Extractive segment. Guide Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.
Fields | |
---|---|
page_ |
Page identifier. |
content |
Extractive segment content. |
AnswerQueryResponse
Response message for ConversationalSearchService.AnswerQuery
method.
Fields | |
---|---|
answer |
Answer resource object. If |
session |
Session resource object. It will be only available when session field is set and valid in the |
answer_ |
A global unique ID used for logging. |
BatchCreateTargetSiteMetadata
Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
BatchCreateTargetSitesRequest
Request message for SiteSearchEngineService.BatchCreateTargetSites
method.
Fields | |
---|---|
parent |
Required. The parent resource shared by all TargetSites being created. |
requests[] |
Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. |
BatchCreateTargetSitesResponse
Response message for SiteSearchEngineService.BatchCreateTargetSites
method.
Fields | |
---|---|
target_ |
TargetSites created. |
BatchGetDocumentsMetadataRequest
Request message for DocumentService.BatchGetDocumentsMetadata
method.
Fields | |
---|---|
parent |
Required. The parent branch resource name, such as |
matcher |
Required. Matcher for the |
FhirMatcher
Matcher for the Document
s by FHIR resource names.
Fields | |
---|---|
fhir_ |
Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |
Matcher
Matcher for the Document
s. Currently supports matching by exact URIs.
Fields | |
---|---|
Union field matcher . Matcher for the Document s. matcher can be only one of the following: |
|
uris_ |
Matcher by exact URIs. |
fhir_ |
Matcher by FHIR resource names. |
UrisMatcher
Matcher for the Document
s by exact uris.
Fields | |
---|---|
uris[] |
The exact URIs to match by. |
BatchGetDocumentsMetadataResponse
Response message for DocumentService.BatchGetDocumentsMetadata
method.
Fields | |
---|---|
documents_ |
The metadata of the |
DocumentMetadata
The metadata of a Document
.
Fields | |
---|---|
matcher_ |
The value of the matcher that was used to match the |
state |
The state of the document. |
last_ |
The timestamp of the last time the |
data_ |
The data ingestion source of the Allowed values are:
|
MatcherValue
The value of the matcher that was used to match the Document
.
Fields | |
---|---|
Union field matcher_value . The value of the matcher that was used to match the Document . matcher_value can be only one of the following: |
|
uri |
If match by URI, the URI of the |
fhir_ |
Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |
State
The state of the Document
.
Enums | |
---|---|
STATE_UNSPECIFIED |
Should never be set. |
INDEXED |
The Document is indexed. |
NOT_IN_TARGET_SITE |
The Document is not indexed because its URI is not in the TargetSite . |
NOT_IN_INDEX |
The Document is not indexed. |
BatchVerifyTargetSitesMetadata
Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
BatchVerifyTargetSitesRequest
Request message for SiteSearchEngineService.BatchVerifyTargetSites
method.
Fields | |
---|---|
parent |
Required. The parent resource shared by all TargetSites being verified. |
BatchVerifyTargetSitesResponse
This type has no fields.
Response message for SiteSearchEngineService.BatchVerifyTargetSites
method.
BigQuerySource
BigQuery source import data from.
Fields | |
---|---|
project_ |
The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
dataset_ |
Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. |
table_ |
Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. |
gcs_ |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. |
data_ |
The schema to use when parsing the data from the source. Supported values for user event imports:
Supported values for document imports:
|
Union field partition . BigQuery table partition info. Leave this empty if the BigQuery table is not partitioned. partition can be only one of the following: |
|
partition_ |
BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. |
BigtableOptions
The Bigtable Options object that contains information to support the import.
Fields | |
---|---|
key_ |
The field name used for saving row key value in the document. The name has to match the pattern |
families |
The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. |
BigtableColumn
The column of the Bigtable.
Fields | |
---|---|
qualifier |
Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. |
field_ |
The field name to use for this column in the document. The name has to match the pattern |
encoding |
The encoding mode of the values when the type is not
|
type |
The type of values in this column family. The values are expected to be encoded using |
BigtableColumnFamily
The column family of the Bigtable.
Fields | |
---|---|
field_ |
The field name to use for this column family in the document. The name has to match the pattern |
encoding |
The encoding mode of the values when the type is not STRING. Acceptable encoding values are:
|
type |
The type of values in this column family. The values are expected to be encoded using |
columns[] |
The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. |
Encoding
The encoding mode of a Bigtable column or column family.
Enums | |
---|---|
ENCODING_UNSPECIFIED |
The encoding is unspecified. |
TEXT |
Text encoding. |
BINARY |
Binary encoding. |
Type
The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY
.
Enums | |
---|---|
TYPE_UNSPECIFIED |
The type is unspecified. |
STRING |
String type. |
NUMBER |
Numerical type. |
INTEGER |
Integer type. |
VAR_INTEGER |
Variable length integer type. |
BIG_NUMERIC |
BigDecimal type. |
BOOLEAN |
Boolean type. |
JSON |
JSON type. |
BigtableSource
The Cloud Bigtable source for importing data.
Fields | |
---|---|
project_ |
The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
instance_ |
Required. The instance ID of the Cloud Bigtable that needs to be imported. |
table_ |
Required. The table ID of the Cloud Bigtable that needs to be imported. |
bigtable_ |
Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. |
CheckGroundingRequest
Request message for GroundedGenerationService.CheckGrounding
method.
Fields | |
---|---|
grounding_ |
Required. The resource name of the grounding config, such as |
answer_ |
Answer candidate to check. It can have a maximum length of 4096 tokens. |
facts[] |
List of facts for the grounding check. We support up to 200 facts. |
grounding_ |
Configuration of the grounding check. |
user_ |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
CheckGroundingResponse
Response message for the GroundedGenerationService.CheckGrounding
method.
Fields | |
---|---|
cited_ |
List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. |
claims[] |
Claim texts and citation info across all claims in the answer candidate. |
support_ |
The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. |
Claim
Text and citation info for a claim in the answer candidate.
Fields | |
---|---|
claim_ |
Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. |
citation_ |
A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. |
start_ |
Position indicating the start of the claim in the answer candidate, measured in bytes. |
end_ |
Position indicating the end of the claim in the answer candidate, exclusive. |
grounding_ |
Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore |
FactChunk
Fact chunk for grounding check.
Fields | |
---|---|
chunk_ |
Text content of the fact chunk. Can be at most 10K characters long. |
source |
Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. |
CheckGroundingSpec
Specification for the grounding check.
Fields | |
---|---|
citation_ |
The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. |
CheckRequirementRequest
Request for CheckRequirement method.
Fields | |
---|---|
location |
Required. Full resource name of the location. Format |
requirement_ |
The type specifying the requirement to check. The supported types are:
|
resources[] |
The type needed for the monitored resources:
|
CheckRequirementResponse
Response for the CheckRequirement method.
Fields | |
---|---|
requirement |
Requirement definition. |
requirement_ |
Requirement result, e.g. pass or fail. |
requirement_ |
The condition for evaluating the requirement result. |
metric_ |
Metric results. |
oldest_ |
Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the |
MetricQueryResult
Metric result. The metric are in the requirement_condition.
Fields | |
---|---|
name |
This metric query name is mapping to variables in the requirement_condition. |
value |
Value of the metric query. |
timestamp |
Time corresponding to when this metric value was calculated. |
unit |
The unit in which this metric is reported. Follows The Unified Code for Units of Measure standard. |
metric_ |
Type identifier of the metric corresponding to this query result. |
RequirementResult
The result of the requirement check (pass or fail or others).
Enums | |
---|---|
UNKNOWN |
The requirement is unknown. |
SUCCESS |
The requirement check is passed. |
FAILURE |
The requirement check fails to meet at least one blocking threshold. |
WARNING |
The requirement check fails at least one warning threshold, but passes all blocking thresholds. |
Chunk
Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.
Fields | |
---|---|
name |
The full resource name of the chunk. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
id |
Unique chunk ID of the current chunk. |
content |
Content is a string from a document (parsed content). |
document_ |
Metadata of the document from the current chunk. |
derived_ |
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. |
page_ |
Page span of the chunk. |
chunk_ |
Output only. Metadata of the current chunk. |
relevance_ |
Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][]. |
ChunkMetadata
Metadata of the current chunk. This field is only populated on SearchService.Search
API.
Fields | |
---|---|
previous_ |
The previous chunks of the current chunk. The number is controlled by |
next_ |
The next chunks of the current chunk. The number is controlled by |
DocumentMetadata
Document metadata contains the information of the document of the current chunk.
Fields | |
---|---|
uri |
Uri of the document. |
title |
Title of the document. |
struct_ |
Data representation. The structured JSON data for the document. It should conform to the registered |
PageSpan
Page span of the chunk.
Fields | |
---|---|
page_ |
The start page of the chunk. |
page_ |
The end page of the chunk. |
CloudSqlSource
Cloud SQL source import data from.
Fields | |
---|---|
project_ |
The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
instance_ |
Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. |
database_ |
Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. |
table_ |
Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. |
gcs_ |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |
offload |
Option for serverless export. Enabling this option will incur additional cost. More info can be found here. |
CmekConfig
Configurations used to enable CMEK data encryption with Cloud KMS keys.
Fields | |
---|---|
name |
Required. Name of the CmekConfig, of the form |
kms_ |
Kms key resource name which will be used to encrypt resources |
kms_ |
Kms key version resource name which will be used to encrypt resources |
state |
Output only. State of the CmekConfig. |
is_ |
Output only. The default CmekConfig for the Customer. |
last_ |
Output only. The timestamp of the last key rotation. |
State
States of the CmekConfig.
Enums | |
---|---|
STATE_UNSPECIFIED |
The CmekConfig state is unknown. |
CREATING |
The CmekConfig is creating. |
ACTIVE |
The CmekConfig can be used with DataStores. |
KEY_ISSUE |
The CmekConfig is unavailable, most likely due to the KMS Key being revoked. |
DELETING |
The CmekConfig is deleting. |
UNUSABLE |
The CmekConfig is not usable, most likely due to some internal issue. |
ACTIVE_ROTATING |
The KMS key version is being rotated. |
CollectUserEventRequest
Request message for CollectUserEvent method.
Fields | |
---|---|
parent |
Required. The parent DataStore resource name, such as |
user_ |
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. |
uri |
The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. |
ets |
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. |
CompleteQueryRequest
Request message for CompletionService.CompleteQuery
method.
Fields | |
---|---|
data_ |
Required. The parent data store resource name for which the completion is performed, such as |
query |
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. |
query_ |
Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values:
Default values:
|
user_ |
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an |
include_ |
Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. |
CompleteQueryResponse
Response message for CompletionService.CompleteQuery
method.
Fields | |
---|---|
query_ |
Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. |
tail_ |
True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. |
QuerySuggestion
Suggestions as search queries.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
completable_ |
The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. |
CompletionConfig
Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them.
Fields | |
---|---|
name |
Required. Immutable. Fully qualified name |
matching_ |
The matching order for autocomplete suggestions, e.g., a query consisting of
Default value: |
max_ |
The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions. |
min_ |
The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. |
query_ |
The data model of query suggestions for serving. Currently supported values:
If query model is empty, the serving applies the "automatic" model by default. |
enable_ |
The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to |
EnableMode
Specifies the enable mode of autocomplete generation pipelines.
Enums | |
---|---|
ENABLE_MODE_UNSPECIFIED |
When AutoComplete enable mode unspecified, it defaults to AUTOMATIC mode. |
AUTOMATIC |
AutoComplete will be enabled when the data store meets criteria. |
MANUAL |
AutoComplete will be enabled regardless of UCS data requirements. |
CompletionInfo
Detailed completion information including completion attribution token and clicked completion info.
Fields | |
---|---|
selected_ |
End user selected |
selected_ |
End user selected |
CompletionSuggestion
Autocomplete suggestions that are imported from Customer.
Fields | |
---|---|
suggestion |
Required. The suggestion text. |
language_ |
BCP-47 language code of this suggestion. |
group_ |
If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. |
group_ |
The score of this suggestion within its group. |
alternative_ |
Alternative matching phrases for this suggestion. |
Union field ranking_info . Ranking metrics of this suggestion. ranking_info can be only one of the following: |
|
global_ |
Global score of this suggestion. Control how this suggestion would be scored / ranked. |
frequency |
Frequency of this suggestion. Will be used to rank suggestions when score is not available. |
Condition
Defines circumstances to be checked before allowing a behavior
Fields | |
---|---|
query_ |
Search only A list of terms to match the query on. Cannot be set when Maximum of 10 query terms. |
active_ |
Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
query_ |
Optional. Query regex to match the whole search query. Cannot be set when |
QueryTerm
Matcher for search request query
Fields | |
---|---|
value |
The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
full_ |
Whether the search query needs to exactly match the query term. |
TimeRange
Used for time-dependent conditions.
Fields | |
---|---|
start_ |
Start of time range. Range is inclusive. |
end_ |
End of time range. Range is inclusive. Must be in the future. |
Control
Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig
to be considered at serving time. Permitted actions dependent on SolutionType
.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
display_ |
Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
associated_ |
Output only. List of all |
solution_ |
Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
use_ |
Specifies the use case for the control. Affects what condition fields can be set. Only applies to |
conditions[] |
Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
Union field Required. |
|
boost_ |
Defines a boost-type control |
filter_ |
Defines a filter-type control Currently not supported by Recommendation |
redirect_ |
Defines a redirect-type control. |
synonyms_ |
Treats a group of terms as synonyms of one another. |
BoostAction
Adjusts order of products in returned list.
Fields | |
---|---|
boost |
Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
filter |
Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
data_ |
Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
FilterAction
Specified which products may be included in results. Uses same filter as boost.
Fields | |
---|---|
filter |
Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
data_ |
Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
RedirectAction
Redirects a shopper to the provided URI.
Fields | |
---|---|
redirect_ |
Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
SynonymsAction
Creates a set of terms that will act as synonyms of one another.
Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".
Fields | |
---|---|
synonyms[] |
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
Conversation
External conversation proto definition.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
state |
The state of the Conversation. |
user_ |
A unique identifier for tracking users. |
messages[] |
Conversation messages. |
start_ |
Output only. The time the conversation started. |
end_ |
Output only. The time the conversation finished. |
State
Enumeration of the state of the conversation.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unknown. |
IN_PROGRESS |
Conversation is currently open. |
COMPLETED |
Conversation has been completed. |
ConversationContext
Defines context of the conversation
Fields | |
---|---|
context_ |
The current list of documents the user is seeing. It contains the document resource references. |
active_ |
The current active document the user opened. It contains the document resource reference. |
ConversationMessage
Defines a conversation message.
Fields | |
---|---|
create_ |
Output only. Message creation timestamp. |
Union field
|
|
user_ |
User text input. |
reply |
Search reply. |
ConverseConversationRequest
Request message for ConversationalSearchService.ConverseConversation
method.
Fields | |
---|---|
name |
Required. The resource name of the Conversation to get. Format: |
query |
Required. Current user input. |
serving_ |
The resource name of the Serving Config to use. Format: |
conversation |
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. |
safe_ |
Whether to turn on safe search. |
user_ |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
summary_ |
A specification for configuring the summary returned in the response. |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter |
boost_ |
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting |
ConverseConversationResponse
Response message for ConversationalSearchService.ConverseConversation
method.
Fields | |
---|---|
reply |
Answer to the current query. |
conversation |
Updated conversation including the answer. |
related_ |
Suggested related questions. |
search_ |
Search Results. |
CrawlRateTimeSeries
The historical crawl rate timeseries data, used for monitoring.
Fields | |
---|---|
qps_ |
The QPS of the crawl rate. |
CreateControlRequest
Request for CreateControl method.
Fields | |
---|---|
parent |
Required. Full resource name of parent data store. Format: |
control |
Required. The Control to create. |
control_ |
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/. |
CreateConversationRequest
Request for CreateConversation method.
Fields | |
---|---|
parent |
Required. Full resource name of parent data store. Format: |
conversation |
Required. The conversation to create. |
CreateDataStoreMetadata
Metadata related to the progress of the DataStoreService.CreateDataStore
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
CreateDataStoreRequest
Request for DataStoreService.CreateDataStore
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
data_ |
Required. The |
data_ |
Required. The ID to use for the This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
create_ |
A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. |
skip_ |
A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if |
Union field cmek_options . CMEK options for the DataStore. Setting this field will override the default CmekConfig if one is set for the project. cmek_options can be only one of the following: |
|
cmek_ |
Resource name of the CmekConfig to use for protecting this DataStore. |
disable_ |
DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |
CreateDocumentRequest
Request message for DocumentService.CreateDocument
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
document |
Required. The |
document_ |
Required. The ID to use for the If the caller does not have permission to create the This field must be unique among all This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an |
CreateEngineMetadata
Metadata related to the progress of the EngineService.CreateEngine
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
CreateEngineRequest
Request for EngineService.CreateEngine
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
engine |
Required. The |
engine_ |
Required. The ID to use for the This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
CreateEvaluationMetadata
This type has no fields.
Metadata for EvaluationService.CreateEvaluation
method.
CreateEvaluationRequest
Request message for EvaluationService.CreateEvaluation
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
evaluation |
Required. The |
CreateSampleQueryRequest
Request message for SampleQueryService.CreateSampleQuery
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
sample_ |
Required. The |
sample_ |
Required. The ID to use for the If the caller does not have permission to create the This field must be unique among all This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an |
CreateSampleQuerySetRequest
Request message for SampleQuerySetService.CreateSampleQuerySet
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
sample_ |
Required. The |
sample_ |
Required. The ID to use for the If the caller does not have permission to create the This field must be unique among all This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an |
CreateSchemaMetadata
Metadata for Create Schema LRO.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
CreateSchemaRequest
Request message for SchemaService.CreateSchema
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name, in the format of |
schema |
Required. The |
schema_ |
Required. The ID to use for the This field should conform to RFC-1034 standard with a length limit of 63 characters. |
CreateServingConfigRequest
Request for CreateServingConfig method.
Fields | |
---|---|
parent |
Required. Full resource name of parent. Format: |
serving_ |
Required. The ServingConfig to create. |
serving_ |
Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /[a-zA-Z0-9][a-zA-Z0-9_-]+/. |
CreateSessionRequest
Request for CreateSession method.
Fields | |
---|---|
parent |
Required. Full resource name of parent data store. Format: |
session |
Required. The session to create. |
CreateTargetSiteMetadata
Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
CreateTargetSiteRequest
Request message for SiteSearchEngineService.CreateTargetSite
method.
Fields | |
---|---|
parent |
Required. Parent resource name of |
target_ |
Required. The |
CustomAttribute
A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent
.
Fields | |
---|---|
text[] |
The textual values of this custom attribute. For example, Empty string is not allowed. Otherwise, an Exactly one of |
numbers[] |
The numerical values of this custom attribute. For example, Exactly one of |
CustomFineTuningSpec
Defines custom fine tuning spec.
Fields | |
---|---|
enable_ |
Whether or not to enable and include custom fine tuned search adaptor model. |
CustomTuningModel
Metadata that describes a custom tuned model.
Fields | |
---|---|
name |
Required. The fully qualified resource name of the model. Format: Model must be an alpha-numerical string with limit of 40 characters. |
display_ |
The display name of the model. |
model_ |
The version of the model. |
model_ |
The state that the model is in (e.g. |
create_time |
Deprecated: Timestamp the Model was created at. |
training_ |
Timestamp the model training was initiated. |
metrics |
The metrics of the trained model. |
error_ |
Currently this is only populated if the model state is |
ModelState
The state of the model.
Enums | |
---|---|
MODEL_STATE_UNSPECIFIED |
Default value. |
TRAINING_PAUSED |
The model is in a paused training state. |
TRAINING |
The model is currently training. |
TRAINING_COMPLETE |
The model has successfully completed training. |
READY_FOR_SERVING |
The model is ready for serving. |
TRAINING_FAILED |
The model training failed. |
NO_IMPROVEMENT |
The model training finished successfully but metrics did not improve. |
INPUT_VALIDATION_FAILED |
Input data validation failed. Model training didn't start. |
DataStore
DataStore captures global settings and configs at the DataStore level.
Fields | |
---|---|
name |
Immutable. The full resource name of the data store. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
display_ |
Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
industry_ |
Immutable. The industry vertical that the data store registers. |
solution_ |
The solutions that the data store enrolls. Available solutions for each
|
default_ |
Output only. The id of the default |
content_ |
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to |
create_ |
Output only. Timestamp the |
advanced_ |
Optional. Configuration for advanced site search. |
language_ |
Language info for DataStore. |
natural_ |
Optional. Configuration for Natural Language Query Understanding. |
kms_ |
Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. |
cmek_ |
Output only. CMEK-related information for the DataStore. |
idp_ |
Output only. Data store level identity provider config. |
billing_ |
Output only. Data size estimation for billing. |
acl_ |
Immutable. Whether data in the When ACL is enabled for the Currently ACL is only supported in |
workspace_ |
Config to store data store type configuration for workspace data. This must be set when |
document_ |
Configuration for Document understanding and enrichment. |
starting_ |
The start schema to use for this This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a The provided schema will be validated against certain rules on schema. Learn more from this doc. |
serving_ |
Optional. Stores serving config at DataStore level. |
BillingEstimation
Estimation of data size per data store.
Fields | |
---|---|
structured_ |
Data size for structured data in terms of bytes. |
unstructured_ |
Data size for unstructured data in terms of bytes. |
website_ |
Data size for websites in terms of bytes. |
structured_ |
Last updated timestamp for structured data. |
unstructured_ |
Last updated timestamp for unstructured data. |
website_ |
Last updated timestamp for websites. |
ContentConfig
Content config of the data store.
Enums | |
---|---|
CONTENT_CONFIG_UNSPECIFIED |
Default value. |
NO_CONTENT |
Only contains documents without any Document.content . |
CONTENT_REQUIRED |
Only contains documents with Document.content . |
PUBLIC_WEBSITE |
The data store is used for public website search. |
GOOGLE_WORKSPACE |
The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig . |
ServingConfigDataStore
Stores information regarding the serving configurations at DataStore level.
Fields | |
---|---|
disabled_ |
If set true, the DataStore will not be available for serving search requests. |
DedicatedCrawlRateTimeSeries
The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.
Fields | |
---|---|
user_ |
Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users. |
auto_ |
Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically. |
DeleteControlRequest
Request for DeleteControl method.
Fields | |
---|---|
name |
Required. The resource name of the Control to delete. Format: |
DeleteConversationRequest
Request for DeleteConversation method.
Fields | |
---|---|
name |
Required. The resource name of the Conversation to delete. Format: |
DeleteDataStoreMetadata
Metadata related to the progress of the DataStoreService.DeleteDataStore
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
DeleteDataStoreRequest
Request message for DataStoreService.DeleteDataStore
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the |
DeleteDocumentRequest
Request message for DocumentService.DeleteDocument
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the |
DeleteEngineMetadata
Metadata related to the progress of the EngineService.DeleteEngine
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
DeleteEngineRequest
Request message for EngineService.DeleteEngine
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the |
DeleteSampleQueryRequest
Request message for SampleQueryService.DeleteSampleQuery
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the |
DeleteSampleQuerySetRequest
Request message for SampleQuerySetService.DeleteSampleQuerySet
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to delete the If the |
DeleteSchemaMetadata
Metadata for DeleteSchema LRO.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
DeleteSchemaRequest
Request message for SchemaService.DeleteSchema
method.
Fields | |
---|---|
name |
Required. The full resource name of the schema, in the format of |
DeleteServingConfigRequest
Request for DeleteServingConfig method.
Fields | |
---|---|
name |
Required. The resource name of the ServingConfig to delete. Format: |
DeleteSessionRequest
Request for DeleteSession method.
Fields | |
---|---|
name |
Required. The resource name of the Session to delete. Format: |
DeleteTargetSiteMetadata
Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
DeleteTargetSiteRequest
Request message for SiteSearchEngineService.DeleteTargetSite
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
DisableAdvancedSiteSearchMetadata
Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
DisableAdvancedSiteSearchRequest
Request message for SiteSearchEngineService.DisableAdvancedSiteSearch
method.
Fields | |
---|---|
site_ |
Required. Full resource name of the |
DisableAdvancedSiteSearchResponse
This type has no fields.
Response message for SiteSearchEngineService.DisableAdvancedSiteSearch
method.
Document
Document captures all raw metadata information of items to be recommended or searched.
Fields | |
---|---|
name |
Immutable. The full resource name of the document. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
id |
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters. |
schema_ |
The identifier of the schema located in the same data store. |
content |
The unstructured data linked to this document. Content must be set if this document is under a |
parent_ |
The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters. |
derived_ |
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. |
acl_ |
Access control information for the document. |
index_ |
Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. |
index_ |
Output only. The index status of the document.
|
Union field data . Data representation. One of struct_data or json_data should be provided otherwise an INVALID_ARGUMENT error is thrown. data can be only one of the following: |
|
struct_ |
The structured JSON data for the document. It should conform to the registered |
json_ |
The JSON string representation of the document. It should conform to the registered |
AclInfo
ACL Information of the Document.
Fields | |
---|---|
readers[] |
Readers of the document. |
AccessRestriction
AclRestriction to model complex inheritance restrictions.
Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document.
Document Hierarchy - Space_S --> Page_P.
Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2
Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }
Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
Fields | |
---|---|
principals[] |
List of principals. |
idp_ |
All users within the Identity Provider. |
Content
Unstructured data linked to this document.
Fields | |
---|---|
mime_ |
The MIME type of the content. Supported types:
See https://www.iana.org/assignments/media-types/media-types.xhtml. |
Union field
|
|
raw_ |
The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all |
uri |
The URI of the content. Only Cloud Storage URIs (e.g. |
IndexStatus
Index status of the document.
Fields | |
---|---|
index_ |
The time when the document was indexed. If this field is populated, it means the document has been indexed. |
error_ |
A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. |
DocumentInfo
Detailed document information associated with a user event.
Fields | |
---|---|
promotion_ |
The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. |
joined |
Output only. Whether the referenced Document can be found in the data store. |
Union field
|
|
id |
The |
name |
The |
uri |
The |
quantity |
Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a Required for events of the following event types:
|
DocumentProcessingConfig
A singleton resource of DataStore
. If it's empty when DataStore
is created and DataStore
is set to DataStore.ContentConfig.CONTENT_REQUIRED
, the default parser will default to digital parser.
Fields | |
---|---|
name |
The full resource name of the Document Processing Config. Format: |
chunking_ |
Whether chunking mode is enabled. |
default_ |
Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. |
parsing_ |
Map from file type to override the default parsing configuration based on the file type. Supported keys:
|
ChunkingConfig
Configuration for chunking config.
Fields | |
---|---|
Union field chunk_mode . Additional configs that defines the behavior of the chunking. chunk_mode can be only one of the following: |
|
layout_ |
Configuration for the layout based chunking. |
LayoutBasedChunkingConfig
Configuration for the layout based chunking.
Fields | |
---|---|
chunk_ |
The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. |
include_ |
Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. |
ParsingConfig
Related configurations applied to a specific type of document parser.
Fields | |
---|---|
Union field type_dedicated_config . Configs for document processing types. type_dedicated_config can be only one of the following: |
|
digital_ |
Configurations applied to digital parser. |
ocr_ |
Configurations applied to OCR parser. Currently it only applies to PDFs. |
layout_ |
Configurations applied to layout parser. |
DigitalParsingConfig
This type has no fields.
The digital parsing configurations for documents.
LayoutParsingConfig
This type has no fields.
The layout parsing configurations for documents.
OcrParsingConfig
The OCR parsing configurations for documents.
Fields | |
---|---|
enhanced_document_elements[] |
[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to |
use_ |
If true, will use native text instead of OCR text on pages containing native text. |
DoubleList
Double list.
Fields | |
---|---|
values[] |
Double values. |
EmbeddingConfig
Defines embedding config, used for bring your own embeddings feature.
Fields | |
---|---|
field_ |
Full field path in the schema mapped as embedding field. |
EnableAdvancedSiteSearchMetadata
Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
EnableAdvancedSiteSearchRequest
Request message for SiteSearchEngineService.EnableAdvancedSiteSearch
method.
Fields | |
---|---|
site_ |
Required. Full resource name of the |
EnableAdvancedSiteSearchResponse
This type has no fields.
Response message for SiteSearchEngineService.EnableAdvancedSiteSearch
method.
Engine
Metadata that describes the training and serving parameters of an Engine
.
Fields | |
---|---|
name |
Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: |
display_ |
Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. |
create_ |
Output only. Timestamp the Recommendation Engine was created at. |
update_ |
Output only. Timestamp the Recommendation Engine was last updated. |
data_ |
The data stores associated with this engine. For If Note that when used in |
solution_ |
Required. The solutions of the engine. |
industry_ |
The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on |
common_ |
Common config spec that specifies the metadata of the engine. |
disable_ |
Optional. Whether to disable analytics for searches performed on this engine. |
Union field engine_config . Additional config specs that defines the behavior of the engine. engine_config can be only one of the following: |
|
similar_ |
Additional config specs for a |
chat_ |
Configurations for the Chat Engine. Only applicable if |
search_ |
Configurations for the Search Engine. Only applicable if |
media_ |
Configurations for the Media Engine. Only applicable on the data stores with |
Union field engine_metadata . Engine metadata to monitor the status of the engine. engine_metadata can be only one of the following: |
|
recommendation_ |
Output only. Additional information of a recommendation engine. Only applicable if |
chat_ |
Output only. Additional information of the Chat Engine. Only applicable if |
ChatEngineConfig
Configurations for a Chat Engine.
Fields | |
---|---|
agent_ |
The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using |
dialogflow_ |
The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide Format: Note that the |
AgentCreationConfig
Configurations for generating a Dialogflow agent.
Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine
or EngineService.ListEngines
API after engine creation.
Fields | |
---|---|
business |
Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. |
default_ |
Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. |
time_ |
Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris. |
location |
Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. |
ChatEngineMetadata
Additional information of a Chat Engine. Fields in this message are output only.
Fields | |
---|---|
dialogflow_ |
The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: |
CommonConfig
Common configurations for an Engine.
Fields | |
---|---|
company_ |
The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. |
MediaRecommendationEngineConfig
Additional config specs for a Media Recommendation engine.
Fields | |
---|---|
type |
Required. The type of engine. e.g., This field together with [optimization_objective][Engine.optimization_objective] describe engine metadata to use to control engine training and serving. Currently supported values: |
optimization_ |
The optimization objective. e.g., This field together with Currently supported values: If not specified, we choose default based on engine type. Default depends on type of recommendation:
|
optimization_ |
Name and value of the custom threshold for cvr optimization_objective. For target_field |
training_ |
The training state that the engine is in (e.g. Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for |
OptimizationObjectiveConfig
Custom threshold for cvr
optimization_objective.
Fields | |
---|---|
target_ |
Required. The name of the field to target. Currently supported values: |
target_ |
Required. The threshold to be applied to the target (e.g., 0.5). |
TrainingState
The training state of the engine.
Enums | |
---|---|
TRAINING_STATE_UNSPECIFIED |
Unspecified training state. |
PAUSED |
The engine training is paused. |
TRAINING |
The engine is training. |
RecommendationMetadata
Additional information of a recommendation engine.
Fields | |
---|---|
serving_ |
Output only. The serving state of the engine: |
data_ |
Output only. The state of data requirements for this engine: Engine cannot be trained if the data is in |
last_ |
Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. |
tuning_ |
Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. |
DataState
Describes whether this engine have sufficient training data to be continuously trained.
Enums | |
---|---|
DATA_STATE_UNSPECIFIED |
Unspecified default value, should never be explicitly set. |
DATA_OK |
The engine has sufficient training data. |
DATA_ERROR |
The engine does not have sufficient training data. Error messages can be queried via Stackdriver. |
ServingState
The serving state of the recommendation engine.
Enums | |
---|---|
SERVING_STATE_UNSPECIFIED |
Unspecified serving state. |
INACTIVE |
The engine is not serving. |
ACTIVE |
The engine is serving and can be queried. |
TUNED |
The engine is trained on tuned hyperparameters and can be queried. |
SearchEngineConfig
Configurations for a Search Engine.
Fields | |
---|---|
search_ |
The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to |
search_ |
The add-on that this search engine enables. |
SimilarDocumentsEngineConfig
This type has no fields.
Additional config specs for a similar-items
engine.
EstimateDataSizeMetadata
Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
EstimateDataSizeRequest
Request message for EstimateBillingService.EstimateDataSize
method
Fields | |
---|---|
location |
Required. Full resource name of the location, such as |
Union field data_source . Data source for which we are estimating its size. data_source can be only one of the following: |
|
website_ |
Website data. |
file_ |
Structured or unstructured data. |
FileDataSource
Data source contains files either in Cloud Storage or BigQuery.
Fields | |
---|---|
Union field source . Which source contains the files to be used. source can be only one of the following: |
|
gcs_ |
Cloud Storage location for the input content. |
bigquery_ |
BigQuery input source. |
WebsiteDataSource
Data source is a set of website patterns that we crawl to get the total number of websites.
Fields | |
---|---|
estimator_ |
Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown. |
EstimatorUriPattern
URI patterns that we use to crawl.
Fields | |
---|---|
provided_ |
User provided URI pattern. For example, |
exact_ |
Whether we infer the generated URI or use the exact provided one. |
exclusive |
Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default. |
EstimateDataSizeResponse
Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
data_ |
Data size in terms of bytes. |
document_ |
Total number of documents. |
Evaluation
An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
Fields | |
---|---|
name |
Identifier. The full resource name of the This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
evaluation_ |
Required. The specification of the evaluation. |
quality_ |
Output only. The metrics produced by the evaluation, averaged across all Only populated when the evaluation's state is SUCCEEDED. |
state |
Output only. The state of the evaluation. |
error |
Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. |
create_ |
Output only. Timestamp the |
end_ |
Output only. Timestamp the |
error_ |
Output only. A sample of errors encountered while processing the request. |
EvaluationSpec
Describes the specification of the evaluation.
Fields | |
---|---|
query_ |
Required. The specification of the query set. |
Union field search_spec . The search specification. search_spec can be only one of the following: |
|
search_ |
Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: |
QuerySetSpec
Describes the specification of the query set.
Fields | |
---|---|
sample_ |
Required. The full resource name of the |
State
Describes the state of an evaluation.
Enums | |
---|---|
STATE_UNSPECIFIED |
The evaluation is unspecified. |
PENDING |
The service is preparing to run the evaluation. |
RUNNING |
The evaluation is in progress. |
SUCCEEDED |
The evaluation completed successfully. |
FAILED |
The evaluation failed. |
ExecuteActionRequest
Request for the DataConnectorService.ExecuteAction
method.
Fields | |
---|---|
name |
Required. The data connector used for executing the action. |
action_ |
Required. Name of the action. For example: "send_email" |
args |
Required. Named arguments of the action. For example: When offered to a user, this part might be editable. |
assist_ |
Optional. If specified, the result of the action execution will be associated with the given assist answer. This lets the assistant take the result into account in subsequent answers in the same session. The referenced assist answer resource must exist. |
AssistAnswerInfo
Message that identifes an action invocation in the assist answer.
Fields | |
---|---|
assist_ |
Required. Name of the assist answer. Format: |
invocation_ |
Required. The action invocation ID. |
ExecuteActionResponse
Response for the DataConnectorService.ExecuteAction
method.
Fields | |
---|---|
status |
Status of the action execution. |
text_ |
Human readable result of the action execution in case of success. |
result |
Detailed result of the action execution in case of success. |
FetchDocumentsRequest
Request message for HomepageDataService.FetchDocuments
method.
Fields | |
---|---|
homepage_ |
Required. The name of the homepage data config. Format: |
page_ |
The maximum number of documents to return. Maximum allowed value is 20. |
type |
The type of request. |
Type
Defines different types of requests.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default value. |
GOOGLE_DRIVE_RECOMMENDED_DOCUMENTS |
Type to fetch recommended documents for the user from Google Drive. |
GOOGLE_CALENDAR_RECENT_EVENTS |
Type to fetch recent events for the user from Google Calendar. |
ANNOUNCEMENTS |
Type to fetch announcements for the user. |
FetchDocumentsResponse
Response message for HomepageDataService.FetchDocuments
method.
Fields | |
---|---|
results[] |
A list of results. The order represents the ranking of results. |
Result
Defines a single result being returned from the homepage data service.
Fields | |
---|---|
document_ |
The type of document. |
document |
Contains the document data. |
DocumentType
Defines the type of document.
Enums | |
---|---|
DOCUMENT_TYPE_UNSPECIFIED |
Default value. |
GOOGLE_DRIVE |
Type for Google Drive documents. |
GOOGLE_CALENDAR |
Type for Google Calendar events. |
ANNOUNCEMENTS |
Type for Announcements. |
FetchDomainVerificationStatusRequest
Request message for SiteSearchEngineService.FetchDomainVerificationStatus
method.
Fields | |
---|---|
site_ |
Required. The site search engine resource under which we fetch all the domain verification status. |
page_ |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
page_ |
A page token, received from a previous When paginating, all other parameters provided to |
FetchDomainVerificationStatusResponse
Response message for SiteSearchEngineService.FetchDomainVerificationStatus
method.
Fields | |
---|---|
target_ |
List of TargetSites containing the site verification status. |
next_ |
A token that can be sent as |
total_ |
The total number of items matching the request. This will always be populated in the response. |
FhirStoreSource
Cloud FhirStore source import data from.
Fields | |
---|---|
fhir_ |
Required. The full resource name of the FHIR store to import data from, in the format of |
gcs_ |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. |
resource_ |
The FHIR resource types to import. The resource types should be a subset of all supported FHIR resource types. Default to all supported FHIR resource types if empty. |
FieldConfig
Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
Fields | |
---|---|
field_ |
Required. Field path of the schema field. For example: |
field_ |
Output only. Raw type of the field. |
indexable_ |
If If |
dynamic_ |
If If |
searchable_ |
If If If For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting |
retrievable_ |
If If |
completable_ |
If If |
recs_ |
If If If When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. |
key_ |
Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are If the schema field has a |
advanced_ |
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with |
schema_ |
Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at schema.org. It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from
|
metatag_ |
Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the |
AdvancedSiteSearchDataSource
Optional source of the advanced site search field.
Enums | |
---|---|
ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED |
Value used when unset. |
METATAGS |
Retrieve value from meta tag. |
PAGEMAP |
Retrieve value from page map. |
URI_PATTERN_MAPPING |
Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API. |
SCHEMA_ORG |
Retrieve value from schema.org data. |
CompletableOption
The setting of Completable options in schema.
Enums | |
---|---|
COMPLETABLE_OPTION_UNSPECIFIED |
Value used when unset. |
COMPLETABLE_ENABLED |
Completable option enabled for a schema field. |
COMPLETABLE_DISABLED |
Completable option disabled for a schema field. |
DynamicFacetableOption
The status of the dynamic facetable option of a schema field.
Enums | |
---|---|
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED |
Value used when unset. |
DYNAMIC_FACETABLE_ENABLED |
Dynamic facetable option enabled for a schema field. |
DYNAMIC_FACETABLE_DISABLED |
Dynamic facetable option disabled for a schema field. |
FieldType
Field value type in the Schema.
Enums | |
---|---|
FIELD_TYPE_UNSPECIFIED |
Field type is unspecified. |
OBJECT |
Field value type is Object. |
STRING |
Field value type is String. |
NUMBER |
Field value type is Number. |
INTEGER |
Field value type is Integer. |
BOOLEAN |
Field value type is Boolean. |
GEOLOCATION |
Field value type is Geolocation. Geolocation is expressed as an object with the following keys:
|
DATETIME |
Field value type is Datetime. Datetime can be expressed as either:
|
FilterableOption
Sets the filterable option for schema fields.
Enums | |
---|---|
FILTERABLE_OPTION_UNSPECIFIED |
Value used when unset. |
FILTERABLE_ENABLED |
Filterable option enabled for a schema field. |
FILTERABLE_DISABLED |
Filterable option disabled for a schema field. |
IndexableOption
The setting of Indexable options in schema.
Enums | |
---|---|
INDEXABLE_OPTION_UNSPECIFIED |
Value used when unset. |
INDEXABLE_ENABLED |
Indexable option enabled for a schema field. |
INDEXABLE_DISABLED |
Indexable option disabled for a schema field. |
RetrievableOption
The setting of Retrievable options in schema.
Enums | |
---|---|
RETRIEVABLE_OPTION_UNSPECIFIED |
Value used when unset. |
RETRIEVABLE_ENABLED |
Retrievable option enabled for a schema field. |
RETRIEVABLE_DISABLED |
Retrievable option disabled for a schema field. |
SearchableOption
The setting of Searchable options in schema.
Enums | |
---|---|
SEARCHABLE_OPTION_UNSPECIFIED |
Value used when unset. |
SEARCHABLE_ENABLED |
Searchable option enabled for a schema field. |
SEARCHABLE_DISABLED |
Searchable option disabled for a schema field. |
FirestoreSource
Firestore source import data from.
Fields | |
---|---|
project_ |
The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
database_ |
Required. The Firestore database to copy the data from with a length limit of 256 characters. |
collection_ |
Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. |
gcs_ |
Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. |
GcsSource
Cloud Storage location for input content.
Fields | |
---|---|
input_ |
Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, A request can contain at most 100 files (or 100,000 files if |
data_ |
The schema to use when parsing the data from the source. Supported values for document imports:
Supported values for user event imports:
|
GetAclConfigRequest
Request message for GetAclConfigRequest method.
Fields | |
---|---|
name |
Required. Resource name of If the caller does not have permission to access the |
GetAnswerRequest
Request for GetAnswer method.
Fields | |
---|---|
name |
Required. The resource name of the Answer to get. Format: |
GetChunkRequest
Request message for ChunkService.GetChunk
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetCmekConfigRequest
Request message for GetCmekConfigRequest method.
Fields | |
---|---|
name |
Required. Resource name of If the caller does not have permission to access the |
GetCompletionConfigRequest
Request for DataStoreService.GetCompletionConfig
method.
Fields | |
---|---|
name |
Required. Full CompletionConfig resource name. Format: |
GetControlRequest
Request for GetControl method.
Fields | |
---|---|
name |
Required. The resource name of the Control to get. Format: |
GetConversationRequest
Request for GetConversation method.
Fields | |
---|---|
name |
Required. The resource name of the Conversation to get. Format: |
GetDataStoreRequest
Request message for DataStoreService.GetDataStore
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetDocumentProcessingConfigRequest
Request for DataStoreService.GetDocumentProcessingConfig
method.
Fields | |
---|---|
name |
Required. Full DocumentProcessingConfig resource name. Format: |
GetDocumentRequest
Request message for DocumentService.GetDocument
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetEngineRequest
Request message for EngineService.GetEngine
method.
Fields | |
---|---|
name |
Required. Full resource name of |
GetEvaluationRequest
Request message for EvaluationService.GetEvaluation
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetProcessedDocumentRequest
Request message for DocumentService.GetDocument
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
processed_ |
Required. What type of processing to return. |
processed_ |
What format output should be. If unspecified, defaults to JSON. |
ProcessedDocumentFormat
The format of the returned processed document. If unspecified, defaults to JSON.
Enums | |
---|---|
PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED |
Default value. |
JSON |
Output format is a JSON string representation of processed document. |
ProcessedDocumentType
The type of processing to return in the response.
Enums | |
---|---|
PROCESSED_DOCUMENT_TYPE_UNSPECIFIED |
Default value. |
PARSED_DOCUMENT |
Available for all data store parsing configs. |
CHUNKED_DOCUMENT |
Only available if ChunkingConfig is enabled on the data store. |
IMAGE_CONVERTED_DOCUMENT |
Returns the converted Image bytes (as JPEG or PNG) if available. |
GetProjectRequest
Request message for ProjectService.GetProject
method.
Fields | |
---|---|
name |
Required. Full resource name of a |
GetSampleQueryRequest
Request message for SampleQueryService.GetSampleQuery
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetSampleQuerySetRequest
Request message for SampleQuerySetService.GetSampleQuerySet
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetSchemaRequest
Request message for SchemaService.GetSchema
method.
Fields | |
---|---|
name |
Required. The full resource name of the schema, in the format of |
GetServingConfigRequest
Request for GetServingConfig method.
Fields | |
---|---|
name |
Required. The resource name of the ServingConfig to get. Format: |
GetSessionRequest
Request for GetSession method.
Fields | |
---|---|
name |
Required. The resource name of the Session to get. Format: |
GetSiteSearchEngineRequest
Request message for SiteSearchEngineService.GetSiteSearchEngine
method.
Fields | |
---|---|
name |
Required. Resource name of If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. |
GetTargetSiteRequest
Request message for SiteSearchEngineService.GetTargetSite
method.
Fields | |
---|---|
name |
Required. Full resource name of If the caller does not have permission to access the If the requested |
GetUriPatternDocumentDataRequest
Request message for SiteSearchEngineService.GetUriPatternDocumentData
method.
Fields | |
---|---|
site_ |
Required. Full resource name of the |
GetUriPatternDocumentDataResponse
Response message for SiteSearchEngineService.GetUriPatternDocumentData
method.
Fields | |
---|---|
document_ |
Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } |
GroundingFact
Grounding Fact.
Fields | |
---|---|
fact_ |
Text content of the fact. Can be at most 10K characters long. |
attributes |
Attributes associated with the fact. Common attributes include |
GuidedSearchSpec
Defines guided search spec.
Fields | |
---|---|
enable_ |
Whether or not to enable and include refinement attributes in gudied search result. |
enable_ |
Whether or not to enable and include related questions in search response. |
max_ |
Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. |
IdpConfig
Identity Provider Config.
Fields | |
---|---|
idp_ |
Identity provider type configured. |
external_ |
External Identity provider config. |
ExternalIdpConfig
Third party IDP Config.
Fields | |
---|---|
workforce_ |
Workforce pool name. Example: "locations/global/workforcePools/pool_id" |
IdpType
Identity Provider Type.
Enums | |
---|---|
IDP_TYPE_UNSPECIFIED |
Default value. ACL search not enabled. |
GSUITE |
Google 1P provider. |
THIRD_PARTY |
Third party provider. |
ImportCompletionSuggestionsMetadata
Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of |
failure_ |
Count of |
ImportCompletionSuggestionsRequest
Request message for CompletionService.ImportCompletionSuggestions
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern |
error_ |
The desired location of errors incurred during the Import. |
Union field source . The source of the autocomplete suggestions. source can be only one of the following: |
|
inline_ |
The Inline source for suggestion entries. |
gcs_ |
Cloud Storage location for the input content. |
bigquery_ |
BigQuery input source. |
InlineSource
The inline source for CompletionSuggestions.
Fields | |
---|---|
suggestions[] |
Required. A list of all denylist entries to import. Max of 1000 items. |
ImportCompletionSuggestionsResponse
Response of the CompletionService.ImportCompletionSuggestions
method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the request. |
error_ |
The desired location of errors incurred during the Import. |
ImportDocumentsMetadata
Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of entries that were processed successfully. |
failure_ |
Count of entries that encountered errors while processing. |
total_ |
Total count of entries that were processed. |
ImportDocumentsRequest
Request message for Import methods.
Fields | |
---|---|
parent |
Required. The parent branch resource name, such as |
error_ |
The desired location of errors incurred during the Import. |
reconciliation_ |
The mode of reconciliation between existing documents and the documents to be imported. Defaults to |
update_ |
Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. |
auto_ |
Whether to automatically generate IDs for the documents if absent. If set to Supported data sources:
|
id_ |
The field indicates the ID field or column to be used as unique IDs of the documents. For The values of the JSON field or the table column are used as the Only set this field when If it is unset, a default value Supported data sources:
|
Union field source . Required. The source of the input. source can be only one of the following: |
|
inline_ |
The Inline source for the input content for documents. |
gcs_ |
Cloud Storage location for the input content. |
bigquery_ |
BigQuery input source. |
fhir_ |
FhirStore input source. |
spanner_ |
Spanner input source. |
cloud_ |
Cloud SQL input source. |
firestore_ |
Firestore input source. |
alloy_ |
AlloyDB input source. |
bigtable_ |
Cloud Bigtable input source. |
InlineSource
The inline source for the input config for ImportDocuments method.
Fields | |
---|---|
documents[] |
Required. A list of documents to update/create. Each document must have a valid |
ReconciliationMode
Indicates how imported documents are reconciled with the existing documents created or imported before.
Enums | |
---|---|
RECONCILIATION_MODE_UNSPECIFIED |
Defaults to INCREMENTAL . |
INCREMENTAL |
Inserts new documents or updates existing documents. |
FULL |
Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location. |
ImportDocumentsResponse
Response of the ImportDocumentsRequest
. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the request. |
error_ |
Echoes the destination for the complete errors in the request if set. |
ImportErrorConfig
Configuration of destination for Import related errors.
Fields | |
---|---|
Union field destination . Required. Errors destination. destination can be only one of the following: |
|
gcs_ |
Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded |
ImportSampleQueriesMetadata
Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
ImportSampleQueries operation create time. |
update_ |
ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of |
failure_ |
Count of |
total_ |
Total count of |
ImportSampleQueriesRequest
Request message for SampleQueryService.ImportSampleQueries
method.
Fields | |
---|---|
parent |
Required. The parent sample query set resource name, such as If the caller does not have permission to list |
error_ |
The desired location of errors incurred during the Import. |
Union field source . The source of the sample queries. source can be only one of the following: |
|
inline_ |
The Inline source for sample query entries. |
gcs_ |
Cloud Storage location for the input content. |
bigquery_ |
BigQuery input source. |
InlineSource
The inline source for SampleQuery
s.
Fields | |
---|---|
sample_ |
Required. A list of |
ImportSampleQueriesResponse
Response of the SampleQueryService.ImportSampleQueries
method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the request. |
error_ |
The desired location of errors incurred during the Import. |
ImportSuggestionDenyListEntriesMetadata
Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
ImportSuggestionDenyListEntriesRequest
Request message for CompletionService.ImportSuggestionDenyListEntries
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*. |
Union field source . The source of the updated SuggestionDenyList. source can be only one of the following: |
|
inline_ |
The Inline source for the input content for suggestion deny list entries. |
gcs_ |
Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values
|
InlineSource
The inline source for SuggestionDenyListEntry.
Fields | |
---|---|
entries[] |
Required. A list of all denylist entries to import. Max of 1000 items. |
ImportSuggestionDenyListEntriesResponse
Response message for CompletionService.ImportSuggestionDenyListEntries
method.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the request. |
imported_ |
Count of deny list entries successfully imported. |
failed_ |
Count of deny list entries that failed to be imported. |
ImportUserEventsMetadata
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of entries that were processed successfully. |
failure_ |
Count of entries that encountered errors while processing. |
ImportUserEventsRequest
Request message for the ImportUserEvents request.
Fields | |
---|---|
parent |
Required. Parent DataStore resource name, of the form |
error_ |
The desired location of errors incurred during the Import. Cannot be set for inline user event imports. |
Union field source . Required - The desired input source of the user event data. source can be only one of the following: |
|
inline_ |
The Inline source for the input content for UserEvents. |
gcs_ |
Cloud Storage location for the input content. |
bigquery_ |
BigQuery input source. |
InlineSource
The inline source for the input config for ImportUserEvents method.
Fields | |
---|---|
user_ |
Required. A list of user events to import. Recommended max of 10k items. |
ImportUserEventsResponse
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the request. |
error_ |
Echoes the destination for the complete errors if this field was set in the request. |
joined_ |
Count of user events imported with complete existing Documents. |
unjoined_ |
Count of user events imported, but with Document information not found in the existing Branch. |
IndustryVertical
The industry vertical associated with the DataStore
.
Enums | |
---|---|
INDUSTRY_VERTICAL_UNSPECIFIED |
Value used when unset. |
GENERIC |
The generic vertical for documents that are not specific to any industry vertical. |
MEDIA |
The media industry vertical. |
HEALTHCARE_FHIR |
The healthcare FHIR vertical. |
Interval
A floating point interval.
Fields | |
---|---|
Union field This field must be not larger than max. Otherwise, an |
|
minimum |
Inclusive lower bound. |
exclusive_ |
Exclusive lower bound. |
Union field This field must be not smaller than min. Otherwise, an |
|
maximum |
Inclusive upper bound. |
exclusive_ |
Exclusive upper bound. |
LanguageInfo
Language info for DataStore.
Fields | |
---|---|
language_ |
The language code for the DataStore. |
normalized_ |
Output only. This is the normalized form of language_code. E.g.: language_code of |
language |
Output only. Language part of normalized_language_code. E.g.: |
region |
Output only. Region part of normalized_language_code, if present. E.g.: |
ListChunksRequest
Request message for ChunkService.ListChunks
method.
Fields | |
---|---|
parent |
Required. The parent document resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListChunksResponse
Response message for ChunkService.ListChunks
method.
Fields | |
---|---|
chunks[] |
The |
next_ |
A token that can be sent as |
ListCmekConfigsRequest
Request message for CmekConfigService.ListCmekConfigs
method.
Fields | |
---|---|
parent |
Required. The parent location resource name, such as If the caller does not have permission to list |
ListCmekConfigsResponse
Response message for CmekConfigService.ListCmekConfigs
method.
Fields | |
---|---|
cmek_ |
All the customer's |
ListControlsRequest
Request for ListControls method.
Fields | |
---|---|
parent |
Required. The data store resource name. Format: |
page_ |
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
page_ |
Optional. A page token, received from a previous |
filter |
Optional. A filter to apply on the list results. Supported features:
|
ListControlsResponse
Response for ListControls method.
Fields | |
---|---|
controls[] |
All the Controls for a given data store. |
next_ |
Pagination token, if not returned indicates the last page. |
ListConversationsRequest
Request for ListConversations method.
Fields | |
---|---|
parent |
Required. The data store resource name. Format: |
page_ |
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
page_ |
A page token, received from a previous |
filter |
A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
order_ |
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * Example: "update_time desc" "create_time" |
ListConversationsResponse
Response for ListConversations method.
Fields | |
---|---|
conversations[] |
All the Conversations for a given data store. |
next_ |
Pagination token, if not returned indicates the last page. |
ListCustomModelsRequest
Request message for SearchTuningService.ListCustomModels
method.
Fields | |
---|---|
data_ |
Required. The resource name of the parent Data Store, such as |
ListCustomModelsResponse
Response message for SearchTuningService.ListCustomModels
method.
Fields | |
---|---|
models[] |
List of custom tuning models. |
ListDataStoresRequest
Request message for DataStoreService.ListDataStores
method.
Fields | |
---|---|
parent |
Required. The parent branch resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an INVALID_ARGUMENT is returned. |
page_ |
A page token When paginating, all other parameters provided to |
filter |
Filter by solution type . For example: |
ListDataStoresResponse
Response message for DataStoreService.ListDataStores
method.
Fields | |
---|---|
data_ |
All the customer's |
next_ |
A token that can be sent as |
ListDocumentsRequest
Request message for DocumentService.ListDocuments
method.
Fields | |
---|---|
parent |
Required. The parent branch resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListDocumentsResponse
Response message for DocumentService.ListDocuments
method.
Fields | |
---|---|
documents[] |
The |
next_ |
A token that can be sent as |
ListEnginesRequest
Request message for EngineService.ListEngines
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
page_ |
Optional. Not supported. |
page_ |
Optional. Not supported. |
filter |
Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH |
ListEnginesResponse
Response message for EngineService.ListEngines
method.
Fields | |
---|---|
engines[] |
All the customer's |
next_ |
Not supported. |
ListEvaluationResultsRequest
Request message for EvaluationService.ListEvaluationResults
method.
Fields | |
---|---|
evaluation |
Required. The evaluation resource name, such as If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a |
page_ |
Maximum number of [EvaluationResult][] to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListEvaluationResultsResponse
Response message for EvaluationService.ListEvaluationResults
method.
Fields | |
---|---|
evaluation_ |
The |
next_ |
A token that can be sent as |
EvaluationResult
Represents the results of an evaluation for a single SampleQuery
.
Fields | |
---|---|
sample_ |
Output only. The |
quality_ |
Output only. The metrics produced by the evaluation, for a given |
ListEvaluationsRequest
Request message for EvaluationService.ListEvaluations
method.
Fields | |
---|---|
parent |
Required. The parent location resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListEvaluationsResponse
Response message for EvaluationService.ListEvaluations
method.
Fields | |
---|---|
evaluations[] |
The |
next_ |
A token that can be sent as |
ListSampleQueriesRequest
Request message for SampleQueryService.ListSampleQueries
method.
Fields | |
---|---|
parent |
Required. The parent sample query set resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListSampleQueriesResponse
Response message for SampleQueryService.ListSampleQueries
method.
Fields | |
---|---|
sample_ |
The |
next_ |
A token that can be sent as |
ListSampleQuerySetsRequest
Request message for SampleQuerySetService.ListSampleQuerySets
method.
Fields | |
---|---|
parent |
Required. The parent location resource name, such as If the caller does not have permission to list |
page_ |
Maximum number of If this field is negative, an |
page_ |
A page token When paginating, all other parameters provided to |
ListSampleQuerySetsResponse
Response message for SampleQuerySetService.ListSampleQuerySets
method.
Fields | |
---|---|
sample_ |
The |
next_ |
A token that can be sent as |
ListSchemasRequest
Request message for SchemaService.ListSchemas
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name, in the format of |
page_ |
The maximum number of If unspecified, at most 100 The maximum value is 1000; values above 1000 are set to 1000. |
page_ |
A page token, received from a previous When paginating, all other parameters provided to |
ListSchemasResponse
Response message for SchemaService.ListSchemas
method.
Fields | |
---|---|
schemas[] |
The |
next_ |
A token that can be sent as |
ListServingConfigsRequest
Request for ListServingConfigs method.
Fields | |
---|---|
parent |
Required. Full resource name of the parent resource. Format: |
page_ |
Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
page_ |
Optional. A page token, received from a previous |
ListServingConfigsResponse
Response for ListServingConfigs method.
Fields | |
---|---|
serving_ |
All the ServingConfigs for a given dataStore. |
next_ |
Pagination token, if not returned indicates the last page. |
ListSessionsRequest
Request for ListSessions method.
Fields | |
---|---|
parent |
Required. The data store resource name. Format: |
page_ |
Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
page_ |
A page token, received from a previous |
filter |
A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
order_ |
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * Example: "update_time desc" "create_time" |
ListSessionsResponse
Response for ListSessions method.
Fields | |
---|---|
sessions[] |
All the Sessions for a given data store. |
next_ |
Pagination token, if not returned indicates the last page. |
ListTargetSitesRequest
Request message for SiteSearchEngineService.ListTargetSites
method.
Fields | |
---|---|
parent |
Required. The parent site search engine resource name, such as If the caller does not have permission to list |
page_ |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
page_ |
A page token, received from a previous When paginating, all other parameters provided to |
ListTargetSitesResponse
Response message for SiteSearchEngineService.ListTargetSites
method.
Fields | |
---|---|
target_ |
List of TargetSites. |
next_ |
A token that can be sent as |
total_ |
The total number of items matching the request. This will always be populated in the response. |
LookupWidgetConfigRequest
Request message for WidgetService.LookupWidgetConfig
method.
Fields | |
---|---|
location |
Required. The location resource where lookup widget will be performed. Format: |
widget_ |
Required. The UUID of the Widget Config. |
LookupWidgetConfigResponse
Response message for WidgetService.LookupWidgetConfig
method.
Fields | |
---|---|
anonymous_ |
The Anonymous Widget Config associated with the UUID. |
MediaInfo
Media-specific user event information.
Fields | |
---|---|
media_ |
The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then |
media_ |
Media progress should be computed using only the This value must be between If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. |
NaturalLanguageQueryUnderstandingConfig
Configuration for Natural Language Query Understanding.
Fields | |
---|---|
mode |
Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to |
Mode
Mode of Natural Language Query Understanding. When the NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural language understanding capabilities will be enabled for a search request if the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the SearchRequest is ENABLED.
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value. |
DISABLED |
Natural Language Query Understanding is disabled. |
ENABLED |
Natural Language Query Understanding is enabled. |
ObtainCrawlRateResponse
Response message for CrawlRateManagementService.ObtainCrawlRate
method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.
Fields | |
---|---|
state |
Output only. The state of the response. |
error |
Errors from service when handling the request. |
Union field crawl_rate_time_series . Once the user sets the dedicated crawl rate, it will return the dedicated crawl rate time series, otherwise it will return the organic crawl rate time series. crawl_rate_time_series can be only one of the following: |
|
organic_ |
The historical organic crawl rate timeseries data, used for monitoring. |
dedicated_ |
The historical dedicated crawl rate timeseries data, used for monitoring. |
State
Different states of the response.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified. |
SUCCEEDED |
The state is successful. |
FAILED |
The state is failed. |
OrganicCrawlRateTimeSeries
The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.
Fields | |
---|---|
google_ |
Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots. |
vertex_ |
Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. |
PageInfo
Detailed page information.
Fields | |
---|---|
pageview_ |
A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. |
page_ |
The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: Required for |
uri |
Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters. |
referrer_ |
The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty. |
PanelInfo
Detailed panel information associated with a user event.
Fields | |
---|---|
panel_ |
Required. The panel ID. |
display_ |
The display name of the panel. |
panel_ |
The ordered position of the panel, if shown to the user with other panels. If set, then |
total_ |
The total number of panels, including this one, shown to the user. Must be set if |
PauseEngineRequest
Request for pausing training of an engine.
Fields | |
---|---|
name |
Required. The name of the engine to pause. Format: |
Principal
Principal identifier of a user or a group.
Fields | |
---|---|
Union field principal . Union field principal. Principal can be a user or a group. principal can be only one of the following: |
|
user_ |
User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. |
group_ |
Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. |
ProcessedDocument
Document captures all raw metadata information of items to be recommended or searched.
Fields | |
---|---|
document |
Required. Full resource name of the referenced document, in the format |
Union field processed_data_format . Output format of the processed document. processed_data_format can be only one of the following: |
|
json_ |
The JSON string representation of the processed document. |
Project
Metadata and configurations for a Google Cloud project in the service.
Fields | |
---|---|
name |
Output only. Full resource name of the project, for example |
create_ |
Output only. The timestamp when this project is created. |
provision_ |
Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. |
service_ |
Output only. A map of terms of services. The key is the |
ServiceTerms
Metadata about the terms of service.
Fields | |
---|---|
id |
The unique identifier of this terms of service. Available terms:
|
version |
The version string of the terms of service. For acceptable values, see the comments for |
state |
Whether the project has accepted/rejected the service terms or it is still pending. |
accept_ |
The last time when the project agreed to the terms of service. |
decline_ |
The last time when the project declined or revoked the agreement to terms of service. |
State
The agreement states this terms of service.
Enums | |
---|---|
STATE_UNSPECIFIED |
The default value of the enum. This value is not actually used. |
TERMS_ACCEPTED |
The project has given consent to the terms of service. |
TERMS_PENDING |
The project is pending to review and accept the terms of service. |
TERMS_DECLINED |
The project has declined or revoked the agreement to terms of service. |
ProvisionProjectMetadata
This type has no fields.
Metadata associated with a project provision operation.
ProvisionProjectRequest
Request for ProjectService.ProvisionProject
method.
Fields | |
---|---|
name |
Required. Full resource name of a |
accept_ |
Required. Set to |
data_ |
Required. The version of the Terms for data use that caller has read and would like to give consent to. Acceptable version is |
PurgeCompletionSuggestionsMetadata
Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
PurgeCompletionSuggestionsRequest
Request message for CompletionService.PurgeCompletionSuggestions
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/*/locations/*/collections/*/dataStores/*. |
PurgeCompletionSuggestionsResponse
Response message for CompletionService.PurgeCompletionSuggestions
method.
Fields | |
---|---|
purge_ |
Whether the completion suggestions were successfully purged. |
error_ |
A sample of errors encountered while processing the request. |
PurgeDocumentsMetadata
Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of entries that were deleted successfully. |
failure_ |
Count of entries that encountered errors while processing. |
ignored_ |
Count of entries that were ignored as entries were not found. |
PurgeDocumentsRequest
Request message for DocumentService.PurgeDocuments
method.
Fields | |
---|---|
parent |
Required. The parent resource name, such as |
filter |
Required. Filter matching documents to purge. Only currently supported value is |
error_ |
The desired location of errors incurred during the purge. |
force |
Actually performs the purge. If |
Union field source . The desired input source for the purging documents based on document IDs. source can be only one of the following: |
|
gcs_ |
Cloud Storage location for the input content. Supported |
inline_ |
Inline source for the input content for purge. |
InlineSource
The inline source for the input config for DocumentService.PurgeDocuments
method.
Fields | |
---|---|
documents[] |
Required. A list of full resource name of documents to purge. In the format |
PurgeDocumentsResponse
Response message for DocumentService.PurgeDocuments
method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Fields | |
---|---|
purge_ |
The total count of documents purged as a result of the operation. |
purge_ |
A sample of document names that will be deleted. Only populated if |
PurgeErrorConfig
Configuration of destination for Purge related errors.
Fields | |
---|---|
Union field destination . Required. Errors destination. destination can be only one of the following: |
|
gcs_ |
Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded |
PurgeSuggestionDenyListEntriesMetadata
Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
PurgeSuggestionDenyListEntriesRequest
Request message for CompletionService.PurgeSuggestionDenyListEntries
method.
Fields | |
---|---|
parent |
Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*. |
PurgeSuggestionDenyListEntriesResponse
Response message for CompletionService.PurgeSuggestionDenyListEntries
method.
Fields | |
---|---|
purge_ |
Number of suggestion deny list entries purged. |
error_ |
A sample of errors encountered while processing the request. |
PurgeUserEventsMetadata
Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
success_ |
Count of entries that were deleted successfully. |
failure_ |
Count of entries that encountered errors while processing. |
PurgeUserEventsRequest
Request message for PurgeUserEvents method.
Fields | |
---|---|
parent |
Required. The resource name of the catalog under which the events are created. The format is |
filter |
Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are:
Examples:
The filtering fields are assumed to have an implicit AND. |
force |
The |
PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Fields | |
---|---|
purge_ |
The total count of events purged as a result of the operation. |
QualityMetrics
Describes the metrics produced by the evaluation.
Fields | |
---|---|
doc_ |
Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single |
doc_ |
Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single |
doc_ |
Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each |
page_ |
Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single |
page_ |
Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for |
TopkMetrics
Stores the metric values at specific top-k levels.
Fields | |
---|---|
top_ |
The top-1 value. |
top_ |
The top-3 value. |
top_ |
The top-5 value. |
top_ |
The top-10 value. |
Query
Defines a user inputed query.
Fields | |
---|---|
query_ |
Unique Id for the query. |
Union field content . Query content. content can be only one of the following: |
|
text |
Plain text. |
RankRequest
Request message for RankService.Rank
method.
Fields | |
---|---|
ranking_ |
Required. The resource name of the rank service config, such as |
model |
The identifier of the model to use. It is one of:
It is set to |
top_ |
The number of results to return. If this is unset or no bigger than zero, returns all results. |
query |
The query to use. |
records[] |
Required. A list of records to rank. At most 200 records to rank. |
ignore_ |
If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. |
user_ |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
RankResponse
Response message for RankService.Rank
method.
Fields | |
---|---|
records[] |
A list of records sorted by descending score. |
RankingRecord
Record message for RankService.Rank
method.
Fields | |
---|---|
id |
The unique ID to represent the record. |
title |
The title of the record. Empty by default. At least one of |
content |
The content of the record. Empty by default. At least one of |
score |
The score of this record based on the given query and selected model. |
RecommendRequest
Request message for Recommend method.
Fields | |
---|---|
serving_ |
Required. Full resource name of a One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine |
user_ |
Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set |
page_ |
Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. |
filter |
Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the Examples:
If
If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set Note that the API never returns |
validate_ |
Use validate only mode for this recommendation query. If set to |
params |
Additional domain specific parameters for the recommendations. Allowed values:
|
user_ |
The user labels applied to a resource must meet the following requirements:
See Requirements for labels for more details. |
RecommendResponse
Response message for Recommend method.
Fields | |
---|---|
results[] |
A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). |
attribution_ |
A unique attribution token. This should be included in the |
missing_ |
IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. |
validate_ |
True if |
RecommendationResult
RecommendationResult represents a generic recommendation result with associated metadata.
Fields | |
---|---|
id |
Resource ID of the recommended Document. |
document |
Set if |
metadata |
Additional Document metadata or annotations. Possible values:
|
RecrawlUrisMetadata
Metadata related to the progress of the SiteSearchEngineService.RecrawlUris
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
invalid_ |
Unique URIs in the request that have invalid format. Sample limited to 1000. |
invalid_ |
Total number of unique URIs in the request that have invalid format. |
uris_ |
Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. Sample limited to 1000. |
uris_ |
Total number of URIs that don't match any TargetSites. |
valid_ |
Total number of unique URIs in the request that are not in invalid_uris. |
success_ |
Total number of URIs that have been crawled so far. |
pending_ |
Total number of URIs that have yet to be crawled. |
quota_ |
Total number of URIs that were rejected due to insufficient indexing resources. |
RecrawlUrisRequest
Request message for SiteSearchEngineService.RecrawlUris
method.
Fields | |
---|---|
site_ |
Required. Full resource name of the |
uris[] |
Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one |
site_ |
Optional. Full resource name of the |
RecrawlUrisResponse
Response message for SiteSearchEngineService.RecrawlUris
method.
Fields | |
---|---|
failure_ |
Details for a sample of up to 10 |
failed_ |
URIs that were not crawled before the LRO terminated. |
FailureInfo
Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.
Fields | |
---|---|
uri |
URI that failed to be crawled. |
failure_ |
List of failure reasons by corpus type (e.g. desktop, mobile). |
FailureReason
Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.
Fields | |
---|---|
corpus_ |
DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. |
error_ |
Reason why the URI was not crawled. |
CorpusType
CorpusType for the failed crawling operation.
Enums | |
---|---|
CORPUS_TYPE_UNSPECIFIED |
Default value. |
DESKTOP |
Denotes a crawling attempt for the desktop version of a page. |
MOBILE |
Denotes a crawling attempt for the mobile version of a page. |
Reply
Defines a reply message to user.
Fields | |
---|---|
reply |
DEPRECATED: use |
references[] |
References in the reply. |
summary |
Summary based on search results. |
Reference
Defines reference in reply.
Fields | |
---|---|
uri |
URI link reference. |
anchor_ |
Anchor text. |
start |
Anchor text start index. |
end |
Anchor text end index. |
ReportConsentChangeRequest
Request for ReportConsentChange method.
Fields | |
---|---|
consent_ |
Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported. |
project |
Required. Full resource name of a |
service_ |
Required. The unique identifier of the terms of service to update. Available term ids:
|
service_ |
Required. The version string of the terms of service to update. |
ConsentChangeAction
Type of consent acknowledgement (accept / reject).
At this moment, only ACCEPT
action is supported.
Enums | |
---|---|
CONSENT_CHANGE_ACTION_UNSPECIFIED |
Invalid action, user must specify accept/decline |
ACCEPT |
User accepts service terms. |
Requirement
A data requirement.
Fields | |
---|---|
type |
The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples:
|
display_ |
The name of the requirement. |
description |
The description of the requirement. |
condition |
The condition for evaluating the requirement result. Variables in the expression should be provided by |
metric_ |
A list of the metric bindings to be used in |
threshold_ |
A list of threshold bindings to be used in |
violation_ |
A list of the metric bindings to be used in |
MetricBinding
Specifies a metrics query and bind its result to a variable which will be used in the condition
.
Fields | |
---|---|
variable_ |
The variable id to be referenced in |
resource_ |
The resource being monitored for the metric. |
metric_ |
The filter string used for metrics query. Example: "metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS"" |
description |
Human readable description of the corresponding metric filter. |
category |
The category of the metric's target resource. Example: "Events" |
ThresholdBinding
Specifies a multi-level threshold to apply to apply to a metric_bindings
in the condition
CEL expression.
Fields | |
---|---|
variable_ |
The variable id to be referenced in |
warning_ |
Threshold to trigger a warning. If not met, the requirement will evaluate as a |
blocking_ |
Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a |
description |
Human readable description of the corresponding threshold and sub-requirement. |
ViolationSamplesBinding
Specifies a samples query and bind its result to a variable which will be used in the condition
.
Fields | |
---|---|
variable_ |
The variable id to be referenced in |
sample_ |
The filter string used for samples query. Example: "sample.type = "retail.googleapis.com/user_event" AND " "sample.labels.event_type = "PURCHASE" " |
description |
Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long. |
ResumeEngineRequest
Request for resuming training of an engine.
Fields | |
---|---|
name |
Required. The name of the engine to resume. Format: |
SampleQuery
Sample Query captures metadata to be used for evaluation.
Fields | |
---|---|
name |
Identifier. The full resource name of the sample query, in the format of This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
create_ |
Output only. Timestamp the |
Union field content . The content of the sample query. content can be only one of the following: |
|
query_ |
The query entry. |
QueryEntry
Query Entry captures metadata to be used for search evaluation.
Fields | |
---|---|
query |
Required. The query. |
targets[] |
List of targets for the query. |
Target
Defines the parameters of the query's expected outcome.
Fields | |
---|---|
uri |
Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: |
page_ |
Expected page numbers of the target. Each page number must be non negative. |
score |
Relevance score of the target. |
SampleQuerySet
A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
Fields | |
---|---|
name |
Identifier. The full resource name of the This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
display_ |
Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. |
create_ |
Output only. Timestamp the |
description |
The description of the |
Schema
Defines the structure and layout of a type of document data.
Fields | |
---|---|
name |
Immutable. The full resource name of the schema, in the format of This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
field_ |
Output only. Configurations for fields of the schema. |
Union field schema . Schema representation. One of struct_schema or json_schema should be provided otherwise an INVALID_ARGUMENT error is thrown. schema can be only one of the following: |
|
struct_ |
The structured representation of the schema. |
json_ |
The JSON representation of the schema. |
SearchAddOn
Add-on that provides additional functionality for search.
Enums | |
---|---|
SEARCH_ADD_ON_UNSPECIFIED |
Default value when the enum is unspecified. This is invalid to use. |
SEARCH_ADD_ON_LLM |
Large language model add-on. |
SearchInfo
Detailed search information.
Fields | |
---|---|
search_ |
The user's search query. See The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an At least one of |
order_ |
The order in which products are returned, if applicable. See The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an This can only be set for |
offset |
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See If this field is negative, an This can only be set for |
SearchRequest
Request message for SearchService.Search
method.
Fields | |
---|---|
serving_ |
Required. The resource name of the Search serving config, such as |
branch |
The branch resource name, such as Use |
query |
Raw search query. |
image_ |
Raw image query. |
page_ |
Maximum number of
If this field is negative, an |
page_ |
A page token received from a previous When paginating, all other parameters provided to |
offset |
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the If this field is negative, an |
one_ |
The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. |
data_ |
Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter |
canonical_ |
The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see |
order_ |
The order in which documents are returned. Documents can be ordered by a field in an For more information on ordering the website search results, see Order web search results. For more information on ordering the healthcare search results, see Order healthcare search results. If this field is unrecognizable, an |
user_ |
Information about the end user. Highly recommended for analytics. |
language_ |
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Standard fields. This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. |
region_ |
The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see Standard fields. If set, then results will be boosted based on the region_code provided. |
facet_ |
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an |
boost_ |
Boost specification to boost certain documents. For more information on boosting, see Boosting |
params |
Additional search parameters. For public website search only, supported values are:
For available codes see Country Codes
|
query_ |
The query expansion specification that specifies the conditions under which query expansion occurs. |
spell_ |
The spell correction specification that specifies the mode under which spell correction takes effect. |
user_ |
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an |
content_ |
A specification for configuring the behavior of content search. |
embedding_ |
Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of If |
ranking_ |
The ranking expression controls the customized ranking on retrieval documents. This overrides
Supported functions:
Function variables:
Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be |
safe_ |
Whether to turn on safe search. This is only supported for website search. |
user_ |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
natural_ |
If |
search_ |
Search as you type configuration. Only supported for the |
custom_ |
Custom fine tuning configs. If set, it has higher priority than the configs set in |
session |
The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. |
session_ |
Session specification. Can be used only when |
relevance_ |
The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. |
personalization_ |
The specification for personalization. Notice that if both |
BoostSpec
Boost specification to boost certain documents.
Fields | |
---|---|
condition_ |
Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. |
ConditionBoostSpec
Boost applies to documents which match a condition.
Fields | |
---|---|
condition |
An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See Examples:
|
boost |
Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. |
boost_ |
Complex specification for custom ranking based on customer defined attribute value. |
BoostControlSpec
Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.
Fields | |
---|---|
field_ |
The name of the field whose value will be used to determine the boost amount. |
attribute_ |
The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
interpolation_ |
The interpolation type to be applied to connect the control points listed below. |
control_ |
The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |
AttributeType
The attribute(or function) for which the custom ranking is to be applied.
Enums | |
---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
Unspecified AttributeType. |
NUMERICAL |
The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
FRESHNESS |
For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD dayTimeDuration value (a restricted subset of an ISO 8601 duration value). The pattern for this is: [nD][T[nH][nM][nS]] . For example, 5D , 3DT12H30M , T24H . |
ControlPoint
The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
Fields | |
---|---|
attribute_ |
Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD |
boost_ |
The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |
InterpolationType
The interpolation type to be applied. Default will be linear (Piecewise Linear).
Enums | |
---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
Interpolation type is unspecified. In this case, it defaults to Linear. |
LINEAR |
Piecewise linear interpolation will be applied. |
ContentSearchSpec
A specification for configuring the behavior of content search.
Fields | |
---|---|
snippet_ |
If |
summary_ |
If |
extractive_ |
If there is no extractive_content_spec provided, there will be no extractive answer in the search response. |
search_ |
Specifies the search result mode. If unspecified, the search result mode defaults to |
chunk_ |
Specifies the chunk spec to be returned from the search response. Only available if the |
ChunkSpec
Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode
is set to CHUNKS
Fields | |
---|---|
num_ |
The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. |
num_ |
The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
ExtractiveContentSpec
A specification for configuring the extractive content in a search response.
Fields | |
---|---|
max_ |
The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the At most five answers are returned for each |
max_ |
The max number of extractive segments returned in each search result. Only applied if the An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than |
return_ |
Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is |
num_ |
Specifies whether to also include the adjacent from each selected segments. Return at most |
num_ |
Return at most |
SearchResultMode
Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS
.
Enums | |
---|---|
SEARCH_RESULT_MODE_UNSPECIFIED |
Default value. |
DOCUMENTS |
Returns documents in the search result. |
CHUNKS |
Returns chunks in the search result. Only available if the [DataStore.DocumentProcessingConfig.chunking_config][] is specified. |
SnippetSpec
A specification for configuring snippets in a search response.
Fields | |
---|---|
max_snippet_count |
[DEPRECATED] This field is deprecated. To control snippet return, use |
reference_only |
[DEPRECATED] This field is deprecated and will have no affect on the snippet. |
return_ |
If |
SummarySpec
A specification for configuring a summary returned in a search response.
Fields | |
---|---|
summary_ |
The number of top results to generate the summary from. If the number of results returned is less than At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when |
include_ |
Specifies whether to include citations in the summary. The default value is When this field is set to Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. |
ignore_ |
Specifies whether to filter out adversarial queries. The default value is Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to |
ignore_ |
Specifies whether to filter out queries that are not summary-seeking. The default value is Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, |
ignore_ |
Specifies whether to filter out queries that have low relevance. The default value is If this field is set to |
ignore_ |
Optional. Specifies whether to filter out jail-breaking queries. The default value is Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to |
model_ |
If specified, the spec will be used to modify the prompt provided to the LLM. |
language_ |
Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature. |
model_ |
If specified, the spec will be used to modify the model specification provided to the LLM. |
use_ |
If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. |
ModelPromptSpec
Specification of the prompt to use with the model.
Fields | |
---|---|
preamble |
Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. |
ModelSpec
Specification of the model.
Fields | |
---|---|
version |
The model version used to generate the summary. Supported values are:
|
DataStoreSpec
A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an INVALID_ARGUMENT
error is returned.
Fields | |
---|---|
data_ |
Required. Full resource name of |
filter |
Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering |
EmbeddingSpec
The specification that uses customized query embedding vector to do semantic document retrieval.
Fields | |
---|---|
embedding_ |
The embedding vector used for retrieval. Limit to 1. |
EmbeddingVector
Embedding vector.
Fields | |
---|---|
field_ |
Embedding field path in schema. |
vector[] |
Query embedding vector. |
FacetSpec
A facet specification to perform faceted search.
Fields | |
---|---|
facet_ |
Required. The facet key specification. |
limit |
Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an |
excluded_ |
List of keys to exclude when faceting. By default, Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an |
enable_ |
Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request:
And also you have a dynamic facets enabled, which generates a facet |
FacetKey
Specifies how a facet is computed.
Fields | |
---|---|
key |
Required. Supported textual and numerical facet keys in |
intervals[] |
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. |
restricted_ |
Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. |
prefixes[] |
Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10. |
contains[] |
Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. |
case_ |
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. |
order_ |
The order in which documents are returned. Allowed values are:
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by |
ImageQuery
Specifies the image query input.
Fields | |
---|---|
Union field
|
|
image_ |
Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. |
NaturalLanguageQueryUnderstandingSpec
Specification to enable natural language understanding capabilities for search requests.
Fields | |
---|---|
filter_ |
The condition under which filter extraction should occur. Default to [Condition.DISABLED][]. |
geo_ |
Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to If this field is set, it overrides the field names set in |
FilterExtractionCondition
Enum describing under which condition filter extraction should occur.
Enums | |
---|---|
CONDITION_UNSPECIFIED |
Server behavior defaults to [Condition.DISABLED][]. |
DISABLED |
Disables NL filter extraction. |
ENABLED |
Enables NL filter extraction. |
PersonalizationSpec
The specification for personalization.
Fields | |
---|---|
mode |
The personalization mode of the search request. Defaults to |
Mode
The personalization mode of each search request.
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value. In this case, server behavior defaults to Mode.AUTO . |
AUTO |
Personalization is enabled if data quality requirements are met. |
DISABLED |
Disable personalization. |
QueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
Fields | |
---|---|
condition |
The condition under which query expansion should occur. Default to |
pin_ |
Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. |
Condition
Enum describing under which condition query expansion should occur.
Enums | |
---|---|
CONDITION_UNSPECIFIED |
Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED . |
DISABLED |
Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero. |
AUTO |
Automatic query expansion built by the Search API. |
RelevanceThreshold
The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.
Enums | |
---|---|
RELEVANCE_THRESHOLD_UNSPECIFIED |
Default value. In this case, server behavior defaults to Google defined threshold. |
LOWEST |
Lowest relevance threshold. |
LOW |
Low relevance threshold. |
MEDIUM |
Medium relevance threshold. |
HIGH |
High relevance threshold. |
SearchAsYouTypeSpec
Specification for search as you type in search requests.
Fields | |
---|---|
condition |
The condition under which search as you type should occur. Default to |
Condition
Enum describing under which condition search as you type should occur.
Enums | |
---|---|
CONDITION_UNSPECIFIED |
Server behavior defaults to Condition.DISABLED . |
DISABLED |
Disables Search As You Type. |
ENABLED |
Enables Search As You Type. |
SessionSpec
Session specification.
Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
Fields | |
---|---|
query_ |
If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. |
search_ |
The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the At most 10 results for documents mode, or 50 for chunks mode. |
SpellCorrectionSpec
The specification for query spell correction.
Fields | |
---|---|
mode |
The mode under which spell correction replaces the original search query. Defaults to |
Mode
Enum describing under which mode spell correction should occur.
Enums | |
---|---|
MODE_UNSPECIFIED |
Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO . |
SUGGESTION_ONLY |
Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query . The spelling suggestion won't be used as the search query. |
AUTO |
Automatic spell correction built by the Search API. Search will be based on the corrected query if found. |
SearchResponse
Response message for SearchService.Search
method.
Fields | |
---|---|
results[] |
A list of matched documents. The order represents the ranking. |
facets[] |
Results of facets requested by user. |
guided_ |
Guided search result. |
total_ |
The estimated total count of matched items irrespective of pagination. The count of |
attribution_ |
A unique search token. This should be included in the |
redirect_ |
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only |
next_ |
A token that can be sent as |
corrected_ |
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. |
summary |
A summary as part of the search results. This field is only returned if |
applied_ |
Controls applied as part of the Control service. |
geo_ |
|
query_ |
Query expansion information for the returned results. |
natural_ |
Natural language query understanding information for the returned results. |
session_ |
Session information. Only set if |
one_ |
A list of One Box results. There can be multiple One Box results of different types. |
Facet
A facet result.
Fields | |
---|---|
key |
The key for this facet. For example, |
values[] |
The facet values for this field. |
dynamic_ |
Whether the facet is dynamically generated. |
FacetValue
A facet value which contains value names and their count.
Fields | |
---|---|
count |
Number of items that have this facet value. |
Union field facet_value . A facet value which contains values. facet_value can be only one of the following: |
|
value |
Text value of a facet, such as "Black" for facet "colors". |
interval |
Interval value for a facet, such as [10, 20) for facet "price". It matches |
GeoSearchDebugInfo
Debug information specifically related to forward geocoding issues arising from Geolocation Search.
Fields | |
---|---|
original_ |
The address from which forward geocoding ingestion produced issues. |
error_ |
The error produced. |
GuidedSearchResult
Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.
Fields | |
---|---|
refinement_ |
A list of ranked refinement attributes. |
follow_ |
Suggested follow-up questions. |
RefinementAttribute
Useful attribute for search result refinements.
Fields | |
---|---|
attribute_ |
Attribute key used to refine the results. For example, |
attribute_ |
Attribute value used to refine the results. For example, |
NaturalLanguageQueryUnderstandingInfo
Information describing what natural language understanding was done on the input query.
Fields | |
---|---|
extracted_ |
The filters that were extracted from the input query. |
rewritten_ |
Rewritten input query minus the extracted filters. |
structured_ |
The filters that were extracted from the input query represented in a structured form. |
StructuredExtractedFilter
The filters that were extracted from the input query represented in a structured form.
Fields | |
---|---|
expression |
The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. |
AndExpression
Logical And
operator.
Fields | |
---|---|
expressions[] |
The expressions that were ANDed together. |
Expression
The expression denoting the filter that was extracted from the input query.
Fields | |
---|---|
Union field expr . The expression type. expr can be only one of the following: |
|
string_ |
String constraint expression. |
number_ |
Numerical constraint expression. |
geolocation_ |
Geolocation constraint expression. |
and_ |
Logical "And" compound operator connecting multiple expressions. |
or_ |
Logical "Or" compound operator connecting multiple expressions. |
GeolocationConstraint
Constraint of a geolocation field. Name of the geolocation field as defined in the schema.
Fields | |
---|---|
field_ |
The name of the geolocation field as defined in the schema. |
address |
The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. |
latitude |
The latitude of the geolocation inferred from the input query. |
longitude |
The longitude of the geolocation inferred from the input query. |
radius_ |
The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. |
NumberConstraint
Constraint expression of a number field. Example: price < 100.
Fields | |
---|---|
field_ |
Name of the numerical field as defined in the schema. |
comparison |
The comparison operation performed between the field value and the value specified in the constraint. |
value |
The value specified in the numerical constraint. |
query_ |
Identifies the keywords within the search query that match a filter. |
Comparison
The comparison operation that was performed.
Enums | |
---|---|
COMPARISON_UNSPECIFIED |
Undefined comparison operator. |
EQUALS |
Denotes equality = operator. |
LESS_THAN_EQUALS |
Denotes less than or equal to <= operator. |
LESS_THAN |
Denotes less than < operator. |
GREATER_THAN_EQUALS |
Denotes greater than or equal to >= operator. |
GREATER_THAN |
Denotes greater than > operator. |
OrExpression
Logical Or
operator.
Fields | |
---|---|
expressions[] |
The expressions that were ORed together. |
StringConstraint
Constraint expression of a string field.
Fields | |
---|---|
field_ |
Name of the string field as defined in the schema. |
values[] |
Values of the string field. The record will only be returned if the field value matches one of the values specified here. |
query_ |
Identifies the keywords within the search query that match a filter. |
OneBoxResult
OneBoxResult is a holder for all results of specific type that we want to display in UI differently.
Fields | |
---|---|
one_ |
The type of One Box result. |
search_ |
The search results for this One Box. |
OneBoxType
The type of One Box result.
Enums | |
---|---|
ONE_BOX_TYPE_UNSPECIFIED |
Default value. Should not be used. |
PEOPLE |
One Box result contains people results. |
ORGANIZATION |
One Box result contains organization results. |
SLACK |
One Box result contains slack results. |
KNOWLEDGE_GRAPH |
One Box result contains Knowledge Graph search responses. |
QueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
Fields | |
---|---|
expanded_ |
Bool describing whether query expansion has occurred. |
pinned_ |
Number of pinned results. This field will only be set when expansion happens and |
SearchResult
Represents the search results.
Fields | |
---|---|
id |
|
document |
The document data snippet in the search response. Only fields that are marked as |
chunk |
The chunk data in the search response if the |
model_ |
Google provided available scores. |
SessionInfo
Information about the session.
Fields | |
---|---|
name |
Name of the session. If the auto-session mode is used (when |
query_ |
Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. |
Summary
Summary of the top N search results specified by the summary spec.
Fields | |
---|---|
summary_ |
The summary content. |
summary_ |
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. |
safety_ |
A collection of Safety Attribute categories and their associated confidence scores. |
summary_ |
Summary with metadata information. |
Citation
Citation info for a segment.
Fields | |
---|---|
start_ |
Index indicates the start of the segment, measured in bytes/unicode. |
end_ |
End of the attributed segment, exclusive. |
sources[] |
Citation sources for the attributed segment. |
CitationMetadata
Citation metadata.
Fields | |
---|---|
citations[] |
Citations for segments. |
CitationSource
Citation source.
Fields | |
---|---|
reference_ |
Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. |
Reference
Document reference.
Fields | |
---|---|
title |
Title of the document. |
document |
Required. |
uri |
Cloud Storage or HTTP uri for the document. |
chunk_ |
List of cited chunk contents derived from document content. |
ChunkContent
Chunk content.
Fields | |
---|---|
content |
Chunk textual content. |
page_ |
Page identifier. |
SafetyAttributes
Safety Attribute categories and their associated confidence scores.
Fields | |
---|---|
categories[] |
The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. |
scores[] |
The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. |
SummarySkippedReason
An Enum for summary-skipped reasons.
Enums | |
---|---|
SUMMARY_SKIPPED_REASON_UNSPECIFIED |
Default value. The summary skipped reason is not specified. |
ADVERSARIAL_QUERY_IGNORED |
The adversarial query ignored case. Only used when |
NON_SUMMARY_SEEKING_QUERY_IGNORED |
The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when |
OUT_OF_DOMAIN_QUERY_IGNORED |
The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B. |
POTENTIAL_POLICY_VIOLATION |
The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic. |
LLM_ADDON_NOT_ENABLED |
The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled. |
NO_RELEVANT_CONTENT |
The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results. |
JAIL_BREAKING_QUERY_IGNORED |
The jail-breaking query ignored case. For example, "Reply in the tone of a competing company's CEO". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to |
CUSTOMER_POLICY_VIOLATION |
The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer. |
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 |
The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to |
SummaryWithMetadata
Summary with metadata information.
Fields | |
---|---|
summary |
Summary text with no citation information. |
citation_ |
Citation metadata for given summary. |
references[] |
Document References. |
SearchTier
Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.
Enums | |
---|---|
SEARCH_TIER_UNSPECIFIED |
Default value when the enum is unspecified. This is invalid to use. |
SEARCH_TIER_STANDARD |
Standard tier. |
SEARCH_TIER_ENTERPRISE |
Enterprise tier. |
SearchUseCase
Defines a further subdivision of SolutionType
. Specifically applies to SOLUTION_TYPE_SEARCH
.
Enums | |
---|---|
SEARCH_USE_CASE_UNSPECIFIED |
Value used when unset. Will not occur in CSS. |
SEARCH_USE_CASE_SEARCH |
Search use case. Expects the traffic has a non-empty query . |
SEARCH_USE_CASE_BROWSE |
Browse use case. Expects the traffic has an empty query . |
ServingConfig
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
display_ |
Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
solution_ |
Required. Immutable. Specifies the solution type that a serving config can be associated with. |
model_ |
The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when |
diversity_ |
How much diversity to use in recommendation model results e.g.
If not specified, we choose default based on recommendation model type. Default value: Can only be set if |
embedding_ |
Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of |
ranking_ |
The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if The ranking expression is a single function or multiple functions that are joined by "+".
Supported functions:
Function variables:
Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be |
guided_ |
Guided search configs. |
custom_ |
Custom fine tuning configs. If |
create_ |
Output only. ServingConfig created timestamp. |
update_ |
Output only. ServingConfig updated timestamp. |
filter_ |
Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. |
boost_ |
Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. |
redirect_ |
IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if |
synonyms_ |
Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if |
oneway_ |
Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if |
dissociate_ |
Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if |
replacement_ |
Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if |
ignore_ |
Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. |
personalization_ |
The specification for personalization spec. Notice that if both |
Union field vertical_config . Industry vertical specific config. vertical_config can be only one of the following: |
|
media_ |
The MediaConfig of the serving configuration. |
generic_ |
The GenericConfig of the serving configuration. |
GenericConfig
Specifies the configurations needed for Generic Discovery.Currently we support:
content_search_spec
: configuration for generic content search.
Fields | |
---|---|
content_ |
Specifies the expected behavior of content search. Only valid for content-search enabled data store. |
MediaConfig
Specifies the configurations needed for Media Discovery. Currently we support:
demote_content_watched
: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.promote_fresh_content
: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set ifSolutionType
isSOLUTION_TYPE_RECOMMENDATION
.
Fields | |
---|---|
demotion_ |
Specifies the event type used for demoting recommendation result. Currently supported values:
If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. |
demote_ |
Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. |
content_ |
Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. |
Union field demote_content_watched . Specify the threshold for demoting watched content, the threshold can be either percentage or minutes value. This must be set for media-complete event type. demote_content_watched can be only one of the following: |
|
content_ |
Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. |
content_ |
Specifies the content watched minutes threshold for demotion. |
Session
External session proto definition.
Fields | |
---|---|
name |
Immutable. Fully qualified name |
state |
The state of the session. |
user_ |
A unique identifier for tracking users. |
turns[] |
Turns. |
start_ |
Output only. The time the session started. |
end_ |
Output only. The time the session finished. |
State
Enumeration of the state of the session.
Enums | |
---|---|
STATE_UNSPECIFIED |
State is unspecified. |
IN_PROGRESS |
The session is currently open. |
Turn
Represents a turn, including a query from the user and a answer from service.
Fields | |
---|---|
query |
The user query. |
answer |
The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. |
SetUriPatternDocumentDataMetadata
Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
SetUriPatternDocumentDataRequest
Request message for SiteSearchEngineService.SetUriPatternDocumentData
method.
Fields | |
---|---|
site_ |
Required. Full resource name of the |
document_ |
Document data keyed by URI pattern. Each entry must be consistent with the document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } |
empty_ |
If true, clears the document data map. If true, |
schema |
Optional. If not provided, the current |
SetUriPatternDocumentDataResponse
This type has no fields.
Response message for SiteSearchEngineService.SetUriPatternDocumentData
method.
SiteSearchEngine
SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
Fields | |
---|---|
name |
The fully qualified resource name of the site search engine. Format: |
SiteVerificationInfo
Verification information for target sites in advanced site search.
Fields | |
---|---|
site_ |
Site verification state indicating the ownership and validity. |
verify_ |
Latest site verification time. |
SiteVerificationState
Site verification state.
Enums | |
---|---|
SITE_VERIFICATION_STATE_UNSPECIFIED |
Defaults to VERIFIED. |
VERIFIED |
Site ownership verified. |
UNVERIFIED |
Site ownership pending verification or verification failed. |
EXEMPTED |
Site exempt from verification, e.g., a public website that opens to all. |
SolutionType
The type of solution.
Enums | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
Default value. |
SOLUTION_TYPE_RECOMMENDATION |
Used for Recommendations AI. |
SOLUTION_TYPE_SEARCH |
Used for Discovery Search. |
SOLUTION_TYPE_CHAT |
Used for use cases related to the Generative AI agent. |
SOLUTION_TYPE_GENERATIVE_CHAT |
Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with SOLUTION_TYPE_CHAT solution. |
SpannerSource
The Spanner source for importing data
Fields | |
---|---|
project_ |
The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. |
instance_ |
Required. The instance ID of the source Spanner table. |
database_ |
Required. The database ID of the source Spanner table. |
table_ |
Required. The table name of the Spanner database that needs to be imported. |
enable_ |
Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found here. |
SuggestionDenyListEntry
Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.
Fields | |
---|---|
block_ |
Required. Phrase to block from suggestions served. Can be maximum 125 characters. |
match_ |
Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. |
MatchOperator
Operator for matching with the generated suggestions.
Enums | |
---|---|
MATCH_OPERATOR_UNSPECIFIED |
Default value. Should not be used |
EXACT_MATCH |
If the suggestion is an exact match to the block_phrase, then block it. |
CONTAINS |
If the suggestion contains the block_phrase, then block it. |
TargetSite
A target site for the SiteSearchEngine.
Fields | |
---|---|
name |
Output only. The fully qualified resource name of the target site. |
provided_ |
Required. Input only. The user provided URI pattern from which the |
type |
The type of the target site, e.g., whether the site is to be included or excluded. |
exact_ |
Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. |
generated_ |
Output only. This is system-generated based on the provided_uri_pattern. |
root_ |
Output only. Root domain of the provided_uri_pattern. |
site_ |
Output only. Site ownership and validity verification status. |
indexing_ |
Output only. Indexing status. |
update_ |
Output only. The target site's last updated time. |
failure_ |
Output only. Failure reason. |
FailureReason
Site search indexing failure reasons.
Fields | |
---|---|
Union field failure . Failure reason. failure can be only one of the following: |
|
quota_ |
Failed due to insufficient quota. |
QuotaFailure
Failed due to insufficient quota.
Fields | |
---|---|
total_ |
This number is an estimation on how much total quota this project needs to successfully complete indexing. |
IndexingStatus
Target site indexing status enumeration.
Enums | |
---|---|
INDEXING_STATUS_UNSPECIFIED |
Defaults to SUCCEEDED. |
PENDING |
The target site is in the update queue and will be picked up by indexing pipeline. |
FAILED |
The target site fails to be indexed. |
SUCCEEDED |
The target site has been indexed. |
DELETING |
The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails. |
Type
Possible target site types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
This value is unused. In this case, server behavior defaults to Type.INCLUDE . |
INCLUDE |
Include the target site. |
EXCLUDE |
Exclude the target site. |
TextInput
Defines text input.
Fields | |
---|---|
input |
Text input. |
context |
Conversation context of the input. |
TrainCustomModelMetadata
Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
TrainCustomModelRequest
Request message for SearchTuningService.TrainCustomModel
method.
Fields | |
---|---|
data_ |
Required. The resource name of the Data Store, such as |
model_ |
Model to be trained. Supported values are:
|
error_ |
The desired location of errors incurred during the data ingestion and training. |
model_ |
If not provided, a UUID will be generated. |
Union field training_input . Model training input. training_input can be only one of the following: |
|
gcs_ |
Cloud Storage training input. |
GcsTrainingInput
Cloud Storage training data input.
Fields | |
---|---|
corpus_ |
The Cloud Storage corpus data which could be associated in train data. The data path format is For search-tuning model, each line should have the _id, title and text. Example: |
query_ |
The gcs query data which could be associated in train data. The data path format is For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} |
train_ |
Cloud Storage training data path whose format should be For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in
|
test_ |
Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. |
TrainCustomModelResponse
Response of the TrainCustomModelRequest
. This message is returned by the google.longrunning.Operations.response field.
Fields | |
---|---|
error_ |
A sample of errors encountered while processing the data. |
error_ |
Echoes the destination for the complete errors in the request if set. |
model_ |
The trained model status. Possible values are:
|
metrics |
The metrics of the trained model. |
model_ |
Fully qualified name of the CustomTuningModel. |
TransactionInfo
A transaction represents the entire purchase transaction.
Fields | |
---|---|
currency |
Required. Currency code. Use three-character ISO-4217 code. |
transaction_ |
The transaction ID with a length limit of 128 characters. |
value |
Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. |
tax |
All the taxes associated with the transaction. |
cost |
All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: |
discount_ |
The total discount(s) value applied to this transaction. This figure should be excluded from For example, if a user paid This means that profit is calculated the same way, regardless of the discount value, and that |
TuneEngineMetadata
Metadata associated with a tune operation.
Fields | |
---|---|
engine |
Required. The resource name of the engine that this tune applies to. Format: |
TuneEngineRequest
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
Fields | |
---|---|
name |
Required. The resource name of the engine to tune. Format: |
TuneEngineResponse
This type has no fields.
Response associated with a tune operation.
UpdateAclConfigRequest
Request message for UpdateAclConfig method.
Fields | |
---|---|
acl_ |
UpdateCmekConfigMetadata
Metadata related to the progress of the CmekConfigService.UpdateCmekConfig
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
UpdateCmekConfigRequest
Request message for UpdateCmekConfig method. rpc.
Fields | |
---|---|
config |
Required. The CmekConfig resource. |
set_ |
Set the following CmekConfig as the default to be used for child resources if one is not specified. |
UpdateCompletionConfigRequest
Request for DataStoreService.UpdateCompletionConfig
method.
Fields | |
---|---|
completion_ |
Required. The If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided
If not set, all supported fields are updated. |
UpdateControlRequest
Request for UpdateControl method.
Fields | |
---|---|
control |
Required. The Control to update. |
update_ |
Optional. Indicates which fields in the provided If not set or empty, all supported fields are updated. |
UpdateConversationRequest
Request for UpdateConversation method.
Fields | |
---|---|
conversation |
Required. The Conversation to update. |
update_ |
Indicates which fields in the provided If not set or empty, all supported fields are updated. |
UpdateDataStoreRequest
Request message for DataStoreService.UpdateDataStore
method.
Fields | |
---|---|
data_ |
Required. The If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
UpdateDocumentProcessingConfigRequest
Request for DataStoreService.UpdateDocumentProcessingConfig
method.
Fields | |
---|---|
document_ |
Required. The If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided
If not set, all supported fields are updated. |
UpdateDocumentRequest
Request message for DocumentService.UpdateDocument
method.
Fields | |
---|---|
document |
Required. The document to update/create. If the caller does not have permission to update the If the |
allow_ |
If set to |
update_ |
Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. |
UpdateEngineRequest
Request message for EngineService.UpdateEngine
method.
Fields | |
---|---|
engine |
Required. The If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
UpdateSampleQueryRequest
Request message for SampleQueryService.UpdateSampleQuery
method.
Fields | |
---|---|
sample_ |
Required. The simple query to update. If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. |
UpdateSampleQuerySetRequest
Request message for SampleQuerySetService.UpdateSampleQuerySet
method.
Fields | |
---|---|
sample_ |
Required. The sample query set to update. If the caller does not have permission to update the If the |
update_ |
Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. |
UpdateSchemaMetadata
Metadata for UpdateSchema LRO.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
UpdateSchemaRequest
Request message for SchemaService.UpdateSchema
method.
Fields | |
---|---|
schema |
Required. The |
allow_ |
If set to true, and the |
UpdateServingConfigRequest
Request for UpdateServingConfig method.
Fields | |
---|---|
serving_ |
Required. The ServingConfig to update. |
update_ |
Indicates which fields in the provided If not set, all supported fields are updated. |
UpdateSessionRequest
Request for UpdateSession method.
Fields | |
---|---|
session |
Required. The Session to update. |
update_ |
Indicates which fields in the provided If not set or empty, all supported fields are updated. |
UpdateTargetSiteMetadata
Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite
operation. This will be returned by the google.longrunning.Operation.metadata field.
Fields | |
---|---|
create_ |
Operation create time. |
update_ |
Operation last update time. If the operation is done, this is also the finish time. |
UpdateTargetSiteRequest
Request message for SiteSearchEngineService.UpdateTargetSite
method.
Fields | |
---|---|
target_ |
Required. The target site to update. If the caller does not have permission to update the If the |
UserEvent
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
Fields | |
---|---|
event_ |
Required. User event type. Allowed values are: Generic values:
Retail-related values:
Media-related values:
|
user_ |
Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field. |
engine |
The Optional. Only required for |
data_ |
The Optional. Only required for user events whose data store can't by determined by |
event_ |
Only required for |
user_ |
Information about the end user. |
direct_ |
Should set to true if the request is made directly from the end user, in which case the This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in |
session_ |
A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id:
|
page_ |
Page metadata such as categories and other critical information for certain event types such as |
attribution_ |
Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of The value must be one of:
This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass |
filter |
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for Similarly, for The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an |
documents[] |
List of This field is optional except for the following event types:
In a |
panel |
Panel metadata associated with this user event. |
search_ |
This field should be set for |
completion_ |
This field should be set for |
transaction_ |
The transaction metadata (if any) associated with this user event. |
tag_ |
A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. |
promotion_ |
The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. |
attributes |
Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an
For product recommendations, an example of extra user information is |
media_ |
Media-specific info. |
UserInfo
Information of an end user.
Fields | |
---|---|
user_ |
Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an |
user_ |
User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an This should not be set when using the client side event reporting with GTM or JavaScript tag in |
WidgetAcquireAndStoreRefreshTokenRequest
Request message for WidgetService.WidgetAcquireAndStoreRefreshToken
method.
Fields | |
---|---|
location |
Required. The location resource where widget homepage FetchDocuments will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
acquire_ |
Required. The proxied request to DataConnectorService.AcquireAndStoreRefreshToken. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetAcquireAndStoreRefreshTokenResponse
Response message for WidgetService.WidgetAcquireAndStoreRefreshToken
method.
Fields | |
---|---|
acquire_ |
The proxied response from DataConnectorService.AcquireAndStoreRefreshToken. |
u_ |
The token in response. |
WidgetAdvancedCompleteQueryRequest
Request message for WidgetService.WidgetAdvancedCompleteQuery
method.
Fields | |
---|---|
location |
Required. The location resource where widget complete query will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. |
advanced_ |
Required. The AdvancedCompleteQuery request to perform auto-complete suggestion query. |
additional_ |
Required. Additional params for security and privacy enhancement. |
WidgetAdvancedCompleteQueryResponse
Response message for WidgetService.WidgetAdvancedCompleteQuery
method.
Fields | |
---|---|
u_ |
The token in response. |
advanced_ |
AdvancedCompleteQueryResponse returned from [CompletionService.AdvanceCompleteQuery][]. |
WidgetAnswerQueryRequest
Request message for WidgetService.WidgetAnswerQuery
method.
Fields | |
---|---|
location |
Required. The location resource where widget answer query will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
answer_ |
Required. The AnswerQueryRequest request to perform answer query. The ServingConfig id will be The session resource will be set as sanitized session name hiding project and location information. Format: The document name in the [ConversationalSearchService.AnswerQueryRequest][] will be sanitized with hiding project and location information also. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetAnswerQueryResponse
Response message for WidgetService.WidgetAnswerQuery
method.
Fields | |
---|---|
answer_ |
AnswerQueryResponse returned from [ConversationalSearchService.AnswerQueryResponse][]. If session is present in request and is a valid session, the session resource returned will be sanitized with hiding project and location information. Format: The returned document name in the [ConversationalSearchService.AnswerQueryRequest][] will be sanitized with hiding project and location information also. |
u_ |
The token in response. |
WidgetCompleteQueryRequest
Request message for WidgetService.WidgetCompleteQuery
method.
Fields | |
---|---|
location |
Required. The location resource where widget complete query will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. |
complete_ |
Required. The CompleteQuery request to perform auto-complete suggestion query. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetCompleteQueryResponse
Response message for WidgetService.WidgetCompleteQuery
method.
Fields | |
---|---|
u_ |
The token in response. |
widget_ |
Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion. |
WidgetQuerySuggestion
Suggestions as search queries.
Fields | |
---|---|
suggestion |
The suggestion for the query. |
WidgetConfig
WidgetConfig captures configs at the Widget level.
Fields | |
---|---|
name |
Immutable. The full resource name of the widget config. Format: This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
display_ |
Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
create_ |
Output only. Timestamp the |
update_ |
Output only. Timestamp the |
enable_autocomplete |
Whether or not to enable autocomplete. |
fields_ui_components_map |
The key is the UI component. Mock. Currently supported The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. |
facet_field[] |
The configuration and appearance of facets in the end user view. |
data_ |
Output only. The type of the parent data store. |
content_search_spec |
The content search spec that configs the desired behavior of content search. |
enable_summarization |
Turn on or off summarization for the search response. |
enable_snippet_result_summary |
Turn on or off summary for each snippets result. |
config_ |
Output only. Unique obfuscated identifier of a |
enable_quality_feedback |
Turn on or off collecting the search result quality feedback from end users. |
solution_ |
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
industry_ |
Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated |
allow_public_access |
Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. |
allowlisted_domains[] |
Allowlisted domains that can load this widget. |
enable_safe_search |
Whether to enable safe search. |
enable_conversational_search |
Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). |
llm_ |
Output only. Whether LLM is enabled in the corresponding data store. |
enable_ |
Whether to show the result score. |
result_display_type |
The type of snippet to display in UCS widget.
|
minimum_ |
Output only. Whether the customer accepted data use terms. |
enable_web_app |
Whether to enable standalone web app. |
data_store_ui_configs[] |
Configurable UI configurations per data store. |
collection_ |
Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. |
enable_search_as_you_type |
Whether to enable search-as-you-type behavior for the search widget |
default_search_request_order_by |
The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
experimental_ |
Allows to toggle unstable/experimental features in the widget (or web app) |
ui_ |
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
access_ |
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
ui_ |
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
homepage_ |
Optional. Describes the homepage settings of the widget. |
AccessSettings
Describes widget access settings.
Fields | |
---|---|
allow_ |
Whether public unauthenticated access is allowed. |
allowlisted_ |
List of domains that are allowed to integrate the search widget. |
enable_ |
Whether web app access is enabled. |
CollectionComponent
Read-only collection component that contains data store collections fields that may be used for filtering
Fields | |
---|---|
name |
The name of the collection. It should be collection resource name. Format: |
id |
Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. |
display_ |
The display name of the collection. |
data_ |
For the data store collection, list of the children data stores. |
data_ |
The name of the data source, retrieved from |
connector_ |
Output only. The icon link of the connector source. |
DataStoreComponent
Read-only data store component that contains data stores fields that may be used for filtering, it's the child of CollectionComponent
.
Fields | |
---|---|
name |
The name of the data store. It should be data store resource name Format: |
id |
Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. |
display_ |
The display name of the data store. |
entity_ |
The name of the entity, retrieved from |
content_ |
The content config of the data store. |
DataStoreType
The type of the widget's parent data store.
Enums | |
---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Unspecified data store type. |
SITE_SEARCH |
The parent data store contains a site search engine. |
STRUCTURED |
The parent data store contains a search engine for structured data. |
UNSTRUCTURED |
The parent data store contains a search engine for unstructured data. |
BLENDED |
The parent data store is served for blended search with multiple data stores. |
DataStoreUiConfig
UI component configuration for data store.
Fields | |
---|---|
name |
The name of the data store. It should be data store resource name Format: |
id |
Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. |
facet_ |
Facet fields that store the mapping of fields to end user widget appearance. |
fields_ |
The key is the UI component. Mock. Currently supported The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. |
FacetField
Facet fields that store the mapping of fields to end user widget appearance.
Fields | |
---|---|
field |
Required. Registered field name. The format is |
display_ |
Optional. The field name that end users will see. |
HomepageSetting
Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
Fields | |
---|---|
shortcuts[] |
Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) |
Shortcut
Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
Fields | |
---|---|
title |
Optional. Title of the shortcut. |
icon |
Optional. Icon URL of shortcut. |
destination_ |
Optional. Destination URL of shortcut. |
Image
Options to store an image.
Fields | |
---|---|
Union field storage_method . Various ways to store an image, i.e., as a URL or base64 encoded string. storage_method can be only one of the following: |
|
url |
Image URL. |
ResultDisplayType
The type of result to display in the ucs widget.
Enums | |
---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
Unspecified display type (default to showing snippet). |
SNIPPET |
Display results from the snippet field. |
EXTRACTIVE_ANSWER |
Display results from extractive answers field. |
UIComponentField
Facet field that maps to a UI Component.
Fields | |
---|---|
field |
Required. Registered field name. The format is |
device_ |
The field visibility on different types of devices. |
display_ |
The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". |
DeviceVisibility
The visibility of the field on different type of devices.
Enums | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
Default value when not specified. Server returns INVALID_ARGUMENT if used in requests. |
MOBILE |
The UI component is visible on Mobile devices. |
DESKTOP |
The UI component is visible on Browser-based client. |
UiBrandingSettings
Describes widget UI branding settings.
Fields | |
---|---|
logo |
Logo image. |
UiSettings
Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
Fields | |
---|---|
interaction_ |
Describes widget (or web app) interaction type |
generative_ |
Describes generative answer configuration. |
result_ |
Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. |
enable_ |
Whether or not to enable autocomplete. |
enable_ |
Whether to enable safe search. |
enable_ |
Turn on or off collecting the search result quality feedback from end users. |
enable_ |
Whether to enable search-as-you-type behavior for the search widget. |
default_ |
The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body |
data_ |
Per data store configuration. |
disable_ |
If set to true, the widget will not collect user events. |
GenerativeAnswerConfig
Describes configuration for generative answer.
Fields | |
---|---|
result_ |
The number of top results to generate the answer from. Up to 10. |
model_ |
The model version used to generate the answer. |
model_ |
Text at the beginning of the prompt that instructs the model that generates the answer. |
max_ |
Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. |
language_ |
Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature. |
disable_ |
Whether generated answer contains suggested related questions. |
ignore_ |
Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to |
ignore_ |
Optional. Specifies whether to filter out queries that are adversarial. |
ignore_ |
Optional. Specifies whether to filter out queries that are not relevant to the content. |
InteractionType
Describes interaction type.
Enums | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Not specified. Defaults to SEARCH_ONLY. |
SEARCH_ONLY |
Search without a generative answer. |
SEARCH_WITH_ANSWER |
Search with the generative answer. |
SEARCH_WITH_FOLLOW_UPS |
Search with the generative answer that supports follow up questions. Also known as multi-turn search. |
WidgetConverseConversationRequest
Request message for WidgetService.WidgetConverseConversation
method.
Fields | |
---|---|
location |
Required. The location resource where widget converse conversation will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. |
converse_ |
Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be |
conversation_ |
The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetConverseConversationResponse
Response message for WidgetService.WidgetConverseConversation
method.
Fields | |
---|---|
converse_ |
ConverseConversationResponse returned from |
u_ |
The token in response. |
conversation_ |
The id of the Conversation returned. |
WidgetExecuteActionRequest
Request message for WidgetService.WidgetExecuteAction
method.
Fields | |
---|---|
location |
Required. The location resource where widget homepage FetchDocuments will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
execute_ |
Required. The proxied request to DataConnectorService.ExecuteAction. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetExecuteActionResponse
Response message for WidgetService.WidgetExecuteAction
method.
Fields | |
---|---|
execute_ |
The proxied response from DataConnectorService.ExecuteAction. |
u_ |
The token in response. |
WidgetHomepageFetchDocumentsRequest
Request message for WidgetService.WidgetHomepageFetchDocuments
method.
Fields | |
---|---|
location |
Required. The location resource where widget homepage FetchDocuments will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration. |
fetch_ |
Required. The request to get documents for Homepage. |
WidgetHomepageFetchDocumentsResponse
Response message for WidgetService.WidgetHomepageFetchDocuments
method.
Fields | |
---|---|
fetch_ |
The response from FetchDocuments. |
WidgetSearchRequest
Request message for WidgetService.WidgetSearch
method.
Fields | |
---|---|
location |
Required. The location resource where widget search will be performed. Format: |
config_ |
Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search. |
search_ |
Required. The search request to perform search. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetSearchResponse
Response message for WidgetService.WidgetSearch
method.
Fields | |
---|---|
search_ |
The search response after performing search. |
u_ |
The token in response. |
WidgetWriteUserEventRequest
Request message for WidgetService.WidgetWriteUserEvent
method.
Fields | |
---|---|
location |
Required. The location resource where widget write user event will be performed. Format: |
config_ |
Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to write user event. |
write_ |
Required. The user event write request. |
additional_ |
Additional params for security and privacy enhancement. |
WidgetWriteUserEventResponse
Response message for WidgetService.WidgetWriteUserEvent
method.
Fields | |
---|---|
u_ |
The token in response. |
WorkspaceConfig
Config to store data store type configuration for workspace data
Fields | |
---|---|
type |
The Google Workspace data source. |
dasher_ |
Obfuscated Dasher customer ID. |
super_ |
Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |
super_ |
Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. |
Type
Specifies the type of Workspace App supported by this DataStore
Enums | |
---|---|
TYPE_UNSPECIFIED |
Defaults to an unspecified Workspace type. |
GOOGLE_DRIVE |
Workspace Data Store contains Drive data |
GOOGLE_MAIL |
Workspace Data Store contains Mail data |
GOOGLE_SITES |
Workspace Data Store contains Sites data |
GOOGLE_CALENDAR |
Workspace Data Store contains Calendar data |
GOOGLE_CHAT |
Workspace Data Store contains Chat data |
GOOGLE_GROUPS |
Workspace Data Store contains Groups data |
GOOGLE_KEEP |
Workspace Data Store contains Keep data |
WriteUserEventRequest
Request message for WriteUserEvent method.
Fields | |
---|---|
parent |
Required. The parent resource name. If the write user event action is applied in |
write_ |
If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. |
user_ |
Required. User event to write. |