Package google.cloud.discoveryengine.v1

インデックス

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

AclConfigService

Acl 構成を管理するためのサービス。

GetAclConfig
rpc GetAclConfig(GetAclConfigRequest) returns (AclConfig) AclConfig を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.aclConfigs.get 詳細については、IAM のドキュメントをご覧ください。

UpdateAclConfig

rpc UpdateAclConfig(UpdateAclConfigRequest) returns (AclConfig) お客様のプロジェクトのロケーションで使用するデフォルトの ACL 構成。更新は新しいデータストアにのみ反映されます。既存のデータストアは引き続き古い値を使用します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.aclConfigs.update 詳細については、IAM のドキュメントをご覧ください。

AssistAnswerService

AssistAnswer リソースをクエリするためのサービス。

GetAssistAnswer
rpc GetAssistAnswer(GetAssistAnswerRequest) returns (AssistAnswer) AssistAnswer を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistAnswers.get 詳細については、IAM のドキュメントをご覧ください。

AssistantService

アシスタントの設定を管理し、ユーザーをサポートするサービス。

AddContextFile

rpc AddContextFile(AddContextFileRequest) returns (AddContextFileResponse) セッション内のアシスト呼び出しのソースとして使用するコンテキスト ファイルをアップロードします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.addContextFile 詳細については、IAM のドキュメントをご覧ください。

サポート

rpc Assist(AssistRequest) returns (AssistResponse) ユーザーのクエリを支援します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.assist 詳細については、IAM のドキュメントをご覧ください。

CreateAssistant

rpc CreateAssistant(CreateAssistantRequest) returns (Assistant) Assistant を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.create 詳細については、IAM のドキュメントをご覧ください。

DeleteAssistant

rpc DeleteAssistant(DeleteAssistantRequest) returns (Empty) Assistant を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.delete 詳細については、IAM のドキュメントをご覧ください。

GetAssistant

rpc GetAssistant(GetAssistantRequest) returns (Assistant) Assistant を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.get 詳細については、IAM のドキュメントをご覧ください。

ListAssistants

rpc ListAssistants(ListAssistantsRequest) returns (ListAssistantsResponse) Engine のすべての Assistant を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.list 詳細については、IAM のドキュメントをご覧ください。

StreamAssist

rpc StreamAssist(StreamAssistRequest) returns (StreamAssistResponse) ユーザーのクエリをストリーミング形式で支援します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.assist 詳細については、IAM のドキュメントをご覧ください。

UpdateAssistant

rpc UpdateAssistant(UpdateAssistantRequest) returns (Assistant) Assistant を更新します 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.assistants.update 詳細については、IAM のドキュメントをご覧ください。

CmekConfigService

CMEK 関連のタスクを管理するサービス

DeleteCmekConfig
rpc DeleteCmekConfig(DeleteCmekConfigRequest) returns (Operation) CmekConfig のプロビジョニングを解除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。

GetCmekConfig
rpc GetCmekConfig(GetCmekConfigRequest) returns (CmekConfig) CmekConfig を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.cmekConfigs.get 詳細については、IAM のドキュメントをご覧ください。

ListCmekConfigs
rpc ListCmekConfigs(ListCmekConfigsRequest) returns (ListCmekConfigsResponse) プロジェクトのすべての CmekConfig を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.cmekConfigs.list 詳細については、IAM のドキュメントをご覧ください。

UpdateCmekConfig

rpc UpdateCmekConfig(UpdateCmekConfigRequest) returns (Operation) 顧客のプロジェクトのロケーションで使用する CMEK 鍵をプロビジョニングします。このメソッドは、指定された cmekConfig でロケーションの検証も行い、鍵が有効で、選択したロケーションで使用できることを確認します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.cmekConfigs.update 詳細については、IAM のドキュメントをご覧ください。

CollectionService

Collection を管理するためのサービス。

DeleteCollection
rpc DeleteCollection(DeleteCollectionRequest) returns (Operation) Collection を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.collections.delete 詳細については、IAM のドキュメントをご覧ください。

CompletionService

オートコンプリートのサービス。

AdvancedCompleteQuery

rpc AdvancedCompleteQuery(AdvancedCompleteQueryRequest) returns (AdvancedCompleteQueryResponse) 高度なキーワード候補を使用してユーザーの入力を補完します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/cloud_search.query https://www.googleapis.com/auth/discoveryengine.complete_query https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 completionConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.completionConfigs.completeQuery 詳細については、IAM のドキュメントをご覧ください。

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) 指定されたユーザー入力をキーワード候補で補完します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 dataStore リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.completeQuery 詳細については、IAM のドキュメントをご覧ください。

ImportCompletionSuggestions
rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest) returns (Operation) DataStore の CompletionSuggestion をインポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。

ImportSuggestionDenyListEntries

rpc ImportSuggestionDenyListEntries(ImportSuggestionDenyListEntriesRequest) returns (Operation) DataStore のすべての SuggestionDenyListEntry をインポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.suggestionDenyListEntries.import 詳細については、IAM のドキュメントをご覧ください。

PurgeCompletionSuggestions
rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest) returns (Operation) DataStore のすべての CompletionSuggestion を完全に削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。

PurgeSuggestionDenyListEntries

rpc PurgeSuggestionDenyListEntries(PurgeSuggestionDenyListEntriesRequest) returns (Operation) DataStore のすべての SuggestionDenyListEntry を完全に削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.suggestionDenyListEntries.purge 詳細については、IAM のドキュメントをご覧ください。

ControlService

コントロールに対して CRUD オペレーションを実行するサービス。コントロールを使用すると、サービス提供パスにカスタム ロジックを実装できます。リクエスト時に考慮されるように、コントロールをサービス構成に関連付ける必要があります。

CreateControl

rpc CreateControl(CreateControlRequest) returns (Control) コントロールを作成します。 デフォルトでは、データストアで 1,000 個のコントロールを使用できます。この上限を調整するリクエストを送信できます。作成する Control がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.controls.create 詳細については、IAM のドキュメントをご覧ください。

DeleteControl
rpc DeleteControl(DeleteControlRequest) returns (Empty) コントロールを削除します。 削除する Control が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.controls.delete 詳細については、IAM のドキュメントをご覧ください。

GetControl
rpc GetControl(GetControlRequest) returns (Control) コントロールを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.controls.get 詳細については、IAM のドキュメントをご覧ください。

ListControls
rpc ListControls(ListControlsRequest) returns (ListControlsResponse) すべてのコントロールを親 DataStore で一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.controls.list 詳細については、IAM のドキュメントをご覧ください。

UpdateControl

rpc UpdateControl(UpdateControlRequest) returns (Control) コントロールを更新します。 Control アクション タイプは変更できません。更新する Control が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.controls.update 詳細については、IAM のドキュメントをご覧ください。

ConversationalSearchService

会話型検索のサービス。

AnswerQuery
rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) Answer クエリ メソッド。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 servingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.servingConfigs.answer 詳細については、IAM のドキュメントをご覧ください。

ConverseConversation
rpc ConverseConversation(ConverseConversationRequest) returns (ConverseConversationResponse) 会話を変換します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.converse 詳細については、IAM のドキュメントをご覧ください。

CreateConversation

rpc CreateConversation(CreateConversationRequest) returns (Conversation) 会話を作成します。 作成する Conversation がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.create 詳細については、IAM のドキュメントをご覧ください。

CreateSession
rpc CreateSession(CreateSessionRequest) returns (Session) セッションを作成します。 作成する Session がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.create 詳細については、IAM のドキュメントをご覧ください。

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty) 会話を削除します。 削除する Conversation が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteSession
rpc DeleteSession(DeleteSessionRequest) returns (Empty) セッションを削除します。 削除する Session が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.delete 詳細については、IAM のドキュメントをご覧ください。

GetAnswer
rpc GetAnswer(GetAnswerRequest) returns (Answer) 回答を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.answers.get 詳細については、IAM のドキュメントをご覧ください。

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) 会話を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.get 詳細については、IAM のドキュメントをご覧ください。

GetSession
rpc GetSession(GetSessionRequest) returns (Session) セッションを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.get 詳細については、IAM のドキュメントをご覧ください。

ListConversations
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) 親 DataStore ごとにすべての会話を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.list 詳細については、IAM のドキュメントをご覧ください。

ListSessions
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) 親 DataStore ごとにすべてのセッションを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.list 詳細については、IAM のドキュメントをご覧ください。

StreamAnswerQuery

rpc StreamAnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) クエリへの回答メソッド（ストリーミング）。 1 つの AnswerQueryRequest を受け取り、ストリームで複数の AnswerQueryResponse メッセージを返します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 servingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.servingConfigs.answer 詳細については、IAM のドキュメントをご覧ください。

UpdateConversation

rpc UpdateConversation(UpdateConversationRequest) returns (Conversation) 会話を更新します。 Conversation アクション タイプは変更できません。更新する Conversation が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.conversations.update 詳細については、IAM のドキュメントをご覧ください。

UpdateSession

rpc UpdateSession(UpdateSessionRequest) returns (Session) セッションを更新します。 Session アクション タイプは変更できません。更新する Session が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.update 詳細については、IAM のドキュメントをご覧ください。

DataConnectorService

データコネクタ管理用のサービス。

GetDataConnector

rpc GetDataConnector(GetDataConnectorRequest) returns (DataConnector) DataConnector を取得します。DataConnector は、各 Collection のシングルトン リソースです。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.dataConnectors.get 詳細については、IAM のドキュメントをご覧ください。

SetUpDataConnector

rpc SetUpDataConnector(SetUpDataConnectorRequest) returns (Operation) Collection を作成し、その DataConnector を設定します。セットアップ後に DataConnector を停止するには、CollectionService.DeleteCollection メソッドを使用します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.locations.setUpDataConnector 詳細については、IAM のドキュメントをご覧ください。

UpdateDataConnector

rpc UpdateDataConnector(UpdateDataConnectorRequest) returns (DataConnector) DataConnector を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.dataConnectors.update 詳細については、IAM のドキュメントをご覧ください。

DataStoreService

DataStore 構成を管理するためのサービス。

CreateDataStore

rpc CreateDataStore(CreateDataStoreRequest) returns (Operation) DataStore を作成します。 DataStore は Documents を保存するためのものです。これらのドキュメントを検索または推奨事項のユースケースで使用するには、Engine を別途作成する必要があります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.create 詳細については、IAM のドキュメントをご覧ください。

DeleteDataStore
rpc DeleteDataStore(DeleteDataStoreRequest) returns (Operation) DataStore を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.delete 詳細については、IAM のドキュメントをご覧ください。

GetDataStore
rpc GetDataStore(GetDataStoreRequest) returns (DataStore) DataStore を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.get 詳細については、IAM のドキュメントをご覧ください。

ListDataStores
rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse) プロジェクトに関連付けられているすべての DataStore を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.list 詳細については、IAM のドキュメントをご覧ください。

UpdateDataStore
rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore) DataStore を更新します 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.update 詳細については、IAM のドキュメントをご覧ください。

DocumentService

お客様のウェブサイトの Document 情報を取り込むサービス。

BatchGetDocumentsMetadata

rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest) returns (BatchGetDocumentsMetadataResponse) Document のインデックスの更新頻度メタデータを取得します。ウェブサイト検索でのみサポートされます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.batchGetDocumentsMetadata 詳細については、IAM のドキュメントをご覧ください。

CreateDocument
rpc CreateDocument(CreateDocumentRequest) returns (Document) Document を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.create 詳細については、IAM のドキュメントをご覧ください。

DeleteDocument
rpc DeleteDocument(DeleteDocumentRequest) returns (Empty) Document を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.delete 詳細については、IAM のドキュメントをご覧ください。

GetDocument
rpc GetDocument(GetDocumentRequest) returns (Document) Document を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.get 詳細については、IAM のドキュメントをご覧ください。

ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation) 複数の Document の一括インポート。リクエスト処理は同期される場合があります。存在しないアイテムが作成されます。 注: Document のサブセットが正常に更新される場合があります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.import 詳細については、IAM のドキュメントをご覧ください。

ListDocuments
rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) Document のリストを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.list 詳細については、IAM のドキュメントをご覧ください。

PurgeDocuments

rpc PurgeDocuments(PurgeDocumentsRequest) returns (Operation) ブランチ内の選択したすべての Document を完全に削除します。 このプロセスは非同期です。削除する Document の数によっては、このオペレーションの完了に数時間かかることがあります。削除オペレーションが完了する前に、DocumentService.GetDocument または DocumentService.ListDocuments によって一部の Document が返されることがあります。 削除する Document のリストを取得するには、PurgeDocumentsRequest.force を false に設定します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.purge 詳細については、IAM のドキュメントをご覧ください。

UpdateDocument
rpc UpdateDocument(UpdateDocumentRequest) returns (Document) Document を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.documents.update 詳細については、IAM のドキュメントをご覧ください。

EngineService

Engine 構成を管理するためのサービス。

CreateEngine
rpc CreateEngine(CreateEngineRequest) returns (Operation) Engine を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.engines.create 詳細については、IAM のドキュメントをご覧ください。

DeleteEngine
rpc DeleteEngine(DeleteEngineRequest) returns (Operation) Engine を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.engines.delete 詳細については、IAM のドキュメントをご覧ください。

GetEngine
rpc GetEngine(GetEngineRequest) returns (Engine) Engine を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.engines.get 詳細については、IAM のドキュメントをご覧ください。

ListEngines
rpc ListEngines(ListEnginesRequest) returns (ListEnginesResponse) プロジェクトに関連付けられているすべての Engine を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.engines.list 詳細については、IAM のドキュメントをご覧ください。

UpdateEngine
rpc UpdateEngine(UpdateEngineRequest) returns (Engine) Engine を更新します 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.engines.update 詳細については、IAM のドキュメントをご覧ください。

GroundedGenerationService

グラウンディング生成用のサービス。

CheckGrounding
rpc CheckGrounding(CheckGroundingRequest) returns (CheckGroundingResponse) アース チェックを行います。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 groundingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.groundingConfigs.check 詳細については、IAM のドキュメントをご覧ください。

IdentityMappingStoreService

ID マッピング ストアを管理するサービス。

CreateIdentityMappingStore

rpc CreateIdentityMappingStore(CreateIdentityMappingStoreRequest) returns (IdentityMappingStore) 新しい ID マッピング ストアを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.create 詳細については、IAM のドキュメントをご覧ください。

DeleteIdentityMappingStore
rpc DeleteIdentityMappingStore(DeleteIdentityMappingStoreRequest) returns (Operation) ID マッピング ストアを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.delete 詳細については、IAM のドキュメントをご覧ください。

GetIdentityMappingStore
rpc GetIdentityMappingStore(GetIdentityMappingStoreRequest) returns (IdentityMappingStore) ID マッピング ストアを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.get 詳細については、IAM のドキュメントをご覧ください。

ImportIdentityMappings

rpc ImportIdentityMappings(ImportIdentityMappingsRequest) returns (Operation) ID マッピング エントリのリストを ID マッピング ストアにインポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 identityMappingStore リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.importIdentityMappings 詳細については、IAM のドキュメントをご覧ください。

ListIdentityMappingStores

rpc ListIdentityMappingStores(ListIdentityMappingStoresRequest) returns (ListIdentityMappingStoresResponse) すべての ID マッピング ストアを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.list 詳細については、IAM のドキュメントをご覧ください。

ListIdentityMappings

rpc ListIdentityMappings(ListIdentityMappingsRequest) returns (ListIdentityMappingsResponse) ID マッピング ストア内の ID マッピングを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 identityMappingStore リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.listIdentityMappings 詳細については、IAM のドキュメントをご覧ください。

PurgeIdentityMappings

rpc PurgeIdentityMappings(PurgeIdentityMappingsRequest) returns (Operation) 指定された ID マッピング エントリまたはすべての ID マッピング エントリを ID マッピング ストアから削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 identityMappingStore リソースに対する次の IAM 権限が必要です。 discoveryengine.identityMappingStores.purgeIdentityMappings 詳細については、IAM のドキュメントをご覧ください。

LicenseConfigService

ライセンス構成関連リソースを管理するサービス。

CreateLicenseConfig
rpc CreateLicenseConfig(CreateLicenseConfigRequest) returns (LicenseConfig) LicenseConfig を作成します 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.licenseConfigs.create 詳細については、IAM のドキュメントをご覧ください。

GetLicenseConfig
rpc GetLicenseConfig(GetLicenseConfigRequest) returns (LicenseConfig) LicenseConfig を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.licenseConfigs.get 詳細については、IAM のドキュメントをご覧ください。

UpdateLicenseConfig
rpc UpdateLicenseConfig(UpdateLicenseConfigRequest) returns (LicenseConfig) LicenseConfig を更新します 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.licenseConfigs.update 詳細については、IAM のドキュメントをご覧ください。

PodcastService

Podcast 構成を管理するためのサービス。

ProjectService

Project のオペレーションを行うためのサービス。

ProvisionProject

rpc ProvisionProject(ProvisionProjectRequest) returns (Operation) プロジェクト リソースをプロビジョニングします。このプロセスでは、関連するシステムが準備され、初期化されます。 呼び出し元は、データ使用に関する条件を読み、必要に応じて、そのサービス条件に同意するリクエストを指定する必要があります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.projects.provision 詳細については、IAM のドキュメントをご覧ください。

RankService

テキスト レコードをランク付けするサービス。

ランク
rpc Rank(RankRequest) returns (RankResponse) 指定された入力クエリに基づいて、テキスト レコードのリストをランク付けします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 rankingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.rankingConfigs.rank 詳細については、IAM のドキュメントをご覧ください。

RecommendationService

レコメンデーションを作成するサービス。

提案
rpc Recommend(RecommendRequest) returns (RecommendResponse) コンテキスト ユーザー イベントを必要とするレコメンデーションを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 servingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.servingConfigs.recommend 詳細については、IAM のドキュメントをご覧ください。

SchemaService

Schema を管理するためのサービス。

CreateSchema
rpc CreateSchema(CreateSchemaRequest) returns (Operation) Schema を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.schemas.create 詳細については、IAM のドキュメントをご覧ください。

DeleteSchema
rpc DeleteSchema(DeleteSchemaRequest) returns (Operation) Schema を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.schemas.delete 詳細については、IAM のドキュメントをご覧ください。

GetSchema
rpc GetSchema(GetSchemaRequest) returns (Schema) Schema を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.schemas.get 詳細については、IAM のドキュメントをご覧ください。

ListSchemas
rpc ListSchemas(ListSchemasRequest) returns (ListSchemasResponse) Schema のリストを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.schemas.list 詳細については、IAM のドキュメントをご覧ください。

UpdateSchema
rpc UpdateSchema(UpdateSchemaRequest) returns (Operation) Schema を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.schemas.update 詳細については、IAM のドキュメントをご覧ください。

SearchService

検索用のサービス。

検索

rpc Search(SearchRequest) returns (SearchResponse) 検索を実行します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 servingConfig リソースに対する次の IAM 権限が必要です。 discoveryengine.servingConfigs.search 詳細については、IAM のドキュメントをご覧ください。

SearchLite

rpc SearchLite(SearchRequest) returns (SearchResponse) 検索を実行します。SearchService.Search メソッドと同様ですが、認証に API キーを使用できるライト バージョンです。OAuth と IAM のチェックは必要ありません。 この方法では、一般公開ウェブサイトの検索のみがサポートされます。公開ウェブサイト検索に関連付けられていないデータストアとエンジンが指定されている場合は、FAILED_PRECONDITION エラーが返されます。 このメソッドを使用すると、認証バックエンドを実装しなくても簡単にオンボーディングできます。ただし、より優れたデータ セキュリティを実現するために、必要な OAuth と IAM チェックを使用して SearchService.Search を使用することを強くおすすめします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。

SearchTuningService

検索チューニング用のサービス。

ListCustomModels
rpc ListCustomModels(ListCustomModelsRequest) returns (ListCustomModelsResponse) すべてのカスタムモデルのリストを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 dataStore リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.listCustomModels 詳細については、IAM のドキュメントをご覧ください。

TrainCustomModel
rpc TrainCustomModel(TrainCustomModelRequest) returns (Operation) カスタムモデルをトレーニングします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 dataStore リソースに対する次の IAM 権限が必要です。 discoveryengine.dataStores.trainCustomModel 詳細については、IAM のドキュメントをご覧ください。

ServingConfigService

ServingConfig に関連するオペレーションのサービス。

UpdateServingConfig

rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) ServingConfig を更新します。 ServingConfig が存在しない場合は NOT_FOUND エラーを返します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.servingConfigs.update 詳細については、IAM のドキュメントをご覧ください。

SessionService

セッションとセッション関連リソースを管理するサービス。

CreateSession

rpc CreateSession(CreateSessionRequest) returns (Session) セッションを作成します。 作成する Session がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.create 詳細については、IAM のドキュメントをご覧ください。

DeleteSession

rpc DeleteSession(DeleteSessionRequest) returns (Empty) セッションを削除します。 削除する Session が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.delete 詳細については、IAM のドキュメントをご覧ください。

GetSession

rpc GetSession(GetSessionRequest) returns (Session) セッションを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.get 詳細については、IAM のドキュメントをご覧ください。

ListSessions

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) 親 DataStore ごとにすべてのセッションを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.list 詳細については、IAM のドキュメントをご覧ください。

UpdateSession

rpc UpdateSession(UpdateSessionRequest) returns (Session) セッションを更新します。 Session アクション タイプは変更できません。更新する Session が存在しない場合は、NOT_FOUND エラーが返されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sessions.update 詳細については、IAM のドキュメントをご覧ください。

SiteSearchEngineService

サイト内検索関連のリソースを管理するサービス。

BatchCreateTargetSites
rpc BatchCreateTargetSites(BatchCreateTargetSitesRequest) returns (Operation) TargetSite をバッチで作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.batchCreate 詳細については、IAM のドキュメントをご覧ください。

BatchVerifyTargetSites

rpc BatchVerifyTargetSites(BatchVerifyTargetSitesRequest) returns (Operation) 対象サイトの所有権と有効性を確認します。この API は、サイト内検索エンジンのすべてのターゲット サイトを検証のために送信します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.batchVerifyTargetSites 詳細については、IAM のドキュメントをご覧ください。

CreateSitemap
rpc CreateSitemap(CreateSitemapRequest) returns (Operation) Sitemap を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sitemaps.create 詳細については、IAM のドキュメントをご覧ください。

CreateTargetSite
rpc CreateTargetSite(CreateTargetSiteRequest) returns (Operation) TargetSite を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.create 詳細については、IAM のドキュメントをご覧ください。

DeleteSitemap
rpc DeleteSitemap(DeleteSitemapRequest) returns (Operation) Sitemap を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.sitemaps.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteTargetSite
rpc DeleteTargetSite(DeleteTargetSiteRequest) returns (Operation) TargetSite を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.delete 詳細については、IAM のドキュメントをご覧ください。

DisableAdvancedSiteSearch

rpc DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest) returns (Operation) 高度なサイト内検索から基本的なサイト内検索にダウングレードします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 siteSearchEngine リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.disableAdvancedSiteSearch 詳細については、IAM のドキュメントをご覧ください。

EnableAdvancedSiteSearch

rpc EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest) returns (Operation) 基本的なサイト内検索から高度なサイト内検索にアップグレードします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 siteSearchEngine リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.enableAdvancedSiteSearch 詳細については、IAM のドキュメントをご覧ください。

FetchDomainVerificationStatus

rpc FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest) returns (FetchDomainVerificationStatusResponse) ドメインの所有権の証明ステータスを含むターゲット サイトのリストを返します。このメソッドは、現時点では BASIC_SITE_SEARCH 状態のデータストアでのみ呼び出すことができます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 siteSearchEngine リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.fetchDomainVerificationStatus 詳細については、IAM のドキュメントをご覧ください。

FetchSitemaps
rpc FetchSitemaps(FetchSitemapsRequest) returns (FetchSitemapsResponse) DataStore で Sitemap を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.sitemaps.fetch 詳細については、IAM のドキュメントをご覧ください。

GetSiteSearchEngine
rpc GetSiteSearchEngine(GetSiteSearchEngineRequest) returns (SiteSearchEngine) SiteSearchEngine を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.get 詳細については、IAM のドキュメントをご覧ください。

GetTargetSite
rpc GetTargetSite(GetTargetSiteRequest) returns (TargetSite) TargetSite を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.get 詳細については、IAM のドキュメントをご覧ください。

ListTargetSites
rpc ListTargetSites(ListTargetSitesRequest) returns (ListTargetSitesResponse) TargetSite のリストを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.list 詳細については、IAM のドキュメントをご覧ください。

RecrawlUris
rpc RecrawlUris(RecrawlUrisRequest) returns (Operation) URI のリストのオンデマンド再クロールをリクエストします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 siteSearchEngine リソースに対する次の IAM 権限が必要です。 discoveryengine.siteSearchEngines.recrawlUris 詳細については、IAM のドキュメントをご覧ください。

UpdateTargetSite
rpc UpdateTargetSite(UpdateTargetSiteRequest) returns (Operation) TargetSite を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 discoveryengine.targetSites.update 詳細については、IAM のドキュメントをご覧ください。

UserEventService

ウェブサイトでのエンドユーザーのアクションを Discovery Engine API に取り込むためのサービス。

CollectUserEvent

rpc CollectUserEvent(CollectUserEventRequest) returns (HttpBody) ブラウザから 1 つのユーザー イベントを書き込みます。こちらは、サードパーティ ドメインに対する POST がブラウザで制限されているため、GET リクエストを使用します。 このメソッドは、Discovery Engine API の JavaScript Pixel と Google タグ マネージャーでのみ使用されます。ユーザーは、このメソッドを直接呼び出す必要はありません。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。

ImportUserEvents

rpc ImportUserEvents(ImportUserEventsRequest) returns (Operation) ユーザー イベントの一括インポート。リクエスト処理は同期される場合があります。すでに存在するイベントはスキップされます。過去のユーザー イベントのバックフィルには、このメソッドを使用します。 Operation.response の型は ImportResponse です。なお、アイテムのサブセットが正常に挿入される場合があります。Operation.metadata の型は ImportMetadata です。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.userEvents.import 詳細については、IAM のドキュメントをご覧ください。

PurgeUserEvents

rpc PurgeUserEvents(PurgeUserEventsRequest) returns (Operation) 特定のフィルタで指定されたすべてのユーザー イベントを完全に削除します。フィルタで指定されたイベントの数によっては、このオペレーションが完了するまでに数時間または数日かかることがあります。フィルタをテストするには、まずリスト コマンドを使用します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.userEvents.purge 詳細については、IAM のドキュメントをご覧ください。

WriteUserEvent

rpc WriteUserEvent(WriteUserEventRequest) returns (UserEvent) 1 つのユーザー イベントを書き込みます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite https://www.googleapis.com/auth/discoveryengine.assist.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.userEvents.create 詳細については、IAM のドキュメントをご覧ください。

UserLicenseService

ユーザー ライセンスを管理するためのサービス。

BatchUpdateUserLicenses

rpc BatchUpdateUserLicenses(BatchUpdateUserLicensesRequest) returns (Operation) ユーザー ライセンスを更新します。このメソッドは、ユーザーにライセンスを一括で割り当てたり、割り当てを解除したりするために使用されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.userStores.batchUpdateUserLicenses 詳細については、IAM のドキュメントをご覧ください。

ListUserLicenses
rpc ListUserLicenses(ListUserLicensesRequest) returns (ListUserLicensesResponse) ユーザー ライセンスを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 discoveryengine.userStores.listUserLicenses 詳細については、IAM のドキュメントをご覧ください。

AclConfig

アクセス制御の構成。

フィールド
name	string 変更不可。ACL 構成の完全なリソース名。形式: projects/{project}/locations/{location}/aclConfig。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
idp_config	IdpConfig ID プロバイダの構成。

ActionConfig

コネクタのアクションをサポートする情報。

フィールド
is_action_configured	bool 出力専用。コネクタには必要なパラメータが含まれており、アクションをサポートするように構成されています。
service_name	string 省略可。DataConnector.params で定義された、データソースの instance_uri への接続に使用される VPC ネットワーク エンドポイントを表す Service Directory リソース名（projects/*/locations/*/namespaces/*/services/*）。 VPC Service Controls が有効な場合は必須です。
use_static_secrets	bool 省略可。コネクタに静的シークレットを使用するかどうか。true の場合、action_params で指定されたシークレットは無視されます。
共用体フィールド action_config_params。アクションをサポートするために必要なパラメータ（Key、Value）ペアの形式。projects/*/[locations/*/]secrets/*/versions/* 形式の文字列値は Secret Manager から読み取られます。 OAUTH をサポートするソース（gmail、google_calendar、jira、workday、salesforce、confluence）の必須パラメータ: キー: client_id 値: STRING 型。アプリケーションを識別するためのサービス プロバイダのクライアント ID。 キー: client_secret 値:型 STRING。アプリケーションの認可サーバーによって生成されたクライアント シークレット。action_config_params は次のいずれかになります。
action_params	Struct 省略可。構造化された JSON 形式のアクション パラメータ。
json_action_params	string 省略可。JSON 文字列形式のアクション パラメータ。

AddContextFileRequest

AssistantService.AddContextFile メソッドのリクエスト。

フィールド
name	string 必須。セッションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} セッション ID として - が指定されている場合、自動生成された ID を持つ新しいセッションが作成されます。
file_name	string 必須。ファイルの名前。
mime_type	string 省略可。ファイルのコンテンツ タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml をご覧ください。 データソースがコンテンツ タイプを提供しない場合、このフィールドは必須です。
共用体フィールド file。ファイルの内容。file は次のいずれかになります。
file_contents	bytes ファイルの内容がインラインで提供されます。

AddContextFileResponse

AssistantService.AddContextFile メソッドに対するレスポンス。

フィールド
session	string セッションの名前（指定された名前または新しく作成された名前）。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
file_id	string アップロードされたファイルの ID。
token_count (deprecated)	int64 この項目は非推奨です。 非推奨: このフィールドはすべてのファイル形式で設定されず、最終的には削除されます。 トークン単位で測定されたファイルの長さ。

AdvancedCompleteQueryRequest

CompletionService.AdvancedCompleteQuery メソッドに対するリクエスト メッセージ。 .

フィールド
completion_config	string 必須。補完が実行される親データストアまたはエンジン リソース名の completion_config（projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig など）。
query	string 必須。候補の取得に使用される予測入力。最大長は 128 文字です。 ほとんどの候補の種類では、クエリを空白にすることはできません。空の場合は、INVALID_ARGUMENT エラーが返されます。例外として、suggestion_types に RECENT_SEARCH 型のみが含まれている場合、クエリは空の文字列にできます。これは「ゼロ接頭辞」機能と呼ばれ、空のクエリを指定すると、ユーザーが最近検索したクエリが返されます。
query_model	string 予測入力クエリモデルを指定します。これは QUERY SuggestionType にのみ適用されます。これにより、Cloud コンソールの [構成] > [予測入力] セクションで指定されたモデルがオーバーライドされます。現在サポートされている値は次のとおりです。 document - ユーザーがインポートしたドキュメントから生成された候補を使用しています。 search-history - SearchService.Search API 呼び出しの過去の履歴から生成された候補を使用します。Search API のトラフィックがない場合は使用しないでください。 user-event - ユーザーがインポートした検索イベントから生成された候補を使用します。 document-completable - 完了可能としてマークされたユーザーがインポートしたドキュメント フィールドから直接取得した候補を使用します。 デフォルト値: document は、通常のデータストアのデフォルトのモデルです。 search-history は、サイト内検索データストアのデフォルトのモデルです。
user_pseudo_id	string 訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。 このフィールドには、unknown_visitor などの固定値は設定しないでください。 これは、UserEvent.user_pseudo_id および SearchRequest.user_pseudo_id と同じ識別子にする必要があります。 このフィールドは、長さの上限が 128 の UTF-8 でエンコードされた文字列にする必要があります。
user_info	UserInfo 省略可。エンドユーザーに関する情報。 これは、UserEvent.user_info および SearchRequest.user_info と同じ識別子情報にする必要があります。
include_tail_suggestions	bool 完全なクエリに一致する候補がない場合に、末尾の候補を返すかどうかを示します。true に設定されている場合でも、クエリ全体に一致する候補がある場合は、それらの候補が返され、末尾の候補は返されません。
boost_spec	BoostSpec 省略可。条件に一致する候補をブーストする仕様。
suggestion_types[]	SuggestionType 省略可。返される候補のタイプ。空または指定されていない場合は、クエリ候補が返されます。現時点では、提案タイプは 1 つのみサポートされています。
suggestion_type_specs[]	SuggestionTypeSpec 省略可。各候補タイプの仕様。
experiment_ids[]	string 省略可。このリクエストのテスト ID。

BoostSpec

候補の条件に基づいて候補をブーストする仕様。

フィールド
condition_boost_specs[]	ConditionBoostSpec 条件ブーストの仕様。提案が仕様の複数の条件に一致する場合、これらの仕様のブースト値はすべて適用され、非線形的に組み合わされます。仕様の最大数は 20 です。 注: 現在は言語条件ブーストのみがサポートされています。

ConditionBoostSpec

ブーストは、条件に一致する候補に適用されます。

フィールド
condition	string ブースト条件を指定する式。構文は、フィルタ式の構文と同じです。現在サポートされている条件は、BCP-47 言語コードのリストのみです。 例: 言語 en または fr の候補をブーストするには: (lang_code: ANY("en", "fr"))
boost	float ブーストの強さ。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0 です。 1.0 に設定すると、提案に強力なプロモーションが設定されます。ただし、上位の検索結果がブーストされた候補になるとは限りません。 -1.0 に設定すると、候補に大幅な降格が適用されます。ただし、関連性の高い他の候補は引き続き表示されることがあります。 0.0 に設定すると、ブーストは適用されません。ブースト条件は無視されます。

SuggestionType

返される候補の種類。

列挙型
SUGGESTION_TYPE_UNSPECIFIED	デフォルト値。
QUERY	クエリの候補を返します。
PEOPLE	ユーザーの候補を返します。
CONTENT	コンテンツの候補を返します。
RECENT_SEARCH	最近の検索候補を返します。
GOOGLE_WORKSPACE	Google Workspace の候補を返します。

SuggestionTypeSpec

各候補タイプの仕様。

フィールド
suggestion_type	SuggestionType 省略可。候補の種類。
max_suggestions	int32 省略可。候補タイプごとに返される候補の最大数。

AdvancedCompleteQueryResponse

CompletionService.AdvancedCompleteQuery メソッドに対するレスポンス メッセージ。

フィールド
query_suggestions[]	QuerySuggestion 一致したクエリ候補の結果。結果リストが並べ替えられ、最初の結果が上位の候補になります。
tail_match_triggered	bool 返された候補がすべて末尾候補である場合は True。 末尾一致をトリガーするには、リクエストの include_tail_suggestions が true であり、クエリ全体と一致する候補がない必要があります。
people_suggestions[]	PersonSuggestion 一致する人物の候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。
content_suggestions[]	ContentSuggestion 関連コンテンツの候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。
recent_search_suggestions[]	RecentSearchSuggestion 一致した「最近の検索」候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。

ContentSuggestion

コンテンツとしての候補。

フィールド
suggestion	string クエリへの候補。
content_type	ContentType コンテンツ候補のタイプ。
document	Document 候補内のドキュメント データ スニペット。入力されるのはフィールドのサブセットのみです。
data_store	string この提案が属する dataStore の名前。
score	double 各候補のスコア。スコアの範囲は [0, 1] です。
icon_uri	string コンテンツ候補のアイコン URI。
destination_uri	string コンテンツ候補の宛先 URI。

ContentType

コンテンツ候補に対して返されるコンテンツのタイプ。

列挙型
CONTENT_TYPE_UNSPECIFIED	デフォルト値。
GOOGLE_WORKSPACE	候補は Google Workspace のソースから提供されています。
THIRD_PARTY	提案がサードパーティのソースからのものである。

PersonSuggestion

人物の候補。

フィールド
suggestion	string クエリへの候補。
person_type	PersonType 人物のタイプ。
document	Document 候補内のドキュメント データ スニペット。フィールドのサブセットのみが入力されます。
data_store	string この提案が属する dataStore の名前。
score	double 各候補のスコア。スコアの範囲は [0, 1] です。
display_photo_uri	string 人物候補の写真の URI。
destination_uri	string ユーザー候補の宛先 URI。

PersonType

ソースに基づく人物のタイプ。

列挙型
PERSON_TYPE_UNSPECIFIED	デフォルト値。
CLOUD_IDENTITY	提案は GOOGLE_IDENTITY ソースからのものです。
THIRD_PARTY_IDENTITY	候補は THIRD_PARTY_IDENTITY ソースからのものです。

QuerySuggestion

検索クエリとしての候補。

フィールド
suggestion	string クエリへの候補。
completable_field_paths[]	string 補完可能なフィールドから生成された場合、この候補のソースとなる一意のドキュメント フィールド パス。 このフィールドは、ドキュメント補完可能なモデルに対してのみ入力されます。
data_store[]	string この提案が属する dataStore の名前。
score	double 各候補のスコア。スコアの範囲は [0, 1] です。

RecentSearchSuggestion

最近の検索履歴に基づく候補。

フィールド
suggestion	string クエリへの候補。
recent_search_time	Timestamp 最近の再検索が発生した時刻。
score	double 各候補のスコア。スコアの範囲は [0, 1] です。

AdvancedSiteSearchConfig

高度なサイト内検索の構成データ。

フィールド
disable_initial_index	bool true に設定すると、DataStore の初期インデックス作成が無効になります。
disable_automatic_refresh	bool true に設定すると、DataStore の自動更新が無効になります。

AlertPolicyConfig

コネクタレベルのアラート構成。

フィールド
alert_policy_name	string 変更不可。AlertPolicy の完全修飾リソース名。
alert_enrollments[]	AlertEnrollment 省略可。各アラートの登録状態。

AlertEnrollment

アラートの登録ステータス。

フィールド
alert_id	string 変更不可。アラートの ID。
enroll_state	EnrollStates 必須。お客様の登録ステータス。

EnrollStates

アラートの登録ステータスの列挙型。

列挙型
ENROLL_STATES_UNSPECIFIED	デフォルト値。アラート ポリシーに応答していないお客様に使用されます。
ENROLLED	お客様はこのポリシーに登録されています。
DECLINED	お客様がこのポリシーを拒否しました。

AlertPolicyResourceConfig

リソースレベルのアラート構成。使用場所: * UserLicense * EngineUserData データコネクタの AlertPolicyConfig も同じ用途で使用されます。移行を簡単に行う方法がない。

フィールド
alert_policy	string 変更不可。AlertPolicy の完全修飾リソース名。
alert_enrollments[]	AlertEnrollment 省略可。各アラートの登録状態。
contact_details[]	ContactDetails 省略可。各アラート ポリシーの連絡先情報。
language_code	string 省略可。通知に使用される言語コード

AlertEnrollment

アラートの登録ステータス。

フィールド
alert_id	string 変更不可。アラートの ID。
enroll_state	EnrollState 必須。お客様の登録ステータス。
notification_params	map<string, string> 省略可。通知のインスタンス化に使用されるパラメータ。登録時にトリガーされる通知に使用されます。保存されません。* Gemini Business のウェルカム メール。* Gemini Business ユーザーの招待メール。

EnrollState

アラートの登録ステータスの列挙型。

列挙型
ENROLL_STATE_UNSPECIFIED	デフォルト値。アラート ポリシーに応答していないお客様に使用されます。
ENROLLED	お客様はこのポリシーに登録されています。
DECLINED	お客様がこのポリシーを拒否しました。

AlloyDbSource

AlloyDB ソースのインポート元データ。

フィールド
project_id	string AlloyDB ソースを含むプロジェクト ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
location_id	string 必須。データのコピー元となる AlloyDB のロケーション。長さは 256 文字に制限されています。
cluster_id	string 必須。データのコピー元となる AlloyDB クラスタ。長さ制限は 256 文字です。
database_id	string 必須。データのコピー元となる AlloyDB データベース。長さは 256 文字に制限されています。
table_id	string 必須。データのコピー元となる AlloyDB テーブル。長さは 256 文字までに制限されています。
gcs_staging_dir	string インポート時に一時的に使用される Cloud Storage ディレクトリ。長さの上限は 2,000 文字です。AlloyDB のエクスポート先を特定の Cloud Storage ディレクトリにする場合に指定できます。 AlloyDB サービス アカウントに、指定された Cloud Storage ディレクトリにアクセスするために必要な Cloud Storage 管理者の権限があることを確認します。

回答

回答を定義します。

フィールド
name	string 変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state	State 回答生成の状態。
answer_text	string テキスト形式の回答。
citations[]	Citation 引用。
grounding_supports[]	GroundingSupport 省略可。グラウンディングをサポートします。
references[]	Reference 参照。
related_questions[]	string 関連する質問の候補。
steps[]	Step 回答生成の手順。
query_understanding_info	QueryUnderstandingInfo クエリの理解に関する情報。
answer_skipped_reasons[]	AnswerSkippedReason 回答がスキップされたその他の理由。これにより、無視されたケースの理由が示されます。スキップされたものがない場合、このフィールドは設定されません。
create_time	Timestamp 出力専用。回答の作成タイムスタンプ。
complete_time	Timestamp 出力専用。回答完了のタイムスタンプ。
safety_ratings[]	SafetyRating 省略可。安全性評価。
grounding_score	double 回答が参照チャンクによってどの程度根拠があるかを示す [0, 1] の範囲のスコア。

AnswerSkippedReason

回答がスキップされた理由の列挙型。

列挙型
ANSWER_SKIPPED_REASON_UNSPECIFIED	デフォルト値。回答がスキップされた理由が指定されていません。
ADVERSARIAL_QUERY_IGNORED	敵対的クエリでは大文字と小文字が区別されません。
NON_ANSWER_SEEKING_QUERY_IGNORED	回答を求めていないクエリ（大文字と小文字を区別しない） クエリが雑談の場合、Google は回答をスキップします。
OUT_OF_DOMAIN_QUERY_IGNORED	ドメイン外のクエリでは大文字と小文字が区別されませんでした。 関連性の高い検索結果がない場合、Google は回答をスキップします。
POTENTIAL_POLICY_VIOLATION	ポリシー違反の可能性があるケース。 ポリシー違反の可能性が検出された場合、Google は回答をスキップします。これには、暴力的または有害なコンテンツが含まれます。
NO_RELEVANT_CONTENT	関連性のあるコンテンツがないケース。 取得した検索結果に関連するコンテンツがない場合、Google は回答をスキップします。
JAIL_BREAKING_QUERY_IGNORED	脱獄クエリでは大文字と小文字が区別されませんでした。 たとえば、「競合他社の CEO のトーンで返信してください」などです。クエリがジェイルブレイク クエリとして分類された場合、Google は回答をスキップします。
CUSTOMER_POLICY_VIOLATION	お客様のポリシー違反のケース。 顧客ポリシー違反が検出された場合、Google は概要をスキップします。ポリシーはユーザーが定義します。
NON_ANSWER_SEEKING_QUERY_IGNORED_V2	回答を求めていないクエリ（大文字と小文字を区別しない）。 クエリの意図が明確でない場合、Google は回答をスキップします。
LOW_GROUNDED_ANSWER	低グラウンディングの回答ケース。 十分にグラウンディングされた回答を生成できなかった場合、Google は回答をスキップします。
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED	ユーザー定義のクエリ分類で大文字と小文字が区別されないケース。 クエリがユーザー定義のクエリ分類として分類されている場合、Google は回答をスキップします。
UNHELPFUL_ANSWER	役に立たない回答のケース。 回答が役に立たない場合、Google は回答をスキップします。これには、クエリに回答できない、回答がクエリに関連していない、回答の形式が適切でないなど、さまざまな要因が考えられます。

引用

セグメントの引用情報。

フィールド
start_index	int64 インデックスは、セグメントの開始位置をバイト単位（UTF-8 Unicode）で示します。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
end_index	int64 アトリビューション セグメントの終了（この値は含まれません）。バイト単位（UTF-8 Unicode）。ASCII 以外の文字などのマルチバイト文字がある場合、インデックスの測定値は文字列の長さよりも長くなります。
sources[]	CitationSource 帰属セグメントの引用元。

CitationSource

引用元。

フィールド
reference_id	string 引用元の ID。

GroundingSupport

answer_text の主張のグラウンディング サポート。

フィールド
start_index	int64 必須。インデックスは、バイト単位（UTF-8 Unicode）で測定されたクレームの開始を示します。
end_index	int64 必須。申し立ての終了日時（この日時を含まない）。
sources[]	CitationSource 省略可。クレームの引用元。
grounding_score	double 特定の主張が参照によってどの程度根拠があるかを示す [0, 1] の範囲のスコア。値が大きいほど、参照チャンクによって主張がより適切にサポートされていることを意味します。
grounding_check_required	bool この主張でグラウンディング チェックが必要だったことを示します。この主張には帰属/グラウンディング チェックが必要ないとシステムが判断した場合、このフィールドは false に設定されます。この場合、クレームの根拠チェックは行われないため、grounding_score、sources は返されません。

QueryUnderstandingInfo

クエリの理解に関する情報。

フィールド
query_classification_info[]	QueryClassificationInfo クエリの分類情報を取得します。

QueryClassificationInfo

クエリの分類情報を取得します。

フィールド
type	Type クエリ分類タイプ。
positive	bool 分類の出力。

タイプ

クエリ分類タイプ。

列挙型
TYPE_UNSPECIFIED	クエリ分類タイプが指定されていません。
ADVERSARIAL_QUERY	敵対的なクエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY	雑談用の回答を求めていないクエリの分類タイプ。
JAIL_BREAKING_QUERY	脱獄クエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY_V2	明確な意図がない場合の、回答を求めていないクエリの分類タイプ。
USER_DEFINED_CLASSIFICATION_QUERY	ユーザー定義のクエリ分類タイプ。

リファレンス

リファレンス。

フィールド
共用体フィールド content。検索結果のコンテンツ。content は次のいずれかになります。
unstructured_document_info	UnstructuredDocumentInfo 非構造化ドキュメント情報。
chunk_info	ChunkInfo チャンク情報。
structured_document_info	StructuredDocumentInfo 構造化されたドキュメント情報。

ChunkInfo

チャンク情報。

フィールド
chunk	string チャンク リソース名。
content	string テキスト コンテンツをチャンク化します。
document_metadata	DocumentMetadata ドキュメントのメタデータ。
relevance_score	float 特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に適切）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクでいつでも変更される可能性があります。

DocumentMetadata

ドキュメントのメタデータ。

フィールド
document	string ドキュメントのリソース名。
uri	string ドキュメントの URI。
title	string 特徴があります
page_identifier	string ページ ID。
struct_data	Struct ドキュメントの構造化された JSON メタデータ。検索結果のチャンクの構造化データから入力されます。

StructuredDocumentInfo

構造化検索情報。

フィールド
document	string ドキュメントのリソース名。
struct_data	Struct 構造化された検索データ。
title	string 出力専用。ドキュメントのタイトル。
uri	string 出力専用。ドキュメントの URI。

UnstructuredDocumentInfo

非構造化ドキュメント情報。

フィールド
document	string ドキュメントのリソース名。
uri	string ドキュメントの URI。
title	string 特徴があります
chunk_contents[]	ChunkContent ドキュメント コンテンツから派生した引用チャンク コンテンツのリスト。
struct_data	Struct ドキュメントの構造化された JSON メタデータ。検索結果のチャンクの構造化データから入力されます。

ChunkContent

コンテンツをチャンク化します。

フィールド
content	string テキスト コンテンツをチャンク化します。
page_identifier	string ページ ID。
relevance_score	float 特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に適切）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクでいつでも変更される可能性があります。

状態

回答生成の状態の列挙型。

列挙型
STATE_UNSPECIFIED	不明。
IN_PROGRESS	回答の生成が進行中です。
FAILED	現在、回答の生成に失敗しています。
SUCCEEDED	回答の生成が成功しました。
STREAMING	回答の生成が進行中です。

ステップ

ステップ情報。

フィールド
state	State ステップの状態。
description	string ステップの説明。
thought	string ステップの考え。
actions[]	Action アクション。

アクション

アクション。

フィールド
observation	Observation 観察結果。
共用体フィールド action。アクション。action は次のいずれかになります。
search_action	SearchAction 検索アクション。

観察

観察結果。

フィールド
search_results[]	SearchResult 検索アクションで取得された検索結果。ユーザーが設定した引用タイプに応じて、スニペット情報またはチャンク情報になります。

SearchResult

フィールド
document	string ドキュメントのリソース名。
uri	string ドキュメントの URI。
title	string 特徴があります
snippet_info[]	SnippetInfo citation_type が DOCUMENT_LEVEL_CITATION の場合は、ドキュメント レベルのスニペットを入力します。
chunk_info[]	ChunkInfo citation_type が CHUNK_LEVEL_CITATION で、チャンクモードがオンの場合は、チャンク情報を入力します。
struct_data	Struct データ表現。ドキュメントの構造化 JSON データ。これは、ドキュメントの構造体データ、または検索結果のチャンクから入力されます。

ChunkInfo

チャンク情報。

フィールド
chunk	string チャンク リソース名。
content	string テキスト コンテンツをチャンク化します。
relevance_score	float 特定のクエリに対するチャンクの関連性。値の範囲は、0.0（完全に無関係）から 1.0（完全に適切）です。この値は情報提供のみを目的としています。この値は、モデルの再トレーニングや実装の変更により、同じクエリとチャンクでいつでも変更される可能性があります。

SnippetInfo

スニペット情報。

フィールド
snippet	string スニペットのコンテンツ。
snippet_status	string 検索チームによって定義されたスニペットのステータス。

SearchAction

検索アクション。

フィールド
query	string 検索するクエリ。

状態

ステップの状態の列挙。

列挙型
STATE_UNSPECIFIED	不明。
IN_PROGRESS	ステップは現在進行中です。
FAILED	ステップが現在失敗しています。
SUCCEEDED	ステップが成功しました。

AnswerGenerationSpec

回答生成の仕様。

フィールド
user_defined_classifier_spec	UserDefinedClassifierSpec 省略可。ユーザー指定の分類子仕様の仕様。

UserDefinedClassifierSpec

ユーザー定義の分類子の仕様。

フィールド
enable_user_defined_classifier	bool 省略可。ユーザー定義の分類子を有効にして含めるかどうか。
preamble	string 省略可。ユーザー定義の分類子に使用する前文。
model_id	string 省略可。ユーザー定義の分類子に使用するモデル ID。
task_marker	string 省略可。ユーザー定義の分類子に使用するタスク マーカー。
top_p	double 省略可。ユーザー定義の分類子に使用する top-p 値。
top_k	int64 省略可。ユーザー定義の分類子に使用する上位 k の値。
temperature	double 省略可。ユーザー定義の分類子に使用する温度値。
seed	int32 省略可。ユーザー定義の分類子に使用されるシード値。

AnswerQueryRequest

ConversationalSearchService.AnswerQuery メソッドに対するリクエスト メッセージ。

フィールド
serving_config	string 必須。検索サービス構成のリソース名（projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config、projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config など）。このフィールドは、検索に使用されるサービス構成名とモデルのセットを識別するために使用されます。
query	Query 必須。現在のユーザークエリ。
session	string セッション リソース名。不要。 セッション フィールドが設定されていない場合、API はセッションレス モードになります。 自動セッション モードがサポートされています。ユーザーはワイルドカード記号 - をセッション ID として使用できます。新しい ID が自動的に生成され、割り当てられます。
safety_spec	SafetySpec モデル仕様。
related_questions_spec	RelatedQuestionsSpec 関連する質問の仕様。
grounding_spec	GroundingSpec 省略可。グラウンディングの仕様。
answer_generation_spec	AnswerGenerationSpec 回答生成の仕様。
search_spec	SearchSpec 検索の仕様。
query_understanding_spec	QueryUnderstandingSpec クエリの理解の仕様。
asynchronous_mode (deprecated)	bool この項目は非推奨です。 非推奨: このフィールドは非推奨になりました。Streaming Answer API がサポートされます。 非同期モード制御。 有効にすると、最終的な回答なしで回答/セッション リソース名を含むレスポンスが返されます。API ユーザーは、ConversationalSearchService.GetAnswer メソッドまたは ConversationalSearchService.GetSession メソッドを呼び出して、回答/セッションの最新のステータスを取得するためにポーリングを行う必要があります。
user_pseudo_id	string 訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。 このフィールドには、unknown_visitor などの固定値は設定しないでください。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳細については、Google Cloud ドキュメントをご覧ください。
end_user_spec	EndUserSpec 省略可。エンドユーザーの仕様。

AnswerGenerationSpec

回答生成の仕様。

フィールド
model_spec	ModelSpec 回答生成モデルの仕様。
prompt_spec	PromptSpec 回答生成プロンプトの仕様。
include_citations	bool 回答に引用メタデータを含めるかどうかを指定します。デフォルト値は false です。
answer_language_code	string 回答の言語コード。BCP47 で定義されている言語タグを使用します。注: これは試験運用版の機能です。
ignore_adversarial_query	bool 敵対的クエリをフィルタリングするかどうかを指定します。デフォルト値は false です。 Google では、検索クエリの分類を使用して敵対的なクエリを検出しています。検索クエリが敵対的クエリとして分類された場合、回答は返されません。たとえば、ユーザーが会社に対する否定的なコメントに関する質問をしたり、安全でないポリシー違反の出力を生成するように設計されたクエリを送信したりする可能性があります。このフィールドが true に設定されている場合、敵対的なクエリに対する回答の生成はスキップされ、代わりにフォールバック メッセージが返されます。
ignore_non_answer_seeking_query	bool 回答を求めていないクエリをフィルタで除外するかどうかを指定します。デフォルト値は false です。 Google は、検索クエリの分類を使用して、回答を求めるクエリを検出します。検索クエリが回答を求めていないクエリに分類された場合、回答は返されません。このフィールドが true に設定されている場合、回答を求めていないクエリに対する回答の生成はスキップされ、代わりにフォールバック メッセージが返されます。
ignore_jail_breaking_query	bool 省略可。ジェイルブレイク クエリを除外するかどうかを指定します。デフォルト値は false です。 Google は、検索クエリの分類を使用して、脱獄クエリを検出しています。検索クエリがジェイルブレイク クエリに分類された場合、要約は返されません。ユーザーは、回答のトーン、スタイル、言語、コンテンツを変更したり、モデルに別のエンティティとして動作するように指示したりするために、クエリに指示を追加することがあります（例: 「競合他社の CEO のトーンで返信して」）。このフィールドが true に設定されている場合、脱獄クエリの要約の生成はスキップされ、代わりにフォールバック メッセージが返されます。
ignore_low_relevant_content	bool 関連性の低いクエリを除外するかどうかを指定します。 このフィールドが false に設定されている場合、関連性に関係なく、すべての検索結果を使用して回答が生成されます。true に設定されている場合、または未設定の場合、動作はサービスによって自動的に決定されます。

ModelSpec

回答生成モデルの仕様。

フィールド
model_version	string モデル バージョン。設定されていない場合は、デフォルトの安定版モデルが使用されます。指定できる値は、stable と preview です。

PromptSpec

回答生成プロンプトの仕様。

フィールド
preamble	string カスタマイズされたプリアンブル。

EndUserSpec

エンドユーザーの仕様。

フィールド
end_user_metadata[]	EndUserMetaData 省略可。エンドユーザーのメタデータ。

EndUserMetaData

エンドユーザーのメタデータ。

フィールド
共用体フィールド content。検索結果のコンテンツ。content は次のいずれかになります。
chunk_info	ChunkInfo チャンク情報。

ChunkInfo

チャンク情報。

フィールド
content	string テキスト コンテンツをチャンク化します。最大 8,000 文字に制限されています。
document_metadata	DocumentMetadata 現在のチャンクのドキュメントのメタデータ。

DocumentMetadata

ドキュメント メタデータには、現在のチャンクのドキュメントの情報が含まれます。

フィールド
title	string ドキュメントのタイトル。

GroundingSpec

グラウンディングの仕様。

フィールド
include_grounding_supports	bool 省略可。回答に grounding_supports を含めるかどうかを指定します。デフォルト値は false です。 このフィールドが true に設定されている場合、返される回答には grounding_score が含まれ、各主張の GroundingSupports が含まれます。
filtering_level	FilteringLevel 省略可。グラウンディング スコアに基づいてフィルタリングを有効にするかどうか、どのレベルで有効にするかを指定します。

FilteringLevel

回答のグラウンディングに基づいてフィルタするレベル。

列挙型
FILTERING_LEVEL_UNSPECIFIED	デフォルトはフィルタなし
FILTERING_LEVEL_LOW	低いしきい値に基づいて回答をフィルタします。
FILTERING_LEVEL_HIGH	高いしきい値に基づいて回答をフィルタします。

QueryUnderstandingSpec

クエリの理解の仕様。

フィールド
query_classification_spec	QueryClassificationSpec クエリ分類の仕様。
query_rephraser_spec	QueryRephraserSpec クエリの言い換えツールの仕様。
disable_spell_correction	bool 省略可。スペル修正を無効にするかどうか。デフォルト値は false です。

QueryClassificationSpec

クエリ分類の仕様。

フィールド
types[]	Type 有効なクエリ分類タイプ。

タイプ

クエリ分類タイプ。

列挙型
TYPE_UNSPECIFIED	クエリ分類タイプが指定されていません。
ADVERSARIAL_QUERY	敵対的なクエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY	雑談用の回答を求めていないクエリの分類タイプ。
JAIL_BREAKING_QUERY	脱獄クエリの分類タイプ。
NON_ANSWER_SEEKING_QUERY_V2	明確な意図がない場合の、回答を求めていないクエリの分類タイプ。
USER_DEFINED_CLASSIFICATION_QUERY	ユーザー定義のクエリ分類タイプ。

QueryRephraserSpec

クエリの言い換えツールの仕様。

フィールド
disable	bool クエリの言い換えを無効にします。
max_rephrase_steps	int32 言い換えステップの最大数。最大ステップ数は 5 です。設定されていない場合、または 1 未満に設定されている場合は、デフォルトで 1 に設定されます。
model_spec	ModelSpec 省略可。クエリ言い換えモデルの仕様。

ModelSpec

クエリ言い換えモデルの仕様。

フィールド
model_type	ModelType 省略可。クエリの言い換えモデルタイプを有効にしました。設定しない場合、デフォルトで LARGE が使用されます。

ModelType

クエリの言い換えの種類。現在、シングルホップ（max_rephrase_steps = 1）モデルの選択のみがサポートされています。マルチホップ（max_rephrase_steps > 1）の場合、デフォルト モデルは 1 つだけです。

列挙型
MODEL_TYPE_UNSPECIFIED	モデルタイプが指定されていません。
SMALL	小規模なクエリ言い換えモデル。Gemini 1.0 XS モデル。
LARGE	大規模なクエリの言い換えモデル。Gemini 1.0 Pro モデル。

RelatedQuestionsSpec

関連する質問の仕様。

フィールド
enable	bool true の場合、関連する質問機能を有効にします。

SafetySpec

安全性に関する仕様。ユースケースは 2 つあります。1. safety_spec.enable のみが設定されている場合、すべてのカテゴリに BLOCK_LOW_AND_ABOVE しきい値が適用されます。2. safety_spec.enable が設定され、一部の safety_settings が設定されている場合、指定された safety_settings のみが適用されます。

フィールド
enable	bool 回答レスポンスで安全フィルタリングを有効にします。デフォルトでは false です。
safety_settings[]	SafetySetting 省略可。安全性設定。この設定は、safety_spec.enable が true の場合にのみ有効です。

SafetySetting

安全性設定。

フィールド
category	HarmCategory 必須。有害カテゴリ。
threshold	HarmBlockThreshold 必須。有害なコンテンツのブロックしきい値。

HarmBlockThreshold

ブロックの確率ベースのしきい値レベル。

列挙型
HARM_BLOCK_THRESHOLD_UNSPECIFIED	有害ブロックのしきい値が指定されていません。
BLOCK_LOW_AND_ABOVE	低いしきい値以上をブロックします（つまり、より多くのものをブロックします）。
BLOCK_MEDIUM_AND_ABOVE	中程度のしきい値以上をブロックします。
BLOCK_ONLY_HIGH	高しきい値のみをブロックします（つまり、ブロックを少なくします）。
BLOCK_NONE	ブロックなし。
OFF	安全フィルタをオフにします。

SearchSpec

検索の仕様。

フィールド
共用体フィールド input。検索動作を制御する検索パラメータ。または、検索結果のリストを提供して回答を生成します。input は次のいずれかになります。
search_params	SearchParams 検索パラメータ。
search_result_list	SearchResultList 検索結果のリスト。

SearchParams

検索パラメータ。

フィールド
max_return_results	int32 返す検索結果の数。デフォルト値は 10 です。
filter	string フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。これは検索結果をフィルタリングするために使用され、回答のレスポンスに影響する可能性があります。 このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。 Vertex AI Search でのフィルタリングは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキー プロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマには「name」というフィールドがある場合があります。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。 構文やフィルタ オペレータなどのフィルタリングの詳細については、フィルタをご覧ください。
boost_spec	BoostSpec 検索結果で特定のドキュメントをブーストするブースト仕様。これにより、回答クエリ レスポンスに影響する可能性があります。ブーストの詳細については、ブーストをご覧ください。
order_by	string ドキュメントが返される順序。ドキュメントは、Document オブジェクトのフィールドで並べ替えることができます。関連性で並べ替える場合は、設定しないままにします。order_by 式では大文字と小文字が区別されます。順序指定の詳細については、順序指定をご覧ください。 このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。
search_result_mode	SearchResultMode 検索結果モードを指定します。指定しない場合、検索結果モードはデフォルトで DOCUMENTS になります。ドキュメントを解析してチャンクするをご覧ください。
data_store_specs[]	DataStoreSpec 検索呼び出しでフィルタする dataStore を定義する仕様と、それらの dataStore の構成。これは、複数のデータストアを使用するユースケースのエンジンでのみ考慮されます。エンジン内の単一のデータストアの場合、最上位の仕様を使用する必要があります。

SearchResultList

検索結果のリスト。

フィールド
search_results[]	SearchResult 検索結果。

SearchResult

検索結果。

フィールド
共用体フィールド content。検索結果のコンテンツ。content は次のいずれかになります。
unstructured_document_info	UnstructuredDocumentInfo 非構造化ドキュメント情報。
chunk_info	ChunkInfo チャンク情報。

ChunkInfo

チャンク情報。

フィールド
chunk	string チャンク リソース名。
content	string テキスト コンテンツをチャンク化します。
document_metadata	DocumentMetadata 現在のチャンクのドキュメントのメタデータ。

DocumentMetadata

ドキュメント メタデータには、現在のチャンクのドキュメントの情報が含まれます。

フィールド
uri	string ドキュメントの URI。
title	string ドキュメントのタイトル。

UnstructuredDocumentInfo

非構造化ドキュメント情報。

フィールド
document	string ドキュメントのリソース名。
uri	string ドキュメントの URI。
title	string 特徴があります
document_contexts[]	DocumentContext ドキュメント コンテキストのリスト。このコンテンツは回答の生成に使用されます。これは、長くて包括的なドキュメントのメイン コンテンツになるはずです。
extractive_segments[]	ExtractiveSegment 抽出セグメントのリスト。
extractive_answers[] (deprecated)	ExtractiveAnswer この項目は非推奨です。 非推奨: このフィールドは非推奨であり、回答の生成には影響しません。document_contexts フィールドと extractive_segments フィールドを使用してください。抽出回答のリスト。

DocumentContext

ドキュメントのコンテキスト。

フィールド
page_identifier	string ページ ID。
content	string 回答の生成に使用するドキュメントのコンテンツ。

ExtractiveAnswer

抽出回答。ガイド

フィールド
page_identifier	string ページ ID。
content	string 抽出回答の内容。

ExtractiveSegment

抽出セグメント。ガイド: document_contexts が空の場合にのみ使用されます。これは短いスニペットを想定しています。

フィールド
page_identifier	string ページ ID。
content	string 抽出セグメントのコンテンツ。

AnswerQueryResponse

ConversationalSearchService.AnswerQuery メソッドに対するレスポンス メッセージ。

フィールド
answer	Answer 回答リソース オブジェクト。AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps が 1 より大きい場合は、Answer.name を使用して ConversationalSearchService.GetAnswer API で回答情報を取得します。
session	Session セッション リソース オブジェクト。これは、AnswerQueryRequest リクエストでセッション フィールドが設定され、有効な場合にのみ使用できます。
answer_query_token	string ロギングに使用されるグローバル一意 ID。

AssistAnswer

AssistAnswer リソース。AssistResponse のメイン部分。

フィールド
name	string 変更不可。ID。AssistAnswer のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer} このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
state	State 回答生成の状態。
replies[]	Reply アシスタントの返信。
assist_skipped_reasons[]	AssistSkippedReason アシスト通話に応答しなかった理由。
customer_policy_enforcement_result	CustomerPolicyEnforcementResult 省略可。このフィールドには、禁止フレーズや Model Armor チェックなど、さまざまなポリシー チェックの結果に関する情報が含まれています。このフィールドは、ポリシー違反が原因でアシスト通話がスキップされた場合にのみ入力されます。

AssistSkippedReason

アシスト通話に応答しない理由として考えられること。

列挙型
ASSIST_SKIPPED_REASON_UNSPECIFIED	デフォルト値。スキップの理由が指定されていません。
NON_ASSIST_SEEKING_QUERY_IGNORED	アシスタントは、回答を求める質問ではないと判断したため、クエリを無視しました。
CUSTOMER_POLICY_VIOLATION	アシスタントが、顧客ポリシー違反（クエリまたは回答に禁止されているフレーズが含まれているなど）を理由にクエリを無視したか、回答を拒否した。

CustomerPolicyEnforcementResult

お客様のポリシー適用結果。禁止フレーズや Model Armor チェックなど、さまざまなポリシー チェックの結果が含まれます。

フィールド
verdict	Verdict お客様のポリシー違反に対する措置の最終的な判断。処理をブロックしたポリシーが 1 つだけの場合、判定は BLOCK になります。
policy_results[]	PolicyEnforcementResult お客様のポリシー適用結果。アシスト通話がポリシー違反によりスキップされた場合にのみ設定されます。クエリの処理をブロックしたフィルタの結果が含まれています。

BannedPhraseEnforcementResult

禁止フレーズ ポリシーに対するお客様のポリシー適用結果。

フィールド
banned_phrases[]	string クエリまたは回答で見つかった禁止フレーズ。

ModelArmorEnforcementResult

Model Armor ポリシーの顧客ポリシー適用結果。

フィールド
共用体フィールド result。Model Armor ポリシーの結果。result は次のいずれかになります。
model_armor_violation	string 検出された Model Armor の違反。
error	Status なんらかの理由でポリシーの適用が失敗した場合に Model Armor から返されるエラー。

PolicyEnforcementResult

単一のポリシータイプの顧客ポリシーの適用結果。

フィールド
共用体フィールド enforcement_result。ポリシー タイプ固有の結果。エラーまたはポリシー違反の結果に関する詳細情報が表示されます。enforcement_result は次のいずれかになります。
banned_phrase_enforcement_result	BannedPhraseEnforcementResult 禁止フレーズ ポリシーのポリシー適用結果。
model_armor_enforcement_result	ModelArmorEnforcementResult Model Armor ポリシーのポリシー適用結果。

判定

お客様のポリシー違反に対する措置の判断。

列挙型
UNSPECIFIED	不明な値。
ALLOW	ポリシー違反はありませんでした。
BLOCK	お客様のポリシーによって処理がブロックされました。

返信

アシストコールのマルチパート レスポンスの一部。

フィールド
共用体フィールド reply。アシスタントの回答の代替案。reply は次のいずれかになります。
grounded_content	AssistantGroundedContent アシスタントからのグラウンディングされたレスポンス テキストまたはメディア。

状態

回答生成の状態。

列挙型
STATE_UNSPECIFIED	不明。
IN_PROGRESS	アシスト オペレーションが現在進行中です。
FAILED	アシスト操作に失敗しました。
SUCCEEDED	アシスト オペレーションが成功しました。
SKIPPED	アシスト オペレーションがスキップされました。

AssistRequest

AssistantService.Assist メソッドのリクエスト。

フィールド
name	string 必須。Assistant のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
query	Query 省略可。現在のユーザークエリ。 空のクエリは、file_ids が指定されている場合にのみサポートされます。この場合、回答はこれらのコンテキスト ファイルに基づいて生成されます。
session	string 省略可。リクエストに使用するセッション。指定した場合、アシスタントはセッション履歴にアクセスでき、クエリと回答がそこに保存されます。 セッション ID として - が指定されている場合、または空のままになっている場合は、自動生成された ID を持つ新しいセッションが作成されます。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assist_skipping_mode	AssistSkippingMode 省略可。アシスタントがクエリに回答しないケースを決定します。回答がスキップされた場合、理由は AssistResponse.answer 内の AssistAnswer.assist_skipped_reasons にリストされます。
file_ids[]	string 省略可。リクエストへの回答に使用するファイルの ID。ファイルをアップロードすると、その ID が AddContextFileResponse.file_id で返されます。
user_metadata	AssistUserMetadata 省略可。クエリを開始したユーザーに関する情報。

AssistSkippingMode

アシスト リクエストで使用可能なスキップ動作。

列挙型
ASSIST_SKIPPING_MODE_UNSPECIFIED	デフォルト値。クエリがサポートを求めていない場合は、回答をスキップできます。
REQUEST_ASSIST	アシスタントの回答をリクエストします。クエリがポリシー チェックに失敗した場合、回答はスキップされることがあります。

AssistResponse

AssistantService.Assist メソッドに対するレスポンス。

フィールド
answer	AssistAnswer クエリに対するレスポンスで生成された AssistAnswer リソース。
session_info	SessionInfo セッション情報。
assist_token	string 現在のリクエストとレスポンスのペアを識別するグローバル一意の ID。フィードバックとサポートに使用されます。

SessionInfo

セッションに関する情報。

フィールド
session	string 新たに生成されたセッションまたは継続されたセッションの名前。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
query_id	string このアシスト API 呼び出しに対応するクエリ ID。1 つのセッションに複数のターンを含めることができ、各ターンには一意のクエリ ID があります。 Assist API 呼び出しでセッション名とこのクエリ ID を指定すると、この検索呼び出しの検索結果のコンテキストでアシスト リクエストが発生します。

AssistUserMetadata

リクエストのユーザー メタデータ。

フィールド
time_zone	string 省略可。IANA タイムゾーン（例: Europe/Budapest）。
preferred_language_code	string 省略可。言語検出に失敗した場合に回答に使用する優先言語。言語検出の結果にかかわらず、アクションによって作成されたエラー メッセージの言語としても使用されます。

アシスタント

Discovery Engine Assistant リソース。

フィールド
name	string 変更不可。アシスタントのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
display_name	string 必須。アシスタントの表示名。 長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。
description	string 省略可。追加情報の説明。アシスタントのユーザーではなく、構成 UI に表示されることが想定されています。
generation_config	GenerationConfig 省略可。アシスタントの回答の生成に関する構成。
google_search_grounding_enabled (deprecated)	bool この項目は非推奨です。 省略可。非推奨。web_grounding_type を代わりに使用してください。
web_grounding_type	WebGroundingType 省略可。使用するウェブ グラウンディングのタイプ。
enabled_actions (deprecated)	map<string, ActionList> この項目は非推奨です。 省略可。非推奨: 代わりに enabled_tools に置き換えられます。このアシスタントで有効になっているアクション。キーはコネクタ名（projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector など）です。値は、コネクタ インスタンスに対して管理者が有効にしたアクションで構成されます。管理者は、プロジェクトで作成したコネクタ インスタンスで複数のアクションを選択的に有効にできます。例: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabled_tools	map<string, ToolList> 省略可。注: まだ実装されていません。代わりに enabled_actions を使用してください。 このアシスタントで有効になっているツール。キーはコネクタ名（projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector など）です。値は、コネクタ インスタンスに対して管理者が有効にしたツールで構成されます。管理者は、プロジェクトで作成したコネクタ インスタンスで複数のツールを選択的に有効にできます。例: {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customer_policy	CustomerPolicy 省略可。アシスタントの顧客ポリシー。

ActionInfo

この項目は非推奨です。

非推奨: 代わりに ToolInfo に置き換えられます。アクションを識別するための情報。

フィールド
action_name	string DataConnectorService.QueryAvailableActions で定義されているアクションの名前。
action_display_name	string アクションの表示名。

ActionList

この項目は非推奨です。

非推奨: 代わりに ToolList に置き換えられます。コネクタで有効になっているアクション

フィールド
action_info[]	ActionInfo 対応するアクション情報を含むアクションのリスト。

CustomerPolicy

アシスタントのユーザー定義ポリシー。

フィールド
banned_phrases[]	BannedPhrase 省略可。禁止されたフレーズのリスト。
model_armor_config	ModelArmorConfig 省略可。ユーザー プロンプトとアシスタント レスポンスのサニタイズに使用される Model Armor 構成。

BannedPhrase

お客様が定義した禁止フレーズの定義。禁止されたフレーズは、ユーザークエリまたは LLM レスポンスに含めることはできません。含めると、回答は拒否されます。

フィールド
phrase	string 必須。禁止する未加工の文字列コンテンツ。
match_type	BannedPhraseMatchType 省略可。禁止フレーズのマッチタイプ。
ignore_diacritics	bool 省略可。true の場合、禁止フレーズのマッチング時に発音区別符号（アクセント、ウムラウトなど）が無視されます。たとえば、「cafe」は「café」と一致します。

BannedPhraseMatchType

禁止フレーズの照合方法。

列挙型
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED	デフォルトは SIMPLE_STRING_MATCH です。
SIMPLE_STRING_MATCH	禁止フレーズは、テキスト内のどこかに完全な部分文字列として含まれている場合に一致します。
WORD_BOUNDARY_STRING_MATCH	禁止フレーズは、テキスト内のパターンが単語区切り文字で囲まれている場合にのみ一致します。フレーズ自体に単語区切り文字が含まれている場合もあります。

ModelArmorConfig

ユーザー プロンプトとアシスタント レスポンスのサニタイズに使用される、顧客定義の Model Armor テンプレートの構成。

フィールド
user_prompt_template	string 省略可。ユーザー プロンプトをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{template_id} 指定しない場合、ユーザー プロンプトにサニタイズは適用されません。
response_template	string 省略可。アシスタント レスポンスをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{template_id} 指定しない場合、アシスタントのレスポンスにサニタイズは適用されません。
failure_mode	FailureMode 省略可。Model Armor のサニタイズの障害モードを定義します。

FailureMode

Model Armor がリクエストの処理に失敗した場合の動作を決定します。

列挙型
FAILURE_MODE_UNSPECIFIED	未指定の障害モード。デフォルトの動作は FAIL_CLOSED です。
FAIL_OPEN	Model Armor の処理が失敗した場合でも、リクエストは変更なしで続行できます。
FAIL_CLOSED	Model Armor の処理が失敗した場合、リクエストは拒否されます。

GenerationConfig

アシスタントの回答の生成に関する構成。

フィールド
system_instruction	SystemInstruction システム指示。LLM 呼び出しのプロンプトの序文とも呼ばれます。https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions もご覧ください。
default_language	string アシスタントの回答の生成に使用するデフォルトの言語。en などの ISO 639-1 言語コードを使用します。指定しない場合、言語は自動的に検出されます。

SystemInstruction

システム指示。LLM 呼び出しのプロンプトの序文とも呼ばれます。

フィールド
additional_system_instruction	string 省略可。デフォルトのシステム指示に追加される追加のシステム指示。

ToolInfo

ツールを識別するための情報。

フィールド
tool_name	string DataConnectorService.QueryAvailableActions で定義されているツールの名前。注: DataConnectorService API で action が使用されていますが、ここでは tool と同じです。
tool_display_name	string ツールの表示名。

ToolList

コネクタで有効になっているツール

フィールド
tool_info[]	ToolInfo ツールと対応するツール情報のリスト。

WebGroundingType

使用するウェブ グラウンディングのタイプ。

列挙型
WEB_GROUNDING_TYPE_UNSPECIFIED	デフォルトの未指定の設定。これは無効と同じです。
WEB_GROUNDING_TYPE_DISABLED	ウェブ グラウンディングが無効になっています。
WEB_GROUNDING_TYPE_GOOGLE_SEARCH	Google 検索によるグラウンディングが有効になっている。
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH	Enterprise Web Search を使用したグラウンディングが有効になっている。

AssistantContent

マルチモーダル コンテンツ。

フィールド
role	string コンテンツの作成者。「model」または「user」にできます。
thought	bool 省略可。モデルによって考えられた部分かどうかを示します。
共用体フィールド data。含まれるデータ。data は次のいずれかになります。
text	string インライン テキスト。
inline_data	Blob インライン バイナリデータ。
file	File ファイル（音声の要約など）。
executable_code	ExecutableCode 実行されることを目的とし、モデルによって生成されたコード。
code_execution_result	CodeExecutionResult ExecutableCode の実行結果。

Blob

インライン blob。

フィールド
mime_type	string 必須。生成されたデータのメディアタイプ（MIME タイプ）。
data	bytes 必須。元のバイト。

CodeExecutionResult

ExecutableCode の実行結果。

フィールド
outcome	Outcome 必須。コード実行の結果。
output	string 省略可。コードの実行が成功した場合は stdout、それ以外の場合は stderr またはその他の説明が含まれます。

結果

コード実行の結果の列挙。

列挙型
OUTCOME_UNSPECIFIED	ステータスが指定されていません。この値は使用しないでください。
OUTCOME_OK	コードの実行が正常に完了しました。
OUTCOME_FAILED	コードの実行は完了しましたが、失敗しました。stderr に理由が出力されます。
OUTCOME_DEADLINE_EXCEEDED	コードの実行に時間がかかり過ぎたため、キャンセルされました。部分的な出力が存在する場合と存在しない場合があります。

ExecutableCode

モデルによって実行されることを目的とし、モデルによって生成されたコード。

フィールド
code	string 必須。コード コンテンツ。現在、Python のみがサポートされています。

ファイル

ファイル（音声の要約など）。

フィールド
mime_type	string 必須。ファイルのメディアタイプ（MIME タイプ）。
file_id	string 必須。ファイル ID。

AssistantGroundedContent

コンテンツと、場合によってはそのグラウンディング情報。

すべてのコンテンツにグラウンディングが必要なわけではありません。「もちろん、喜んでお探しします」などのフレーズはグラウンディングを必要としません。

フィールド
content	AssistantContent コンテンツ。
citation_metadata	CitationMetadata 生成されたコンテンツのソースの帰属。https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check もご覧ください。
content_metadata	ContentMetadata 省略可。コンテンツのメタデータ。現在は、リサーチ アシスタントの回答でのみ使用されます。
共用体フィールド metadata。さまざまなモーダルのグラウンディング メタデータ。現時点ではテキストのみがサポートされています。metadata は次のいずれかになります。
text_grounding_metadata	TextGroundingMetadata テキストソースに基づくグラウンディングのメタデータ。

ContentMetadata

コンテンツのメタデータ。

フィールド
content_kind	ContentKind コンテンツのタイプ。このコンテンツがリサーチ アシスタントの回答のどの部分に属するかを示します。
content_id	string コンテンツの ID。これは、調査の質問とその回答を結び付けるために使用されます。たとえば、研究課題の回答の一部は、課題と同じ content_id を持ちます。

ContentKind

コンテンツの種類。現在は、リサーチ アシスタントの回答全体でセクションを区別するためにのみ使用されます。

列挙型
CONTENT_KIND_UNSPECIFIED	不明。
RESEARCH_PLAN	リサーチプラン。
RESEARCH_QUESTION	調査課題。
RESEARCH_ANSWER	調査の回答。
RESEARCH_REPORT	調査レポート。
RESEARCH_AUDIO_SUMMARY	リサーチの音声による要約。

TextGroundingMetadata

テキストソースのグラウンディングの詳細。

フィールド
segments[]	Segment テキストの一部のグラウンディング情報。
references[]	Reference グラウンドされたテキストの参照。

リファレンス

参照されたコンテンツと関連するドキュメントのメタデータ。

フィールド
content	string 参照されたテキスト コンテンツ。
document_metadata	DocumentMetadata ドキュメントのメタデータ。

DocumentMetadata

ドキュメントのメタデータ。

フィールド
document	string ドキュメントのリソース名。
uri	string ドキュメントの URI。実際のウェブサイトにリダイレクトする URL が含まれている場合があります。
title	string 特徴があります
page_identifier	string ページ ID。
domain	string ドキュメント URI のドメイン名。uri フィールドには、実際のウェブサイトにリダイレクトする URL が含まれている場合があります。その場合、このフィールドにはターゲット サイトのドメイン名が含まれます。
mime_type	string ドキュメントの MIME タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml。

セグメント

テキストのセグメントのグラウンディング情報。

フィールド
start_index	int64 セグメントの開始位置を示す 0 ベースのインデックス。UTF-8 文字列のバイト数で測定されます（つまり、複数のバイトでエンコードされた文字の長さは 1 より大きくなります）。
end_index	int64 セグメントの終了（この値を含まない）。
reference_indices[]	int32 セグメントの参照。
grounding_score	float セグメントのスコア。
text	string テキスト セグメント自体。

BAPConfig

BAP コネクタの構成。

フィールド
supported_connector_modes[]	ConnectorMode 必須。関連付けられた BAP 接続でサポートされているコネクタ モード。
enabled_actions[]	string 省略可。関連付けられた BAP 接続で有効になっているアクション。

ConnectorMode

この BAP コネクタでサポートされているユースケース。

列挙型
CONNECTOR_MODE_UNSPECIFIED	コネクタモードが指定されていません。
DATA_INGESTION	データ取り込みに使用されるコネクタ。
ACTIONS	アクションに使用されるコネクタ
END_USER_AUTHENTICATION	エンドユーザー認証に使用されるコネクタ。

BatchCreateTargetSiteMetadata

SiteSearchEngineService.BatchCreateTargetSites オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

BatchCreateTargetSitesRequest

SiteSearchEngineService.BatchCreateTargetSites メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。作成されるすべての TargetSite で共有される親リソース。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。CreateBookRequest メッセージの親フィールドは、空にするか、このフィールドと一致させる必要があります。
requests[]	CreateTargetSiteRequest 必須。作成するリソースを指定するリクエスト メッセージ。バッチで作成できる TargetSite の最大数は 20 です。

BatchCreateTargetSitesResponse

SiteSearchEngineService.BatchCreateTargetSites メソッドに対するレスポンス メッセージ。

フィールド
target_sites[]	TargetSite TargetSites が作成されました。

BatchGetDocumentsMetadataRequest

DocumentService.BatchGetDocumentsMetadata メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} など）。
matcher	Matcher 必須。Document のマッチャー。

FhirMatcher

FHIR リソース名による Document のマッチャー。

フィールド
fhir_resources[]	string 必須。照合する FHIR リソース。形式: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Document のマッチャー。現在は、完全一致の URI による照合をサポートしています。

フィールド
共用体フィールド matcher。Document のマッチャー。matcher は次のいずれかになります。
uris_matcher	UrisMatcher 正確な URI によるマッチャー。
fhir_matcher	FhirMatcher FHIR リソース名によるマッチャー。

UrisMatcher

完全な URI による Document のマッチャー。

フィールド
uris[]	string 照合する正確な URI。

BatchGetDocumentsMetadataResponse

DocumentService.BatchGetDocumentsMetadata メソッドに対するレスポンス メッセージ。

フィールド
documents_metadata[]	DocumentMetadata Document のメタデータ。

DocumentMetadata

Document のメタデータ。

フィールド
matcher_value	MatcherValue Document の照合に使用されたマッチャーの値。
state	State ドキュメントの状態。
last_refreshed_time	Timestamp Document が最後にインデックスに登録された時刻のタイムスタンプ。
data_ingestion_source	string Document のデータ取り込みソース。 指定できる値は次のとおりです。 batch: Batch API を介して取り込まれたデータ（例: ImportDocuments。 streaming Streaming API を介して取り込まれたデータ（例: FHIR ストリーミング。

MatcherValue

Document の照合に使用されたマッチャーの値。

フィールド
共用体フィールド matcher_value。Document の照合に使用されたマッチャーの値。matcher_value は次のいずれかになります。
uri	string URI で一致させる場合は、Document の URI。
fhir_resource	string 形式: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

状態

Document の状態。

列挙型
STATE_UNSPECIFIED	設定しないでください。
INDEXED	Document がインデックスに登録されている。
NOT_IN_TARGET_SITE	Document の URI が TargetSite にないため、Document はインデックスに登録されません。
NOT_IN_INDEX	Document はインデックスに登録されていません。

BatchUpdateUserLicensesMetadata

UserLicenseService.BatchUpdateUserLicenses オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常に更新されたユーザー ライセンスの数。
failure_count	int64 更新できなかったユーザー ライセンスの数。

BatchUpdateUserLicensesRequest

UserLicenseService.BatchUpdateUserLicenses メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親の [UserStore][] リソース名。形式: projects/{project}/locations/{location}/userStores/{user_store_id}。
delete_unassigned_user_licenses	bool 省略可。true の場合、ユーザー ライセンスに関連付けられたライセンス構成が削除されると、ユーザー ライセンスが削除されます。デフォルトでは（false）、ユーザー ライセンスは割り当て解除状態に更新されます。
共用体フィールド source。必須。入力のソース。source は次のいずれかになります。
inline_source	InlineSource ドキュメント エンベディングの入力コンテンツのインライン ソース。

InlineSource

BatchUpdateUserLicenses メソッドの入力構成のインライン ソース。

フィールド
user_licenses[]	UserLicense 必須。更新するユーザー ライセンスのリスト。各ユーザー ライセンスには有効な UserLicense.user_principal が必要です。
update_mask	FieldMask 省略可。更新するフィールドのリスト。

BatchUpdateUserLicensesResponse

UserLicenseService.BatchUpdateUserLicenses メソッドに対するレスポンス メッセージ。

フィールド
user_licenses[]	UserLicense UserLicenses が正常に更新されました。
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。

BatchVerifyTargetSitesMetadata

SiteSearchEngineService.BatchVerifyTargetSites オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

BatchVerifyTargetSitesRequest

SiteSearchEngineService.BatchVerifyTargetSites メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。検証されるすべての TargetSite で共有される親リソース。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。

BatchVerifyTargetSitesResponse

この型にはフィールドがありません。

SiteSearchEngineService.BatchVerifyTargetSites メソッドに対するレスポンス メッセージ。

BigQuerySource

BigQuery ソースからインポートするデータ。

フィールド
project_id	string BigQuery ソースを含むプロジェクトのプロジェクト ID またはプロジェクト番号。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
dataset_id	string 必須。データのコピー元となる BigQuery データセット。長さは 1,024 文字以下にする必要があります。
table_id	string 必須。データのコピー元となる BigQuery テーブル。長さは 1,024 文字に制限されています。
gcs_staging_dir	string インポート時に一時的に使用される Cloud Storage ディレクトリ。長さの上限は 2,000 文字です。BigQuery のエクスポート先を特定の Cloud Storage ディレクトリにする場合に指定できます。
data_schema	string ソースからのデータ解析に使用するスキーマ。 ユーザー イベントのインポートでサポートされている値は次のとおりです。 user_event（デフォルト）: 行ごとに 1 つの UserEvent。 ドキュメントのインポートでサポートされている値は次のとおりです。 document（デフォルト）: 行ごとに 1 つの Document 形式。各ドキュメントには、有効な Document.id と Document.json_data または Document.struct_data のいずれかが必要です。 custom: データストアの定義された Schema に準拠する任意の形式のカスタムデータ。これは、一般的なデータストアの業種でのみ使用できます。
共用体フィールド partition。BigQuery テーブルのパーティション情報。BigQuery テーブルがパーティション分割されていない場合は、空のままにします。partition は次のいずれかになります。
partition_date	Date BigQuery の時間パーティション分割テーブルの _PARTITIONDATE（YYYY-MM-DD 形式）。

BigtableOptions

インポートをサポートする情報を含む Bigtable オプション オブジェクト。

フィールド
key_field_name	string ドキュメントに行キー値を保存するために使用されるフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。
families	map<string, BigtableColumnFamily> ファミリー名から、指定された列ファミリーの列ファミリー レベルの情報を含むオブジェクトへのマッピング。このマップにないファミリは無視されます。

BigtableColumn

Bigtable の列。

フィールド
qualifier	bytes 必須。列の修飾子。utf-8 でデコードできない場合は、代わりに base-64 でエンコードされた文字列を使用します。
field_name	string ドキュメントでこの列に使用するフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。設定されていない場合は、修飾子バイトから最善を尽くして解析されます。ただし、命名パターンが異なるため、フィールド名の競合が発生する可能性があります。この場合、解析動作は未定義です。
encoding	Encoding 型が STRING でない場合の値のエンコード モード。使用できるエンコード値は次のとおりです。 TEXT: 値が英数字のテキスト文字列であることを示します。 BINARY: 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。これは、columns に列を一覧表示して、エンコードを指定することによって、特定の列に対してオーバーライドできます。
type	Type この列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。

BigtableColumnFamily

Bigtable の列ファミリー。

フィールド
field_name	string ドキュメントでこの列ファミリーに使用するフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。設定されていない場合は、ファミリー名から解析されます。ただし、命名パターンが異なるため、フィールド名の競合が発生する可能性があります。この場合、解析動作は未定義です。
encoding	Encoding 型が STRING でない場合の値のエンコード モード。使用できるエンコード値は次のとおりです。 TEXT: 値が英数字のテキスト文字列であることを示します。 BINARY: 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。これは、columns に列を一覧表示して、エンコードを指定することによって、特定の列に対してオーバーライドできます。
type	Type この列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。
columns[]	BigtableColumn 各列の列レベルの情報を含むオブジェクトのリスト。このリストに含まれていない列は無視されます。

エンコード

Bigtable の列または列ファミリーのエンコード モード。

列挙型
ENCODING_UNSPECIFIED	エンコードは指定されていません。
TEXT	テキスト エンコード。
BINARY	バイナリ エンコード。

タイプ

Bigtable の列または列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。

列挙型
TYPE_UNSPECIFIED	タイプが指定されていません。
STRING	文字列型。
NUMBER	数値型。
INTEGER	整数型。
VAR_INTEGER	可変長の整数型。
BIG_NUMERIC	BigDecimal 型。
BOOLEAN	ブール型。
JSON	JSON 型。

BigtableSource

データをインポートする Cloud Bigtable ソース。

フィールド
project_id	string Bigtable ソースを含むプロジェクトのプロジェクト ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
instance_id	string 必須。インポートする必要がある Cloud Bigtable のインスタンス ID。
table_id	string 必須。インポートする必要がある Cloud Bigtable のテーブル ID。
bigtable_options	BigtableOptions 必須。データを型付き構造に解析するときに必要な情報を含む Bigtable オプション。たとえば、列の型のアノテーションなどです。

CheckGroundingRequest

GroundedGenerationService.CheckGrounding メソッドに対するリクエスト メッセージ。

フィールド
grounding_config	string 必須。グラウンディング構成のリソース名（例: projects/*/locations/global/groundingConfigs/default_grounding_config）。
answer_candidate	string チェックする回答候補。最大長は 4,096 トークンです。
facts[]	GroundingFact グラウンディング チェックの事実のリスト。最大 200 個の事実をサポートしています。
grounding_spec	CheckGroundingSpec グラウンディング チェックの構成。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳細については、Google Cloud ドキュメントをご覧ください。

CheckGroundingResponse

GroundedGenerationService.CheckGrounding メソッドに対するレスポンス メッセージ。

フィールド
cited_chunks[]	FactChunk 回答候補内のすべての主張で引用されている事実のリスト。これらは、リクエストで提供された事実から導き出されます。
cited_facts[]	CheckGroundingFactChunk 回答候補内のすべての主張で引用されている事実のリスト。これらは、リクエストで提供された事実から導き出されます。
claims[]	Claim 回答候補内のすべての申し立てにわたる申し立てテキストと引用情報。
support_score	float 入力された回答候補のサポートスコア。スコアが高いほど、提示された事実によって裏付けられる主張の割合が高くなります。レスポンスが返されると、常に設定されます。

CheckGroundingFactChunk

グラウンディング チェック用の事実チャンク。

フィールド
chunk_text	string ファクト チャンクのテキスト コンテンツ。最大 1 万文字まで入力できます。

クレーム

回答候補内の主張のテキストと引用情報。

フィールド
claim_text	string 回答候補のクレームのテキスト。引用または反引用が見つかったかどうかにかかわらず、常に提供されます。
citation_indices[]	int32 申し立てに関連付けられた引用を指定するインデックス（cited_chunks 内）のリスト。たとえば、[1,3,4] は、cited_chunks[1]、cited_chunks[3]、cited_chunks[4] が、主張を裏付けるために引用された事実であることを意味します。事実への引用は、その主張が事実によって裏付けられていることを示します。
start_pos	int32 回答候補内の主張の開始位置を示す位置（バイト単位）。これは文字数で測定されるものではないため、一部の文字が複数バイトを占める可能性があることを考慮して、ユーザー インターフェースでレンダリングする必要があります。たとえば、クレーム テキストに ASCII 以外の文字が含まれている場合、文字数（プログラミング言語に依存）で測定した場合とバイト数（プログラミング言語に依存しない）で測定した場合で、開始位置と終了位置が異なります。
end_pos	int32 回答候補内の主張の終了位置を示す位置（バイト単位、終了位置は含まない）。これは文字数で測定されるものではないため、そのようにレンダリングする必要があります。たとえば、クレーム テキストに ASCII 以外の文字が含まれている場合、文字数（プログラミング言語に依存）で測定した場合とバイト数（プログラミング言語に依存しない）で測定した場合で、開始位置と終了位置が異なります。
grounding_check_required	bool この主張でグラウンディング チェックが必要だったことを示します。システムがこの主張には帰属/グラウンディング チェックが必要ないと判断した場合、このフィールドは false に設定されます。この場合、主張に対してグラウンディング チェックが行われていないため、citation_indices は返されません。
score	double 回答候補の主張の信頼スコア。範囲は [0, 1] です。これは、CheckGroundingRequest.grounding_spec.enable_claim_level_score が true の場合にのみ設定されます。

CheckGroundingSpec

グラウンディング チェックの仕様。

フィールド
citation_threshold	double 回答候補の主張に対して事実の引用が必要かどうかを判断するために使用されるしきい値（[0,1]）。しきい値を高くすると、引用数は減りますが、引用の信頼性は高くなります。しきい値を低くすると、引用数は増えますが、引用の信頼性は低くなります。設定しない場合、しきい値はデフォルトで 0.6 になります。
enable_claim_level_score	bool レスポンスで主張レベルのグラウンディング スコアを有効にする制御フラグ。

チャンク

チャンクは、チャンクモードで推奨または検索されるアイテムのすべての未加工のメタデータ情報をキャプチャします。

フィールド
name	string チャンクの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
id	string 現在のチャンクの一意のチャンク ID。
content	string コンテンツはドキュメントの文字列（解析されたコンテンツ）です。
document_metadata	DocumentMetadata 現在のチャンクのドキュメントのメタデータ。
derived_struct_data	Struct 出力専用。このフィールドは OUTPUT_ONLY です。元の入力ドキュメントにはない派生データが含まれています。
page_span	PageSpan チャンクのページ範囲。
chunk_metadata	ChunkMetadata 出力専用。現在のチャンクのメタデータ。
data_urls[]	string 出力専用。現在のチャンクに画像が含まれている場合は、画像データ URL。データ URL は、接頭辞（data:）、データのタイプを示す MIME タイプ、テキスト以外の場合はオプションの base64 トークン、データ自体の 4 つの部分で構成されます。data:[][;base64],
annotation_contents[]	string 出力専用。現在チャンクにアノテーションが含まれている場合のアノテーションの内容。
annotation_metadata[]	AnnotationMetadata 出力専用。アノテーション メタデータには、現在のチャンクの構造化コンテンツが含まれます。
relevance_score	double 出力専用。類似性に基づく関連性スコアを表します。スコアが高いほど、チャンクの関連性が高いことを示します。スコアの範囲は [-1.0, 1.0] です。SearchResponse でのみ入力されます。

AnnotationMetadata

アノテーション メタデータには、現在のチャンクの構造化コンテンツが含まれます。

フィールド
structured_content	StructuredContent 出力専用。構造化コンテンツの情報。
image_id	string 出力専用。構造化コンテンツが画像に基づいている場合は、画像 ID が提供されます。

ChunkMetadata

現在のチャンクのメタデータ。このフィールドは、SearchService.Search API でのみ入力されます。

フィールド
previous_chunks[]	Chunk 現在のチャンクの前のチャンク。この数は SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks によって制御されます。このフィールドは、SearchService.Search API でのみ入力されます。
next_chunks[]	Chunk 現在のチャンクの次のチャンク。この数は SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks によって制御されます。このフィールドは、SearchService.Search API でのみ入力されます。

DocumentMetadata

ドキュメント メタデータには、現在のチャンクのドキュメントの情報が含まれます。

フィールド
uri	string ドキュメントの URI。
title	string ドキュメントのタイトル。
mime_type	string ドキュメントの MIME タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml。
struct_data	Struct データ表現。ドキュメントの構造化 JSON データ。登録された Schema に準拠している必要があります。準拠していない場合は INVALID_ARGUMENT エラーがスローされます。

PageSpan

チャンクのページ範囲。

フィールド
page_start	int32 チャンクの開始ページ。
page_end	int32 チャンクの終了ページ。

StructureType

抽出できる構造化コンテンツのタイプを定義します。

列挙型
STRUCTURE_TYPE_UNSPECIFIED	デフォルト値。
SHAREHOLDER_STRUCTURE	株主構成。
SIGNATURE_STRUCTURE	署名の構造。
CHECKBOX_STRUCTURE	チェックボックスの構造。

StructuredContent

構造化コンテンツの情報。

フィールド
structure_type	StructureType 出力専用。構造化コンテンツの構造タイプ。
content	string 出力専用。構造化コンテンツの内容。

引用

コンテンツのソースの帰属。

フィールド
start_index	int32 出力専用。コンテンツの開始インデックス。
end_index	int32 出力専用。コンテンツの終了インデックス。
uri	string 出力専用。アトリビューションの URL 参照。
title	string 出力専用。帰属のタイトル。
license	string 出力専用。帰属のライセンス。
publication_date	Date 出力専用。帰属の公開日。

CitationMetadata

コンテンツのソース帰属情報のコレクション。

フィールド
citations[]	Citation 出力専用。引用のリスト。

CloudSqlSource

Cloud SQL のインポート元データ。

フィールド
project_id	string Cloud SQL ソースを含むプロジェクトのプロジェクト ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
instance_id	string 必須。データのコピー元となる Cloud SQL インスタンス。長さの上限は 256 文字です。
database_id	string 必須。データのコピー元となる Cloud SQL データベース。長さの上限は 256 文字です。
table_id	string 必須。データのコピー元となる Cloud SQL テーブル。長さの上限は 256 文字です。
gcs_staging_dir	string インポート時に一時的に使用される Cloud Storage ディレクトリ。長さの上限は 2,000 文字です。Cloud SQL のエクスポート先を特定の Cloud Storage ディレクトリにする場合に指定できます。 Cloud SQL サービス アカウントに、指定された Cloud Storage ディレクトリにアクセスするために必要な Cloud Storage 管理者の権限があることを確認します。
offload	bool サーバーレス エクスポートのオプション。このオプションを有効にすると、追加費用が発生します。詳しくは、こちらをご参照ください。

CmekConfig

Cloud KMS 鍵で CMEK データ暗号化を有効にするために使用される構成。

フィールド
name	string 必須。projects/{project}/locations/{location}/cmekConfig または projects/{project}/locations/{location}/cmekConfigs/{cmek_config} 形式の CmekConfig の名前。
kms_key	string 必須。リソース projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} の暗号化に使用される KMS 鍵のリソース名。
kms_key_version	string 出力専用。リソース <kms_key>/cryptoKeyVersions/{keyVersion} の暗号化に使用される KMS 鍵バージョン リソース名。
state	State 出力専用。CmekConfig の状態。
is_default	bool 出力専用。顧客のデフォルトの CmekConfig。
last_rotation_timestamp_micros	int64 出力専用。前回の鍵のローテーションのタイムスタンプ。
single_region_keys[]	SingleRegionKey 省略可。一部の VAIS 機能に必要な単一リージョン CMEK。
notebooklm_state	NotebookLMState 出力専用。NotebookLM コーパスを使用できる状態かどうか。

NotebookLMState

NotebookLM の状態。

列挙型
NOTEBOOK_LM_STATE_UNSPECIFIED	NotebookLM の状態が不明です。
NOTEBOOK_LM_NOT_READY	NotebookLM の準備ができていません。
NOTEBOOK_LM_READY	NotebookLM を使用できるようになりました。
NOTEBOOK_LM_NOT_ENABLED	NotebookLM が有効になっていない。

状態

CmekConfig の状態。

列挙型
STATE_UNSPECIFIED	CmekConfig の状態が不明です。
CREATING	CmekConfig を作成しています。
ACTIVE	CmekConfig は DataStore で使用できます。
KEY_ISSUE	CmekConfig が使用できません。これは、KMS 鍵が取り消されたことが原因である可能性が高いです。
DELETING	CmekConfig の削除中です。
DELETE_FAILED	CmekConfig の削除プロセスが失敗しました。
UNUSABLE	CmekConfig は使用できません。内部的な問題が原因である可能性が高いです。
ACTIVE_ROTATING	KMS 鍵バージョンがローテーションされています。
DELETED	KMS 鍵が削除済みです。最終的に一部のクリーンアップ ポリシーが適用されます。
EXPIRED	KMS 鍵が期限切れです。つまり、鍵が 30 日以上無効になっています。お客様は DeleteCmekConfig を呼び出して、状態を DELETED に変更できます。

CollectUserEventRequest

CollectUserEvent メソッドのリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名。ユーザー イベント収集アクションが DataStore レベルで適用される場合、形式は projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} です。たとえば、Location レベルでユーザー イベント収集アクションが適用され、複数の DataStore にわたって Document を含むイベントの場合、形式は projects/{project}/locations/{location} になります。
user_event	string 必須。長さの上限が 2,000,000 文字の URL エンコードされた UserEvent proto。
uri	string cgi パラメータを含むが、ハッシュ フラグメントを含まない URL。長さの上限は 5,000 文字です。多くのブラウザはサードパーティのリクエストに対してのみドメインを送信するため、リファラー URL よりも有用な場合が多々あります。
ets	int64 イベントのタイムスタンプ（ミリ秒単位）。これにより、同一の GET リクエストがブラウザにキャッシュ保存されるのを防ぐことができます。ペイロード バイトを削減するため、名前は簡潔になっています。

コレクション

コレクションは、リソースと一連のデータストアへのアクセスを構成するためのコンテナです。

フィールド
name	string 変更不可。コレクションの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
display_name	string 必須。コレクションの表示名。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
create_time	Timestamp 出力専用。Collection が作成されたタイムスタンプ。

CompleteQueryRequest

CompletionService.CompleteQuery メソッドに対するリクエスト メッセージ。

フィールド
data_store	string 必須。オートコンプリートを行う親データストアのリソース名（projects/*/locations/global/collections/default_collection/dataStores/default_data_store など）。
query	string 必須。候補の取得に使用される予測入力。最大長は 128 文字です。
query_model	string 予測入力データモデルを指定します。これにより、Cloud コンソールの [構成] > [予測入力] セクションで指定されたモデルがオーバーライドされます。現在サポートされている値は次のとおりです。 document - ユーザーがインポートしたドキュメントから生成された候補を使用しています。 search-history - SearchService.Search API 呼び出しの過去の履歴から生成された候補を使用します。Search API のトラフィックがない場合は使用しないでください。 user-event - ユーザーがインポートした検索イベントから生成された候補を使用します。 document-completable - 完了可能としてマークされたユーザーがインポートしたドキュメント フィールドから直接取得した候補を使用します。 デフォルト値: document は、通常のデータストアのデフォルトのモデルです。 search-history は、サイト内検索データストアのデフォルトのモデルです。
user_pseudo_id	string 訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。 このフィールドには、unknown_visitor などの固定値は設定しないでください。 これは、UserEvent.user_pseudo_id および SearchRequest.user_pseudo_id と同じ識別子にする必要があります。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
include_tail_suggestions	bool 完全なクエリに一致する候補がない場合に、末尾の候補を返すかどうかを示します。true に設定されている場合でも、クエリ全体に一致する候補がある場合は、それらの候補が返され、末尾の候補は返されません。

CompleteQueryResponse

CompletionService.CompleteQuery メソッドに対するレスポンス メッセージ。

フィールド
query_suggestions[]	QuerySuggestion 一致したクエリ候補の結果。結果リストが並べ替えられ、最初の結果が上位の候補になります。
tail_match_triggered	bool 返された候補がすべて末尾候補である場合は True。 末尾一致をトリガーするには、リクエストの include_tail_suggestions が true であり、クエリ全体と一致する候補がない必要があります。

QuerySuggestion

検索クエリとしての候補。

フィールド
suggestion	string クエリへの候補。
completable_field_paths[]	string 補完可能なフィールドから生成された場合、この候補のソースとなる一意のドキュメント フィールド パス。 このフィールドは、ドキュメント補完可能なモデルに対してのみ入力されます。

CompletionInfo

完了アトリビューション トークンやクリックされた完了情報などの詳細な完了情報。

フィールド
selected_suggestion	string エンドユーザーが CompleteQueryResponse.QuerySuggestion.suggestion を選択しました。
selected_position	int32 エンドユーザーが選択した CompleteQueryResponse.QuerySuggestion.suggestion の位置（0 から始まる）。

CompletionSuggestion

Customer からインポートされたオートコンプリート候補。

フィールド
suggestion	string 必須。候補のテキスト。
language_code	string この候補の BCP-47 言語コード。
group_id	string 2 つの提案の groupId が同じ場合、それらの提案は同時に返されません。代わりに、ランクの高い方が返されます。これは、意味的に同一の候補の重複除去に使用できます。
group_score	double グループ内でのこの提案のスコア。
alternative_phrases[]	string この候補の代替一致フレーズ。
共用体フィールド ranking_info。この提案のランキング指標。ranking_info は次のいずれかになります。
global_score	double この提案のグローバル スコア。この提案のスコア付け / ランク付けの方法を制御します。
frequency	int64 この候補の頻度。スコアが利用できない場合に候補のランク付けに使用されます。

条件

動作を許可する前に確認する状況を定義します

フィールド
query_terms[]	QueryTerm 検索のみ: クエリを照合する用語のリスト。Condition.query_regex が設定されている場合は設定できません。 クエリ用語は最大 10 個までです。
active_time_range[]	TimeRange 条件が有効になる時間帯を指定します。 最大 10 個の時間範囲。
query_regex	string 省略可。検索クエリ全体に一致するクエリの正規表現。Condition.query_terms を設定した場合は設定できません。ベーシック サイト検索のプロモーション配信コントロールでのみサポートされています。

QueryTerm

検索リクエスト クエリのマッチャー

フィールド
value	string 照合する特定のクエリ値 小文字で、UTF-8 である必要があります。full_match が true の場合、スペースで区切られた用語を最大 3 つまで含めることができます。空の文字列にすることはできません。最大文字数は 5,000 文字です。
full_match	bool 検索クエリがクエリ キーワードと完全に一致する必要があるかどうか。

TimeRange

時間依存の条件に使用されます。

フィールド
start_time	Timestamp 期間の開始。 範囲は包括的です。
end_time	Timestamp 期間の終了。 範囲は包括的です。将来の時点であることが必要です。

ConnectorType

コネクタのタイプ。

列挙型
CONNECTOR_TYPE_UNSPECIFIED	デフォルト値。
THIRD_PARTY	サードパーティ コネクタからサードパーティ アプリケーションへのコネクタ。
GCP_FHIR	データ コネクタは、FHIR ストアと VAIS データストアを接続します。
BIG_QUERY	BigQuery コネクタ。
GCS	Google Cloud Storage コネクタ。
GOOGLE_MAIL	Gmail コネクタ。
GOOGLE_CALENDAR	Google カレンダー コネクタ。
GOOGLE_DRIVE	Google ドライブ コネクタ。
NATIVE_CLOUD_IDENTITY	People API を利用したユーザー検索用のネイティブ Cloud Identity コネクタ。
THIRD_PARTY_FEDERATED	フェデレーション コネクタ。データを取り込まず、検索はサードパーティ アプリケーションの API によって行われるサードパーティ製コネクタです。
THIRD_PARTY_EUA	エンドユーザー認証機能に使用されるコネクタ。
GCNV	Google Cloud NetApp Volumes コネクタ。

ContactDetails

リソースレベルで保存されている連絡先情報。プロジェクト レベルとリソースレベルの両方が入力されている場合、リソースレベルの連絡先情報がプロジェクト レベルの連絡先情報よりも優先されます。

フィールド
email_address	string 省略可。連絡先のメールアドレス。

管理

サービング中に使用する条件付き動作を定義します。サービング時に考慮されるには、ServingConfig に関連付けられている必要があります。許可されるアクションは SolutionType によって異なります。

フィールド
name	string 変更不可。完全修飾名 projects/*/locations/global/dataStore/*/controls/*
display_name	string 必須。人が読める形式の名前。UI ビューで使用される識別子。 UTF-8 でエンコードされた文字列である必要があります。長さの上限は 128 文字です。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
associated_serving_config_ids[]	string 出力専用。このコントロールが関連付けられているすべての ServingConfig ID のリスト。変更後、更新されるまでに 10 分ほどかかることがあります。
solution_type	SolutionType 必須。変更不可。コントロールが属するソリューション。 リソースの業種と互換性がある必要があります。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
use_cases[]	SearchUseCase コントロールのユースケースを指定します。設定できる条件フィールドに影響します。SOLUTION_TYPE_SEARCH にのみ適用されます。現時点では、コントロールごとに 1 つのユースケースのみが許可されています。solution_type が SolutionType.SOLUTION_TYPE_SEARCH の場合に設定する必要があります。
conditions[]	Condition 関連付けられたアクションがトリガーされるタイミングを決定します。 省略すると、アクションが常に適用されます。現時点では、指定できる条件は 1 つのみです。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
共用体フィールド action。アクションは業種とソリューションによって制限されます 必須。action は次のいずれかになります。
boost_action	BoostAction ブーストタイプのコントロールを定義する
filter_action	FilterAction フィルタタイプのコントロールを定義します。現在、Recommendation ではサポートされていません
redirect_action	RedirectAction リダイレクト タイプのコントロールを定義します。
synonyms_action	SynonymsAction 一連のキーワードを互いに同義語として扱います。
promote_action	PromoteAction 事前定義されたトリガー クエリに基づいて特定のリンクを宣伝します。

BoostAction

返されたリスト内の商品の順序を調整します。

フィールド
boost (deprecated)	float この項目は非推奨です。 ブーストの強さ。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0（No-op）です。
filter	string 必須。ブーストを適用する商品を指定します。 フィルタを指定しない場合、すべての商品がブーストされます（No-op）。構文のドキュメント: https://cloud.google.com/retail/docs/filter-and-order 最大文字数は 5,000 文字です。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
data_store	string 必須。このコントロールによってブーストできるデータストアのドキュメントを指定します。データストアの完全な名前（例: projects/123/locations/global/collections/default_collection/dataStores/default_data_store）
共用体フィールド boost_spec。定数値ブーストまたはカスタム ランキング ベースのブースト仕様。boost_spec は次のいずれかになります。
fixed_boost	float 省略可。ブーストの強さ。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0（No-op）です。
interpolation_boost_spec	InterpolationBoostSpec 省略可。顧客定義の属性値に基づくカスタム ランキングの複雑な仕様。

InterpolationBoostSpec

顧客が指定した属性値に基づくカスタム ランキングの仕様。上記の単純な（条件、ブースト）の組み合わせよりも、カスタマイズされたランキングをより細かく制御できます。

フィールド
field_name	string 省略可。ブースト量を決定するために値が使用されるフィールドの名前。
attribute_type	AttributeType 省略可。ブースト額の決定に使用する属性のタイプ。属性値は、指定された field_name のフィールド値から導出できます。数値の場合、attribute_value = numerical_field_value となります。ただし、鮮度の場合は、attribute_value = (time.now() - datetime_field_value) となります。
interpolation_type	InterpolationType 省略可。以下にリストされているコントロール ポイントを接続するために適用される補間タイプ。
control_points[]	ControlPoint 省略可。曲線の定義に使用されるコントロール ポイント。単調関数（上記の interpolation_type で定義）は、ここに記載されている制御点を通過します。

AttributeType

カスタム ランキングを適用する属性（または関数）。

列挙型
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType が指定されていません。
NUMERICAL	数値フィールドの値は、ブースト額を動的に更新するために使用されます。この場合、コントロール ポイントの attribute_value（x 値）は、boost_amount が指定されている数値フィールドの実際の値になります。
FRESHNESS	鮮度のユースケースでは、属性値は現在時刻と指定された datetime フィールドの日付の間の期間になります。値は、XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。たとえば、5D、3DT12H30M、T24H。

ControlPoint

曲線の定義に使用されるコントロール ポイント。これらの制御点を通過する曲線は、単調に増加または減少する（定数値は許容される）必要があります。

フィールド
attribute_value	string 省略可。次のいずれかになります。1. 数値フィールドの値。2. 鮮度の期間仕様: 値は XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。
boost_amount	float 省略可。attribute_value が上記の指定された値と評価された場合にスコアをブーストする値（-1 ～ 1）。

InterpolationType

適用する補間タイプ。デフォルトは線形（区分線形）です。

列挙型
INTERPOLATION_TYPE_UNSPECIFIED	補間タイプが指定されていません。この場合、デフォルトは Linear になります。
LINEAR	区分線形補間が適用されます。

FilterAction

結果に含めることができる製品を明記しました。ブーストと同じフィルタを使用します。

フィールド
filter	string 必須。一致条件の結果に適用するフィルタ。 必要な構文のドキュメント: https://cloud.google.com/retail/docs/filter-and-order 最大文字数は 5,000 文字です。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。
data_store	string 必須。このコントロールによってフィルタできるデータストアのドキュメントを指定します。データストアの完全な名前（例: projects/123/locations/global/collections/default_collection/dataStores/default_data_store）

PromoteAction

トリガー クエリに基づいて特定のリンクを宣伝します。

例: shoe キーワードで検索したときに靴店のリンクを宣伝します。リンクは、関連付けられたデータストアの外部に配置できます。

フィールド
data_store	string 必須。このプロモーションが関連付けられているデータストア。
search_link_promotion	SearchLinkPromotion 必須。このアクションに関連付けられたプロモーション。

RedirectAction

購入者を指定された URI にリダイレクトします。

フィールド
redirect_uri	string 必須。購入者がリダイレクトされる URI。 必須。URI の長さは 2,000 文字以下にする必要があります。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。

SynonymsAction

互いに類義語として機能する一連のキーワードを作成します。

たとえば、「happy」は「glad」と見なされ、「glad」は「happy」と見なされます。

フィールド
synonyms[]	string 同義語のセットを定義します。最大 100 個の同義語を指定できます。同義語を 2 つ以上指定する必要があります。それ以外の場合は、INVALID ARGUMENT エラーがスローされます。

会話

外部会話の proto 定義。

フィールド
name	string 変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* または projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*。
state	State 会話の状態。
user_pseudo_id	string ユーザーをトラッキングするための一意の識別子。
messages[]	ConversationMessage 会話メッセージ。
start_time	Timestamp 出力専用。会話が開始された時刻。
end_time	Timestamp 出力専用。会話が終了した時刻。

状態

会話の状態の列挙。

列挙型
STATE_UNSPECIFIED	不明。
IN_PROGRESS	現在、会話は開いています。
COMPLETED	会話が完了しました。

ConversationContext

会話のコンテキストを定義します

フィールド
context_documents[]	string ユーザーに現在表示されているドキュメントのリスト。ドキュメント リソース参照が含まれています。
active_document	string ユーザーが開いた現在のアクティブなドキュメント。ドキュメント リソース リファレンスが含まれています。

ConversationMessage

会話メッセージを定義します。

フィールド
create_time	Timestamp 出力専用。メッセージの作成タイムスタンプ。
共用体フィールド message。 message は次のいずれかになります。
user_input	TextInput ユーザーのテキスト入力。
reply	Reply 検索の返信。

ConverseConversationRequest

ConversationalSearchService.ConverseConversation メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。取得する会話のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/- を使用して自動セッション モードを有効にします。これにより、ConverseConversation セッション内に新しい会話が自動的に作成されます。
query	TextInput 必須。現在のユーザー入力。
serving_config	string 使用するサービング構成のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} 設定されていない場合、デフォルトのサービング構成が使用されます。
conversation	Conversation 自動セッションでのみ使用される会話。自動セッションでは会話に新しい名前が自動的に割り当てられるため、名前フィールドは無視されます。
safe_search	bool セーフサーチをオンにするかどうか。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳細については、Google Cloud ドキュメントをご覧ください。
summary_spec	SummarySpec レスポンスで返される概要を構成するための仕様。
filter	string フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。これは検索結果のフィルタリングに使用され、要約の回答に影響する可能性があります。 このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。 Vertex AI Search でのフィルタリングは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキー プロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマに「name」というフィールドがあるとします。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。 構文やフィルタ オペレータなどのフィルタリングの詳細については、フィルタをご覧ください。
boost_spec	BoostSpec 検索結果で特定のドキュメントをブーストするブースト仕様。これにより、会話の回答に影響する可能性があります。ブーストの詳細については、ブーストをご覧ください。

ConverseConversationResponse

ConversationalSearchService.ConverseConversation メソッドに対するレスポンス メッセージ。

フィールド
reply	Reply 現在のクエリに対する回答。
conversation	Conversation 回答を含む更新された会話。
search_results[]	SearchResult 検索結果。

CreateAssistantRequest

AssistantService.CreateAssistant メソッドのリクエスト。

フィールド
parent	string 必須。親リソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
assistant	Assistant 必須。作成する Assistant。
assistant_id	string 必須。Assistant に使用する ID。Assistant のリソース名の最終的なコンポーネントになります。 このフィールドは RFC-1034 に準拠し、長さは 63 文字以内にする必要があります。

CreateControlRequest

CreateControl メソッドのリクエスト。

フィールド
parent	string 必須。親データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} または projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。
control	Control 必須。作成する Control。
control_id	string 必須。Control に使用する ID。Control のリソース名の最終的なコンポーネントになります。 この値は 1 ～ 63 文字にする必要があります。有効な文字は /[a-z][0-9]-_/ です。

CreateConversationRequest

CreateConversation メソッドのリクエスト。

フィールド
parent	string 必須。親データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
conversation	Conversation 必須。作成する会話。

CreateDataStoreMetadata

DataStoreService.CreateDataStore オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

CreateDataStoreRequest

DataStoreService.CreateDataStore メソッドのリクエスト。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location}/collections/{collection} など）。
data_store	DataStore 必須。作成する DataStore。
data_store_id	string 必須。DataStore に使用する ID。DataStore のリソース名の最終的なコンポーネントになります。 このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
create_advanced_site_search	bool サイト内検索用の高度なデータストアを直接作成するかどうかを示すブール値フラグ。データストアがサイト内検索（GENERIC 業種と PUBLIC_WEBSITE content_config）として構成されていない場合、このフラグは無視されます。
skip_default_schema_creation	bool データストアのデフォルト スキーマの作成をスキップするかどうかを示すブール値のフラグ。デフォルトのスキーマがユースケースと互換性がないことが確実な場合にのみ、このフラグを有効にしてください。 true に設定した場合、ドキュメントを取り込む前に、データストアのスキーマを手動で作成する必要があります。 data_store.starting_schema が指定されている場合、このフラグは指定できません。
共用体フィールド cmek_options。DataStore の CMEK オプション。このフィールドを設定すると、プロジェクトに設定されているデフォルトの CmekConfig がオーバーライドされます。cmek_options は次のいずれかになります。
cmek_config_name	string この DataStore の保護に使用する CmekConfig のリソース名。
disable_cmek	bool CMEK 保護のない DataStore。プロジェクトにデフォルトの CmekConfig が設定されている場合、このフィールドを設定すると、デフォルトの CmekConfig もオーバーライドされます。

CreateDocumentRequest

DocumentService.CreateDocument メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} など）。
document	Document 必須。作成する Document。
document_id	string 必須。Document に使用する ID。これは Document.name の最終的なコンポーネントになります。 呼び出し元に Document を作成する権限がない場合、Document が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 このフィールドは、同じ parent を持つすべての Document の中で一意である必要があります。それ以外の場合は、ALREADY_EXISTS エラーが返されます。 このフィールドは RFC-1034 標準に準拠している必要があり、長さの上限は 128 文字です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

CreateEngineMetadata

EngineService.CreateEngine オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

CreateEngineRequest

EngineService.CreateEngine メソッドのリクエスト。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location}/collections/{collection} など）。
engine	Engine 必須。作成する Engine。
engine_id	string 必須。Engine に使用する ID。Engine のリソース名の最終的なコンポーネントになります。 このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

CreateIdentityMappingStoreRequest

IdentityMappingStoreService.CreateIdentityMappingStore のリクエスト メッセージ

フィールド
parent	string 必須。親コレクションのリソース名（projects/{project}/locations/{location} など）。
identity_mapping_store_id	string 必須。作成する ID マッピング ストアの ID。 ID には、英字（a ～ z、A ～ Z）、数字（0 ～ 9）、アンダースコア（_）、ハイフン（-）のみを含めることができます。最大長は 63 文字です。
identity_mapping_store	IdentityMappingStore 必須。作成する ID マッピング ストア。
共用体フィールド cmek_options。ID マッピング ストアの CMEK オプション。このフィールドを設定すると、プロジェクトに設定されているデフォルトの CmekConfig がオーバーライドされます。cmek_options は次のいずれかになります。
cmek_config_name	string この ID マッピング ストアの保護に使用する CmekConfig のリソース名。
disable_cmek	bool CMEK 保護のない ID マッピング ストア。プロジェクトにデフォルトの CmekConfig が設定されている場合、このフィールドを設定すると、デフォルトの CmekConfig もオーバーライドされます。

CreateLicenseConfigRequest

LicenseConfigService.CreateLicenseConfig メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location} など）。
license_config	LicenseConfig 必須。作成する LicenseConfig。
license_config_id	string 省略可。LicenseConfig に使用する ID。LicenseConfig のリソース名の最終的なコンポーネントになります。ライセンス構成 ID として、階層（プロダクト エディション）名（search、search_and_assistant など）を使用しています。

CreateSchemaMetadata

スキーマ作成 LRO のメタデータ。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

CreateSchemaRequest

SchemaService.CreateSchema メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親データストアのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} 形式）。
schema	Schema 必須。作成する Schema。
schema_id	string 必須。Schema に使用する ID。これは Schema.name の最終的なコンポーネントになります。 このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。

CreateSessionRequest

CreateSession メソッドのリクエスト。

フィールド
parent	string 必須。親データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
session	Session 必須。作成するセッション。

CreateSitemapMetadata

SiteSearchEngineService.CreateSitemap オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

CreateSitemapRequest

SiteSearchEngineService.CreateSitemap メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。SiteSearchEngine の親リソース名（projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine など）。
sitemap	Sitemap 必須。作成する Sitemap。

CreateTargetSiteMetadata

SiteSearchEngineService.CreateTargetSite オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

CreateTargetSiteRequest

SiteSearchEngineService.CreateTargetSite メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。TargetSite の親リソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine など）。
target_site	TargetSite 必須。作成する TargetSite。

CustomAttribute

リソースで明示的にモデル化されていないカスタム属性（UserEvent など）。

フィールド
text[]	string このカスタム属性のテキスト値。たとえば、キーが「color」の場合は ["yellow", "green"] です。 空の文字列は使用できません。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 CustomAttribute.text または CustomAttribute.numbers のいずれか 1 つのみを設定する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
numbers[]	double このカスタム属性の数値。たとえば、キーが「lengths_cm」の場合は [2.3, 15.4] です。 CustomAttribute.text または CustomAttribute.numbers のいずれか 1 つのみを設定する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

CustomTuningModel

カスタム チューニング モデルを説明するメタデータ。

フィールド
name	string 必須。モデルの完全修飾リソース名。 形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}。 モデルは 40 文字以内の英数字の文字列で指定する必要があります。
display_name	string モデルの表示名。
model_version	int64 モデルのバージョン。
model_state	ModelState モデルの状態（TRAINING、TRAINING_FAILED など）。
create_time (deprecated)	Timestamp この項目は非推奨です。 非推奨: モデルが作成されたときのタイムスタンプ。
training_start_time	Timestamp モデル トレーニングが開始されたタイムスタンプ。
metrics	map<string, double> トレーニング済みモデルの指標。
error_message	string 現在、これはモデルの状態が INPUT_VALIDATION_FAILED の場合にのみ入力されます。

ModelState

モデルの状態。

列挙型
MODEL_STATE_UNSPECIFIED	デフォルト値。
TRAINING_PAUSED	モデルはトレーニングが一時停止された状態です。
TRAINING	モデルは現在トレーニング中です。
TRAINING_COMPLETE	モデルのトレーニングが正常に完了しました。
READY_FOR_SERVING	モデルはサービングの準備が整っています。
TRAINING_FAILED	モデルのトレーニングが失敗しました。
NO_IMPROVEMENT	モデルのトレーニングは正常に完了しましたが、指標が改善されませんでした。
INPUT_VALIDATION_FAILED	入力データの検証に失敗しました。モデルのトレーニングが開始されませんでした。

DataConnector

Collection にグループ化されたすべてのデータストアの外部データソースへの接続を管理します。これは Collection のシングルトン リソースです。初期化は DataConnectorService.SetUpDataConnector メソッドでのみサポートされます。このメソッドは新しい Collection を作成し、その DataConnector を初期化します。

フィールド
name	string 出力専用。データコネクタの完全なリソース名。形式: projects/*/locations/*/collections/*/dataConnector。
state	State 出力専用。コネクタの状態。
data_source	string 必須。データソースの名前。サポートされる値: salesforce、jira、confluence、bigquery。
remove_param_keys[]	string 省略可。「params」フィールドから削除するキーを指定します。これは、UpdateDataConnectorRequest の update_mask に params が含まれている場合にのみ有効になります。キーが remove_param_keys にあり、リクエストの params フィールドにも存在する場合、削除が優先されます。
refresh_interval	Duration 必須。データ同期の更新間隔。期間を 0 に設定すると、データはリアルタイムで同期されます。ストリーミング機能はまだサポートされていません。最小値は 30 分、最大値は 7 日です。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。
next_sync_time	DateTime 次のデータ同期のスケジュール時間を定義します。このフィールドには、IANA タイムゾーン データベースの hour、minute、time_zone が必要です。これは、データコネクタの更新間隔が 1 日を超える場合に使用されます。時間または分が指定されていない場合は、同期時間は 0:00 とみなされます。ユーザーは、あいまいさを避けるためにタイムゾーンを指定する必要があります。
entities[]	SourceEntity 接続されたデータソースから取り込むエンティティのリスト。
create_time	Timestamp 出力専用。DataConnector が作成されたタイムスタンプ。
latest_pause_time	Timestamp 出力専用。この DataConnector が一時停止された最新のタイムスタンプ。データ同期などのすべての機能に影響します。コネクタを一時停止すると、次の影響があります。- データ同期を含むすべての機能が停止します。- 進行中のデータ同期ジョブはすべてキャンセルされます。- 今後のデータ同期の実行はスケジュールされず、トリガーすることもできません。
last_sync_time	Timestamp 出力専用。定期的なコネクタの場合のみ、データ同期が最後に完了した日時。
update_time	Timestamp 出力専用。DataConnector が最後に更新されたときのタイムスタンプ。
errors[]	Status 出力専用。初期化または最新のコネクタ実行からのエラー。
sync_mode	SyncMode データコネクタでサポートされているデータ同期モード。
kms_key_name	string 入力専用。このコネクタで管理される DataStore の保護に使用される KMS 鍵。 CMEK 組織のポリシーの保護に準拠する必要があるリクエストに設定する必要があります。 このフィールドが設定され、正常に処理されると、このコネクタによって作成された DataStore は KMS 鍵で保護されます。
destination_configs[]	DestinationConfig 省略可。サードパーティのサービスへの接続に使用されるターゲット宛先。
action_state	State 出力専用。アクション コネクタの状態。これは、アクション コネクタが初期化中、アクティブ、またはエラーが発生したかどうかを反映します。
action_config	ActionConfig 省略可。コネクタがアクションをサポートするようにするアクション構成。
end_user_config	EndUserConfig 省略可。EUA コネクタ専用に使用されるパラメータと認証情報。
federated_config	FederatedConfig 省略可。FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。このフィールドは、コネクタがハイブリッド コネクタで、フェデレーション モードを有効にする場合にのみ設定する必要があります。
connector_modes[]	ConnectorMode 省略可。このコネクタで有効になっているモード。デフォルトの状態は CONNECTOR_MODE_UNSPECIFIED です。
static_ip_enabled	bool 省略可。お客様がこのコネクタで静的 IP アドレスを有効にしているかどうか。
static_ip_addresses[]	string 出力専用。このコネクタで使用される静的 IP アドレス。
blocking_reasons[]	BlockingReason 出力専用。コネクタがデータの同期を開始する前に完了する必要があるユーザー アクション。
identity_refresh_interval (deprecated)	Duration この項目は非推奨です。 このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。
identity_schedule_config	IdentityScheduleConfig ID データ同期の実行の構成。このコネクタで取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔が含まれます。
private_connectivity_project_id	string 出力専用。プライベート接続コネクタに関連付けられているテナント プロジェクト ID。コネクタが機能するには、このプロジェクトを許可リストに登録する必要があります。
bap_config	BAPConfig 省略可。BAP 接続を確立するための構成。
connector_type	ConnectorType 出力専用。コネクタのタイプ。各ソースは 1 つのタイプにのみマッピングできます。たとえば、salesforce、confluence、jira のコネクタ タイプは THIRD_PARTY です。システムによって設定されると、変更できません。
realtime_state	State 出力専用。リアルタイム同期の状態
alert_policy_configs[]	AlertPolicyConfig 省略可。コネクタレベルのアラート構成。
realtime_sync_config	RealtimeSyncConfig 省略可。リアルタイム同期の構成。
acl_enabled	bool 省略可。コネクタが ACL 構成で作成されるかどうか。現在、このフィールドは Cloud Storage コネクタと BigQuery コネクタにのみ影響します。
create_eua_saas	bool 省略可。END USER AUTHENTICATION コネクタが SaaS で作成されているかどうか。
auto_run_disabled	bool 省略可。コネクタが自動実行で無効になっているかどうかを示します。定期的な同期とリアルタイム同期を一時停止するために使用できます。更新: incremental_sync_disabled の導入により、auto_run_disabled は完全同期のみを一時停止/無効にするために使用されます
incremental_sync_disabled	bool 省略可。このコネクタの増分同期が一時停止されているかどうかを示します。これは auto_run_disabled とは無関係です。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります（true に設定されます）。
incremental_refresh_interval	Duration 省略可。増分データ同期専用の更新間隔。設定されていない場合、増分同期では環境のデフォルト（3 時間）が使用されます。最小値は 30 分、最大値は 7 日です。サードパーティ コネクタにのみ適用されます。更新間隔が増分更新間隔と同じ値に設定されている場合、増分同期は無効になります。
hybrid_ingestion_disabled	bool 省略可。コネクタがハイブリッド コネクタの場合、コネクタの作成時に取り込みが有効になり、適切なリソースがプロビジョニングされるかどうかを決定します。コネクタがハイブリッド コネクタでない場合、このフィールドは無視されます。
共用体フィールド data_connector_params。ソースにアクセスするために必要なパラメータ（Key、Value）ペアの形式。projects/*/[locations/*/]secrets/*/versions/* 形式の文字列値は Secret Manager から読み取られます。 すべてのデータソースで必須のパラメータ: キー: instance_uri 値: STRING 型。データソースにアクセスするための URI。 OAUTH をサポートするソース（salesforce など）の必須パラメータ: キー: client_id 値: STRING 型。アプリケーションを識別するためのサードパーティ サービス プロバイダのクライアント ID。 キー: client_secret 値:型 STRING。サードパーティ認証サーバーによって生成されたクライアント シークレット。 キー: access_token 値: STRING 型。保護リソースにアクセスするための UCS の OAuth トークン。 キー: refresh_token 値: STRING 型。ユーザーの操作なしで新しいアクセス トークンを取得するための UCS の OAuth 更新トークン。 基本的な API トークン認証（jira、confluence など）をサポートするソースに必要なパラメータ: キー: user_account 値: STRING 型。ソースを含むユーザー名またはメールアドレス。 キー: api_token 値: STRING 型。ソース アカウント用に生成された API トークン。パスワードを使用する場所での認証に使用されます。 例: { "instance_uri": "https://xxx.atlassian.net", "user_account": "[e-mail]", "api_token": "test-token" } 複数の認証タイプをサポートするために使用する認証タイプを指定する省略可能なパラメータ: キー: auth_type 値: STRING 型。データソースの認証タイプ。サポートされる値: BASIC_AUTH、OAUTH、OAUTH_ACCESS_TOKEN、OAUTH_TWO_LEGGED、OAUTH_JWT_BEARER、OAUTH_PASSWORD_GRANT、JWT、API_TOKEN、FEDERATED_CREDENTIAL。data_connector_params は次のいずれかになります。
params	Struct 構造化された JSON 形式の必須データ コネクタ パラメータ。
json_params	string JSON 文字列形式の必須データ コネクタ パラメータ。

BlockingReason

コネクタがデータの同期を開始する前に完了する必要があるユーザー アクション。

列挙型
BLOCKING_REASON_UNSPECIFIED	デフォルト値。
ALLOWLIST_STATIC_IP	コネクタでは、静的 IP を許可リストに登録する必要があります。
ALLOWLIST_IN_SERVICE_ATTACHMENT	コネクタを使用するには、お客様がサービス アタッチメントで Google のプロジェクトを許可リストに登録する必要があります。
ALLOWLIST_SERVICE_ACCOUNT	コネクタでは、お客様のプロジェクトでサービス アカウントを許可リストに登録する必要があります。

ConnectorMode

このコネクタで有効になっているモード。INGESTION、ACTIONS、FEDERATED、EUA

列挙型
CONNECTOR_MODE_UNSPECIFIED	コネクタモードが指定されていません。
DATA_INGESTION	データ取り込みに使用されるコネクタ。
ACTIONS	アクションに使用されるコネクタ。
FEDERATED	連携検索に使用されるコネクタ。
EUA	エンドユーザー認証に使用されるコネクタ。
FEDERATED_AND_EUA	連携検索とエンドユーザー認証に使用されるハイブリッド コネクタ。

EndUserConfig

EUA コネクタ専用に使用されるパラメータと認証情報。

フィールド
additional_params	Struct 省略可。EUA に必要な追加のパラメータ。
tenant	Tenant 省略可。コネクタが接続されているテナント プロジェクト。
共用体フィールド auth_config。EUA コネクタの認証構成。auth_config は次のいずれかになります。
auth_params	Struct 省略可。EUA コネクタに固有の認証パラメータ。
json_auth_params	string 省略可。EUA コネクタに固有の認証パラメータ（JSON 文字列形式）。

FederatedConfig

FEDERATED モードをサポートするハイブリッド コネクタ専用に使用されるパラメータと認証情報。

フィールド
additional_params	Struct 省略可。FEDERATED に必要な追加のパラメータ。
共用体フィールド auth_config。FEDERATED コネクタの認証構成。auth_config は次のいずれかになります。
auth_params	Struct 省略可。FEDERATED コネクタに固有の認証パラメータ。
json_auth_params	string 省略可。json 文字列形式の FEDERATED コネクタに固有の認証パラメータ。

RealtimeSyncConfig

リアルタイム同期の追加パラメータを保存するリアルタイム同期の構成。

フィールド
webhook_uri	string 省略可。コネクタの Webhook URL。リアルタイム同期の追加パラメータを指定します。
realtime_sync_secret	string 省略可。Webhook シークレットに使用される Secret Manager シークレットの ID。
streaming_error	StreamingError 省略可。ストリーミング エラーの詳細。

StreamingError

ストリーミング エラーの詳細。

フィールド
streaming_error_reason	StreamingErrorReason 省略可。ストリーミング エラー。
error	Status 省略可。エラーの詳細。

StreamingErrorReason

ストリーミング エラーの一般的なタイプ。

列挙型
STREAMING_ERROR_REASON_UNSPECIFIED	ストリーミング エラーの理由が指定されていません。
STREAMING_SETUP_ERROR	リアルタイム同期のリソースの設定中にエラーが発生しました。
STREAMING_SYNC_ERROR	コネクタのリアルタイム同期の実行中にエラーが発生しました。
INGRESS_ENDPOINT_REQUIRED	プライベート接続でリアルタイム同期を設定する場合は、上り（内向き）エンドポイントが必要です。

SourceEntity

データソース内のエンティティを表します。たとえば、Salesforce の Account オブジェクトなどです。

フィールド
entity_name	string エンティティの名前。データソース別のサポートされている値: Salesforce: Lead、Opportunity、Contact、Account、Case、Contract、Campaign Jira: Issue Confluence: Content、Space
key_property_mappings	map<string, string> インデックス登録用の属性。キー: フィールド名。値: フィールドをマッピングするキー プロパティ（title、description など）。サポートされているキー プロパティ: title: データレコードのタイトル。これは検索結果に表示されます。 description: データレコードの説明。これは検索結果に表示されます。
data_store	string 出力専用。ソース エンティティに関連付けられたデータストアの完全なリソース名。形式: projects/*/locations/*/collections/*/dataStores/*。コネクタが DataConnectorService.SetUpDataConnector メソッドによって初期化されると、各ソース エンティティに対して DataStore が自動的に作成されます。
starting_schema	Schema 省略可。この SourceEntity から作成された DataStore に使用する開始スキーマ。設定されていない場合、デフォルトの業種別スキーマが使用されます。 このフィールドは [SetUpDataConnector][] API でのみ使用され、他の API で使用された場合は無視されます。このフィールドは、[GetDataConnector][] API を含むすべての API レスポンスから省略されます。DataStore のスキーマを取得するには、代わりに SchemaService.GetSchema API を使用します。 提供されたスキーマは、スキーマに関する特定のルールに対して検証されます。詳しくは、こちらのドキュメントをご覧ください。
healthcare_fhir_config	HealthcareFhirConfig 省略可。HEALTHCARE_FHIR 業種の構成。
共用体フィールド entity_params。データ取り込みを容易にするエンティティのパラメータ。たとえば、BigQuery コネクタの場合: キー: document_id_column 値: STRING 型。列 ID の値。entity_params は次のいずれかになります。
params	Struct 構造化された JSON 形式でデータ取り込みを容易にするエンティティのパラメータ。
json_params	string JSON 文字列形式で、データ取り込みを容易にするエンティティのパラメータ。

状態

コネクタの状態。

列挙型
STATE_UNSPECIFIED	デフォルト値。
CREATING	コネクタを設定しています。
ACTIVE	コネクタが正常に設定され、次回の同期実行を待機しています。
FAILED	コネクタがエラー状態です。エラーの詳細は DataConnector.errors で確認できます。エラーを修正できない場合は、[CollectionService.DeleteCollection] API で DataConnector を削除できます。
RUNNING	コネクタがデータソースからレコードをアクティブに同期しています。
WARNING	コネクタは同期実行を完了しましたが、致命的でないエラーが発生しました。
INITIALIZATION_FAILED	コネクタの初期化に失敗しました。考えられる原因としては、ランタイム エラーや非同期パイプラインの問題などがあります。これにより、リクエストがダウンストリーム サービスに到達できなくなります（一部のコネクタタイプを除く）。
UPDATING	コネクタの更新中です。

SyncMode

データコネクタでサポートされているデータ同期モードを定義します。

列挙型
PERIODIC	コネクタは、refresh_interval に基づいてデータを定期的に同期します。auto_run_disabled と組み合わせて使用すると、定期的な同期を一時停止したり、1 回限りの同期を指定したりできます。
STREAMING	データはリアルタイムで同期されます。
UNSPECIFIED	データを取り込まないコネクタにはこの値が設定されます

DataStore

DataStore は、グローバル設定と構成を DataStore レベルでキャプチャします。

フィールド
name	string 変更不可。ID。データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
display_name	string 必須。データストアの表示名。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
industry_vertical	IndustryVertical 変更不可。データストアが登録する業種。
solution_types[]	SolutionType データストアが登録するソリューション。各 industry_vertical で利用可能なソリューション: MEDIA: SOLUTION_TYPE_RECOMMENDATION と SOLUTION_TYPE_SEARCH。 SITE_SEARCH: SOLUTION_TYPE_SEARCH が自動的に登録されます。他のソリューションは登録できません。
default_schema_id	string 出力専用。このデータストアに関連付けられたデフォルトの Schema の ID。
content_config	ContentConfig 変更不可。データストアのコンテンツ構成。このフィールドが設定されていない場合、サーバーの動作はデフォルトで ContentConfig.NO_CONTENT になります。
create_time	Timestamp 出力専用。DataStore が作成されたタイムスタンプ。
advanced_site_search_config	AdvancedSiteSearchConfig 省略可。高度なサイト内検索の設定。
kms_key_name	string 入力専用。作成時にこの DataStore の保護に使用される KMS 鍵。 CMEK 組織のポリシーの保護に準拠する必要があるリクエストに設定する必要があります。 このフィールドが設定され、正常に処理されると、cmek_config フィールドで示されているように、DataStore は KMS 鍵で保護されます。
cmek_config	CmekConfig 出力専用。DataStore の CMEK 関連情報。
billing_estimation	BillingEstimation 出力専用。お支払いのためのデータサイズの見積もり。
acl_enabled	bool 変更不可。DataStore のデータに ACL 情報があるかどうか。true に設定した場合、ソースデータに ACL が必要です。ACL は、DocumentService.ImportDocuments メソッドでデータが取り込まれるときに取り込まれます。 DataStore で ACL が有効になっている場合、DocumentService.GetDocument または DocumentService.ListDocuments を呼び出しても Document にアクセスできません。 現在、ACL は PUBLIC_WEBSITE 以外のコンテンツ構成の GENERIC 業界のみでサポートされています。
workspace_config	WorkspaceConfig ワークスペース データのデータストア タイプ構成を保存する構成。DataStore.content_config が DataStore.ContentConfig.GOOGLE_WORKSPACE に設定されている場合は、この値を設定する必要があります。
document_processing_config	DocumentProcessingConfig ドキュメントの理解と拡充の構成。
starting_schema	Schema この DataStore のプロビジョニング時に使用する開始スキーマ。設定されていない場合、デフォルトの業種別スキーマが使用されます。 このフィールドは CreateDataStore API でのみ使用され、他の API で使用された場合は無視されます。このフィールドは、CreateDataStore API を含むすべての API レスポンスから省略されます。DataStore のスキーマを取得するには、代わりに SchemaService.GetSchema API を使用します。 提供されたスキーマは、スキーマに関する特定のルールに対して検証されます。詳しくは、こちらのドキュメントをご覧ください。
healthcare_fhir_config	HealthcareFhirConfig 省略可。HEALTHCARE_FHIR 業種の構成。
serving_config_data_store	ServingConfigDataStore 省略可。DataStore レベルでサービング構成を保存します。
identity_mapping_store	string 変更不可。関連付けられた IdentityMappingStore の完全修飾リソース名。このフィールドは、THIRD_PARTY または GSUITE IdP を使用する acl_enabled DataStore に対してのみ設定できます。形式: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}。
is_infobot_faq_data_store	bool 省略可。設定されている場合、この DataStore は Infobot FAQ DataStore です。
configurable_billing_approach	ConfigurableBillingApproach 省略可。構成可能な課金アプローチの構成。見る

BillingEstimation

データストアあたりのデータサイズの推定。

フィールド
structured_data_size	int64 構造化データのデータサイズ（バイト単位）。
unstructured_data_size	int64 非構造化データのデータサイズ（バイト単位）。
website_data_size	int64 ウェブサイトのデータサイズ（バイト単位）。
structured_data_update_time	Timestamp 構造化データの最終更新タイムスタンプ。
unstructured_data_update_time	Timestamp 非構造化データの最終更新タイムスタンプ。
website_data_update_time	Timestamp ウェブサイトの最終更新日時のタイムスタンプ。

ConfigurableBillingApproach

構成可能な課金アプローチの構成。

列挙型
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED	デフォルト値。Spark と非 Spark の構成不可の課金アプローチの場合。
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE	エンベディング以外のストレージのインデックス コアには、サブスクリプションの基本料金 + 超過料金の請求を使用します。
CONFIGURABLE_CONSUMPTION_EMBEDDING	ストレージ アドオンの埋め込みには、従量課金制の課金を使用します。

ContentConfig

データストアのコンテンツ構成。

列挙型
CONTENT_CONFIG_UNSPECIFIED	デフォルト値。
NO_CONTENT	Document.content のないドキュメントのみが含まれます。
CONTENT_REQUIRED	Document.content を含むドキュメントのみが含まれます。
PUBLIC_WEBSITE	データストアは、一般公開ウェブサイトの検索に使用されます。
GOOGLE_WORKSPACE	データストアはワークスペース検索に使用されます。ワークスペース データストアの詳細は、WorkspaceConfig で指定します。

ServingConfigDataStore

DataStore レベルでサービング構成に関する情報を保存します。

フィールド
disabled_for_serving	bool 省略可。true に設定すると、DataStore は検索リクエストの処理に使用できなくなります。

DeleteAssistantRequest

AssistantService.DeleteAssistant メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Assistant のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 呼び出し元に Assistant を削除する権限がない場合、Assistant が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 削除する Assistant が存在しない場合は、NOT_FOUND エラーが返されます。

DeleteCmekConfigMetadata

CmekConfigService.DeleteCmekConfig オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteCmekConfigRequest

CmekConfigService.DeleteCmekConfig メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。削除する CmekConfig のリソース名（例: projects/{project}/locations/{location}/cmekConfigs/{cmek_config}）。

DeleteCollectionMetadata

[CollectionService.UpdateCollection][] オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteCollectionRequest

CollectionService.DeleteCollection メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Collection の完全なリソース名（projects/{project}/locations/{location}/collections/{collection} 形式）。

DeleteControlRequest

DeleteControl メソッドのリクエスト。

フィールド
name	string 必須。削除する Control のリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

DeleteConversation メソッドのリクエスト。

フィールド
name	string 必須。削除する会話のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

DataStoreService.DeleteDataStore オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteDataStoreRequest

DataStoreService.DeleteDataStore メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。DataStore の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} など）。 呼び出し元に DataStore を削除する権限がない場合、DataStore が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 削除する DataStore が存在しない場合は、NOT_FOUND エラーが返されます。

DeleteDocumentRequest

DocumentService.DeleteDocument メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Document の完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document} など）。 呼び出し元に Document を削除する権限がない場合、Document が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 削除する Document が存在しない場合は、NOT_FOUND エラーが返されます。

DeleteEngineMetadata

EngineService.DeleteEngine オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteEngineRequest

EngineService.DeleteEngine メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Engine の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id} など）。 呼び出し元に Engine を削除する権限がない場合、Engine が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 削除する Engine が存在しない場合は、NOT_FOUND エラーが返されます。

DeleteIdentityMappingStoreMetadata

IdentityMappingStoreService.DeleteIdentityMappingStore オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteIdentityMappingStoreRequest

IdentityMappingStoreService.DeleteIdentityMappingStore のリクエスト メッセージ

フィールド
name	string 必須。削除する ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

DeleteSchema LRO のメタデータ。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteSchemaRequest

SchemaService.DeleteSchema メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。スキーマの完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} 形式）。

DeleteSessionRequest

DeleteSession メソッドのリクエスト。

フィールド
name	string 必須。削除する Session のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

SiteSearchEngineService.DeleteSitemap オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteSitemapRequest

SiteSearchEngineService.DeleteSitemap メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Sitemap の完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap} など）。 呼び出し元に Sitemap へのアクセス権がない場合、Sitemap が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた Sitemap が存在しない場合は、NOT_FOUND エラーが返されます。

DeleteTargetSiteMetadata

SiteSearchEngineService.DeleteTargetSite オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DeleteTargetSiteRequest

SiteSearchEngineService.DeleteTargetSite メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。TargetSite の完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} など）。 呼び出し元に TargetSite へのアクセス権がない場合、TargetSite が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた TargetSite が存在しない場合は、NOT_FOUND エラーが返されます。

DestinationConfig

サードパーティ ソースへの接続に使用されるターゲット エンドポイントを定義します。

フィールド
key	string 省略可。コネクタでサポートされている一意の宛先識別子。
destinations[]	Destination 省略可。対応するキーの宛先。
共用体フィールド destination_config_params。この宛先構成の追加パラメータ。destination_config_params は次のいずれかになります。
params	Struct 省略可。この宛先構成の追加パラメータを構造化された JSON 形式で指定します。
json_params	string この宛先構成の追加パラメータ（JSON 文字列形式）。

目的地

ターゲット エンドポイントを定義します

フィールド
port	int32 省略可。宛先で受け入れられたターゲット ポート番号。
共用体フィールド destination。エンドポイントの宛先。destination は次のいずれかになります。
host	string 一般公開されたルーティング可能なホスト。

DisableAdvancedSiteSearchMetadata

SiteSearchEngineService.DisableAdvancedSiteSearch オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

DisableAdvancedSiteSearchRequest

SiteSearchEngineService.DisableAdvancedSiteSearch メソッドに対するリクエスト メッセージ。

フィールド
site_search_engine	string 必須。SiteSearchEngine の完全なリソース名（projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine など）。

DisableAdvancedSiteSearchResponse

この型にはフィールドがありません。

SiteSearchEngineService.DisableAdvancedSiteSearch メソッドに対するレスポンス メッセージ。

ドキュメント

Document は、推奨または検索されるアイテムのすべての未加工のメタデータ情報をキャプチャします。

フィールド
name	string 変更不可。ドキュメントの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
id	string 変更不可。ドキュメントの識別子。 ID は RFC-1034 標準に準拠し、長さの上限は 128 文字です。
schema_id	string 同じデータストアにあるスキーマの ID。
content	Content このドキュメントにリンクされている非構造化データ。このドキュメントが CONTENT_REQUIRED データストアにある場合、コンテンツは設定可能であり、設定する必要があります。
parent_document_id	string 親ドキュメントの識別子。現在、最大 2 レベルのドキュメント階層がサポートされています。 ID は RFC-1034 標準に準拠し、長さは 63 文字以内にする必要があります。
derived_struct_data	Struct 出力専用。このフィールドは OUTPUT_ONLY です。元の入力ドキュメントにはない派生データが含まれています。
acl_info	AclInfo ドキュメントのアクセス制御情報。
index_time	Timestamp 出力専用。ドキュメントが最後にインデックスに登録された時刻。このフィールドが設定されている場合、ドキュメントが検索結果で返される可能性があります。 このフィールドは OUTPUT_ONLY です。このフィールドが入力されていない場合、ドキュメントは一度もインデックスに登録されていません。
index_status	IndexStatus 出力専用。ドキュメントのインデックス ステータス。 ドキュメントが正常にインデックス登録されると、index_time フィールドにデータが入力されます。 それ以外の場合、エラーが原因でドキュメントがインデックスに登録されていないと、error_samples フィールドにデータが入力されます。 それ以外の場合、ドキュメントのインデックス作成が進行中であれば、pending_message フィールドに値が入力されます。
共用体フィールド data。データ表現。struct_data または json_data のいずれかを指定する必要があります。指定しないと、INVALID_ARGUMENT エラーがスローされます。data は次のいずれかになります。
struct_data	Struct ドキュメントの構造化 JSON データ。登録された Schema に準拠している必要があります。準拠していない場合は INVALID_ARGUMENT エラーがスローされます。
json_data	string ドキュメントの JSON 文字列表現。登録された Schema に準拠している必要があります。準拠していない場合は INVALID_ARGUMENT エラーがスローされます。

AclInfo

ドキュメントの ACL 情報。

フィールド
readers[]	AccessRestriction ドキュメントの閲覧者。

AccessRestriction

複雑な継承制限をモデル化する AclRestriction。

例: 子ドキュメントにアクセスするには、ユーザーが親ドキュメントにアクセスする必要がある「両方許可」継承をモデル化します。

ドキュメント階層 - Space_S --> Page_P。

閲覧者: Space_S: group_1、user_1 Page_P: group_2、group_3、user_2

Space_S ACL 制限 - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Page_P ACL 制限。{ "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

フィールド
principals[]	Principal プリンシパルのリスト。
idp_wide	bool ID プロバイダ内のすべてのユーザー。

コンテンツ

このドキュメントにリンクされている非構造化データ。

フィールド
mime_type	string コンテンツの MIME タイプ。サポートされているタイプ: application/pdf（PDF。現時点ではネイティブ PDF のみがサポートされています） text/html（HTML） text/plain（TXT） application/xml または text/xml（XML） application/json（JSON） application/vnd.openxmlformats-officedocument.wordprocessingml.document（DOCX） application/vnd.openxmlformats-officedocument.presentationml.presentation（PPTX） application/vnd.openxmlformats-officedocument.spreadsheetml.sheet（XLSX） application/vnd.ms-excel.sheet.macroenabled.12（XLSM） 次のタイプは、データストアでレイアウト パーサーが有効になっている場合にのみサポートされます。 image/bmp（BMP） image/gif（GIF） image/jpeg（JPEG） image/png（PNG） image/tiff（TIFF） https://www.iana.org/assignments/media-types/media-types.xhtml をご覧ください。
共用体フィールド content。非構造化ドキュメントの内容。content は次のいずれかになります。
raw_bytes	bytes バイト ストリームとして表されるコンテンツ。最大長は 1,000,000 バイト（1 MB / 約 0.95 MiB）です。 注: すべての bytes フィールドと同様に、このフィールドは Protocol Buffers では純 2 進数として表され、JSON では base64 でエンコードされた文字列として表されます。たとえば、abc123!?$*&()'-=@~ は JSON で YWJjMTIzIT8kKiYoKSctPUB+ として表されます。https://developers.google.com/protocol-buffers/docs/proto3#json をご覧ください。
uri	string コンテンツの URI。Cloud Storage URI（gs://bucket-name/path/to/file など）のみがサポートされています。テキストベースの形式のファイルの最大サイズは 2.5 MB、その他の形式の場合は 200 MB です。

IndexStatus

ドキュメントのインデックス ステータス。

フィールド
index_time	Timestamp ドキュメントがインデックスに登録された時刻。このフィールドに値が入力されている場合は、ドキュメントがインデックスに登録されていることを意味します。
error_samples[]	Status ドキュメントのインデックス登録中に発生したエラーのサンプル。このフィールドに入力がある場合、エラーによりドキュメントはインデックスに登録されません。
pending_message	string 変更不可。このメッセージは、ドキュメント インデックス作成が進行中であることを示しています。このフィールドが入力されている場合、ドキュメント インデックスは保留中です。

DocumentInfo

ユーザー イベントに関連付けられたドキュメントの詳細情報。

フィールド
promotion_ids[]	string このドキュメントに関連付けられているプロモーション ID。現在、このフィールドは最大 1 つの ID に制限されています。
joined	bool 出力専用。参照されたドキュメントがデータストアで見つかるかどうか。
共用体フィールド document_descriptor。関連付けられている Document の必須記述子。 id が指定されている場合、保存されたドキュメントでアノテーションを付けるときに、{location}、{collection_id}、{data_store_id}、{branch_id} のデフォルト値が使用されます。 name が指定されている場合、保存されたドキュメントでアノテーションを付けるときに、{location}、{collection_id}、{data_store_id}、{branch_id} に指定された値（デフォルト値も可）が使用されます。document_descriptor は次のいずれかになります。
id	string Document リソース ID。
name	string Document リソースの完全な名前（形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}）
uri	string Document URI - ウェブサイトのデータストアでのみ許可されます。
quantity	int32 ユーザー イベントに関連付けられたドキュメントの数量。デフォルトは 1 です。 たとえば、同じドキュメントの数量が 2 つ add-to-cart イベントに関与している場合、このフィールドは 2 になります。 次のイベントタイプのイベントで必須です。 add-to-cart purchase
conversion_value	float 省略可。このドキュメントに関連付けられているコンバージョン値。UserEvent.event_type が「conversion」の場合は設定する必要があります。 たとえば、値 1000 は、watch コンバージョン タイプでドキュメントの閲覧に 1, 000 秒費やしたことを意味します。

DocumentProcessingConfig

DataStore のシングルトン リソース。DataStore の作成時に空で、DataStore が DataStore.ContentConfig.CONTENT_REQUIRED に設定されている場合、デフォルトのパーサーはデジタル パーサーにデフォルト設定されます。

フィールド
name	string ドキュメント処理構成の完全なリソース名。形式: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig。
chunking_config	ChunkingConfig チャンク モードが有効かどうか。
default_parsing_config	ParsingConfig デフォルトのドキュメント パーサーの構成。指定しない場合、デフォルトの DigitalParsingConfig として構成され、デフォルトの解析構成がドキュメント解析のすべてのファイル形式に適用されます。
parsing_config_overrides	map<string, ParsingConfig> ファイル形式からマッピングして、ファイル形式に基づいてデフォルトの解析構成をオーバーライドします。サポートされているキー: pdf: PDF ファイルの解析構成をオーバーライドします。デジタル解析、OCR 解析、レイアウト解析のいずれかがサポートされています。 html: HTML ファイルの解析構成をオーバーライドします。デジタル解析とレイアウト解析のみがサポートされています。 docx: DOCX ファイルの解析構成をオーバーライドします。デジタル解析とレイアウト解析のみがサポートされています。 pptx: PPTX ファイルの解析構成をオーバーライドします。デジタル解析とレイアウト解析のみがサポートされています。 xlsm: XLSM ファイルの解析構成をオーバーライドします。デジタル解析とレイアウト解析のみがサポートされています。 xlsx: XLSX ファイルの解析構成をオーバーライドします。デジタル解析とレイアウト解析のみがサポートされています。

ChunkingConfig

チャンク化構成の構成。

フィールド
共用体フィールド chunk_mode。チャンクの動作を定義する追加の構成。chunk_mode は次のいずれかになります。
layout_based_chunking_config	LayoutBasedChunkingConfig レイアウト ベースのチャンクの構成。

LayoutBasedChunkingConfig

レイアウト ベースのチャンクの構成。

フィールド
chunk_size	int32 各チャンクのトークン サイズの上限。 サポートされている値: 100 ～ 500（両端を含む）。デフォルト値: 500。
include_ancestor_headings	bool コンテキストの損失を防ぐため、ドキュメントの途中部分からチャンクに異なるレベルの見出しを追加するかどうか。 デフォルト値: False。

ParsingConfig

特定のタイプのドキュメント パーサーに適用される関連構成。

フィールド
共用体フィールド type_dedicated_config。ドキュメント処理タイプの構成。type_dedicated_config は次のいずれかになります。
digital_parsing_config	DigitalParsingConfig デジタル パーサーに適用された構成。
ocr_parsing_config	OcrParsingConfig OCR パーサーに適用された構成。現在、これは PDF にのみ適用されます。
layout_parsing_config	LayoutParsingConfig レイアウト パーサーに適用された構成。

DigitalParsingConfig

この型にはフィールドがありません。

ドキュメントのデジタル解析構成。

LayoutParsingConfig

ドキュメントのレイアウト解析構成。

フィールド
enable_table_annotation	bool 省略可。true の場合、解析中に LLM ベースのアノテーションが表に追加されます。
enable_image_annotation	bool 省略可。true の場合、解析中に LLM ベースのアノテーションが画像に追加されます。
structured_content_types[]	string 省略可。ドキュメントから抽出する必要な構造タイプが含まれています。サポートされる値: shareholder-structure
exclude_html_elements[]	string 省略可。解析されたコンテンツから除外する HTML 要素のリスト。
exclude_html_classes[]	string 省略可。解析されたコンテンツから除外する HTML クラスのリスト。
exclude_html_ids[]	string 省略可。解析されたコンテンツから除外する HTML ID のリスト。
enable_get_processed_document	bool 省略可。true の場合、処理されたドキュメントは GetProcessedDocument API で使用できるようになります。

OcrParsingConfig

ドキュメントの OCR 解析構成。

フィールド
enhanced_document_elements[] (deprecated)	string この項目は非推奨です。 [非推奨] このフィールドは非推奨になりました。追加の拡張ドキュメント要素処理を使用するには、layout_parsing_config に切り替えてください。
use_native_text	bool true の場合、ネイティブ テキストを含むページで OCR テキストの代わりにネイティブ テキストを使用します。

DoubleList

ダブルリスト。

フィールド
values[]	double double 値。

EnableAdvancedSiteSearchMetadata

SiteSearchEngineService.EnableAdvancedSiteSearch オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

EnableAdvancedSiteSearchRequest

SiteSearchEngineService.EnableAdvancedSiteSearch メソッドに対するリクエスト メッセージ。

フィールド
site_search_engine	string 必須。SiteSearchEngine の完全なリソース名（projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine など）。

EnableAdvancedSiteSearchResponse

この型にはフィールドがありません。

SiteSearchEngineService.EnableAdvancedSiteSearch メソッドに対するレスポンス メッセージ。

エンジン

Engine のトレーニング パラメータとサービング パラメータを記述するメタデータ。

フィールド
name	string 変更不可。ID。エンジンの完全修飾リソース名。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} エンジンは 1 ～ 63 文字で、有効な文字は /[a-z0-9][a-z0-9-_]*/ です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
display_name	string 必須。エンジンの表示名。人間が読めるようにする必要があります。UTF-8 でエンコードされた文字列で、上限は 1,024 文字です。
create_time	Timestamp 出力専用。レコメンデーション エンジンが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。Recommendation Engine が最後に更新されたときのタイムスタンプ。
data_store_ids[]	string 省略可。このエンジンに関連付けられているデータストア。 SOLUTION_TYPE_SEARCH タイプと SOLUTION_TYPE_RECOMMENDATION タイプのエンジンは、最大で 1 つのデータストアにのみ関連付けることができます。 solution_type が SOLUTION_TYPE_CHAT の場合、同じ Collection 内の複数の DataStore をここに関連付けることができます。 CreateEngineRequest で使用する場合、システムが初期化に必要な処理で使用するため、DataStore ID を 1 つ指定する必要があります。
solution_type	SolutionType 必須。エンジンのソリューション。
industry_vertical	IndustryVertical 省略可。エンジンが登録する業種。Engine 業種の制限は、DataStore に基づいています。Engine の業種は、Engine にリンクされている DataStore の業種と一致する必要があります。
common_config	CommonConfig エンジンのメタデータを指定する共通構成仕様。
app_type	AppType 省略可。変更不可。このエンジン リソースが表すアプリケーション タイプ。注: これは、既存の業界の業種やソリューション タイプとは無関係の新しいコンセプトです。
disable_analytics	bool 省略可。このエンジンで行われた検索のアナリティクスを無効にするかどうか。
features	map<string, FeatureState> 省略可。エンジンが機能をオプトインまたはオプトアウトするための機能構成。サポートされているキー: *: すべての対象物。この値が存在する場合、他のすべての対象物の状態設定は無視されます。 agent-gallery no-code-agent-builder prompt-gallery model-selector notebook-lm people-search people-search-org-chart bi-directional-audio feedback session-sharing personalization-memory disable-agent-sharing disable-image-generation disable-video-generation disable-onedrive-upload disable-talk-to-content disable-google-drive-upload
configurable_billing_approach	ConfigurableBillingApproach 省略可。構成可能な課金アプローチの構成。
共用体フィールド engine_config。エンジンの動作を定義する追加の構成仕様。engine_config は次のいずれかになります。
chat_engine_config	ChatEngineConfig Chat Engine の構成。solution_type が SOLUTION_TYPE_CHAT の場合にのみ適用されます。
search_engine_config	SearchEngineConfig 検索エンジンの構成。solution_type が SOLUTION_TYPE_SEARCH の場合にのみ適用されます。
media_recommendation_engine_config	MediaRecommendationEngineConfig Media Engine の構成。solution_type、SOLUTION_TYPE_RECOMMENDATION、IndustryVertical.MEDIA の業種を含むデータストアにのみ適用されます。
共用体フィールド engine_metadata。エンジンのステータスをモニタリングするエンジン メタデータ。engine_metadata は次のいずれかになります。
chat_engine_metadata	ChatEngineMetadata 出力専用。Chat Engine の追加情報。solution_type が SOLUTION_TYPE_CHAT の場合にのみ適用されます。

AppType

エンジンのアプリ。

列挙型
APP_TYPE_UNSPECIFIED	指定されていないすべてのアプリ。
APP_TYPE_INTRANET	イントラネット検索と Agentspace のアプリタイプ。

ChatEngineConfig

Chat Engine の構成。

フィールド
agent_creation_config	AgentCreationConfig この構成により、この Engine に関連付けられた Dialogflow エージェントが生成されます。 これらの構成は、Dialogflow サービスによって 1 回だけ使用され、渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。
dialogflow_agent_to_link	string この Chat Engine にリンクする既存の Dialogflow エージェントのリソース名。お客様は、agent_creation_config を指定してエージェントを作成するか、エージェントを Chat エンジンにリンクするエージェント名を指定できます。 形式: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。 dialogflow_agent_to_link は 1 回限りで、Dialogflow サービスによって使用され、渡されます。つまり、エンジン作成後に EngineService.GetEngine または EngineService.ListEngines API を使用して取得することはできません。Engine の作成後に実際のエージェントの関連付けを行うには、ChatEngineMetadata.dialogflow_agent を使用します。
allow_cross_region	bool 省略可。フラグが true に設定されている場合、エージェントとエンジンが異なるロケーションにあることが許可されます。それ以外の場合、エージェントとエンジンは同じロケーションにある必要があります。このフラグはデフォルトで false に設定されています。 allow_cross_region は 1 回だけ使用され、EngineService.CreateEngine に渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。

AgentCreationConfig

Dialogflow エージェントを生成するための構成。

これらの構成は、Dialogflow サービスによって 1 回だけ使用され、渡されます。つまり、エンジン作成後に EngineService.GetEngine API または EngineService.ListEngines API を使用して取得することはできません。

フィールド
business	string エージェントが代理人を務める会社、組織、その他の団体の名前。ナレッジ コネクタの LLM プロンプトとナレッジ検索に使用されます。
default_language_code	string 必須。エージェントのデフォルト言語。言語タグとして使用されます。現在サポートされている言語コードのリストについては、言語のサポートをご覧ください。
time_zone	string 必須。タイムゾーン データベースにあるエージェントのタイムゾーン（例: America/New_York、Europe/Paris）。
location	string エージェント作成のエージェントのロケーション。サポートされている値は global、us、eu です。指定しない場合、us Engine はデフォルトで us-central-1 を使用してエージェントを作成し、eu Engine はデフォルトで eu-west-1 を使用してエージェントを作成します。

ChatEngineMetadata

Chat Engine の追加情報。このメッセージのフィールドは出力専用です。

フィールド
dialogflow_agent	string この Chat Engine が参照する Dialogflow エージェントのリソース名。 形式: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。

CommonConfig

Engine の一般的な構成。

フィールド
company_name	string エンジンに関連付けられている会社、ビジネス、またはエンティティの名前。この設定を行うと、LLM 関連機能の改善に役立つことがあります。

ConfigurableBillingApproach

構成可能な課金アプローチの構成。

列挙型
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED	デフォルト値。Spark と非 Spark の構成不可の課金アプローチの場合。一般的な料金モデル。
CONFIGURABLE_BILLING_APPROACH_ENABLED	課金方法は、お客様が指定した構成に従います。

FeatureState

エンジンの機能の状態。

列挙型
FEATURE_STATE_UNSPECIFIED	機能の状態が指定されていません。
FEATURE_STATE_ON	この機能は、アクセスできるようにオンになっています。
FEATURE_STATE_OFF	この機能はオフになっており、アクセスできません。

MediaRecommendationEngineConfig

メディア レコメンデーション エンジンの追加の構成仕様。

フィールド
type	string 必須。エンジンの種類。例: recommended-for-you。 このフィールドは optimization_objective とともに、エンジンのトレーニングとサービングの制御に使用するエンジン メタデータを記述します。 現在サポートされている値: recommended-for-you、others-you-may-like、more-like-this、most-popular-items。
optimization_objective	string 最適化の目標。例: cvr。 このフィールドは optimization_objective とともに、エンジンのトレーニングとサービングの制御に使用するエンジン メタデータを記述します。 現在サポートされている値: ctr、cvr。 指定しない場合、エンジンタイプに基づいてデフォルトが選択されます。デフォルトは推奨事項のタイプによって異なります。 recommended-for-you => ctr others-you-may-like => ctr
optimization_objective_config	OptimizationObjectiveConfig cvr 最適化目標のカスタムしきい値の名前と値。target_field watch-time の場合、target_field_value は、(0, 86400]（0 は除外、86400 は含む）の範囲のメディアの進行状況の時間を秒単位で示す整数値にする必要があります（例: 90）。target_field watch-percentage の場合、target_field_value は (0, 1.0]（0 は除外、1.0 は含む）の範囲内の有効な浮動小数点値にする必要があります（例: 0.5）。
training_state	TrainingState エンジンが置かれているトレーニング状態（TRAINING、PAUSED など）。 サービスの実行コストの一部はトレーニングの頻度であるため、これを使用して、コストを制御するためにエンジンをトレーニングするタイミングを決定できます。指定しない場合: CreateEngine メソッドのデフォルト値は TRAINING です。UpdateEngine メソッドのデフォルト値は、状態を以前と同じに保つことです。
engine_features_config	EngineFeaturesConfig 省略可。追加のエンジン機能の構成。

EngineFeaturesConfig

選択したエンジンタイプのその他の特徴構成。

フィールド
共用体フィールド type_dedicated_config。特定のタイプのメディア レコメンデーション エンジンに適用される機能関連の構成。type_dedicated_config は次のいずれかになります。
recommended_for_you_config	RecommendedForYouFeatureConfig おすすめのエンジン機能構成。
most_popular_config	MostPopularFeatureConfig 最も人気のあるエンジン機能の構成。

MostPopularFeatureConfig

最も人気のあるエンジンを作成するために必要な機能構成。

フィールド
time_window_days	int64 トレーニング時と予測時にエンジンがクエリされる時間枠。正の整数のみ。この値は、イベントの過去 X 日間に変換されます。現在、most-popular-items エンジンに必要です。

OptimizationObjectiveConfig

cvr optimization_objective のカスタムしきい値。

フィールド
target_field	string 必須。ターゲットにするフィールドの名前。現在サポートされている値: watch-percentage、watch-time。
target_field_value_float	float 必須。ターゲットに適用するしきい値（例: 0.5）。

RecommendedForYouFeatureConfig

recommended-for-you エンジンを作成するための追加の機能構成。

フィールド
context_event_type	string 予測時にエンジンがクエリされるイベントのタイプ。generic に設定した場合、エンジン トレーニングで context-event として使用されるのは view-item、media-play、media-complete のみです。view-home-page に設定すると、view-item、media-play、media-complete に加えて、context-events としても view-home-page が使用されます。現在、recommended-for-you エンジンでサポートされています。現在サポートされている値: view-home-page、generic。

TrainingState

エンジンのトレーニング状態。

列挙型
TRAINING_STATE_UNSPECIFIED	トレーニングの状態が未指定。
PAUSED	エンジン トレーニングは一時停止しています。
TRAINING	エンジンはトレーニング中です。

SearchEngineConfig

検索エンジンの構成。

フィールド
search_tier	SearchTier このエンジンの検索機能の階層。 プランによって料金が異なる場合があります。詳細については、料金に関するドキュメントをご覧ください。 指定しない場合のデフォルトは SearchTier.SEARCH_TIER_STANDARD です。
search_add_ons[]	SearchAddOn この検索エンジンが有効にするアドオン。

FactChunk

Fact Chunk。

フィールド
chunk_text	string ファクト チャンクのテキスト コンテンツ。最大 1 万文字まで入力できます。
source	string このファクト チャンクが取得されたソース。リクエストで提供された GroundingFacts から取得された場合、このフィールドには、このチャンクが取得された特定の事実のインデックスが含まれます。
index	int32 このチャンクのインデックス。現在は、ストリーミング モードでのみ使用されます。
source_metadata	map<string, string> ソース参照の詳細情報。
uri	string ソースの URI。
title	string ソースのタイトル。
domain	string ソースのドメイン。

FetchDomainVerificationStatusRequest

SiteSearchEngineService.FetchDomainVerificationStatus メソッドに対するリクエスト メッセージ。

フィールド
site_search_engine	string 必須。すべてのドメイン所有権確認のステータスを取得するサイト検索エンジン リソース。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine。
page_size	int32 リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。 このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
page_token	string 前回の FetchDomainVerificationStatus 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、FetchDomainVerificationStatus に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

FetchDomainVerificationStatusResponse

SiteSearchEngineService.FetchDomainVerificationStatus メソッドに対するレスポンス メッセージ。

フィールド
target_sites[]	TargetSite サイトの確認ステータスを含む TargetSite のリスト。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
total_size	int32 リクエストに一致するアイテムの総数。この値はレスポンスに常に入力されます。

FetchSitemapsRequest

SiteSearchEngineService.FetchSitemaps メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。SiteSearchEngine の親リソース名（projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine など）。
matcher	Matcher 省略可。指定すると、一致する Sitemap が取得されます。指定しない場合、DataStore 内のすべての Sitemap を取得します。

Matcher

Sitemap のマッチャー。現在、uris マッチャーのみをサポートしています。

フィールド
共用体フィールド matcher。Sitemap のマッチャー。matcher は次のいずれかになります。
uris_matcher	UrisMatcher サイトマップ URI によるマッチャー。

UrisMatcher

uri による Sitemap のマッチャー。

フィールド
uris[]	string Sitemap URI。

FetchSitemapsResponse

SiteSearchEngineService.FetchSitemaps メソッドに対するレスポンス メッセージ。

フィールド
sitemaps_metadata[]	SitemapMetadata 取得された Sitemap のリスト。

SitemapMetadata

Sitemap とそのメタデータが含まれます。

フィールド
sitemap	Sitemap Sitemap。

FhirStoreSource

Cloud FhirStore のソース インポート元データ。

フィールド
fhir_store	string 必須。データをインポートする FHIR ストアの完全なリソース名（projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store} 形式）。
gcs_staging_dir	string インポート時に一時的に使用される Cloud Storage ディレクトリ。長さの上限は 2,000 文字です。FhirStore を特定の Cloud Storage ディレクトリにエクスポートする場合に指定できます。
resource_types[]	string インポートする FHIR リソースタイプ。リソースタイプは、サポートされているすべての FHIR リソースタイプのサブセットである必要があります。空の場合は、サポートされているすべての FHIR リソースタイプがデフォルトになります。
update_from_latest_predefined_schema	bool 省略可。DataStore スキーマを最新の事前定義スキーマに更新するかどうか。 true の場合、DataStore スキーマは、前回インポート以降に追加された FHIR フィールドまたはリソースタイプを含むように更新され、対応する FHIR リソースが FHIR ストアからインポートされます。 このフィールドは resource_types と組み合わせて使用することはできません。初回インポート後に使用する必要があります。

FirestoreSource

Firestore ソースのインポート元データ。

フィールド
project_id	string Cloud SQL ソースが存在するプロジェクトの ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
database_id	string 必須。データのコピー元となる Firestore データベース。長さは 256 文字までです。
collection_id	string 必須。データのコピー元となる Firestore コレクション（またはエンティティ）。文字数上限は 1,500 文字です。
gcs_staging_dir	string インポート時に一時的に使用される Cloud Storage ディレクトリ。長さの上限は 2,000 文字です。Firestore を特定の Cloud Storage ディレクトリにエクスポートする場合に指定できます。 Firestore サービス アカウントに、指定された Cloud Storage ディレクトリにアクセスするために必要な Cloud Storage 管理者の権限があることを確認します。

GcsSource

入力コンテンツの Cloud Storage のロケーション。

フィールド
input_uris[]	string 必須。入力ファイルの Cloud Storage URI。各 URI の長さは 2,000 文字までです。URI は、完全なオブジェクト パス（gs://bucket/directory/object.json など）または 1 つ以上のファイルに一致するパターン（gs://bucket/directory/*.json など）に一致できます。 リクエストには最大 100 個のファイル（data_schema が content の場合は 100,000 個のファイル）を含めることができます。各ファイルのサイズは最大 2 GB（data_schema が content の場合は 100 MB）です。
data_schema	string ソースからのデータ解析に使用するスキーマ。 ドキュメントのインポートでサポートされている値は次のとおりです。 document（デフォルト）: 1 行に 1 つの JSON Document。各ドキュメントには有効な Document.id が必要です。 content: 非構造化データ（PDF、HTML など）。input_uris に一致する各ファイルはドキュメントになり、ID は SHA256(URI) の最初の 128 ビットを 16 進文字列としてエンコードした値に設定されます。 custom: データストアの定義された Schema に準拠した任意の形式のカスタムデータ JSON。行ごとに 1 つ。これは、一般的なデータストアの業種でのみ使用できます。 csv: データストアの定義された Schema に準拠するヘッダーを含む CSV ファイル。ヘッダーの後の各エントリはドキュメントとしてインポートされます。これは、GENERIC データストア業種でのみ使用できます。 ユーザー イベントのインポートでサポートされている値は次のとおりです。 user_event（デフォルト）: 1 行に 1 つの JSON UserEvent。

GetAclConfigRequest

GetAclConfigRequest メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。AclConfig のリソース名（例: projects/*/locations/*/aclConfig）。 呼び出し元に AclConfig へのアクセス権がない場合、AclConfig が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

GetAnswerRequest

GetAnswer メソッドのリクエスト。

フィールド
name	string 必須。取得する回答のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

AssistAnswerService.GetAssistAnswer メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。AssistAnswer のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

AssistantService.GetAssistant メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Assistant のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

GetCmekConfigRequest メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。CmekConfig のリソース名（projects/*/locations/*/cmekConfig、projects/*/locations/*/cmekConfigs/* など）。 呼び出し元に CmekConfig へのアクセス権がない場合、CmekConfig が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

GetControlRequest

GetControl メソッドのリクエスト。

フィールド
name	string 必須。取得する Control のリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

GetConversation メソッドのリクエスト。

フィールド
name	string 必須。取得する会話のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

DataConnectorService.GetDataConnector メソッドのリクエスト。

フィールド
name	string 必須。DataConnector の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/dataConnector など）。 呼び出し元に DataConnector へのアクセス権がない場合、DataConnector が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた DataConnector が存在しない場合は、NOT_FOUND エラーが返されます。

GetDataStoreRequest

DataStoreService.GetDataStore メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。DataStore の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} など）。 呼び出し元に DataStore へのアクセス権がない場合、DataStore が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた DataStore が存在しない場合は、NOT_FOUND エラーが返されます。

GetDocumentRequest

DocumentService.GetDocument メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Document の完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document} など）。 呼び出し元に Document へのアクセス権がない場合、Document が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた Document が存在しない場合は、NOT_FOUND エラーが返されます。

GetEngineRequest

EngineService.GetEngine メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。Engine の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id} など）。

GetIdentityMappingStoreRequest

IdentityMappingStoreService.GetIdentityMappingStore のリクエスト メッセージ

フィールド
name	string 必須。取得する ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

LicenseConfigService.GetLicenseConfig メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。LicenseConfig の完全なリソース名（projects/{project}/locations/{location}/licenseConfigs/* など）。 呼び出し元に LicenseConfig へのアクセス権がない場合、LicenseConfig が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた LicenseConfig が存在しない場合は、NOT_FOUND エラーが返されます。

GetSchemaRequest

SchemaService.GetSchema メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。スキーマの完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} 形式）。

GetSessionRequest

GetSession メソッドのリクエスト。

フィールド
name	string 必須。取得するセッションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}
include_answer_details	bool 省略可。true に設定すると、すべての回答の詳細を含む完全なセッションが返されます。

GetSiteSearchEngineRequest

SiteSearchEngineService.GetSiteSearchEngine メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。SiteSearchEngine のリソース名（例: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine）。 呼び出し元に [SiteSearchEngine] へのアクセス権がない場合、[SiteSearchEngine] が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

GetTargetSiteRequest

SiteSearchEngineService.GetTargetSite メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。TargetSite の完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} など）。 呼び出し元に TargetSite へのアクセス権がない場合、TargetSite が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 リクエストされた TargetSite が存在しない場合は、NOT_FOUND エラーが返されます。

GroundingFact

根拠となる事実。

フィールド
fact_text	string ファクトのテキスト コンテンツ。最大 1 万文字まで入力できます。
attributes	map<string, string> ファクトに関連付けられている属性。一般的な属性には、source（事実の出典を示す）、author（事実の著者を示す）などがあります。

HarmCategory

コンテンツをブロックする有害カテゴリ。

列挙型
HARM_CATEGORY_UNSPECIFIED	有害カテゴリが指定されていません。
HARM_CATEGORY_HATE_SPEECH	有害カテゴリはヘイトスピーチです。
HARM_CATEGORY_DANGEROUS_CONTENT	有害カテゴリは危険なコンテンツです。
HARM_CATEGORY_HARASSMENT	有害カテゴリはハラスメントです。
HARM_CATEGORY_SEXUALLY_EXPLICIT	有害カテゴリは、性的描写が露骨なコンテンツです。
HARM_CATEGORY_CIVIC_INTEGRITY	有害カテゴリは市民の誠実性です。

HealthcareFhirConfig

HEALTHCARE_FHIR 業種のデータストアの構成。

フィールド
enable_configurable_schema	bool HEALTHCARE_FHIR 業種で構成可能なスキーマを有効にするかどうか。 true に設定すると、事前定義された医療用 FHIR スキーマを拡張して、よりカスタマイズされた検索とフィルタリングを行うことができます。
enable_static_indexing_for_batch_ingestion	bool HEALTHCARE_FHIR バッチ取り込みで静的インデックス登録を有効にするかどうか。 true に設定すると、バッチ取り込みは静的インデックス モードで処理されます。このモードは処理速度は遅いものの、大量のデータを処理できます。

IdentityMappingEntry

外部 ID を内部 ID にマッピングする ID マッピング エントリ。

フィールド
external_identity	string 必須。顧客 ID プロバイダの外部の ID。外部 ID の長さの上限は 100 文字です。
共用体フィールド identity_provider_id。共用体フィールド identity_provider_id。ID プロバイダ ID はユーザーまたはグループにできます。identity_provider_id は次のいずれかになります。
user_id	string ユーザー識別子。Google Workspace ユーザー アカウントの場合、user_id は Google Workspace ユーザーのメールアドレスにする必要があります。Google 以外の ID プロバイダの場合、user_id は workforcepool 構成時に構成されたマッピングされたユーザー ID です。
group_id	string グループ ID。Google Workspace ユーザー アカウントの場合、group_id は Google Workspace グループのメールアドレスである必要があります。Google 以外の ID プロバイダの場合、group_id は workforcepool 構成時に構成されたマッピングされたグループ ID です。

IdentityMappingEntryOperationMetadata

IdentityMappingStoreService.ImportIdentityMappings と IdentityMappingStoreService.PurgeIdentityMappings の IdentityMappingEntry LongRunningOperation メタデータ

フィールド
success_count	int64 正常に処理された IdentityMappingEntry の数。
failure_count	int64 処理できなかった IdentityMappingEntry の数。
total_count	int64 処理された IdentityMappingEntry の合計数。

IdentityMappingStore

ID マッピング エントリを含む ID マッピング ストア。

フィールド
name	string 変更不可。ID マッピング ストアの完全なリソース名。形式: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}。このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
kms_key_name	string 入力専用。作成時にこの Identity Mapping Store の保護に使用される KMS 鍵。 CMEK 組織のポリシーの保護に準拠する必要があるリクエストに設定する必要があります。 このフィールドが設定され、正常に処理されると、cmek_config フィールドで示されているように、Identity Mapping Store は KMS 鍵によって保護されます。
cmek_config	CmekConfig 出力専用。Identity Mapping Store の CMEK 関連情報。

IdentityScheduleConfig

ID データ同期の実行の構成。

フィールド
refresh_interval	Duration 省略可。このコネクタによって取り込まれたドキュメントのアクセス制御リスト情報を同期する更新間隔。設定しない場合、アクセス制御リストはデフォルトの 30 分間隔で更新されます。ID の更新間隔は、30 分から 7 日までの範囲で設定できます。
next_sync_time	DateTime 省略可。データコネクタの次のデータ同期が開始される予定の UTC 時間。お客様は、データ同期のスケジュールを設定する際に、時間と分のみを指定できます。これは、データコネクタの更新間隔が 1 日を超える場合に使用されます。

IdpConfig

ID プロバイダ構成。

フィールド
idp_type	IdpType ID プロバイダのタイプが構成されています。
external_idp_config	ExternalIdpConfig 外部 ID プロバイダの構成。

ExternalIdpConfig

サードパーティの IDP の構成。

フィールド
workforce_pool_name	string Workforce プールの名前。例: 「locations/global/workforcePools/pool_id」

IdpType

ID プロバイダのタイプ。

列挙型
IDP_TYPE_UNSPECIFIED	デフォルト値。ACL 検索が有効になっていません。
GSUITE	Google の自社プロバイダ。
THIRD_PARTY	サードパーティ プロバイダ。

ImportCompletionSuggestionsMetadata

ImportCompletionSuggestions オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常にインポートされた CompletionSuggestion の数。
failure_count	int64 インポートできなかった CompletionSuggestion の数。

ImportCompletionSuggestionsRequest

CompletionService.ImportCompletionSuggestions メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。顧客のオートコンプリート候補をインポートする親データストアのリソース名。 パターン projects/*/locations/*/collections/*/dataStores/* に従います
error_config	ImportErrorConfig インポート中に発生したエラーを記録する目的の場所。
共用体フィールド source。予測入力候補のソース。source は次のいずれかになります。
inline_source	InlineSource 候補エントリのインライン ソース。
gcs_source	GcsSource 入力コンテンツの Cloud Storage のロケーション。
bigquery_source	BigQuerySource BigQuery 入力ソース。

InlineSource

CompletionSuggestions のインライン ソース。

フィールド
suggestions[]	CompletionSuggestion 必須。インポートするすべての拒否リスト エントリのリスト。最大 1,000 個のアイテム。

ImportCompletionSuggestionsResponse

CompletionService.ImportCompletionSuggestions メソッドのレスポンス。長時間実行オペレーションが完了し、オペレーションが成功した場合、このメッセージは google.longrunning.Operations.response フィールドにより返されます。

フィールド
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。
error_config	ImportErrorConfig インポート中に発生したエラーを記録する目的の場所。

ImportDocumentsMetadata

ImportDocuments オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常に処理されたエントリの数。
failure_count	int64 処理中にエラーが発生したエントリの数。
total_count	int64 処理されたエントリの合計数。

ImportDocumentsRequest

インポート メソッドのリクエスト メッセージ。

フィールド
parent	string 必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} など）。作成/更新権限が必要です。
error_config	ImportErrorConfig インポート中に発生したエラーを記録する目的の場所。
reconciliation_mode	ReconciliationMode 既存のドキュメントとインポートするドキュメント間の調整モード。デフォルトは ReconciliationMode.INCREMENTAL です。
update_mask	FieldMask 指定されたインポート済みドキュメントで更新するフィールドを示します。設定しない場合、デフォルトではすべてのフィールドが更新されます。
auto_generate_ids	bool ドキュメントに ID がない場合に自動的に生成するかどうか。 true に設定すると、ペイロードのハッシュに基づいて Document.id が自動的に生成されます。複数のインポートで ID の整合性が維持されない場合があります。この場合、コンテンツの重複を避けるために ReconciliationMode.FULL を強くおすすめします。未設定の場合、または false に設定されている場合、id_field を使用して Document.id を指定する必要があります。指定しないと、ID のないドキュメントをインポートできません。 サポートされているデータソース: GcsSource。GcsSource.data_schema は custom または csv にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。 BigQuerySource。BigQuerySource.data_schema は custom または csv にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。 SpannerSource。 CloudSqlSource。 FirestoreSource。 BigtableSource。
id_field	string このフィールドは、ドキュメントの一意の ID として使用される ID フィールドまたは列を示します。 GcsSource の場合は、JSON フィールドのキーです。たとえば、JSON {"my_id": "some_uuid"} の場合は my_id です。それ以外の場合は、一意の ID が保存されているテーブルの列名になります。 JSON フィールドまたはテーブル列の値は Document.id として使用されます。JSON フィールドまたはテーブル列は文字列型である必要があります。値は、1 ～ 63 文字の RFC-1034 に準拠した有効な文字列として設定する必要があります。そうしないと、有効な ID のないドキュメントはインポートされません。 このフィールドは、auto_generate_ids が未設定であるか、false に設定されている場合にのみ設定します。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。 設定されていない場合、許可されたデータソースからインポートするときにデフォルト値 _id が使用されます。 サポートされているデータソース: GcsSource。GcsSource.data_schema は custom または csv にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。 BigQuerySource。BigQuerySource.data_schema は custom または csv にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。 SpannerSource。 CloudSqlSource。 BigtableSource。
force_refresh_content	bool 省略可。ドキュメントの非構造化コンテンツを強制的に更新するかどうか。 true に設定すると、参照コンテンツの更新ステータスに関係なく、ドキュメントのコンテンツ部分が更新されます。
共用体フィールド source。必須。入力のソース。source は次のいずれかになります。
inline_source	InlineSource ドキュメントの入力コンテンツのインライン ソース。
gcs_source	GcsSource 入力コンテンツの Cloud Storage のロケーション。
bigquery_source	BigQuerySource BigQuery 入力ソース。
fhir_store_source	FhirStoreSource FhirStore 入力ソース。
spanner_source	SpannerSource Spanner 入力ソース。
cloud_sql_source	CloudSqlSource Cloud SQL 入力ソース。
firestore_source	FirestoreSource Firestore 入力ソース。
alloy_db_source	AlloyDbSource AlloyDB 入力ソース。
bigtable_source	BigtableSource Cloud Bigtable 入力ソース。

InlineSource

ImportDocuments メソッドの入力構成のインライン ソース。

フィールド
documents[]	Document 必須。更新または作成するドキュメントのリスト。各ドキュメントには有効な Document.id が必要です。推奨最大値は 100 アイテムです。

ReconciliationMode

インポートされたドキュメントが、以前に作成またはインポートされた既存のドキュメントとどのように調整されるかを示します。

列挙型
RECONCILIATION_MODE_UNSPECIFIED	デフォルトは INCREMENTAL です。
INCREMENTAL	新しいドキュメントを挿入するか、既存のドキュメントを更新します。
FULL	差分を計算し、ドキュメント データセット全体を置き換えます。既存のドキュメントが転送元に存在しない場合は、削除されることがあります。このモードを使用する場合、ターゲットのデータセットでダウンタイムは発生しません。変更されないドキュメントや更新されるドキュメントは、オペレーションの実行中も引き続き提供されます。

ImportDocumentsResponse

ImportDocumentsRequest のレスポンス。長時間実行オペレーションが完了し、オペレーションが成功した場合、このメッセージは google.longrunning.Operations.response フィールドにより返されます。

フィールド
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。
error_config	ImportErrorConfig 設定されている場合、リクエスト内で発生した全エラーの宛先を返します。

ImportErrorConfig

インポート関連エラーの宛先の構成。

フィールド
共用体フィールド destination。必須。エラーの宛先。destination は次のいずれかになります。
gcs_prefix	string インポート エラーの Cloud Storage 接頭辞。これは、既存の空の Cloud Storage ディレクトリである必要があります。インポート エラーは、このディレクトリのシャード ファイルに 1 行に 1 つずつ、JSON エンコードされた google.rpc.Status メッセージとして書き込まれます。

ImportIdentityMappingsRequest

IdentityMappingStoreService.ImportIdentityMappings のリクエスト メッセージ

フィールド
identity_mapping_store	string 必須。ID マッピング エントリのインポート先となる ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
共用体フィールド source。入力のソース。source は次のいずれかになります。
inline_source	InlineSource ID マッピング エントリのインポート元となるインライン ソース。

InlineSource

ID マッピング エントリのインポート元となるインライン ソース。

フィールド
identity_mapping_entries[]	IdentityMappingEntry 一度にインポートできるエントリは最大 10,000 件です

ImportIdentityMappingsResponse

IdentityMappingStoreService.ImportIdentityMappings に対するレスポンス メッセージ。

フィールド
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。

ImportSuggestionDenyListEntriesMetadata

ImportSuggestionDenyListEntries オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

ImportSuggestionDenyListEntriesRequest

CompletionService.ImportSuggestionDenyListEntries メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。拒否リスト エントリをインポートする親データストアのリソース名。パターン projects/*/locations/*/collections/*/dataStores/* に従います。
共用体フィールド source。更新された SuggestionDenyList のソース。source は次のいずれかになります。
inline_source	InlineSource 提案拒否リスト エントリの入力コンテンツのインライン ソース。
gcs_source	GcsSource 入力コンテンツの Cloud Storage のロケーション。 インポートするすべてのエントリを含むファイルは 1 つだけ指定できます。予測入力候補の拒否リスト エントリのインポートでサポートされている値 gcs_source.schema: suggestion_deny_list（デフォルト）: 1 行に 1 つの JSON [SuggestionDenyListEntry]。

InlineSource

SuggestionDenyListEntry のインライン ソース。

フィールド
entries[]	SuggestionDenyListEntry 必須。インポートするすべての拒否リスト エントリのリスト。最大 1,000 個のアイテム。

ImportSuggestionDenyListEntriesResponse

CompletionService.ImportSuggestionDenyListEntries メソッドに対するレスポンス メッセージ。

フィールド
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。
imported_entries_count	int64 拒否リスト エントリのインポート成功数。
failed_entries_count	int64 インポートできなかった拒否リスト エントリの数。

ImportUserEventsMetadata

インポート オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常に処理されたエントリの数。
failure_count	int64 処理中にエラーが発生したエントリの数。

ImportUserEventsRequest

ImportUserEvents リクエストのリクエスト メッセージ。

フィールド
parent	string 必須。親 DataStore リソース名。形式は projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} です。
error_config	ImportErrorConfig インポート中に発生したエラーを記録する目的の場所。インラインのユーザー イベントのインポートには設定できません。
共用体フィールド source。必須 - ユーザー イベント データの目的の入力ソース。source は次のいずれかになります。
inline_source	InlineSource UserEvents の入力コンテンツのインライン ソース。
gcs_source	GcsSource 入力コンテンツの Cloud Storage のロケーション。
bigquery_source	BigQuerySource BigQuery 入力ソース。

InlineSource

ImportUserEvents メソッドの入力構成のインライン ソース。

フィールド
user_events[]	UserEvent 必須。インポートするユーザー イベントのリスト。推奨最大値は 1 万アイテムです。

ImportUserEventsResponse

ImportUserEventsRequest のレスポンス。長時間実行オペレーションが成功した場合、このメッセージは google.longrunning.Operations.response フィールドにより返されます。

フィールド
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。
error_config	ImportErrorConfig このフィールドがリクエスト内で設定されている場合、発生した全エラーの宛先を返します。
joined_events_count	int64 インポートされたユーザー イベント数（完全な既存のドキュメントを含む）。
unjoined_events_count	int64 インポートされたユーザー イベント数（既存の Branch にドキュメント情報が見つからないものを含む）。

IndustryVertical

DataStore に関連付けられている業種。

列挙型
INDUSTRY_VERTICAL_UNSPECIFIED	設定されていない場合に使用される値。
GENERIC	特定の業種に固有ではないドキュメントの汎用カテゴリ。
MEDIA	メディア業界。
HEALTHCARE_FHIR	医療 FHIR 業種。

間隔

浮動小数点間隔。

フィールド
共用体フィールド min。区間の下限。最小フィールドのいずれも設定されていない場合、下限は負の無限大になります。 このフィールドは最大値以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。min は次のいずれかになります。
minimum	double 境界値を含む下限。
exclusive_minimum	double 境界値を含まない下限。
共用体フィールド max。間隔の上限。max フィールドがどちらも設定されていない場合、上限は正の無限大になります。 このフィールドは min 以上である必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。max は次のいずれかになります。
maximum	double 境界値を含む上限。
exclusive_maximum	double 境界値を含まない上限。

LicenseConfig

ユーザーのライセンスに関する情報。

フィールド
name	string 変更不可。ID。ライセンス構成の完全修飾リソース名。形式: projects/{project}/locations/{location}/licenseConfigs/{license_config}
license_count	int64 必須。購入したライセンス数。
subscription_tier	SubscriptionTier 必須。ライセンス構成のサブスクリプション ティア情報。
state	State 出力専用。ライセンス構成の状態。
auto_renew	bool 省略可。ライセンス構成が終了日に達したときに自動更新されるかどうか。
start_date	Date 必須。開始日。
end_date	Date 省略可。予定終了日。
subscription_term	SubscriptionTerm 必須。サブスクリプション期間。
free_trial	bool 省略可。ライセンス構成が無料トライアル用かどうか。
alert_policy_resource_config	AlertPolicyResourceConfig 省略可。このライセンス構成のアラート ポリシー構成。
gemini_bundle	bool 出力専用。ライセンス構成が Gemini バンドル用かどうか。

状態

ライセンス構成の状態の列挙。

列挙型
STATE_UNSPECIFIED	デフォルト値。ライセンス構成が存在しません。
ACTIVE	ライセンス構成が有効で、使用されている。
EXPIRED	ライセンス構成の有効期限が切れています。
NOT_STARTED	ライセンス設定がまだ開始されておらず、開始日が将来の日付になっている。

ListAssistantsRequest

AssistantService.ListAssistants メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
page_size	int32 返す Assistant の最大数。指定しない場合、デフォルトは 100 です。最大許容値は 1,000 です。これを超える値は 1,000 に強制変換されます。
page_token	string 前回の AssistantService.ListAssistants 呼び出しから受け取ったページトークン ListAssistantsResponse.next_page_token。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListAssistants に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListAssistantsResponse

AssistantService.ListAssistants メソッドに対するレスポンス メッセージ。

フィールド
assistants[]	Assistant お客様のすべての Assistant。
next_page_token	string 次のページを取得するために ListAssistantsRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListCmekConfigsRequest

CmekConfigService.ListCmekConfigs メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親ロケーションのリソース名（projects/{project}/locations/{location} など）。 呼び出し元にこのロケーションの CmekConfig を一覧表示する権限がない場合、CmekConfig が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

ListCmekConfigsResponse

CmekConfigService.ListCmekConfigs メソッドに対するレスポンス メッセージ。

フィールド
cmek_configs[]	CmekConfig お客様のすべての CmekConfig。

ListControlsRequest

ListControls メソッドのリクエスト。

フィールド
parent	string 必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} または projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}。
page_size	int32 省略可。ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
page_token	string 省略可。前回の ListControls 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter	string 省略可。リストの結果に適用するフィルタ。サポートされている機能: filter が設定されていない場合は、親ブランチのすべての商品を一覧表示します。現在、このフィールドはサポートされていません。

ListControlsResponse

ListControls メソッドのレスポンス。

フィールド
controls[]	Control 特定のデータストアのすべてのコントロール。
next_page_token	string ページ設定トークン。返されない場合は最後のページを示します。

ListConversationsRequest

ListConversations メソッドのリクエスト。

フィールド
parent	string 必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
page_size	int32 ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
page_token	string 前回の ListConversations 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter	string リストの結果に適用するフィルタ。サポートされている機能は、user_pseudo_id と state です。 例: 「user_pseudo_id = some_id」
order_by	string 並べ替えに使用するフィールドのカンマ区切りのリスト（昇順）。降順にするには、フィールド名の後に「desc」を使用します。サポートされているフィールド: * update_time * create_time * conversation_name 例: 「update_time desc」、「create_time」

ListConversationsResponse

ListConversations メソッドのレスポンス。

フィールド
conversations[]	Conversation 特定のデータストアのすべての会話。
next_page_token	string ページ設定トークン。返されない場合は最後のページを示します。

ListCustomModelsRequest

SearchTuningService.ListCustomModels メソッドに対するリクエスト メッセージ。

フィールド
data_store	string 必須。親データストアのリソース名（projects/*/locations/global/collections/default_collection/dataStores/default_data_store など）。このフィールドは、モデルの取得元となるデータストアを特定するために使用されます。

ListCustomModelsResponse

SearchTuningService.ListCustomModels メソッドに対するレスポンス メッセージ。

フィールド
models[]	CustomTuningModel カスタム チューニング モデルのリスト。

ListDataStoresRequest

DataStoreService.ListDataStores メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection_id} など）。 呼び出し元にこのロケーションの DataStore を一覧表示する権限がない場合、このデータストアが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。
page_size	int32 返す DataStore の最大数。指定しない場合、デフォルトは 10 です。最大値は 50 です。50 を超える値は 50 に強制変換されます。 このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。
page_token	string 前回の DataStoreService.ListDataStores 呼び出しから受け取ったページトークン ListDataStoresResponse.next_page_token。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、DataStoreService.ListDataStores に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
filter	string ソリューション タイプでフィルタします。例: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

ListDataStoresResponse

DataStoreService.ListDataStores メソッドに対するレスポンス メッセージ。

フィールド
data_stores[]	DataStore お客様のすべての DataStore。
next_page_token	string 次のページを取得するために ListDataStoresRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDocumentsRequest

DocumentService.ListDocuments メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} など）。ブランチ ID として default_branch を使用して、デフォルト ブランチでドキュメントを一覧表示します。 呼び出し元にこのブランチの Document を一覧表示する権限がない場合、このブランチが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。
page_size	int32 返す Document の最大数。指定しない場合、デフォルトは 100 です。最大値は 1,000 です。1,000 を超える値は 1,000 に設定されます。 このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
page_token	string 前回の DocumentService.ListDocuments 呼び出しから受け取ったページトークン ListDocumentsResponse.next_page_token。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、DocumentService.ListDocuments に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

ListDocumentsResponse

DocumentService.ListDocuments メソッドに対するレスポンス メッセージ。

フィールド
documents[]	Document Document。
next_page_token	string 次のページを取得するために ListDocumentsRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListEnginesRequest

EngineService.ListEngines メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location}/collections/{collection_id} など）。
page_size	int32 省略可。非対応。
page_token	string 省略可。非対応。
filter	string 省略可。ソリューション タイプでフィルタします。例: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

EngineService.ListEngines メソッドに対するレスポンス メッセージ。

フィールド
engines[]	Engine お客様のすべての Engine。
next_page_token	string 非対応。

ListIdentityMappingStoresRequest

IdentityMappingStoreService.ListIdentityMappingStores のリクエスト メッセージ

フィールド
parent	string 必須。一覧表示する Identity Mapping Store の親。形式: projects/{project}/locations/{location}。
page_size	int32 返される IdentityMappingStore の最大数。指定しない場合、デフォルトは 100 です。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
page_token	string 前回の ListIdentityMappingStores 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListIdentityMappingStores に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListIdentityMappingStoresResponse

IdentityMappingStoreService.ListIdentityMappingStores に対するレスポンス メッセージ。

フィールド
identity_mapping_stores[]	IdentityMappingStore ID マッピング ストア。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListIdentityMappingsRequest

IdentityMappingStoreService.ListIdentityMappings のリクエスト メッセージ

フィールド
identity_mapping_store	string 必須。ID マッピング エントリを一覧表示する ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
page_size	int32 返す IdentityMapping の最大数。指定しない場合、デフォルトは 2, 000 です。最大 10,000 です。10,000 を超える値は 10,000 に強制変換されます。
page_token	string 前回の ListIdentityMappings 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListIdentityMappings に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListIdentityMappingsResponse

IdentityMappingStoreService.ListIdentityMappings に対するレスポンス メッセージ。

フィールド
identity_mapping_entries[]	IdentityMappingEntry ID マッピング エントリ。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSchemasRequest

SchemaService.ListSchemas メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親データストアのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} 形式）。
page_size	int32 返す Schema の最大数。サービスから返される数は、この値より少ない場合があります。 指定されていない場合、最大で 100 個の Schema が返されます。 最大値は 1,000 です。1,000 を超える値は 1,000 に設定されます。
page_token	string 前回の SchemaService.ListSchemas 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、SchemaService.ListSchemas に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListSchemasResponse

SchemaService.ListSchemas メソッドに対するレスポンス メッセージ。

フィールド
schemas[]	Schema Schema。
next_page_token	string 次のページを取得するために ListSchemasRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSessionsRequest

ListSessions メソッドのリクエスト。

フィールド
parent	string 必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
page_size	int32 ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
page_token	string 前回の ListSessions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter	string フィルタするフィールドのカンマ区切りのリスト（EBNF 文法）。 サポートされているフィールドは次のとおりです。 user_pseudo_id state display_name starred is_pinned labels create_time update_time 例: user_pseudo_id = some_id display_name = "some_name" starred = true is_pinned=true AND (NOT labels:hidden) create_time > "1970-01-01T12:00:00Z"
order_by	string 並べ替えに使用するフィールドのカンマ区切りのリスト（昇順）。降順にするには、フィールド名の後に「desc」を使用します。 サポートされているフィールド: update_time create_time session_name is_pinned 例: update_time desc create_time is_pinned desc,update_time desc: セッションを is_pinned で並べ替え、次に update_time で並べ替えます。

ListSessionsResponse

ListSessions メソッドのレスポンス。

フィールド
sessions[]	Session 特定のデータストアのすべてのセッション。
next_page_token	string ページ設定トークン。返されない場合は最後のページを示します。

ListTargetSitesRequest

SiteSearchEngineService.ListTargetSites メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親サイト検索エンジンのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine など）。 呼び出し元にこのサイト検索エンジンの TargetSite を一覧表示する権限がない場合、このブランチが存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。
page_size	int32 リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。 このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
page_token	string 前回の ListTargetSites 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListTargetSites に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListTargetSitesResponse

SiteSearchEngineService.ListTargetSites メソッドに対するレスポンス メッセージ。

フィールド
target_sites[]	TargetSite TargetSite のリスト。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
total_size	int32 リクエストに一致するアイテムの総数。この値はレスポンスに常に入力されます。

ListUserLicensesRequest

UserLicenseService.ListUserLicenses のリクエスト メッセージです。

フィールド
parent	string 必須。親の [UserStore][] リソース名。形式: projects/{project}/locations/{location}/userStores/{user_store_id}。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合、デフォルトは 10 です。最大値は 50 です。50 を超える値は 50 に強制変換されます。 このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の ListUserLicenses 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListUserLicenses に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter	string 省略可。リスト リクエストのフィルタ。 サポートされているフィールド: license_assignment_state 例: license_assignment_state = ASSIGNED: 割り当てられたユーザー ライセンスを一覧表示します。 license_assignment_state = NO_LICENSE: ライセンスが付与されていないユーザーを一覧表示します。 license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN: ログインを試みたがライセンスが割り当てられていないユーザーを一覧表示します。 license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN: ログインを試みたがライセンスが割り当てられていないユーザーを除外します。

ListUserLicensesResponse

UserLicenseService.ListUserLicenses に対するレスポンス メッセージです。

フィールド
user_licenses[]	UserLicense お客様のすべての UserLicense。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

MediaInfo

メディア固有のユーザー イベント情報。

フィールド
media_progress_duration	Duration メディアの進行状況（秒単位、該当する場合）。たとえば、エンドユーザーが再生動画の 90 秒を視聴した場合、MediaInfo.media_progress_duration.seconds は 90 に設定されます。
media_progress_percentage	float メディアの進行状況は、メディアの合計長に対する media_progress_duration のみを使用して計算する必要があります。 この値は [0, 1.0] の範囲で指定する必要があります。 再生ではない場合や、進行状況を計算できない場合（ライブ配信中など）は、このフィールドを未設定にする必要があります。

PageInfo

詳細なページ情報。

フィールド
pageview_id	string ウェブページ ビューの一意の ID。 同じページビューからトリガーされたすべてのユーザー イベントで同じ値にする必要があります。たとえば、アイテムの詳細ページビューでは、ユーザーがページをブラウジングする際に複数のイベントがトリガーされる可能性があります。これらのイベントが適切にグループ化されるように、pageview_id プロパティはすべてのイベントで同じにする必要があります。 JavaScript Pixel と Google タグ マネージャーでクライアントサイドのイベント レポートを使用する場合、この値は自動的に入力されます。
page_category	string カテゴリページに関連付けられている最も具体的なカテゴリ。 カテゴリのフルパスを表すには、異なる階層を区切るために「>」記号を使用します。'>' がカテゴリ名の一部である場合は、別の文字に置き換えます。 カテゴリページには、セールやプロモーションなどの特別なページが含まれます。たとえば、特別セールページには、"pageCategory" : "Sales > 2017 Black Friday Deals" などのカテゴリ階層を設定できます。 view-category-page イベントで必須です。他のイベントタイプでは、このフィールドを設定しないでください。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
uri	string ユーザーの現在のページの完全な URL（window.location.href）。 JavaScript Pixel と Google タグ マネージャーでクライアントサイドのイベント レポートを使用する場合、この値は自動的に入力されます。最大文字数は 5,000 文字です。
referrer_uri	string 現在のページの参照元 URL。 JavaScript Pixel と Google タグ マネージャーでクライアントサイドのイベント レポートを使用する場合、この値は自動的に入力されます。ただし、ブラウザのプライバシー制限により、このフィールドが空になることがあります。

PanelInfo

ユーザー イベントに関連付けられた詳細パネル情報。

フィールド
panel_id	string 必須。パネル ID。
display_name	string パネルの表示名。
documents[]	DocumentInfo 省略可。このパネルに関連付けられているドキュメント ID。
panel_position	int32 他のパネルとともにユーザーに表示される場合の、パネルの順序付き位置。設定する場合は、total_panels も設定する必要があります。
total_panels	int32 ユーザーに表示されたパネルの合計数（このパネルを含む）。panel_position が設定されている場合は、設定する必要があります。

プリンシパル

ユーザーまたはグループのプリンシパル ID。

フィールド
共用体フィールド principal。共用体フィールド principal。プリンシパルは、ユーザーまたはグループにすることができます。principal は次のいずれかになります。
user_id	string ユーザー識別子。Google Workspace ユーザー アカウントの場合、user_id は Google Workspace ユーザーのメールアドレスにする必要があります。Google 以外の ID プロバイダのユーザー アカウントの場合、user_id は workforcepool 構成時に構成されたマッピングされたユーザー ID です。
group_id	string グループ ID。Google Workspace ユーザー アカウントの場合、group_id は Google Workspace グループのメールアドレスである必要があります。Google 以外の ID プロバイダのユーザー アカウントの場合、group_id は workforcepool 構成時に構成されたマッピングされたグループ ID です。
external_entity_id	string お客様の ID プロバイダに存在しないサードパーティ アプリケーション ID。

プロジェクト

サービス内の Google Cloud プロジェクトのメタデータと構成。

フィールド
name	string 出力専用。プロジェクトの完全なリソース名（例: projects/{project}）。リクエストを行う際は、プロジェクト番号とプロジェクト ID の両方を使用できますが、サーバーは常にプロジェクト番号で応答します。
create_time	Timestamp 出力専用。このプロジェクトが作成されたときのタイムスタンプ。
provision_completion_time	Timestamp 出力専用。このプロジェクトが正常にプロビジョニングされたときのタイムスタンプ。値が空の場合、このプロジェクトはまだプロビジョニング中で、使用する準備ができていないことを意味します。
service_terms_map	map<string, ServiceTerms> 出力専用。利用規約のマップ。キーは ServiceTerms の id です。
customer_provided_config	CustomerProvidedConfig 省略可。お客様が提供した構成。

CustomerProvidedConfig

お客様が提供した構成。

フィールド
notebooklm_config	NotebooklmConfig 省略可。NotebookLM の設定の構成。

NotebooklmConfig

NotebookLM の構成。

フィールド
model_armor_config	ModelArmorConfig ユーザー プロンプトと LLM レスポンスのサニタイズに使用される Model Armor 構成。

ModelArmorConfig

ユーザー プロンプトと LLM レスポンスのサニタイズに使用される、お客様が定義した Model Armor テンプレートの構成。

フィールド
user_prompt_template	string 省略可。ユーザー プロンプトをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{template_id} 指定しない場合、ユーザー プロンプトにサニタイズは適用されません。
response_template	string 省略可。LLM レスポンスをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{template_id}。指定しない場合、LLM レスポンスにサニタイズは適用されません。

ServiceTerms

利用規約に関するメタデータ。

フィールド
id	string この利用規約の固有識別子。利用可能なキーワード: GA_DATA_USE_TERMS: データ使用に関する条件。これを id として使用する場合、指定できる version は 2022-11-23 です。
version	string 利用規約のバージョン文字列。有効な値については、上記の id のコメントをご覧ください。
state	State プロジェクトがサービス規約に同意したか、拒否したか、またはまだ保留中であるか。
accept_time	Timestamp プロジェクトが利用規約に同意した最終日時。
decline_time	Timestamp プロジェクトが利用規約への同意を拒否または取り消した日時。

状態

この利用規約は契約に記載されています。

列挙型
STATE_UNSPECIFIED	列挙型のデフォルト値。この値は実際には使用されません。
TERMS_ACCEPTED	プロジェクトが利用規約に同意している。
TERMS_PENDING	プロジェクトは利用規約の確認と同意待ちです。
TERMS_DECLINED	プロジェクトが利用規約への同意を拒否または取り消した。

ProvisionProjectMetadata

この型にはフィールドがありません。

プロジェクト プロビジョニング オペレーションに関連付けられたメタデータ。

ProvisionProjectRequest

ProjectService.ProvisionProject メソッドのリクエスト。

フィールド
name	string 必須。Project の完全なリソース名（例: projects/{project_id_or_number}）。
accept_data_use_terms	bool 必須。呼び出し元がデータ利用規約を読み、同意することを指定するには、true に設定します。
data_use_terms_version	string 必須。呼び出し元が確認し、同意を希望するデータ利用規約のバージョン。 許容されるバージョンは 2022-11-23 です。これは今後変更される可能性があります。
saas_params	SaasParams 省略可。Agentspace のパラメータ。

SaasParams

Agentspace のパラメータ。

フィールド
accept_biz_qos	bool 省略可。呼び出し元が [Agent Space のサービス品質に関する規約] を読み、同意することを指定する場合は、true に設定します。
is_biz	bool 省略可。現在のリクエストが Biz エディション用かどうかを示します（Biz エディションの場合は true、それ以外の場合は false）。

PurgeCompletionSuggestionsMetadata

PurgeCompletionSuggestions オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

PurgeCompletionSuggestionsRequest

CompletionService.PurgeCompletionSuggestions メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。補完候補を削除する親データストアのリソース名。パターン projects/*/locations/*/collections/*/dataStores/* に従います。

PurgeCompletionSuggestionsResponse

CompletionService.PurgeCompletionSuggestions メソッドに対するレスポンス メッセージ。

フィールド
purge_succeeded	bool 補完候補が正常に削除されたかどうか。
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。

PurgeDocumentsMetadata

PurgeDocuments オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常に削除されたエントリの数。
failure_count	int64 処理中にエラーが発生したエントリの数。
ignored_count	int64 エントリが見つからなかったため無視されたエントリの数。

PurgeDocumentsRequest

DocumentService.PurgeDocuments メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch} など）。
filter	string 必須。一致するドキュメントをフィルタして削除します。現在サポートされている値は *（すべてのアイテム）のみです。
error_config	PurgeErrorConfig 削除中に発生したエラーを記録する目的の場所。
force	bool 実際に削除を実行します。force が false に設定されている場合は、ドキュメントを削除せずに、予想される削除件数を返します。
共用体フィールド source。ドキュメント ID に基づいてドキュメントを削除するための目的の入力ソース。source は次のいずれかになります。
gcs_source	GcsSource 入力コンテンツの Cloud Storage のロケーション。サポートされている data_schema: * document_id: 1 行に 1 つの有効な Document.id。
inline_source	InlineSource 削除の入力コンテンツのインライン ソース。

InlineSource

DocumentService.PurgeDocuments メソッドの入力構成のインライン ソース。

フィールド
documents[]	string 必須。削除するドキュメントの完全なリソース名のリスト。形式は projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/* です。推奨最大値は 100 アイテムです。

PurgeDocumentsResponse

DocumentService.PurgeDocuments メソッドに対するレスポンス メッセージ。長時間実行オペレーションが正常に完了すると、このメッセージが google.longrunning.Operations.response フィールドにより返されます。

フィールド
purge_count	int64 オペレーションの結果として削除されたドキュメントの合計数。
purge_sample[]	string 削除されるドキュメント名のサンプル。force が false に設定されている場合にのみ入力されます。最大 100 個の名前が返され、名前はランダムに選択されます。

PurgeErrorConfig

削除関連エラーの宛先の構成。

フィールド
共用体フィールド destination。必須。エラーの宛先。destination は次のいずれかになります。
gcs_prefix	string 削除エラーの Cloud Storage 接頭辞。これは、既存の空の Cloud Storage ディレクトリである必要があります。削除エラーは、このディレクトリのシャード ファイルに 1 行に 1 つずつ、JSON エンコードされた google.rpc.Status メッセージとして書き込まれます。

PurgeIdentityMappingsRequest

IdentityMappingStoreService.PurgeIdentityMappings のリクエスト メッセージ

フィールド
identity_mapping_store	string 必須。ID マッピング エントリを削除する ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
filter	string 削除する一致する ID マッピングをフィルタします。フィルタリングの対象となるフィールドは次のとおりです。* update_time: ISO 8601 の「zulu」形式。* external_id 例: 期間内に更新されたすべての ID マッピングの削除: update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z" 特定の external_id のすべての ID マッピングを削除する: external_id = "id1" ID マッピング ストア内のすべての ID マッピングを削除する: * フィルタリング フィールドには暗黙的な AND があると想定されます。ソースとともに使用しないでください。両方が指定されている場合は、エラーがスローされます。
共用体フィールド source。入力のソース。source は次のいずれかになります。
inline_source	InlineSource ID マッピング エントリを削除するインライン ソース。
force	bool 実際に削除を実行します。force が false に設定されている場合は、ID マッピングを削除せずに、予想される削除件数を返します。このフィールドは、フィルタを使用した削除でのみサポートされています。入力ソースの場合、このフィールドは無視され、このフィールドの値に関係なくデータは削除されます。

InlineSource

ID マッピング エントリを削除するインライン ソース。

フィールド
identity_mapping_entries[]	IdentityMappingEntry 一度に削除できるエントリは最大 10,000 件です

PurgeSuggestionDenyListEntriesMetadata

PurgeSuggestionDenyListEntries オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

PurgeSuggestionDenyListEntriesRequest

CompletionService.PurgeSuggestionDenyListEntries メソッドに対するリクエスト メッセージ。

フィールド
parent	string 必須。拒否リスト エントリをインポートする親データストアのリソース名。パターン projects/*/locations/*/collections/*/dataStores/* に従います。

PurgeSuggestionDenyListEntriesResponse

CompletionService.PurgeSuggestionDenyListEntries メソッドに対するレスポンス メッセージ。

フィールド
purge_count	int64 削除された候補の拒否リスト エントリの数。
error_samples[]	Status リクエストの処理中に発生したエラーのサンプル。

PurgeUserEventsMetadata

PurgeUserEvents オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
success_count	int64 正常に削除されたエントリの数。
failure_count	int64 処理中にエラーが発生したエントリの数。

PurgeUserEventsRequest

PurgeUserEvents メソッドのリクエスト メッセージ。

フィールド
parent	string 必須。イベントが作成されるカタログのリソース名。形式は projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore} です。
filter	string 必須。削除するイベントを指定するフィルタ文字列。長さの上限は 5,000 文字です。フィルタリングの対象となるフィールドは次のとおりです。 eventType: 二重引用符で囲まれた UserEvent.event_type 文字列。 eventTime: ISO 8601 の「zulu」形式。 userPseudoId: 二重引用符で囲まれた文字列。これを指定すると、訪問者に関連付けられているすべてのイベントが削除されます。 userId: 二重引用符で囲まれた文字列。これを指定すると、ユーザーに関連付けられているすべてのイベントが削除されます。 注: この API は、最大 30 日間の範囲の削除のみをサポートしています。 例: 期間内のすべてのイベントの削除: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" 期間内の特定の eventType の削除: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search" 期間内の特定の訪問者のすべてのイベントの削除: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024" DataStore 内の過去 30 日間のイベントを削除する: * フィルタリング フィールドには暗黙的な AND があると想定されます。
force	bool force フィールドは現在サポートされていません。ユーザー イベントの削除リクエストを行うと、削除可能なすべてのイベントが完全に削除されます。開発が完了したら: force が false に設定されている場合、このメソッドは、ユーザー イベントを削除せずに、予想される削除件数を返します。リクエストに含まれていない場合、このフィールドはデフォルトで false になります。

PurgeUserEventsResponse

PurgeUserEventsRequest のレスポンス。長時間実行オペレーションが正常に完了すると、このメッセージが google.longrunning.Operations.response フィールドにより返されます。

フィールド
purge_count	int64 オペレーションの結果として削除されたイベントの合計数。

クエリ

ユーザーが入力したクエリを定義します。

フィールド
query_id	string 出力専用。クエリの一意の ID。
共用体フィールド content。コンテンツをクエリします。content は次のいずれかになります。
text	string 書式なしテキスト。

RankRequest

RankService.Rank メソッドに対するリクエスト メッセージ。

フィールド
ranking_config	string 必須。ランクサービス構成のリソース名（projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config など）。
model	string 使用するモデルの識別子。次のいずれかです。 semantic-ranker-512@latest: 最大入力トークン サイズが 512 のセマンティック ランキング モデル。 指定しない場合、デフォルトで semantic-ranker-512@latest に設定されます。
top_n	int32 返す結果の数。設定されていない場合、またはゼロ以下の場合、すべての結果を返します。
query	string 使用するクエリ。
records[]	RankingRecord 必須。ランク付けするレコードのリスト。
ignore_record_details_in_response	bool true の場合、レスポンスにはレコード ID とスコアのみが含まれます。デフォルトでは false で、レスポンスにはレコードの詳細が含まれます。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳細については、Google Cloud ドキュメントをご覧ください。

RankResponse

RankService.Rank メソッドに対するレスポンス メッセージ。

フィールド
records[]	RankingRecord スコアの降順で並べ替えられたレコードのリスト。

RankingRecord

RankService.Rank メソッドのメッセージを記録します。

フィールド
id	string レコードを表す一意の ID。
title	string レコードのタイトル。デフォルトでは空です。title または content の少なくとも 1 つを設定する必要があります。設定しないと、INVALID_ARGUMENT エラーがスローされます。
content	string レコードの内容。デフォルトでは空です。title または content の少なくとも 1 つを設定する必要があります。設定しないと、INVALID_ARGUMENT エラーがスローされます。
score	float 指定されたクエリと選択されたモデルに基づくこのレコードのスコア。スコアは小数点第 2 位までに四捨五入されます。スコアが 0 に近い場合は、未設定が返されないように 0.0001 に丸められます。

RecommendRequest

Recommend メソッドのリクエスト メッセージ。

フィールド
serving_config	string 必須。ServingConfig の完全なリソース名: projects/*/locations/global/collections/*/engines/*/servingConfigs/* または projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* デフォルトのサービス構成は、レコメンデーション エンジンの作成と同時に作成されます。エンジン ID は、デフォルトのサービス提供構成の ID として使用されます。たとえば、Engine projects/*/locations/global/collections/*/engines/my-engine の場合、RecommendationService.Recommend リクエストに projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine を使用できます。
user_event	UserEvent 必須。ユーザー、ユーザーが閲覧しているもの、Recommend リクエストをトリガーするためにユーザーが取ったアクションに関するコンテキスト。このユーザー イベントの詳細は userEvent ログに取り込まれません。そのため、イベントのロギングには個別の userEvent 書き込みリクエストが必要です。 UserEvent.user_pseudo_id または UserEvent.user_info.user_id を異なるユーザーに対して同じ固定 ID に設定しないでください。パーソナライズされていないおすすめコンテンツを受け取ろうとしている場合（おすすめしません。モデルのパフォーマンスに悪影響を及ぼす可能性があります）、代わりに UserEvent.user_pseudo_id をランダムな一意の ID に設定し、UserEvent.user_info.user_id を未設定のままにします。
page_size	int32 ページあたりの結果数の上限です。このプロパティを必要なレコメンデーション結果の数に設定します。ゼロの場合、サービスは適切なデフォルトを選択します。最大値は 100 です。100 を超える値は 100 に設定されます。
filter	string レコメンデーションの結果を制限するフィルタ。長さの上限は 5,000 文字です。現在、filter_tags 属性のフィルタ式のみがサポートされています。 例: (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold")) (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green")) params フィールドで attributeFilteringSyntax が true に設定されている場合、上記で説明したタグベースの構文ではなく、属性ベースの式が想定されます。例: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) フィルタによってすべての結果がブロックされると、API は一般的な（フィルタされていない）人気の高いドキュメントを返します。フィルタに厳密に一致する結果のみが必要な場合は、RecommendRequest.params で strictFiltering を true に設定して、代わりに空の結果を受け取ります。 フィルタの選択に関係なく、API は storageStatus が EXPIRED または DELETED の Document を返すことはありません。
validate_only	bool この推奨事項クエリには、検証専用モードを使用します。true に設定すると、任意のドキュメント ID を返すフェイクモデルが使用されます。検証専用モードは、API のテストまたはモデルの準備が整っていない場合にのみ使用してください。
params	map<string, Value> 推奨事項のドメイン固有の追加パラメータ。 使用できる値: returnDocument: ブール値true に設定すると、関連付けられた Document オブジェクトが RecommendResponse.RecommendationResult.document で返されます。 returnScore: ブール値true に設定すると、返された各ドキュメントに対応する推奨スコアが RecommendResponse.RecommendationResult.metadata に設定されます。指定されたスコアは、ユーザーのコンテキストと履歴に基づいてドキュメントが変換される確率を示します。 strictFiltering: ブール値デフォルトでは True です。false に設定されている場合、フィルタによってすべてのレコメンデーション結果がブロックされると、サービスは空ではなく一般的な（フィルタされていない）人気のドキュメントを返します。 diversityLevel: 文字列。デフォルトは空です。空でない値に設定する場合は、次のいずれかにする必要があります。 no-diversity low-diversity medium-diversity high-diversity auto-diversity: リクエスト レベルで制御し、ドキュメントのカテゴリに基づいてレコメンデーションの結果を調整します。 attributeFilteringSyntax: ブール値デフォルトは False です。true に設定すると、filter フィールドは新しい属性ベースの構文に従って解釈されます。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳しくは、ラベルの要件をご覧ください。

RecommendResponse

Recommend メソッドのレスポンス メッセージ。

フィールド
results[]	RecommendationResult おすすめのドキュメントのリスト。順序はランキング（最も関連性の高いドキュメントから最も関連性の低いドキュメント）を表します。
attribution_token	string 一意の属性トークン。これは、この推奨事項から得られた UserEvent ログに含める必要があります。これにより、レコメンデーション モデルのパフォーマンスを正確に特定できます。
missing_ids[]	string リクエストされた ServingConfig に関連付けられたデフォルトのブランチに存在しなかった、リクエスト内のドキュメントの ID。
validate_only	bool RecommendRequest.validate_only が設定されている場合は true。

RecommendationResult

RecommendationResult は、関連するメタデータを含む一般的なレコメンデーション結果を表します。

フィールド
id	string 推奨されるドキュメントのリソース ID。
document	Document RecommendRequest.params で returnDocument が true に設定されている場合に設定します。
metadata	map<string, Value> ドキュメントの追加のメタデータまたはアノテーション。 値は次のいずれかです。 score: レコメンデーション スコア（倍精度浮動小数点値）。RecommendRequest.params で returnScore が true に設定されている場合に設定されます。

RecrawlUrisMetadata

SiteSearchEngineService.RecrawlUris オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。
invalid_uris[]	string リクエスト内の形式が無効な一意の URI。サンプルは 1,000 に制限されています。
invalid_uris_count	int32 形式が無効なリクエスト内のユニークな URI の合計数。
noindex_uris[]	string インデックス メタタグがない URI。サンプルは 1,000 に制限されています。
noindex_uris_count	int32 インデックス メタタグのない URI の合計数。
uris_not_matching_target_sites[]	string リクエスト内のユニーク URI が、DataStore 内の TargetSite と一致しない、完全にインデックス登録されていない TargetSite とのみ一致する、またはタイプが EXCLUDE の TargetSite と一致する場合。サンプルは 1,000 に制限されています。
uris_not_matching_target_sites_count	int32 TargetSites と一致しない URI の総数。
valid_uris_count	int32 invalid_uris に含まれていないリクエスト内の固有 URI の合計数。
success_count	int32 これまでにクロールされた URI の合計数。
pending_count	int32 まだクロールされていない URI の合計数。
quota_exceeded_count	int32 インデックス登録リソースが不足しているため拒否された URI の合計数。

RecrawlUrisRequest

SiteSearchEngineService.RecrawlUris メソッドに対するリクエスト メッセージ。

フィールド
site_search_engine	string 必須。SiteSearchEngine の完全なリソース名（projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine など）。
uris[]	string 必須。クロールする URI のリスト。サポートされる URI は最大 10, 000 個です。それ以外の場合は、INVALID_ARGUMENT エラーがスローされます。各 URI は、site_search_engine の少なくとも 1 つの TargetSite と一致する必要があります。
site_credential	string 省略可。クロールに使用する認証情報の ID。

RecrawlUrisResponse

SiteSearchEngineService.RecrawlUris メソッドに対するレスポンス メッセージ。

フィールド
failure_samples[]	FailureInfo 最大 10 個の failed_uris のサンプルに関する詳細。
failed_uris[]	string LRO が終了する前にクロールされなかった URI。

FailureInfo

特定の URI のクロールが失敗した理由の詳細。各 FailureInfo には、CorpusType ごとに 1 つの FailureReason が含まれています。

フィールド
uri	string クロールに失敗した URI。
failure_reasons[]	FailureReason コーパスの種類（パソコン、モバイルなど）別の失敗理由のリスト。

FailureReason

特定の CorpusType のクロールが失敗した理由に関する詳細（例: パソコンとモバイルのクロールは、それぞれ異なる理由で失敗することがあります。

フィールド
corpus_type	CorpusType DESKTOP、MOBILE、または CORPUS_TYPE_UNSPECIFIED。
error_message	string URI がクロールされなかった理由。

CorpusType

失敗したクロール オペレーションの CorpusType。

列挙型
CORPUS_TYPE_UNSPECIFIED	デフォルト値。
DESKTOP	ページのパソコン版のクロール試行を示します。
MOBILE	ページのモバイル版のクロール試行を示します。

返信

ユーザーへの返信メッセージを定義します。

フィールド
summary	Summary 検索結果に基づく要約。

SafetyRating

生成されたコンテンツに対応する安全性評価。

フィールド
category	HarmCategory 出力専用。有害カテゴリ。
probability	HarmProbability 出力専用。コンテンツ内が有害である確率のレベル。
probability_score	float 出力専用。有害である確率のスコア。
severity	HarmSeverity 出力専用。コンテンツ内の有害性の重大度レベル。
severity_score	float 出力専用。有害性の重大度スコア。
blocked	bool 出力専用。このレーティングが原因でコンテンツがフィルタリングされたかどうかを示します。

HarmProbability

コンテンツ内が有害である確率のレベル。

列挙型
HARM_PROBABILITY_UNSPECIFIED	有害である確率が指定されていません。
NEGLIGIBLE	有害性のレベルが無視できる。
LOW	危害のレベルが低い。
MEDIUM	中程度の有害性。
HIGH	有害性のレベルが高い。

HarmSeverity

有害性の重大度レベル。

列挙型
HARM_SEVERITY_UNSPECIFIED	有害性の重大度が指定されていません。
HARM_SEVERITY_NEGLIGIBLE	有害性の重大度が無視できるレベル。
HARM_SEVERITY_LOW	危害の重大度が低い。
HARM_SEVERITY_MEDIUM	中程度の有害性の重大度。
HARM_SEVERITY_HIGH	有害性の重大度が高い。

スキーマ

ドキュメント データの種類の構造とレイアウトを定義します。

フィールド
name	string 変更不可。スキーマの完全なリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema} 形式）。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
共用体フィールド schema。スキーマの表現。struct_schema または json_schema のいずれかを指定する必要があります。指定しないと、INVALID_ARGUMENT エラーがスローされます。schema は次のいずれかになります。
struct_schema	Struct スキーマの構造化された表現。
json_schema	string スキーマの JSON 表現。

SearchAddOn

検索に追加機能を提供するアドオン。

列挙型
SEARCH_ADD_ON_UNSPECIFIED	列挙型が指定されていない場合のデフォルト値。これは使用できません。
SEARCH_ADD_ON_LLM	大規模言語モデル アドオン。

SearchInfo

検索の詳細情報。

フィールド
search_query	string ユーザーの検索クエリ。 定義については、SearchRequest.query をご覧ください。 値は UTF-8 でエンコードされた文字列で、長さの上限は 5,000 文字です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 search イベントには、search_query または PageInfo.page_category の少なくとも 1 つが必要です。他のイベントタイプでは、このフィールドを設定しないでください。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
order_by	string 商品が返される順序（該当する場合）。 定義と構文については、SearchRequest.order_by をご覧ください。 値は UTF-8 でエンコードされた文字列で、長さの上限は 1,000 文字です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 これは search イベントにのみ設定できます。他のイベントタイプでは、このフィールドを設定しないでください。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
offset	int32 ページネーションの現在のオフセット（API で関連すると見なされるプロダクトにおける 0 から始まる開始位置）を指定する整数。 定義については、SearchRequest.offset をご覧ください。 このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。 これは search イベントにのみ設定できます。他のイベントタイプでは、このフィールドを設定しないでください。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

SearchLinkPromotion

プロモーションの proto には、プロモーションを表示するための URI などの補助情報が含まれています。

フィールド
title	string 必須。プロモーションのタイトル。最大文字数: 160 文字。
uri	string 省略可。ユーザーがプロモートするページの URL。サイト内検索用に設定する必要があります。他の業種では、これは省略可能です。
document	string 省略可。ユーザーが昇格を希望する Document。サイト検索の場合は、設定せずに uri のみを入力します。URI とともに設定できます。
image_uri	string 省略可。プロモーションのサムネイル画像の URL。
description	string 省略可。プロモーションの説明。最大 200 文字を入力できます。
enabled	bool 省略可。有効なプロモーションは、このプロモーションが関連付けられているコントロールの親に関連付けられているサービス構成に対して返されます。 このフラグは基本的なサイト内検索でのみ使用されます。

SearchRequest

SearchService.Search メソッドに対するリクエスト メッセージ。

フィールド
serving_config	string 必須。検索サービス構成のリソース名（projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config、projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config など）。このフィールドは、検索に使用されるサービス構成名とモデルのセットを識別するために使用されます。
branch	string ブランチのリソース名（projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0 など）。 ブランチ ID として default_branch を使用するか、このフィールドを空白のままにして、デフォルト ブランチでドキュメントを検索します。
query	string 未加工の検索クエリ。
image_query	ImageQuery 未加工の画像クエリ。
page_size	int32 返す Document の最大数。許容される最大値は、データ型によって異なります。最大値を超える値は、最大値に強制変換されます。 基本的なインデックス登録のウェブサイト: デフォルト 10、最大 25。 高度なインデックス登録が有効になっているウェブサイト: デフォルト 25、最大 50。 その他: デフォルト 50、最大 100。 このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。
page_token	string 前回の SearchService.Search 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、SearchService.Search に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
offset	int32 検索結果の現在のオフセット（つまり、API で関連すると見なされる Document における開始結果の場所）を指定する 0 から始まる整数。このフィールドは、page_token が設定されていない場合にのみ考慮されます。 このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。 大きなオフセットは、妥当なしきい値に制限されることがあります。
one_box_page_size	int32 OneBox で返される結果の最大数。これは、各 OneBox タイプに個別に適用されます。デフォルト値は 10 です。
data_store_specs[]	DataStoreSpec 検索する特定の DataStore と、それらのデータストアの構成を定義する仕様。これは、複数のデータストアを持つ Engine でのみ考慮されます。単一のデータストアを持つエンジンでは、SearchRequest の直下の仕様を使用する必要があります。
filter	string フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。 このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。 Vertex AI Search でのフィルタリングは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキー プロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマに「name」というフィールドがあるとします。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。 構文やフィルタ オペレータなどのフィルタリングの詳細については、フィルタをご覧ください。
canonical_filter	string ユーザーが検索ページでフィルタをオンにせずに検索を実行したときに適用されるデフォルトのフィルタ。 クエリ拡張などの品質改善が必要な場合に、すべての検索リクエストに適用されるフィルタ。クエリの結果が十分でない場合、このフィルタを使用して、クエリ拡張フローを有効にするかどうかを判断します。元のフィルタは、クエリ拡張検索で引き続き使用されます。このフィールドは、検索品質を高めるために強く推奨されます。 フィルタ構文の詳細については、SearchRequest.filter をご覧ください。
order_by	string ドキュメントが返される順序。ドキュメントは、Document オブジェクトのフィールドで並べ替えることができます。関連性で並べ替える場合は、設定しないままにします。order_by 式では大文字と小文字が区別されます。 ウェブサイトの検索結果の並べ替えについて詳しくは、ウェブ検索結果を並べ替えるをご覧ください。医療検索結果の並べ替えの詳細については、医療検索結果を並べ替えるをご覧ください。このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。
user_info	UserInfo エンドユーザーに関する情報。分析とパーソナライズに強く推奨されます。UserInfo.user_agent は、分析用の device_type を推測するために使用されます。
language_code	string 「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、標準フィールドをご覧ください。このフィールドは、クエリの解釈を改善するのに役立ちます。値を指定しない場合、クエリ言語コードが自動的に検出されますが、正確でない可能性があります。
facet_specs[]	FacetSpec ファセット検索のファセット仕様。空の場合、ファセットは返されません。 最大 100 個の値を指定できます。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
boost_spec	BoostSpec 特定のドキュメントをブーストするブースト仕様。ブーストの詳細については、ブーストをご覧ください。
params	map<string, Value> 追加の検索パラメータ。 一般公開ウェブサイト検索のみの場合、サポートされる値は次のとおりです。 user_country_code: 文字列。デフォルトは空です。空でない値に設定すると、指定された場所に基づいて結果が制限またはブーストされます。例: user_country_code: "au" 利用可能なコードについては、国コードをご覧ください。 search_type: double。デフォルトは空です。値に応じて、ウェブページ以外の検索を有効にします。デフォルト以外の有効な値は 1 のみです。この値は画像検索を有効にします。例: search_type: 1
query_expansion_spec	QueryExpansionSpec クエリ拡張が行われる条件を指定するクエリ拡張仕様。
spell_correction_spec	SpellCorrectionSpec スペル補正が有効になるモードを指定するスペル補正仕様。
user_pseudo_id	string 訪問者をトラッキングするための一意の識別子。たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。 このフィールドには、unknown_visitor などの固定値は設定しないでください。 これは、UserEvent.user_pseudo_id および CompleteQueryRequest.user_pseudo_id と同じ識別子にする必要があります。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
content_search_spec	ContentSearchSpec コンテンツ検索の動作を構成するための仕様。
ranking_expression	string 省略可。ランキング式は、取得ドキュメントのカスタマイズされたランキングを制御します。これは ServingConfig.ranking_expression をオーバーライドします。構文とサポートされている機能は、ranking_expression_backend の値によって異なります。ranking_expression_backend が指定されていない場合、デフォルトは RANK_BY_EMBEDDING です。 ranking_expression_backend が指定されていないか、RANK_BY_EMBEDDING に設定されている場合は、単一の関数または「+」で結合された複数の関数にする必要があります。 ranking_expression = function, { " + ", function }; サポートされている関数: double * relevance_score double * dotProduct(embedding_field_path) 関数変数: relevance_score: 事前定義されたキーワード。クエリとドキュメントの関連性を測定するために使用されます。 embedding_field_path: クエリ エンベディング ベクトルで使用されるドキュメント エンベディング フィールド。 dotProduct: embedding_field_path とクエリ エンベディング ベクトルの間のエンベディング関数。 ランキング式の例: ドキュメントにエンベディング フィールド doc_embedding がある場合、ランキング式は 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding) になります。 ranking_expression_backend が RANK_BY_FORMULA に設定されている場合、次の式型（および + 演算子または * 演算子を使用して連結されたこれらの型の組み合わせ）がサポートされます。 double signal log(signal) exp(signal) rr(signal, double > 0) - 逆数ランク変換。2 番目の引数は分母の定数です。 is_nan(signal) - シグナルが NaN の場合は 0、それ以外の場合は 1 を返します。 fill_nan(signal1, signal2 | double) -- signal1 が NaN の場合は signal2 | double を返し、それ以外の場合は signal1 を返します。 サポートされているランキング式の型を使用するランキング数式の例を次に示します。 0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score) -- ほとんどの場合、keyword_similarity_score の対数でランク付けされ、semantic_smilarity_score の調整がわずかに加えられます。 0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score) -- semantic_similarity_score の指数でランク付けします。値が NaN の場合は 0 で埋めます。また、semantic_similarity_score が NaN の場合は、最終スコアに定数 0.3 の調整を加えます。 0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16) - ほとんどは keyword_similarity_score の逆数ランクで、semantic_smilarity_score の逆数ランクがわずかに調整されています。 次のシグナルがサポートされています。 semantic_similarity_score: Google の独自モデルで生成されたエンベディングを使用して計算されるセマンティック類似性の調整。このスコアは、検索クエリとドキュメントの意味的な類似性を決定します。 keyword_similarity_score: キーワード マッチの調整では、Best Match 25（BM25）ランキング関数が使用されます。このスコアは、確率モデルを使用して、ドキュメントが特定のクエリに関連する確率を推定して計算されます。 relevance_score: 独自の Google モデルを使用して、ドキュメント内のコンテンツのコンテキストでユーザーのクエリの意図と意味を判断するセマンティック関連性調整。 pctr_rank: ランクの使用として予測されるコンバージョン率の調整。予測されるクリック率（pCTR）を使用して、ユーザーの視点から検索結果の関連性と魅力度を測定します。pCTR が高いほど、検索結果がユーザーのクエリと意図を満たす可能性が高く、ランキングの貴重なシグナルとなります。 freshness_rank: 鮮度調整をランクとして指定します document_age: ドキュメントが最後に更新されてからの経過時間（時間単位）。浮動小数点数（例: 0.25 は 15 分を意味します）。 topicality_rank: 関連性の調整（ランク）。Google 独自のモデルを使用して、クエリとドキュメントのキーワード ベースの重複を判断します。 base_rank: 結果のデフォルトのランク
ranking_expression_backend	RankingExpressionBackend 省略可。ランキング式の評価に使用するバックエンド。
safe_search	bool セーフサーチをオンにするかどうか。これはウェブサイト検索でのみサポートされています。
user_labels	map<string, string> リソースに適用するユーザーラベルは、次の要件を満たす必要があります。 1 つのリソースには、最大 64 個のラベルを適用できます。 ラベルは、Key-Value ペアでなければなりません。 キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。 キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。 ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。 キーは、小文字または国際文字で始める必要があります。 詳細については、Google Cloud ドキュメントをご覧ください。
natural_language_query_understanding_spec	NaturalLanguageQueryUnderstandingSpec 省略可。クエリから構造化フィールド フィルタを抽出するなど、自然言語クエリ理解機能の構成。詳しくは、こちらのドキュメントをご覧ください。naturalLanguageQueryUnderstandingSpec が指定されていない場合、自然言語クエリの追加の理解は行われません。
search_as_you_type_spec	SearchAsYouTypeSpec 入力逐次検索の設定。IndustryVertical.MEDIA 業種でのみサポートされています。
display_spec	DisplaySpec 省略可。検索結果での一致のハイライト表示などの表示機能の設定。
session	string セッション リソース名。省略可。 セッションを使用すると、ユーザーは /search API 呼び出しを複数回実行したり、/search API 呼び出しと /answer API 呼び出しを連携させたりできます。 例 1（マルチターン /search API 呼び出し）: 最初の呼び出しで生成されたセッション ID を使用して /search API を呼び出します。ここでは、以前の検索クエリがクエリのスタンディングで考慮されます。たとえば、最初のクエリが「Alphabet の 2022 年の業績はどうでしたか？」の場合、現在のクエリが「2023 年はどうでしたか？」の場合、現在のクエリは「Alphabet の 2023 年の業績はどうでしたか？」と解釈されます。 例 2（/search API 呼び出しと /answer API 呼び出しの連携）: 最初の呼び出しで生成されたセッション ID を使用して /answer API を呼び出します。ここで、回答の生成は最初の検索呼び出しの検索結果のコンテキストで行われます。 マルチターンの検索機能は現在、限定公開の一般提供段階です。この機能が一般提供（GA）されるまでは、代わりに v1alpha バージョンまたは v1beta バージョンを使用してください。または、Google サポートチームを通じて許可リストへの登録をリクエストしてください。
session_spec	SessionSpec セッションの仕様。 session が設定されている場合にのみ使用できます。
relevance_threshold	RelevanceThreshold 検索結果の関連性のしきい値。 Google が定義したしきい値をデフォルトで使用し、精度と再現性のバランスを活かして、関連性の高い情報を網羅的にカバーしつつ、精度の高い結果を提供します。 この機能は医療検索ではサポートされていません。
relevance_score_spec	RelevanceScoreSpec 省略可。関連性スコアを返すための仕様。

BoostSpec

特定のドキュメントをブーストするブースト仕様。

フィールド
condition_boost_specs[]	ConditionBoostSpec 条件ブーストの仕様。ドキュメントが仕様の複数の条件に一致する場合、これらの仕様のブースト スコアはすべて適用され、非線形に結合されます。仕様の最大数は 20 です。

ConditionBoostSpec

ブーストは、条件に一致するドキュメントに適用されます。

フィールド
condition	string ブースト条件を指定する式。構文とサポートされているフィールドは、フィルタ式と同じです。構文と制限事項の詳細については、SearchRequest.filter をご覧ください。 例: ドキュメント ID が「doc_1」または「doc_2」で、色が「赤」または「青」のドキュメントをブーストするには: (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
boost	float 条件ブーストの強度。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0 です。 1.0 に設定すると、ドキュメントに強力なプロモーションが設定されます。ただし、ブーストされたドキュメントが常に上位の検索結果に表示されるわけではなく、他のドキュメントが除外されるとも限りません。条件に一致する結果がなくても、引き続き結果が表示されることがあります。また、検索クエリとの関連性が大幅に高い検索結果は、強くブーストされていても無関係なドキュメントより、上位にランクされることがあります。 -1.0 に設定すると、ドキュメントの降格が大きくなります。ただし、深く関連している結果が引き続き表示されることがあります。このドキュメントは上位にランクインするために上位のドキュメントと競合しますが、完全にブロックされることはありません。 0.0 に設定すると、ブーストは適用されません。ブースト条件は無視されます。（条件、ブースト）の組み合わせまたは以下の boost_control_spec のいずれか 1 つのみが設定されます。両方が設定されている場合は、グローバル ブーストは無視され、より詳細な boost_control_spec が適用されます。
boost_control_spec	BoostControlSpec 顧客定義の属性値に基づくカスタム ランキングの複雑な仕様。

BoostControlSpec

顧客が指定した属性値に基づくカスタム ランキングの仕様。上記の単純な（条件、ブースト）の組み合わせよりも、カスタマイズされたランキングをより細かく制御できます。

フィールド
field_name	string ブースト量を決定するために値が使用されるフィールドの名前。
attribute_type	AttributeType ブースト額の決定に使用する属性のタイプ。属性値は、指定された field_name のフィールド値から導出できます。数値の場合、attribute_value = numerical_field_value となります。ただし、鮮度の場合は、attribute_value = (time.now() - datetime_field_value) となります。
interpolation_type	InterpolationType 以下にリストされているコントロール ポイントを接続するために適用される補間タイプ。
control_points[]	ControlPoint 曲線の定義に使用されるコントロール ポイント。単調関数（上記の interpolation_type で定義）は、ここに記載されている制御点を通過します。

AttributeType

カスタム ランキングを適用する属性（または関数）。

列挙型
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType が指定されていません。
NUMERICAL	数値フィールドの値は、ブースト額を動的に更新するために使用されます。この場合、コントロール ポイントの attribute_value（x 値）は、boost_amount が指定されている数値フィールドの実際の値になります。
FRESHNESS	鮮度のユースケースでは、属性値は現在時刻と指定された datetime フィールドの日付の間の期間になります。値は、XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。たとえば、5D、3DT12H30M、T24H。

ControlPoint

曲線の定義に使用されるコントロール ポイント。これらの制御点を通過する曲線は、単調に増加または減少する（定数値は許容される）必要があります。

フィールド
attribute_value	string 次のいずれかになります。1. 数値フィールドの値。2. 鮮度の期間仕様: 値は XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。
boost_amount	float attribute_value が上記の指定された値と評価された場合にスコアをブーストする値（-1 ～ 1）。

InterpolationType

適用する補間タイプ。デフォルトは線形（区分線形）です。

列挙型
INTERPOLATION_TYPE_UNSPECIFIED	補間タイプが指定されていません。この場合、デフォルトは Linear になります。
LINEAR	区分線形補間が適用されます。

ContentSearchSpec

コンテンツ検索の動作を構成するための仕様。

フィールド
snippet_spec	SnippetSpec snippetSpec が指定されていない場合、スニペットは検索レスポンスに含まれません。
summary_spec	SummarySpec summarySpec が指定されていない場合、検索レスポンスに概要は含まれません。
extractive_content_spec	ExtractiveContentSpec extract_content_spec が指定されていない場合、検索レスポンスに抽出回答は含まれません。
search_result_mode	SearchResultMode 検索結果モードを指定します。指定しない場合、検索結果モードはデフォルトで DOCUMENTS になります。
chunk_spec	ChunkSpec 検索レスポンスから返されるチャンク仕様を指定します。SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合にのみ使用できます。

ChunkSpec

検索レスポンスから返されるチャンク仕様を指定します。SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合にのみ使用できます。

フィールド
num_previous_chunks	int32 現在のチャンクの前のチャンクの数。最大値は 3 です。指定しない場合、以前のチャンクは返されません。
num_next_chunks	int32 現在のチャンクから返される次のチャンクの数。最大値は 3 です。指定しない場合、次のチャンクは返されません。

ExtractiveContentSpec

検索レスポンスで抽出コンテンツを構成するための仕様。

フィールド
max_extractive_answer_count	int32 各検索結果で返される抽出回答の最大数。 抽出回答は、元のドキュメントから抽出された逐語的な回答であり、検索クエリに対する正確で文脈的に関連性の高い回答を提供します。 一致する回答の数が max_extractive_answer_count 未満の場合は、すべての回答を返します。それ以外の場合は、max_extractive_answer_count を返します。 各 SearchResult に対して最大 5 つの回答が返されます。
max_extractive_segment_count	int32 各検索結果で返される抽出セグメントの最大数。DataStore が DataStore.ContentConfig.CONTENT_REQUIRED に設定されている場合、または DataStore.solution_types が SOLUTION_TYPE_CHAT の場合にのみ適用されます。 抽出セグメントは、検索クエリに関連する元のドキュメントから抽出されたテキスト セグメントです。通常、抽出回答よりも冗長です。このセグメントは、LLM の入力として使用して、要約や回答を生成できます。 一致するセグメントの数が max_extractive_segment_count より少ない場合は、すべてのセグメントを返します。それ以外の場合は、max_extractive_segment_count を返します。
return_extractive_segment_score	bool 各検索結果の抽出セグメントから信頼スコアを返すかどうかを指定します。この機能は、新しいデータストアまたは許可リストに登録されたデータストアでのみ使用できます。データストアを許可リストに登録するには、カスタマー エンジニアにお問い合わせください。デフォルト値は false です。
num_previous_segments	int32 選択した各セグメントの隣接するセグメントも含むかどうかを指定します。選択した各セグメントの前に最大 num_previous_segments 個のセグメントを返します。
num_next_segments	int32 選択した各セグメントの後に最大 num_next_segments 個のセグメントを返します。

SearchResultMode

検索結果モードを指定します。指定しない場合、検索結果モードはデフォルトで DOCUMENTS になります。

列挙型
SEARCH_RESULT_MODE_UNSPECIFIED	デフォルト値。
DOCUMENTS	検索結果のドキュメントを返します。
CHUNKS	検索結果でチャンクを返します。DocumentProcessingConfig.chunking_config が指定されている場合にのみ使用できます。

SnippetSpec

検索レスポンスでスニペットを構成するための仕様。

フィールド
max_snippet_count (deprecated)	int32 この項目は非推奨です。 [非推奨] このフィールドは非推奨になりました。スニペットの戻りを制御するには、return_snippet フィールドを使用します。下位互換性を維持するため、max_snippet_count > 0 の場合はスニペットを返します。
reference_only (deprecated)	bool この項目は非推奨です。 [非推奨] このフィールドは非推奨であり、スニペットには影響しません。
return_snippet	bool true の場合は、スニペットを返します。スニペットを生成できない場合は、「このページのスニペットはありません」と返します。SUCCESS または NO_SNIPPET_AVAILABLE を含む snippet_status も返されます。

SummarySpec

検索レスポンスで返される概要を構成するための仕様。

フィールド
summary_result_count	int32 概要の生成に使用する上位の結果の数。返された結果の数が summaryResultCount 未満の場合は、すべての結果からサマリーが生成されます。 ドキュメント モードでは最大 10 件、チャンク モードでは最大 50 件の結果を使用して要約を生成できます。チャンクモードは、SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合に使用されます。
include_citations	bool 要約に引用を含めるかどうかを指定します。デフォルト値は false です。 このフィールドが true に設定されている場合、要約にはインラインの引用番号が含まれます。 引用を含む要約の例: BigQuery は、Google Cloud のフルマネージドで完全にサーバーレスなエンタープライズ データ ウェアハウスです [1]。BigQuery は、すべてのデータ型をサポートし、クラウド全体で機能します。また、統合プラットフォーム内に ML とビジネス インテリジェンスがすべて組み込まれています [2、3]。 引用番号は、返された検索結果を指し、1 からインデックス付けされます。たとえば、[1] は、その文が最初の検索結果に由来することを示します。[2, 3] は、文が 2 番目と 3 番目の両方の検索結果に帰属することを意味します。
ignore_adversarial_query	bool 敵対的クエリをフィルタリングするかどうかを指定します。デフォルト値は false です。 Google では、検索クエリの分類を使用して敵対的なクエリを検出しています。検索クエリが敵対的クエリに分類された場合、サマリーは返されません。たとえば、ユーザーが会社に対する否定的なコメントに関する質問をしたり、安全でないポリシー違反の出力を生成するように設計されたクエリを送信したりする可能性があります。このフィールドが true に設定されている場合、敵対的クエリの要約の生成はスキップされ、代わりにフォールバック メッセージが返されます。
ignore_non_summary_seeking_query	bool サマリーを求めていないクエリを除外するかどうかを指定します。デフォルト値は false です。 Google は、検索クエリの分類を使用して、概要を求めるクエリを検出します。検索クエリがサマリーを求めていないクエリに分類された場合、サマリーは返されません。たとえば、why is the sky blue と Who is the best soccer player in the world? は要約を求めるクエリですが、SFO airport と world cup 2026 は要約を求めるクエリではありません。ナビゲーション クエリである可能性が高いです。このフィールドが true に設定されている場合、サマリーを求めていないクエリのサマリーの生成をスキップし、代わりにフォールバック メッセージを返します。
ignore_low_relevant_content	bool 関連性の低いクエリを除外するかどうかを指定します。デフォルト値は false です。 このフィールドが false に設定されている場合、関連性に関係なく、すべての検索結果を使用して回答が生成されます。true に設定すると、関連性の高い検索結果を含むクエリのみが回答を生成します。
ignore_jail_breaking_query	bool 省略可。ジェイルブレイク クエリを除外するかどうかを指定します。デフォルト値は false です。 Google は、検索クエリの分類を使用して、脱獄クエリを検出しています。検索クエリがジェイルブレイク クエリに分類された場合、要約は返されません。ユーザーは、回答のトーン、スタイル、言語、コンテンツを変更したり、モデルに別のエンティティとして動作するように指示したりするために、クエリに指示を追加することがあります（例: 「競合他社の CEO のトーンで返信して」）。このフィールドが true に設定されている場合、脱獄クエリの要約の生成はスキップされ、代わりにフォールバック メッセージが返されます。
model_prompt_spec	ModelPromptSpec 指定した場合、この仕様は LLM に提供されるプロンプトの変更に使用されます。
language_code	string 要約の言語コード。BCP47 で定義されている言語タグを使用します。注: これは試験運用版の機能です。
model_spec	ModelSpec 指定した場合、この仕様は LLM に提供されるモデル仕様の変更に使用されます。
use_semantic_chunks	bool true の場合、回答は検索結果の上位にある最も関連性の高いチャンクから生成されます。この機能により、要約の品質が向上します。この機能を有効にすると、上位の検索結果がすべて参照されて参照リストに含まれるわけではないため、引用元インデックスは参照リストに記載されている検索結果のみを指します。

ModelPromptSpec

モデルで使用するプロンプトの仕様。

フィールド
preamble	string アシスタントに指示するプロンプトの冒頭のテキスト。例については、ユーザーガイドをご覧ください。

ModelSpec

モデルの仕様。

フィールド
version	string 要約の生成に使用されたモデル バージョン。 サポートされている値は次のとおりです。 stable: 文字列。値が指定されていない場合のデフォルト値。一般提供されているファインチューニング済みモデルを使用します。詳細については、回答生成モデルのバージョンとライフサイクルをご覧ください。 preview: 文字列。（公開プレビュー版）プレビュー モデルを使用します。詳細については、回答生成モデルのバージョンとライフサイクルをご覧ください。

DataStoreSpec

検索呼び出しでフィルタするデータストアと、それらのデータストアの構成を定義する構造体。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

フィールド
data_store	string 必須。DataStore の完全なリソース名（projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} など）。パスにはプロジェクト番号を含める必要があります。このフィールドではプロジェクト ID はサポートされていません。
filter	string 省略可。data_store フィールドで指定されたデータストア内のドキュメントをフィルタするフィルタ仕様。フィルタリングの詳細については、フィルタリングをご覧ください。
boost_spec	BoostSpec 省略可。特定のドキュメントをブーストするブースト仕様。ブーストの詳細については、ブーストをご覧ください。
custom_search_operators	string 省略可。カスタム検索演算子。指定すると、ワークスペース データストアの結果をフィルタするために使用されます。カスタム検索演算子の詳細については、SearchOperators をご覧ください。

DisplaySpec

一致のハイライト表示など、表示する機能を指定します。

フィールド
match_highlighting_condition	MatchHighlightingCondition 一致するハイライト表示を行う条件。

MatchHighlightingCondition

一致のハイライト表示を行う条件を記述する列挙型。

列挙型
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED	サーバーの動作は MATCH_HIGHLIGHTING_DISABLED と同じです。
MATCH_HIGHLIGHTING_DISABLED	すべてのドキュメントで一致する部分のハイライト表示を無効にします。
MATCH_HIGHLIGHTING_ENABLED	すべてのドキュメントで一致する部分のハイライト表示を有効にします。

FacetSpec

ファセット検索を実行するファセットの仕様。

フィールド
facet_key	FacetKey 必須。ファセット キーの仕様。
limit	int32 このファセットに対して返されるファセット値の最大数。指定しない場合、デフォルトは 20 です。最大値は 300 です。300 を超える値は 300 に強制変換されます。医療検索の集計では、[FacetKey.key] が「healthcare_aggregation_key」の場合、ここで設定された値に関係なく、上限は内部的に 10,000 にオーバーライドされます。 このフィールドが負の数の場合、INVALID_ARGUMENT が返されます。
excluded_filter_keys[]	string ファセット処理時に除外するキーのリスト。 デフォルトでは、このフィールドにリストされていない限り、FacetKey.key はフィルタから除外されません。 このフィールドにファセットキーを登録すると、検索結果から除外された場合でも、その値がファセット結果として表示されます。このフィールドを使用しても、返される検索結果には影響しません。 たとえば、色のファセット「赤」を含むドキュメントが 100 個、色のファセット「青」を含むドキュメントが 200 個あるとします。フィルタ「color:ANY("Red")」を含み、FacetKey.key として「color」を持つクエリは、デフォルトで検索結果に「Red」ドキュメントのみを返し、カウント 100 の「Red」を唯一のカラー ファセットとして返します。青いドキュメントも利用可能ですが、「青」は利用可能なファセット値として表示されません。 「color」が「excludedFilterKeys」にリストされている場合、クエリはファセット値「Red」（カウント 100）と「Blue」（カウント 200）を返します。これは、「color」キーがフィルタから除外されたためです。このフィールドは検索結果に影響しないため、検索結果は引き続き正しくフィルタリングされ、「赤」のドキュメントのみが返されます。 最大 100 個の値を指定できます。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
enable_dynamic_position	bool このファセットの動的位置を有効にします。true に設定すると、レスポンス内のすべてのファセットにおけるこのファセットの位置が自動的に決定されます。動的ファセットが有効になっている場合は、一緒に並べ替えられます。false に設定すると、レスポンスでのこのファセットの位置はリクエストでの位置と同じになり、動的ポジションが有効になっているファセットとすべての動的ファセットの前にランク付けされます。 たとえば、レスポンスで常に評価ファセットを返すようにしたいが、評価ファセットを常に上部に表示する必要はない場合があります。その場合は、enable_dynamic_position を true に設定して、レスポンス内の評価ファセットの位置を自動的に決定できるようにします。 別の例として、リクエストに次のファセットがあるとします。 "rating", enable_dynamic_position = true "price"、enable_dynamic_position = false "brands", enable_dynamic_position = false また、動的ファセットが有効になっているため、ファセット gender が生成されます。レスポンス内のファセットの最終的な順序は、API が「性別」と「評価」のファセットをどのように順序付けるかによって、（「価格」、「ブランド」、「評価」、「性別」）または（「価格」、「ブランド」、「性別」、「評価」）になります。ただし、enable_dynamic_position が false のため、「price」と「brands」は常に 1 位と 2 位にランク付けされます。

FacetKey

ファセットの計算方法を指定します。

フィールド
key	string 必須。Document オブジェクトでサポートされているテキストと数値のファセットキー。ファセット値が計算されます。ファセットキーでは大文字と小文字が区別されます。
intervals[]	Interval 値を区間に分類する場合にのみ設定します。数値を含むファセットに設定する必要があります。テキスト値を含むファセットには設定できません。インターバルの最大数は 30 です。
restricted_values[]	string 指定された制限付きの値のファセットのみを取得します。テキスト フィールドでのみサポートされます。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「restricted_values」を「Action > 2022」に設定すると、「category」ファセットには「Action > 2022」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。
prefixes[]	string 指定された文字列プレフィックスで始まるファセット値のみを取得します。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「prefixes」を「Action」に設定すると、「category」ファセットには「Action > 2022」と「Action > 2021」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。
contains[]	string 指定された文字列を含むファセット値のみを取得します。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「contains」を「2022」に設定すると、「category」ファセットには「Action > 2022」と「Sci-Fi > 2022」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。
case_insensitive	bool 接頭辞または contains を使用してファセット値を取得するときに、ファセットキーを大文字と小文字を区別しないようにする場合は true。それ以外の場合は false。
order_by	string ドキュメントが返される順序。 指定できる値は次のとおりです。 「count desc」（SearchResponse.Facet.values.count の降順で並べ替える）。 「value desc」は、SearchResponse.Facet.values.value の降順で並べ替えることを意味します。テキスト ファセットにのみ適用されます。 設定されていない場合、テキスト値は自然順序で並べ替えられ、数値間隔は FacetSpec.FacetKey.intervals で指定された順序で並べ替えられます。

ImageQuery

画像クエリの入力を指定します。

フィールド
共用体フィールド image。 image は次のいずれかになります。
image_bytes	string Base64 でエンコードされた画像バイト。サポートされている画像形式: JPEG、PNG、BMP。

NaturalLanguageQueryUnderstandingSpec

検索リクエストの自然言語理解機能を有効にするための仕様。

フィールド
filter_extraction_condition	FilterExtractionCondition フィルタ抽出を行う条件。サーバーの動作はデフォルトで DISABLED に設定されます。
geo_search_query_detection_field_names[]	string 位置情報に基づくフィルタリングに使用されるフィールド名。自然言語検索クエリで位置情報フィルタが検出された場合に使用されます。FilterExtractionCondition が ENABLED に設定されている場合にのみ有効です。 このフィールドが設定されている場合、ServingConfig.geo_search_query_detection_field_names で設定されているフィールド名がオーバーライドされます。
extracted_filter_behavior	ExtractedFilterBehavior 省略可。抽出されたフィルタが検索に適用される動作を制御します。デフォルトの動作はリクエストによって異なります。単一データストアの構造化検索の場合、デフォルトは HARD_FILTER です。マルチデータストア検索の場合、デフォルトの動作は SOFT_BOOST です。位置情報に基づくフィルタは常にハードフィルタとして適用され、SOFT_BOOST 設定は影響しません。このフィールドは、[SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] が FilterExtractionCondition.ENABLED に設定されている場合にのみ使用されます。
allowed_field_names[]	string 省略可。自然言語フィルタの抽出に使用できるフィールドの許可リスト。デフォルトでは、この設定が指定されていない場合、インデックス登録可能なすべてのフィールドが自然言語フィルタの抽出対象になります（ただし、必ず使用されるとは限りません）。allowed_field_names でフィールドが指定されている場合、スキーマでインデックス可能としてマークされ、許可リストで指定されているフィールドのみが自然言語フィルタの抽出の対象となります。注: マルチデータストア検索では、これはまだサポートされておらず、無視されます。

ExtractedFilterBehavior

抽出されたフィルタが検索にどのように適用されるかを記述する列挙型。

列挙型
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED	EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED は、抽出されたフィルタのデフォルトの動作を使用します。単一データストア検索の場合、デフォルトではハードフィルタとして適用されます。マルチ データストア検索の場合、デフォルトではソフトブーストとして適用されます。
HARD_FILTER	抽出されたすべてのフィルタを結果にハードフィルタとして適用します。抽出されたフィルタを通過しない結果は、結果セットで返されません。
SOFT_BOOST	抽出されたすべてのフィルタをソフトブーストとして適用します。フィルタを通過した結果は、結果セットの上位にブーストされます。

FilterExtractionCondition

フィルタの抽出を行う条件を説明する列挙型。

列挙型
CONDITION_UNSPECIFIED	サーバーの動作はデフォルトで DISABLED に設定されます。
DISABLED	NL フィルタの抽出を無効にします。
ENABLED	NL フィルタの抽出を有効にします。

QueryExpansionSpec

クエリ拡張を行う条件を決定する仕様。

フィールド
condition	Condition クエリ拡張を行う条件。デフォルトは Condition.DISABLED です。
pin_unexpanded_results	bool 展開されていない結果を固定するかどうか。このフィールドが true に設定されている場合、拡張されていない商品は常に検索結果の先頭に表示され、その後に拡張された結果が表示されます。

条件

クエリ拡張を行う条件を説明する列挙型。

列挙型
CONDITION_UNSPECIFIED	クエリ拡張条件が指定されていません。この場合、サーバーの動作はデフォルトで Condition.DISABLED になります。
DISABLED	クエリ拡張が無効になっています。SearchResponse.total_size がゼロの場合でも、完全一致の検索クエリのみが使用されます。
AUTO	Search API によって構築された自動クエリ拡張。

RankingExpressionBackend

ランキング式の評価に使用するバックエンド。

列挙型
RANKING_EXPRESSION_BACKEND_UNSPECIFIED	未指定または不明な値のデフォルト オプション。
BYOE	非推奨: 代わりに、RANK_BY_EMBEDDING を使用してください。カスタム エンベディング モデルによるランキング。ランキング式を評価するデフォルトの方法です。以前の列挙型オプション。代わりに RANK_BY_EMBEDDING を使用してください。 この項目は非推奨です。
CLEARBOX	非推奨: 代わりに、RANK_BY_FORMULA を使用してください。カスタム数式によるランキング。以前の列挙型オプション。代わりに RANK_BY_FORMULA を使用してください。 この項目は非推奨です。
RANK_BY_EMBEDDING	カスタム エンベディング モデルによるランキング。ランキング式を評価するデフォルトの方法。
RANK_BY_FORMULA	カスタム数式によるランキング。

RelevanceScoreSpec

ドキュメントの関連性スコアを返すための仕様。

フィールド
return_relevance_score	bool 省略可。検索結果の関連性スコアを返すかどうか。スコアが高いほど、ドキュメントがクエリに関連していることを示します。

RelevanceThreshold

検索結果の関連性のしきい値。関連性のしきい値が高いほど、関連性の高い結果が表示され、返される結果の数が少なくなります。

列挙型
RELEVANCE_THRESHOLD_UNSPECIFIED	デフォルト値。この場合、サーバーの動作はデフォルトで Google が定義したしきい値になります。
LOWEST	関連性のしきい値が最も低い。
LOW	関連性のしきい値が低い。
MEDIUM	関連性のしきい値（中）。
HIGH	関連性のしきい値が高い。

SearchAsYouTypeSpec

検索リクエストでの入力中の検索の仕様。

フィールド
condition	Condition 入力中の検索が行われる条件。デフォルトは Condition.DISABLED です。

条件

入力中の検索が実行される条件を記述する列挙型。

列挙型
CONDITION_UNSPECIFIED	サーバーの動作はデフォルトで Condition.DISABLED に設定されます。
DISABLED	入力逐次検索を無効にします。
ENABLED	入力逐次検索を有効にします。
AUTO	入力逐次検索モードと標準検索モードを自動的に切り替えるため、単一 API 実装（デバウンスなど）に最適です。

SessionSpec

セッションの仕様。

マルチターンの検索機能は現在、限定公開の一般提供段階です。この機能が一般提供（GA）されるまでは、代わりに v1alpha バージョンまたは v1beta バージョンを使用してください。または、Google サポートチームを通じて許可リストへの登録をリクエストしてください。

フィールド
query_id	string 設定されている場合、検索結果はこのクエリ ID で指定された「ターン」に保存されます。 例: セッションが次のようになっているとします。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" } } } ユーザーは、次のようなリクエストで /search API を呼び出すことができます。 session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } API は、最後のターンに関連付けられた検索結果を保存します。保存された検索結果は、後続の /answer API 呼び出し（セッション ID とクエリ ID を指定）で使用できます。また、同じセッション ID とクエリ ID を使用して /search と /answer を並行して呼び出すこともできます。
search_result_persistence_count	int32 保持する上位の検索結果の数。永続化された検索結果は、後続の /answer API 呼び出しに使用できます。 このフィールドは、SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count の summary_result_count フィールドに似ています。 ドキュメント モードの場合は最大 10 件、チャンク モードの場合は最大 50 件の結果。

SpellCorrectionSpec

クエリのスペル修正の仕様。

フィールド
mode	Mode スペル修正によって元の検索クエリが置き換えられるモード。デフォルトは Mode.AUTO です。

モード

スペル修正を行うモードを記述する列挙型。

列挙型
MODE_UNSPECIFIED	スペル修正モードが指定されていません。この場合、サーバーの動作はデフォルトで Mode.AUTO になります。
SUGGESTION_ONLY	Search API はスペル候補を探します。候補が見つかった場合は、SearchResponse.corrected_query に入れられます。スペル候補は検索クエリとして使用されません。
AUTO	Search API によって構築された自動スペル修正。修正されたクエリが見つかった場合、検索は修正されたクエリに基づいて行われます。

SearchResponse

SearchService.Search メソッドに対するレスポンス メッセージ。

フィールド
results[]	SearchResult 一致するドキュメントのリスト。順序はランキングを表します。
facets[]	Facet ユーザーがリクエストしたファセットの結果。
total_size	int32 ページネーションに関係なく、一致したアイテムの推定合計数。ページネーションで返される results の数は、一致する total_size よりも少ない場合があります。
attribution_token	string 一意の検索トークン。これは、この検索の結果として得られる UserEvent ログに含まれる必要があります。これにより、検索モデルのパフォーマンスを正確に特定できます。また、カスタマー サポートのシナリオでリクエストを特定するのにも役立ちます。
redirect_uri	string 顧客が定義したリダイレクト ページの URI。リダイレクト アクションがトリガーされると、検索は実行されず、レスポンスに redirect_uri と attribution_token のみが設定されます。
next_page_token	string 次のページを取得するために SearchRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
corrected_query	string スペルチェックで修正されたクエリが含まれます（見つかった場合）。スペル修正タイプが AUTOMATIC の場合、検索結果は corrected_query に基づきます。それ以外の場合は、元のクエリが検索に使用されます。
summary	Summary 検索結果の一部としての要約。このフィールドは、SearchRequest.ContentSearchSpec.summary_spec が設定されている場合にのみ返されます。
query_expansion_info	QueryExpansionInfo 返された結果のクエリ拡張情報。
session_info	SessionInfo セッション情報。 SearchRequest.session が指定されている場合にのみ設定されます。詳しくは、説明をご覧ください。
search_link_promotions[]	SearchLinkPromotion サイト内検索のプロモーション。

ファセット

ファセット結果。

フィールド
key	string このファセットのキー。たとえば、"colors" や "price" などです。SearchRequest.FacetSpec.FacetKey.key と一致します。
values[]	FacetValue このフィールドのファセット値。
dynamic_facet	bool ファセットが動的に生成されるかどうか。

FacetValue

値の名前とそのカウントを含むファセット値。

フィールド
count	int64 このファセット値を持つアイテムの数。
共用体フィールド facet_value。値を含むファセット値。facet_value は次のいずれかになります。
value	string ファセットのテキスト値（ファセット「colors」の「Black」など）。
interval	Interval ファセットのインターバル値（ファセット「price」の [10, 20) など）。SearchRequest.FacetSpec.FacetKey.intervals と一致します。

QueryExpansionInfo

クエリ拡張に関する情報（拡張が行われたかどうかなど）。

フィールド
expanded_query	bool クエリ拡張が行われたかどうかを示すブール値。
pinned_result_count	int64 固定された結果の数。このフィールドは、拡張が行われ、SearchRequest.QueryExpansionSpec.pin_unexpanded_results が true に設定されている場合にのみ設定されます。

SearchResult

検索結果を表します。

フィールド
id	string 検索された Document の Document.id。
document	Document 検索レスポンスのドキュメント データ スニペット。retrievable とマークされたフィールドのみが入力されます。
chunk	Chunk SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合、検索レスポンスのチャンクデータ。
model_scores	map<string, DoubleList> 出力専用。Google が利用可能なスコアを提供しました。
rank_signals	RankSignals 省略可。結果に関連付けられたランキング シグナルのセット。

RankSignals

ランキング シグナルのセット。

フィールド
default_rank	float 省略可。結果のデフォルトのランク。
custom_signals[]	CustomSignal 省略可。カスタム クリアボックス シグナルのリスト。
keyword_similarity_score	float 省略可。キーワードのマッチタイプの調整。
relevance_score	float 省略可。意味的関連性の調整。
semantic_similarity_score	float 省略可。意味的類似性の調整。
pctr_rank	float 省略可。推定コンバージョン率の調整をランクとして表します。
topicality_rank	float 省略可。ランキングとしてのトピックの調整。
document_age	float 省略可。ドキュメントの経過時間（単位は時間）。
boosting_factor	float 省略可。ドキュメントのカスタム ブーストを組み合わせたもの。

CustomSignal

名前と値のペアで表されるカスタム クリアボックス シグナル。

フィールド
name	string 省略可。シグナルの名前。
value	float 省略可。ランキング シグナルを表す浮動小数点値（BM25 の場合は 1.25 など）。

SessionInfo

セッションに関する情報。

フィールド
name	string セッションの名前。自動セッション モードが使用されている場合（SearchRequest.session が「-」で終わる場合）、このフィールドには新しく生成されたセッション名が格納されます。
query_id	string この検索 API 呼び出しに対応するクエリ ID。1 つのセッションに複数のターンを含めることができ、各ターンには一意のクエリ ID があります。 Answer API 呼び出しでセッション名とこのクエリ ID を指定すると、この検索呼び出しの検索結果のコンテキストで回答が生成されます。

概要

概要仕様で指定された上位 N 件の検索結果の概要。

フィールド
summary_text	string 要約コンテンツ。
summary_skipped_reasons[]	SummarySkippedReason 追加の要約スキップの理由。これにより、無視されたケースの理由が示されます。スキップされたものがない場合、このフィールドは設定されません。
safety_attributes	SafetyAttributes 安全性属性のカテゴリとそれに関連付けられた信頼スコアのコレクション。
summary_with_metadata	SummaryWithMetadata メタデータ情報を含む概要。

引用

セグメントの引用情報。

フィールド
start_index	int64 インデックスは、セグメントの開始位置をバイト/Unicode で示します。
end_index	int64 アトリビューション セグメントの終了（この値を含まない）。
sources[]	CitationSource 帰属セグメントの引用元。

CitationMetadata

引用メタデータ。

フィールド
citations[]	Citation セグメントの引用。

CitationSource

引用元。

フィールド
reference_index	int64 SummaryWithMetadata.references からのドキュメント参照インデックス。0 から始まるインデックスです。reference_index が明示的に設定されていない場合、値は 0 になります。

リファレンス

ドキュメント リファレンス。

フィールド
title	string ドキュメントのタイトル。
document	string 必須。Document.name を取得します。参照されるドキュメントの完全なリソース名（projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/* 形式）。
uri	string ドキュメントの Cloud Storage または HTTP URI。
chunk_contents[]	ChunkContent ドキュメント コンテンツから派生した引用チャンク コンテンツのリスト。

ChunkContent

コンテンツをチャンク化します。

フィールド
content	string テキスト コンテンツをチャンク化します。
page_identifier	string ページ ID。

SafetyAttributes

安全性属性のカテゴリとそれに関連付けられた信頼スコア。

フィールド
categories[]	string 生成されたコンテンツに関連付けられた安全性属性カテゴリの表示名。順序がスコアと一致する。
scores[]	float 各カテゴリの信頼スコア。値が大きいほど、信頼度が高くなります。順序がカテゴリと一致する。

SummarySkippedReason

概要がスキップされた理由の列挙型。

列挙型
SUMMARY_SKIPPED_REASON_UNSPECIFIED	デフォルト値。要約がスキップされた理由が指定されていません。
ADVERSARIAL_QUERY_IGNORED	敵対的クエリでは大文字と小文字が区別されません。 SummarySpec.ignore_adversarial_query が true に設定されている場合にのみ使用されます。
NON_SUMMARY_SEEKING_QUERY_IGNORED	サマリーを求めていないクエリでは、大文字と小文字が区別されませんでした。 クエリが雑談の場合、Google は要約をスキップします。SummarySpec.ignore_non_summary_seeking_query が true に設定されている場合にのみ使用されます。
OUT_OF_DOMAIN_QUERY_IGNORED	ドメイン外のクエリでは大文字と小文字が区別されませんでした。 関連性の高い検索結果がない場合、Google は概要をスキップします。たとえば、データストアには会社 A に関する事実が含まれているが、ユーザーのクエリは会社 B についての質問をしている場合などです。
POTENTIAL_POLICY_VIOLATION	ポリシー違反の可能性があるケース。 ポリシー違反の可能性が検出された場合、Google は要約をスキップします。これには、暴力的または有害なコンテンツが含まれます。
LLM_ADDON_NOT_ENABLED	LLM アドオンが有効になっていないケース。 LLM アドオンが有効になっていない場合、Google は要約をスキップします。
NO_RELEVANT_CONTENT	関連性のあるコンテンツがないケース。 取得した検索結果に関連するコンテンツがない場合、Google は概要をスキップします。
JAIL_BREAKING_QUERY_IGNORED	脱獄クエリでは大文字と小文字が区別されませんでした。 たとえば、「競合他社の CEO のトーンで返信してください」などです。[SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] が true に設定されている場合にのみ使用されます。
CUSTOMER_POLICY_VIOLATION	お客様のポリシー違反のケース。 顧客ポリシー違反が検出された場合、Google は概要をスキップします。ポリシーはユーザーが定義します。
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2	回答を求めていないクエリ（大文字と小文字を区別しない）。 クエリの意図が明確でない場合、Google は要約をスキップします。[SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] が true に設定されている場合にのみ使用されます。
TIME_OUT	タイムアウトのケース。 タイムアウトした場合、Google は要約をスキップします。

SummaryWithMetadata

メタデータ情報を含む概要。

フィールド
summary	string 引用情報のない要約テキスト。
citation_metadata	CitationMetadata 指定された要約の引用メタデータ。
references[]	Reference ドキュメント リファレンス。

SearchTier

検索機能の階層。プランによって料金が異なる場合があります。詳細については、料金に関するドキュメントをご覧ください。

列挙型
SEARCH_TIER_UNSPECIFIED	列挙型が指定されていない場合のデフォルト値。これは使用できません。
SEARCH_TIER_STANDARD	スタンダード ティア。
SEARCH_TIER_ENTERPRISE	エンタープライズ ティア。

SearchUseCase

SolutionType のさらなる細分化を定義します。特に SOLUTION_TYPE_SEARCH に適用されます。

列挙型
SEARCH_USE_CASE_UNSPECIFIED	設定されていない場合に使用される値。CSS では発生しません。
SEARCH_USE_CASE_SEARCH	検索ユースケース。トラフィックに空でない query があることを想定しています。
SEARCH_USE_CASE_BROWSE	ユースケースを参照します。トラフィックに空の query があることを想定しています。

ServingConfig

サービス提供時の結果（検索結果やレコメンデーション予測など）の生成に使用されるメタデータを構成します。ServingConfig は検索リクエストと予測リクエストで渡され、結果を生成します。

フィールド
name	string 変更不可。完全修飾名 projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
display_name	string 必須。人が読める形式のサービス提供構成の表示名。Discovery UI で使用されます。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
solution_type	SolutionType 必須。変更不可。サービング構成を関連付けることができるソリューション タイプを指定します。
model_id	string サービング時に使用するモデルの ID。現在、サポートされているのは RecommendationModel のみです。変更できますが、互換性のあるモデル（関連商品のおすすめのクリック率から関連商品のおすすめのコンバージョン率など）にのみ変更できます。 SolutionType が SOLUTION_TYPE_RECOMMENDATION の場合は必須。
diversity_level	string レコメンデーション モデルの結果で使用する多様性の量（medium-diversity や high-diversity など）。現在サポートされている値は次のとおりです。 no-diversity low-diversity medium-diversity high-diversity auto-diversity 指定しない場合は、レコメンデーション モデルのタイプに基づいてデフォルトが選択されます。デフォルト値: no-diversity。 SolutionType が SOLUTION_TYPE_RECOMMENDATION の場合にのみ設定できます。
ranking_expression	string ランキング式は、取得ドキュメントのカスタマイズされたランキングを制御します。これを活用するには、ドキュメントのエンベディングが必要です。ServingConfig のランキング式の設定は、サービス構成によって処理されるすべての検索リクエストに適用されます。ただし、SearchRequest.ranking_expression が指定されている場合は、ServingConfig のランキング式がオーバーライドされます。 ランキング式は、単一の関数または「+」で結合された複数の関数です。 ranking_expression = function, { " + ", function }; サポートされている関数: double * relevance_score double * dotProduct(embedding_field_path) 関数変数: relevance_score: 事前定義されたキーワード。クエリとドキュメントの関連性を測定するために使用されます。 embedding_field_path: クエリ エンベディング ベクトルで使用されるドキュメント エンベディング フィールド。 dotProduct: embedding_field_path とクエリ エンベディング ベクトルの間のエンベディング関数。 ランキング式の例: ドキュメントにエンベディング フィールド doc_embedding がある場合、ランキング式は 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding) になります。
create_time	Timestamp 出力専用。ServingConfig の作成タイムスタンプ。
update_time	Timestamp 出力専用。ServingConfig の更新タイムスタンプ。
filter_control_ids[]	string サービング パスで使用するフィルタ コントロール。トリガーされたフィルタ コントロールがすべて適用されます。フィルタ コントロールは、サービング構成と同じデータストアに存在する必要があります。フィルタ オプションは最大 20 個までです。
boost_control_ids[]	string サービング パスで使用するブースト コントロール。トリガーされたブースト コントロールがすべて適用されます。ブースト コントロールは、サービング構成と同じデータストアに存在する必要があります。ブースト コントロールは最大 20 個までです。
redirect_control_ids[]	string リダイレクト コントロールの ID。複数のリダイレクト アクションが適用される場合でも、最初にトリガーされたリダイレクト アクションのみが適用されます。仕様の最大数は 100 です。 SolutionType が SOLUTION_TYPE_SEARCH の場合にのみ設定できます。
synonyms_control_ids[]	string 条件の同義語の仕様。複数の同義語条件が一致した場合、リスト内の一致するすべての同義語コントロールが実行されます。仕様の最大数は 100 です。 SolutionType が SOLUTION_TYPE_SEARCH の場合にのみ設定できます。
oneway_synonyms_control_ids[]	string 一方向の類義語の条件の仕様。一方向の類義語条件が複数一致した場合、リスト内の一致する一方向の類義語制御がすべて実行されます。仕様の最大数は 100 です。 SolutionType が SOLUTION_TYPE_SEARCH の場合にのみ設定できます。
dissociate_control_ids[]	string 条件は仕様に関連付けられていません。複数の関連付けない条件が一致した場合、リスト内の関連付けないコントロールがすべて実行されます。順序は関係ありません。仕様の最大数は 100 です。 SolutionType が SOLUTION_TYPE_SEARCH の場合にのみ設定できます。
replacement_control_ids[]	string 条件の置換仕様。リストの順序に従って適用されます。以前に交換した用語を再度交換することはできません。仕様の最大数は 100 です。 SolutionType が SOLUTION_TYPE_SEARCH の場合にのみ設定できます。
ignore_control_ids[]	string 条件無視仕様。複数の無視条件が一致した場合、リスト内の一致する無視コントロールがすべて実行されます。順序は関係ありません。仕様の最大数は 100 です。
promote_control_ids[]	string 条件の昇格の仕様。 仕様の最大数は 100 です。
answer_generation_spec	AnswerGenerationSpec 省略可。回答生成の仕様。
共用体フィールド vertical_config。業種固有の構成。vertical_config は次のいずれかになります。
media_config	MediaConfig サービス提供構成の MediaConfig。
generic_config	GenericConfig サービス構成の GenericConfig。

GenericConfig

汎用検出に必要な構成を指定します。現在、次の構成がサポートされています。

• content_search_spec: 汎用コンテンツ検索の構成。

フィールド
content_search_spec	ContentSearchSpec コンテンツ検索の想定される動作を指定します。コンテンツ検索が有効になっているデータストアでのみ有効です。

MediaConfig

メディア検出に必要な構成を指定します。現在サポートされているのは次のとおりです。

• demote_content_watched: 視聴済みコンテンツの降格のしきい値。視聴済みコンテンツの順位を下げるか、閲覧済みの詳細ページを使用するかを指定できます。視聴済みコンテンツの降格を使用すると、視聴時間または視聴率がしきい値を超えた場合に、レコメンデーション結果でコンテンツが降格されるように指定できます。
• promote_fresh_content: 新しいコンテンツのプロモーションの締め切り日。コンテンツの鮮度プロモーションを使用するかどうかを指定できます。コンテンツがカットオフ日以内に公開された場合、そのコンテンツはおすすめの結果に表示されます。SolutionType が SOLUTION_TYPE_RECOMMENDATION の場合にのみ設定できます。

フィールド
demotion_event_type	string レコメンデーション結果の降格に使用されるイベントタイプを指定します。現在サポートされている値は次のとおりです。 view-item: アイテムが閲覧されました。 media-play: 動画の視聴や曲の再生などを開始/再開します。 media-complete: 動画や曲などが終了したか、途中で停止したか。 未設定の場合、再生履歴の降格は適用されません。コンテンツの更新頻度による降格は引き続き適用されます。
demote_content_watched_past_days	int32 省略可。視聴済みコンテンツの表示順位を下げるために遡る日数を指定します。ゼロに設定した場合、または設定しなかった場合は、デフォルトで最大 365 日になります。
content_freshness_cutoff_days	int32 おすすめの結果に使用されるコンテンツの鮮度を指定します。コンテンツの公開からコンテンツの更新頻度のカットオフ日数を経過している場合、コンテンツの表示順位が下がります。
共用体フィールド demote_content_watched。視聴済みのコンテンツを降格させるしきい値を指定します。しきい値は、割合または分数のいずれかの値にできます。これは media-complete イベントタイプで設定する必要があります。demote_content_watched は次のいずれかになります。
content_watched_percentage_threshold	float 視聴済みコンテンツの表示順位を下げるための視聴済みコンテンツの割合のしきい値を指定します。しきい値は [0, 1.0] の範囲で指定する必要があります。
content_watched_seconds_threshold	float 視聴済みコンテンツの表示順位を下げるための視聴時間（分）のしきい値を指定します。

セッション

外部セッションの proto 定義。

フィールド
name	string 変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
display_name	string 省略可。セッションの表示名。 このフィールドは、UI でセッションを識別するために使用されます。デフォルトでは、表示名はセッションの最初のターンのクエリテキストです。
state	State セッションの状態。
user_pseudo_id	string ユーザーをトラッキングするための一意の識別子。
turns[]	Turn ターン。
labels[]	string 省略可。セッションのラベル。ListSessionsRequest でフィルタとして設定できます。
start_time	Timestamp 出力専用。セッションの開始時刻。
end_time	Timestamp 出力専用。セッションが終了した時刻。
is_pinned	bool 省略可。セッションが固定されているかどうか。固定されているセッションはセッション リストの上部に表示されます。

状態

セッションの状態の列挙。

列挙型
STATE_UNSPECIFIED	状態が指定されていません。
IN_PROGRESS	セッションは現在オープンです。

Turn

ユーザーからのクエリやサービスからの回答など、ターンを表します。

フィールド
query	Query 省略可。ユーザーのクエリ。このターンが別のターンの回答を再生成しているだけの場合は設定されないことがあります
answer	string 省略可。ユーザー クエリに対する回答のリソース名。 このターンで回答生成（/answer API 呼び出し）が行われた場合にのみ設定します。
assist_answer	string 出力専用。ユーザーのクエリに対するアシスタントの回答のリソース名。 このターンでアシスト呼び出し（/assist API 呼び出し）が発生した場合にのみ設定されます。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}。セッションのすべての AssistAnswer を取得するには、GetSessionRequest.include_answer_details を true に設定します。または、個々の AssistAnswer リソースを取得するには、AssistAnswerService.GetAssistAnswer API を使用します。
detailed_answer	Answer 出力専用。ConversationalSearchService.GetSession API で GetSessionRequest.include_answer_details が true に設定されている場合、回答クエリ セッションを取得するときにこのフィールドが入力されます。
detailed_assist_answer	AssistAnswer 出力専用。ConversationalSearchService.GetSession API で GetSessionRequest.include_answer_details が true に設定されている場合、アシスタント セッションを取得するときにこのフィールドが入力されます。
query_config	map<string, string> 省略可。クエリ構成に関連するメタデータ（使用された LLM モデルとバージョン、モデル パラメータ（温度、グラウンディング パラメータなど））を表します。接頭辞「google.」は、Google が開発した機能用に予約されています。

SetUpDataConnectorMetadata

この型にはフィールドがありません。

DataConnectorService.SetUpDataConnector メソッドのメタデータ。

SetUpDataConnectorRequest

DataConnectorService.SetUpDataConnector メソッドのリクエスト。

フィールド
parent	string 必須。Collection の親（projects/{project}/locations/{location} の形式）。
collection_id	string 必須。Collection に使用する ID。Collection のリソース名の最終的なコンポーネントになります。DataConnector の設定の一部として、新しい Collection が作成されます。DataConnector は Collection のシングルトン リソースで、Collection のすべての DataStore を管理します。 このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
collection_display_name	string 必須。Collection の表示名。 人が読める文字列で、コンソール ダッシュボードでコレクションを表示するために使用されます。UTF-8 でエンコードされた文字列で、上限は 1,024 文字です。
data_connector	DataConnector 必須。新しく作成された Collection で初期化する DataConnector。

SingleRegionKey

単一リージョン CMEK のメタデータ。

フィールド
kms_key	string 必須。リソース projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} の暗号化に使用される単一リージョンの KMS 鍵リソース名。

SiteSearchEngine

SiteSearchEngine は、DataStore レベルのサイト内検索の永続構成をキャプチャします。データストアごとのシングルトン値です。

フィールド
name	string サイト検索エンジンの完全修飾リソース名。形式: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

高度なサイト内検索の対象サイトの確認情報。

フィールド
site_verification_state	SiteVerificationState 所有権と有効性を示すサイトの確認状態。
verify_time	Timestamp サイトの最新の確認日時。

SiteVerificationState

サイトの確認状態。

列挙型
SITE_VERIFICATION_STATE_UNSPECIFIED	デフォルトは VERIFIED です。
VERIFIED	サイトの所有権が確認されました。
UNVERIFIED	サイトの所有権の確認が保留中であるか、確認に失敗しました。
EXEMPTED	確認が免除されているサイト（すべてのユーザーに公開されているウェブサイトなど）。

サイトマップ

SiteSearchEngine のサイトマップ。

フィールド
name	string 出力専用。サイトマップの完全修飾リソース名。projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/* sitemap_id 接尾辞はシステムによって生成されます。
create_time	Timestamp 出力専用。サイトマップの作成日時。
共用体フィールド feed。サポートされているフィードソース。feed は次のいずれかになります。
uri	string サイトマップの公開 URI（例: www.example.com/sitemap.xml）。

ソリューション タイプ

ソリューションのタイプ。

列挙型
SOLUTION_TYPE_UNSPECIFIED	デフォルト値。
SOLUTION_TYPE_RECOMMENDATION	Recommendations AI に使用されます。
SOLUTION_TYPE_SEARCH	ファインド検索で使用されます。
SOLUTION_TYPE_CHAT	生成 AI エージェントに関連するユースケースに使用されます。
SOLUTION_TYPE_GENERATIVE_CHAT	生成チャット エージェントに関連するユースケースに使用されます。生成チャット エンジンでのみ使用されます。関連するデータストアは SOLUTION_TYPE_CHAT ソリューションに登録されている必要があります。

SpannerSource

データをインポートする Spanner ソース

フィールド
project_id	string Spanner ソースを含むプロジェクトのプロジェクト ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。
instance_id	string 必須。ソース Spanner テーブルのインスタンス ID。
database_id	string 必須。ソース Spanner テーブルのデータベース ID。
table_id	string 必須。インポートする必要がある Spanner データベースのテーブル名。
enable_data_boost	bool Spanner エクスポートでデータブーストを適用するかどうか。このオプションを有効にすると、追加費用が発生します。詳しくは、こちらをご参照ください。

StreamAssistRequest

AssistantService.StreamAssist メソッドのリクエスト。

フィールド
name	string 必須。Assistant のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
query	Query 省略可。現在のユーザークエリ。 空のクエリは、file_ids が指定されている場合にのみサポートされます。この場合、回答はこれらのコンテキスト ファイルに基づいて生成されます。
session	string 省略可。リクエストに使用するセッション。指定した場合、アシスタントはセッション履歴にアクセスでき、クエリと回答がそこに保存されます。 セッション ID として - が指定されている場合、または空のままになっている場合は、自動生成された ID を持つ新しいセッションが作成されます。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
user_metadata	AssistUserMetadata 省略可。クエリを開始したユーザーに関する情報。
agents_spec	AgentsSpec 省略可。リクエストの処理に使用されるエージェントの仕様。
tools_spec	ToolsSpec 省略可。リクエストの処理に使用されるツールの仕様。
generation_spec	GenerationSpec 省略可。リクエストの生成構成の仕様。

AgentsSpec

リクエストの処理に使用されるエージェントの仕様。

フィールド
agent_specs[]	AgentSpec 省略可。リクエストの処理に使用されるエージェントの仕様。

AgentSpec

エージェントの仕様。

フィールド
agent_id	string 必須。リクエストを処理するエージェント リソースを識別する ID。 このフィールドは RFC-1034 に準拠し、長さは 63 文字以内にする必要があります。

GenerationSpec

リクエストのアシスタント生成仕様。これにより、エンジンレベルでデフォルトの生成構成をオーバーライドできます。

フィールド
model_id	string 省略可。生成モデルに使用される Vertex AI model_id。設定されていない場合は、デフォルトのアシスタント モデルが使用されます。

ToolsSpec

リクエストの処理に使用されるツールの仕様。

フィールド
vertex_ai_search_spec	VertexAiSearchSpec 省略可。Vertex AI Search ツールの仕様。
web_grounding_spec	WebGroundingSpec 省略可。ウェブ グラウンディング ツールの仕様。このフィールドが存在する場合、ウェブ検索によるグラウンディングが有効になります。Assistant.web_grounding_type が [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] または [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] の場合にのみ機能します。
image_generation_spec	ImageGenerationSpec 省略可。画像生成ツールの仕様。
video_generation_spec	VideoGenerationSpec 省略可。動画生成ツールの仕様。

ImageGenerationSpec

この型にはフィールドがありません。

画像生成ツールの仕様。

VertexAiSearchSpec

Vertex AI Search ツールの仕様。

フィールド
data_store_specs[]	DataStoreSpec 省略可。検索呼び出しでフィルタする DataStore と、それらのデータストアの構成を定義する仕様。これは、複数のデータストアを持つ Engine でのみ考慮されます。
filter	string 省略可。フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。 このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。 Vertex AI Search でのフィルタリングは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキー プロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマに「name」というフィールドがあるとします。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。 構文やフィルタ オペレータなどのフィルタリングの詳細については、フィルタをご覧ください。

VideoGenerationSpec

この型にはフィールドがありません。

動画生成ツールの仕様。

WebGroundingSpec

この型にはフィールドがありません。

ウェブ グラウンディング ツールの仕様。

StreamAssistResponse

AssistantService.StreamAssist メソッドに対するレスポンス。

フィールド
answer	AssistAnswer ユーザーのクエリに対するアシスタントの最終回答の一部を含むアシスト回答リソース オブジェクト。 現在のレスポンスで以前に送信された AssistAnswer.replies に何も追加されていない場合は存在しません。 AssistAnswer.state を監視して、さらにパーツが予想されるかどうかを確認します。状態が IN_PROGRESS の間、各レスポンスの AssistAnswer.replies フィールドには、前のレスポンスで受信したレスポンスに追加されるレスポンス（レスポンス フラグメント）が含まれます。AssistAnswer.name は入力されません。 状態が SUCCEEDED、FAILED、SKIPPED の場合、レスポンスは最後のレスポンスであり、AssistAnswer.name に値が設定されます。
session_info	SessionInfo セッション情報。レスポンス ストリームの最終的な StreamAssistResponse にのみ含まれます。
assist_token	string 現在の一連のリクエストとレスポンスを識別するグローバル一意 ID。フィードバックとサポートに使用されます。

SessionInfo

セッションに関する情報。

フィールド
session	string 新たに生成されたセッションまたは継続されたセッションの名前。 形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}。

SubscriptionTerm

サブスクリプション期間。LINT.IfChange

列挙型
SUBSCRIPTION_TERM_UNSPECIFIED	デフォルト値。使用しないでください。
SUBSCRIPTION_TERM_ONE_MONTH	1 か月。
SUBSCRIPTION_TERM_ONE_YEAR	1 年間。
SUBSCRIPTION_TERM_THREE_YEARS	3 年間。

SubscriptionTier

サブスクリプション階層情報。

列挙型
SUBSCRIPTION_TIER_UNSPECIFIED	デフォルト値。
SUBSCRIPTION_TIER_SEARCH	検索階層。Search 階層では、VAIS 検索機能と NotebookLM 機能にアクセスできます。
SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT	検索 + アシスタントの階層。検索 + アシスタント階層では、VAIS 検索機能、NotebookLM 機能、アシスタント機能にアクセスできます。
SUBSCRIPTION_TIER_NOTEBOOK_LM	NotebookLM の階層。NotebookLM は、NotebookLM の機能にのみアクセスできるサブスクリプション ティアです。
SUBSCRIPTION_TIER_FRONTLINE_WORKER	現場スタッフの階層。
SUBSCRIPTION_TIER_AGENTSPACE_STARTER	Agentspace Starter Tier。
SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS	Agentspace Business ティア。
SUBSCRIPTION_TIER_ENTERPRISE	エンタープライズ ティア。
SUBSCRIPTION_TIER_EDU	EDU 階層。
SUBSCRIPTION_TIER_EDU_PRO	EDU Pro 階層。
SUBSCRIPTION_TIER_EDU_EMERGING	EDU 新興市場の階層。
SUBSCRIPTION_TIER_EDU_PRO_EMERGING	EDU Pro 新興市場ティア。

SuggestionDenyListEntry

候補からブロックするフレーズと、そのフレーズに適用されるオペレーションを特定する候補の拒否リスト エントリ。

フィールド
block_phrase	string 必須。候補に表示しないフレーズ。最大 125 文字まで入力できます。
match_operator	MatchOperator 必須。このフレーズに適用する一致演算子。フレーズを完全に一致させるか、このフレーズを含む候補をブロックするかを指定します。

MatchOperator

生成された候補と照合するための演算子。

列挙型
MATCH_OPERATOR_UNSPECIFIED	デフォルト値。使用しないでください
EXACT_MATCH	候補が block_phrase と完全に一致する場合は、ブロックします。
CONTAINS	候補に block_phrase が含まれている場合は、ブロックします。

TargetSite

SiteSearchEngine のターゲット サイト。

フィールド
name	string 出力専用。ターゲット サイトの完全修飾リソース名。projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} target_site_id はシステムによって生成されます。
provided_uri_pattern	string 必須。入力専用。generated_uri_pattern の生成元となるユーザー指定の URI パターン。
type	Type ターゲット サイトのタイプ（サイトを含めるか除外するかなど）。
exact_match	bool 変更不可。false に設定すると、provided_uri_pattern を含むアドレスを持つすべてのページを含む uri_pattern が生成されます。true に設定すると、provided_uri_pattern と完全に一致する URI パターンが生成されます。provided_uri_pattern が特定のパターンである場合は、特定のページと完全に一致する URI パターンが生成されます。provided_uri_pattern は、検索エンジンで使用される URI パターンを生成するために常に正規化されます。
generated_uri_pattern	string 出力専用。これは、provided_uri_pattern に基づいてシステムで生成されます。
root_domain_uri	string 出力専用。provided_uri_pattern のルートドメイン。
site_verification_info	SiteVerificationInfo 出力専用。サイトの所有権と有効性の確認ステータス。
indexing_status	IndexingStatus 出力専用。インデックス登録のステータス。
update_time	Timestamp 出力専用。ターゲット サイトの最終更新日時。
failure_reason	FailureReason 出力専用。失敗の理由。

FailureReason

サイト内検索のインデックス登録が失敗した理由。

フィールド
共用体フィールド failure。失敗の理由。failure は次のいずれかになります。
quota_failure	QuotaFailure 割り当てが不足しているため、失敗しました。

QuotaFailure

割り当てが不足しているため、失敗しました。

フィールド
total_required_quota	int64 この数値は、このプロジェクトでインデックス登録を正常に完了するために必要な合計割り当て量の推定値です。

IndexingStatus

ターゲット サイトのインデックス登録ステータスの列挙型。

列挙型
INDEXING_STATUS_UNSPECIFIED	デフォルトは SUCCEEDED です。
PENDING	ターゲット サイトは更新キューに登録され、インデックス パイプラインによって取得されます。
FAILED	ターゲット サイトのインデックス登録に失敗します。
SUCCEEDED	ターゲット サイトがインデックスに登録されている。
DELETING	以前にインデックス登録されたターゲット サイトは、削除対象としてマークされています。これは移行状態です。インデックス登録解除が成功した場合はターゲット サイトが削除され、インデックス登録解除が失敗した場合は状態が SUCCEEDED に戻ります。
CANCELLABLE	ターゲット サイトの変更は保留中ですが、キャンセルできます。
CANCELLED	ターゲット サイトの変更がキャンセルされます。

タイプ

ターゲット サイトのタイプ。

列挙型
TYPE_UNSPECIFIED	この値は使用されません。この場合、サーバーの動作はデフォルトで Type.INCLUDE になります。
INCLUDE	ターゲット サイトを含めます。
EXCLUDE	ターゲット サイトを除外します。

テナント

コネクタソースのテナント情報。これには、Credential メッセージに保存されている情報の一部が含まれますが、ユーザーにアクセス可能なテナントのリストを提供するために必要な情報のみに限定されます。

フィールド
id	string テナントのインスタンス ID。例: Jira（「8594f221-9797-5f78-1fa4-485e198d7cd0」）、Slack（「T123456」）。
uri	string テナントの URI（該当する場合）。たとえば、Jira インスタンスの URI は https://my-jira-instance.atlassian.net です。Slack テナントには URI がありません。
display_name	string テナントのオプションの表示名（「My Slack Team」など）。

TextInput

テキスト入力を定義します。

フィールド
input	string テキスト入力。
context	ConversationContext 入力の会話コンテキスト。

TrainCustomModelMetadata

TrainCustomModel オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

TrainCustomModelRequest

SearchTuningService.TrainCustomModel メソッドに対するリクエスト メッセージ。

フィールド
data_store	string 必須。データストアのリソース名（例: projects/*/locations/global/collections/default_collection/dataStores/default_data_store）。このフィールドは、モデルをトレーニングするデータストアを特定するために使用されます。
model_type	string トレーニングするモデル。サポートされている値は次のとおりです。 search-tuning: 提供されたデータに基づいて検索システムを微調整します。
error_config	ImportErrorConfig データ取り込みとトレーニング中に発生したエラーを記録する目的の場所。
model_id	string 指定しない場合、UUID が生成されます。
共用体フィールド training_input。モデル トレーニングの入力。training_input は次のいずれかになります。
gcs_training_input	GcsTrainingInput Cloud Storage トレーニング入力。

GcsTrainingInput

Cloud Storage トレーニング データ入力。

フィールド
corpus_data_path	string トレーニング データに関連付けることができる Cloud Storage コーパス データ。データパスの形式は gs://<bucket_to_data>/<jsonl_file_name> です。改行区切りの jsonl/ndjson ファイル。 検索チューニング モデルの場合、各行には _id、タイトル、テキストが必要です。例: {"_id": "doc1", title: "relevant doc", "text": "relevant text"}
query_data_path	string トレーニング データに関連付けることができる gcs クエリデータ。データパスの形式は gs://<bucket_to_data>/<jsonl_file_name> です。改行区切りの jsonl/ndjson ファイル。 検索チューニング モデルの場合、各行に _id とテキストが必要です。例: {"_id": "query1", "text": "example query"}
train_data_path	string Cloud Storage トレーニング データパス。形式は gs://<bucket_to_data>/<tsv_file_name> である必要があります。ファイルは tsv 形式にする必要があります。各行には、doc_id、query_id、スコア（数値）が必要です。 検索チューニング モデルの場合、tsv ファイルのヘッダーとして query-id corpus-id score が必要です。スコアは [0, inf+) の数値である必要があります。数値が大きいほど、ペアの関連性が高くなります。例: query-id\tcorpus-id\tscore query1\tdoc1\t1
test_data_path	string Cloud Storage テストデータ。train_data_path と同じ形式。指定されていない場合は、train_data_path に対して 80/20 のランダムなトレーニング/テスト分割が実行されます。

TrainCustomModelResponse

TrainCustomModelRequest のレスポンス。このメッセージは、google.longrunning.Operations.response フィールドにより返されます。

フィールド
error_samples[]	Status データの処理中に発生したエラーのサンプル。
error_config	ImportErrorConfig 設定されている場合、リクエスト内で発生した全エラーの宛先を返します。
model_status	string トレーニング済みモデルのステータス。次の値があります。 bad-data: トレーニング データの品質が低い。 no-improvement: チューニングによってパフォーマンスが向上しませんでした。デプロイされません。 in-progress: モデル トレーニング ジョブの作成が進行中です。 training: モデルがアクティブにトレーニングされています。 評価中: モデルがトレーニング済みの指標を評価しています。 インデックス登録: モデルのトレーニング指標がインデックス登録されています。 ready: モデルはサービングの準備ができています。
metrics	map<string, double> トレーニング済みモデルの指標。
model_name	string CustomTuningModel の完全修飾名。

TransactionInfo

トランザクションは購入トランザクション全体を表します。

フィールド
currency	string 必須。通貨コード。3 文字の ISO-4217 コードを使用します。
transaction_id	string 長さの上限が 128 文字の取引 ID。
value	float 必須。トランザクションに関連付けられたゼロ以外の合計値。この値には、合計値に含める送料、税金、その他の調整額を含めることができます。
tax	float トランザクションに関連付けられたすべての税金。
cost	float 商品に関連付けられたすべての費用。たとえば、製造費や、エンドユーザーが負担しない配送費用などが該当します。 利益 = value - tax - cost
discount_value	float この取引に適用された割引の合計額。この数値は TransactionInfo.value から除外する必要があります たとえば、ユーザーが TransactionInfo.value の金額を支払った場合、トランザクションの名目値（割引前）は TransactionInfo.value と TransactionInfo.discount_value の合計になります。 つまり、割引額に関係なく利益は同じ方法で計算され、TransactionInfo.discount_value は TransactionInfo.value より大きくなる可能性があります。 利益 = value - tax - cost

UpdateAclConfigRequest

UpdateAclConfig メソッドに対するリクエスト メッセージ。

フィールド
acl_config	AclConfig

UpdateAssistantRequest

AssistantService.UpdateAssistant メソッドに対するリクエスト メッセージ。

フィールド
assistant	Assistant 必須。更新する Assistant。 Assistant の name フィールドは、更新する Assistant を識別するために使用されます。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} 呼び出し元に Assistant を更新する権限がない場合、Assistant が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 更新する Assistant が存在しない場合は、NOT_FOUND エラーが返されます。
update_mask	FieldMask 更新するフィールドのリスト。

UpdateCmekConfigMetadata

CmekConfigService.UpdateCmekConfig オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

UpdateCmekConfigRequest

UpdateCmekConfig メソッドに対するリクエスト メッセージ。rpc。

フィールド
config	CmekConfig 必須。CmekConfig リソース。
set_default	bool 子リソースが指定されていない場合に使用されるデフォルトとして、次の CmekConfig を設定します。

UpdateControlRequest

UpdateControl メソッドのリクエスト。

フィールド
control	Control 必須。更新する Control。
update_mask	FieldMask 省略可。指定された Control で更新するフィールドを示します。以下はサポートされません。 Control.name Control.solution_type 設定されていない場合、または空の場合、サポートされているすべてのフィールドが更新されます。

UpdateConversationRequest

UpdateConversation メソッドのリクエスト。

フィールド
conversation	Conversation 必須。更新する会話。
update_mask	FieldMask 指定された Conversation で更新するフィールドを示します。以下はサポートされません。 Conversation.name 設定されていない場合、または空の場合、サポートされているすべてのフィールドが更新されます。

UpdateDataConnectorRequest

DataConnectorService.UpdateDataConnector メソッドに対するリクエスト メッセージ。

フィールド
data_connector	DataConnector 必須。更新する DataConnector。 呼び出し元に DataConnector を更新する権限がない場合、DataConnector が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 DataConnector が存在しない場合は、NOT_FOUND エラーが返されます。
update_mask	FieldMask 指定された DataConnector で更新するフィールドを示します。 サポートされているフィールド パスは次のとおりです。 refresh_interval params auto_run_disabled action_config action_config.action_params action_config.service_name destination_configs blocking_reasons sync_mode incremental_sync_disabled incremental_refresh_interval 注: これらのフィールドのサポートは、コネクタのタイプによって異なる場合があります。たとえば、すべてのコネクタが destination_configs をサポートしているわけではありません。 サポートされていないフィールド パスや不明なフィールド パスを指定すると、リクエストは INVALID_ARGUMENT エラーを返します。

UpdateDataStoreRequest

DataStoreService.UpdateDataStore メソッドに対するリクエスト メッセージ。

フィールド
data_store	DataStore 必須。更新する DataStore。 呼び出し元に DataStore を更新する権限がない場合、DataStore が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 更新する DataStore が存在しない場合は、NOT_FOUND エラーが返されます。
update_mask	FieldMask 指定された DataStore で更新するフィールドを示します。 サポートされていないフィールドや不明なフィールドを指定すると、INVALID_ARGUMENT エラーが返されます。

UpdateDocumentRequest

DocumentService.UpdateDocument メソッドに対するリクエスト メッセージ。

フィールド
document	Document 必須。更新または作成するドキュメント。 呼び出し元に Document を更新する権限がない場合、Document が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 更新する Document が存在せず、allow_missing が設定されていない場合は、NOT_FOUND エラーが返されます。
allow_missing	bool true に設定されていて Document が見つからない場合は、新しい Document が作成されます。
update_mask	FieldMask 指定されたインポート済みの「ドキュメント」で更新するフィールドを示します。設定しない場合、デフォルトですべてのフィールドが更新されます。

UpdateEngineRequest

EngineService.UpdateEngine メソッドに対するリクエスト メッセージ。

フィールド
engine	Engine 必須。更新する Engine。 呼び出し元に Engine を更新する権限がない場合、Engine が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 更新する Engine が存在しない場合は、NOT_FOUND エラーが返されます。
update_mask	FieldMask 指定された Engine で更新するフィールドを示します。 サポートされていないフィールドや不明なフィールドを指定すると、INVALID_ARGUMENT エラーが返されます。

UpdateLicenseConfigRequest

LicenseConfigService.UpdateLicenseConfig メソッドに対するリクエスト メッセージ。

フィールド
license_config	LicenseConfig 必須。更新する LicenseConfig。
update_mask	FieldMask 省略可。指定された LicenseConfig で更新するフィールドを示します。 サポートされていないフィールドや不明なフィールドを指定すると、INVALID_ARGUMENT エラーが返されます。

UpdateSchemaMetadata

UpdateSchema LRO のメタデータ。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

UpdateSchemaRequest

SchemaService.UpdateSchema メソッドに対するリクエスト メッセージ。

フィールド
schema	Schema 必須。更新する Schema。
allow_missing	bool true に設定されていて Schema が見つからない場合は、新しい Schema が作成されます。この場合、update_mask は無視されます。

UpdateServingConfigRequest

UpdateServingConfig メソッドのリクエスト。

フィールド
serving_config	ServingConfig 必須。更新する ServingConfig。
update_mask	FieldMask 指定された ServingConfig で更新するフィールドを示します。以下はサポートされません。 ServingConfig.name 設定しない場合、サポートされているすべてのフィールドが更新されます。

UpdateSessionRequest

UpdateSession メソッドのリクエスト。

フィールド
session	Session 必須。更新するセッション。
update_mask	FieldMask 指定された Session で更新するフィールドを示します。以下はサポートされません。 Session.name 設定されていない場合、または空の場合、サポートされているすべてのフィールドが更新されます。

UpdateTargetSiteMetadata

SiteSearchEngineService.UpdateTargetSite オペレーションの進行状況に関連するメタデータ。これは、google.longrunning.Operation.metadata フィールドによって返されます。

フィールド
create_time	Timestamp オペレーションの作成時刻。
update_time	Timestamp オペレーションの最終更新時刻。オペレーションが完了している場合は、終了時刻もこの値になります。

UpdateTargetSiteRequest

SiteSearchEngineService.UpdateTargetSite メソッドに対するリクエスト メッセージ。

フィールド
target_site	TargetSite 必須。更新するターゲット サイト。呼び出し元に TargetSite を更新する権限がない場合、TargetSite が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。 更新する TargetSite が存在しない場合は、NOT_FOUND エラーが返されます。

UserEvent

UserEvent は、エンドユーザーがウェブサイトをどのように操作したかについて、Discovery Engine API が把握する必要があるすべてのメタデータ情報をキャプチャします。

フィールド
event_type	string 必須。ユーザー イベントタイプ。指定できる値は次のとおりです。 一般的な値: search: ドキュメントを検索します。 view-item: ドキュメントの詳細ページ ビュー。 view-item-list: パネルまたはドキュメントの順序付きリストのビュー。 view-home-page: ホームページのビュー。 view-category-page: カテゴリページのビュー（例: ホーム > メンズ > ジーンズ） 小売関連の値: add-to-cart: カートに商品を追加する（小売業のオンライン ショッピングなど） purchase: アイテムを購入する メディア関連の値: media-play: 動画の視聴や曲の再生などを開始/再開します。 media-complete: 動画や曲などが終了したか、途中で停止したか。 カスタム コンバージョン値: conversion: ユーザー定義のコンバージョン イベント。
conversion_type	string 省略可。コンバージョンの種類。 UserEvent.event_type が conversion の場合は必須です。これは、お客様が定義したコンバージョン名です。小文字または数字を「-」で区切って指定します（例: 「watch」、「good-visit」など）。 UserEvent.event_type が conversion でない場合は、フィールドを設定しないでください。これにより、カスタム コンバージョン イベントが search や view-item などの事前定義イベントと混在します。
user_pseudo_id	string 必須。訪問者をトラッキングするための一意の識別子。 たとえば、これは HTTP Cookie で実装できます。これにより、1 台のデバイス上の訪問者を一意に識別できます。この一意の識別子は、訪問者がウェブサイトに対してログインまたはログアウトしても変更されません。 異なるユーザーに対して同じ固定 ID を設定しないでください。これにより、これらのユーザーのイベント履歴が混在し、モデルの品質が低下します。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 このフィールドに PII やユーザーデータを含めることはできません。このフィールドには、Google アナリティクスのクライアント ID を使用することをおすすめします。
engine	string Engine リソース名（projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id} 形式）。 省略可。Engine で生成されたユーザー イベントにのみ必要です。たとえば、ブレンド検索のユーザー イベントなどです。
data_store	string DataStore リソースの完全な名前（projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} 形式）。 省略可。UserEvent.engine または UserEvent.documents でデータストアを特定できないユーザー イベントでのみ必要です。データストアが書き込み/インポート/収集のユーザー イベント リクエストの親に設定されている場合、このフィールドは省略できます。
event_time	Timestamp UserEventService.ImportUserEvents メソッドでのみ必須です。ユーザー イベントが発生したタイムスタンプ。
user_info	UserInfo エンドユーザーに関する情報。
direct_user_request	bool リクエストがエンドユーザーから直接行われた場合は true に設定する必要があります。この場合、UserEvent.user_info.user_agent は HTTP リクエストから入力できます。 このフラグは、API リクエストがエンドユーザー（モバイルアプリなど）から直接行われた場合にのみ設定する必要があります（ゲートウェイまたはサーバーがユーザー イベントを処理して push している場合は設定しないでください）。 UserEventService.CollectUserEvent で JavaScript タグを使用している場合は、この値を設定しないでください。
session_id	string 訪問者セッションをトラッキングするための一意の識別子。長さの上限は 128 バイトです。セッションとは、一定期間内のエンドユーザーの行動をまとめたものです。 session_id にデータを入力するための一般的なガイドラインは次のとおりです。 ユーザーが 30 分間操作を行わなかった場合は、新しい session_id を割り当てる必要があります。 session_id はユーザー間で一意である必要があります。uuid を使用するか、接頭辞として UserEvent.user_pseudo_id を追加することをおすすめします。
page_info	PageInfo view-category-page などの特定のイベントタイプに関するカテゴリやその他の重要な情報などのページ メタデータ。
attribution_token	string イベントをトリガーするユーザー アクションに API レスポンスを関連付けるためのトークン。 RecommendationService.Recommend の結果であるユーザー イベントに強く推奨されます。このフィールドを使用すると、レコメンデーション モデルのパフォーマンスを正確に特定できます。 値は次のいずれかにする必要があります。 RecommendationService.Recommend の結果であるイベントの RecommendResponse.attribution_token。 SearchService.Search の結果であるイベントの SearchResponse.attribution_token。 このトークンにより、ページビューやコンバージョンの完了を、イベントとクリックまたは購入された商品を含む特定の予測レスポンスへと正確に関連付けることができます。ユーザーがレコメンデーション結果の商品 K をクリックした場合は、RecommendResponse.attribution_token を URL パラメータとして商品 K のページに渡します。商品 K のページでイベントを記録するときは、このフィールドに RecommendResponse.attribution_token を記録します。
filter	string フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。 たとえば、search イベントの場合、関連付けられた SearchRequest の SearchRequest.filter には、https://google.aip.dev/160#filtering に準拠したフィルタ式が含まれている場合があります。 同様に、RecommendRequest から生成された view-item-list イベントの場合、このフィールドは https://google.aip.dev/160#filtering に準拠する RecommendRequest.filter から直接入力されることがあります。 値は UTF-8 でエンコードされた文字列で、長さの上限は 1,000 文字です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
documents[]	DocumentInfo このユーザー イベントに関連付けられた Document のリスト。 このフィールドは、次のイベントタイプを除き、省略可能です。 view-item add-to-cart purchase media-play media-complete search イベントでは、このフィールドは現在のページでエンドユーザーに返されたドキュメントを表します（エンドユーザーがページ全体のブラウジングを完了していない場合があります）。同じクエリでも、ページネーション、フィルタリング、並べ替えの後に新しいページがエンドユーザーに返される場合は、異なる UserEvent.documents を含む新しい search イベントが望ましいです。
panel	PanelInfo このユーザー イベントに関連付けられたパネルのメタデータ。
search_info	SearchInfo イベントに関連する SearchService.Search の詳細。 このフィールドは search イベントに設定する必要があります。
completion_info	CompletionInfo イベントに関連する CompletionService.CompleteQuery の詳細。 このフィールドは、予測入力機能が有効で、ユーザーが検索候補をクリックしたときに、search イベントに設定する必要があります。
transaction_info	TransactionInfo このユーザー イベントに関連付けられているトランザクション メタデータ（ある場合）。
tag_ids[]	string このユーザー イベントが属する独立したテストグループの ID リスト。これは、異なるテスト設定に関連付けられたユーザー イベントを区別するために使用されます。
promotion_ids[]	string プロモーションに関連付けられたイベントの場合のプロモーション ID。現在、このフィールドは最大 1 つの ID に制限されています。
attributes	map<string, CustomAttribute> レコメンデーション モデルに含める追加のユーザー イベントの特徴。これらの属性には、JSON などの解析や処理が必要なデータを含めてはなりません。 取り込まれたユーザー イベントのカスタム属性を指定する場合は、予測リクエストに関連付けるユーザー イベントにも含めます。カスタム属性の形式は、インポートされたイベントと、予測リクエストで指定されたイベントの間で一貫している必要があります。これにより、Discovery Engine API はモデルのトレーニング時や予測の提供時にこれらのカスタム属性を使用できるため、レコメンデーションの品質向上に役立ちます。 このフィールドは、以下のすべての条件を満たしている必要があります。満たしていない場合、INVALID_ARGUMENT エラーが返されます。 キーは UTF-8 でエンコードされた文字列で、長さの上限は 5,000 文字です。 テキスト属性の場合、最大 400 個の値を指定できます。空の値は使用できません。各値は、長さの上限が 256 文字の UTF-8 でエンコードされた文字列にする必要があります。 数値属性の場合、最大 400 個の値が許可されます。 商品のおすすめの場合、ユーザーがサイトにアクセスした経路を示す traffic_channel がユーザーの追加情報の例です。ユーザーは、サイトに直接アクセスしたり、Google 検索からアクセスしたり、その他の方法でサイトにアクセスしたりします。
media_info	MediaInfo メディア固有の情報。
panels[]	PanelInfo 省略可。このイベントに関連付けられているパネルのリスト。ページ単位のインプレッション データに使用されます。

UserInfo

エンドユーザーの情報。

フィールド
user_id	string ログインしているユーザーに強く推奨されます。ログイン中のユーザーの一意の識別子（ユーザー名など）。匿名ユーザーには設定しないでください。 この ID には常にハッシュ値を使用します。 異なるユーザーに対して同じ固定 ID を設定しないでください。これにより、これらのユーザーのイベント履歴が混在し、モデルの品質が低下します。 このフィールドは、長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。
user_agent	string HTTP ヘッダーに含まれるユーザー エージェント。 このフィールドは、長さの上限が 1,000 文字の UTF-8 でエンコードされた文字列にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。 GTM または JavaScript タグでクライアントサイドのイベント レポートを使用している場合（UserEventService.CollectUserEvent）や、UserEvent.direct_user_request が設定されている場合は、こちらを設定しないでください。
time_zone	string 省略可。IANA タイムゾーン（例: Europe/Budapest）。

UserLicense

管理者によって割り当てられたユーザー ライセンス情報。

フィールド
user_principal	string 必須。変更不可。ユーザーのユーザー プリンシパル。メールアドレスまたは他のプリンシパル識別子を指定できます。このフィールドは変更できません。管理者はユーザー プリンシパルに基づいてライセンスを割り当てます。
user_profile	string 省略可。ユーザー プロファイル。ユーザー プロフィールとしてユーザーのフルネーム（名 + 姓）を使用します。
license_assignment_state	LicenseAssignmentState 出力専用。ユーザーのライセンス割り当ての状態。ユーザーにライセンス構成が割り当てられている場合、ユーザーのログインにライセンスが割り当てられます。ユーザーのライセンス割り当て状態が割り当てなしまたは未指定の場合、ユーザーにライセンス構成は関連付けられません。
license_config	string 省略可。ユーザーに割り当てられた Subscription（LicenseConfig）の完全なリソース名。
create_time	Timestamp 出力専用。ユーザー作成タイムスタンプ。
update_time	Timestamp 出力専用。ユーザー更新のタイムスタンプ。
last_login_time	Timestamp 出力専用。ユーザーが最後にログインした日時。ユーザーがまだログインしていない場合、このフィールドは空になります。

LicenseAssignmentState

ライセンス割り当て状態の列挙型。

列挙型
LICENSE_ASSIGNMENT_STATE_UNSPECIFIED	デフォルト値。
ASSIGNED	ユーザーに割り当てられているライセンス。
UNASSIGNED	ユーザーにライセンスが割り当てられていません。非推奨。NO_LICENSE に変換されます。
NO_LICENSE	ユーザーにライセンスが割り当てられていません。
NO_LICENSE_ATTEMPTED_LOGIN	ユーザーがログインを試みましたが、ユーザーにライセンスが割り当てられていません。この状態は、ユーザーが初めてログインしようとしたが、ライセンスを割り当てることができなかった場合にのみ使用されます。すでにログインしているが、ライセンスを割り当てることができないユーザーには、NO_LICENSE 状態が割り当てられます（ライセンスは管理者によって割り当て解除されている可能性があります）。
BLOCKED	ユーザーがライセンスを割り当てることができない。

WorkspaceConfig

ワークスペース データのデータストア タイプ構成を保存する構成

フィールド
type	Type Google Workspace データソース。
dasher_customer_id	string 難読化された Dasher のお客様 ID。
super_admin_service_account	string 省略可。アクセス トークンの生成に使用されるワークスペースの特権管理者サービス アカウント。現時点では、ネイティブの Google ドライブ コネクタのデータ取り込みにのみ使用されます。
super_admin_email_address	string 省略可。アクセス トークンの生成に使用されるワークスペースの特権管理者メールアドレス。現時点では、ネイティブの Google ドライブ コネクタのデータ取り込みにのみ使用されます。

タイプ

この DataStore でサポートされている Workspace アプリのタイプを指定します

列挙型
TYPE_UNSPECIFIED	デフォルトは、指定されていない Workspace タイプです。
GOOGLE_DRIVE	Workspace データストアにドライブのデータが含まれている
GOOGLE_MAIL	Workspace データストアにメールデータが含まれている
GOOGLE_SITES	Workspace データストアにサイトのデータが含まれている
GOOGLE_CALENDAR	Workspace データストアにカレンダー データが含まれている
GOOGLE_CHAT	Workspace データストアに Chat データが含まれている
GOOGLE_GROUPS	Workspace データストアにグループ データが含まれている
GOOGLE_KEEP	Workspace Data Store に Keep のデータが含まれている
GOOGLE_PEOPLE	Workspace データストアにユーザーデータが含まれている

WriteUserEventRequest

WriteUserEvent メソッドのリクエスト メッセージ。

フィールド
parent	string 必須。親リソース名。書き込みユーザー イベント アクションが DataStore レベルで適用される場合、形式は projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} です。書き込みユーザー イベント アクションが Location レベル（複数の DataStore にわたる Document を含むイベントなど）で適用される場合、形式は projects/{project}/locations/{location} になります。
write_async	bool true に設定すると、ユーザー イベントは検証後に非同期で書き込まれ、API は書き込みを待たずに応答します。
user_event	UserEvent 必須。書き込みをするユーザー イベント。