Index
AclConfigService(interface)AssistAnswerService(interface)AssistantService(interface)CmekConfigService(interface)CollectionService(interface)CompletionService(interface)ControlService(interface)ConversationalSearchService(interface)DataConnectorService(interface)DataStoreService(interface)DocumentService(interface)EngineService(interface)GroundedGenerationService(interface)IdentityMappingStoreService(interface)LicenseConfigService(interface)PodcastService(interface)ProjectService(interface)RankService(interface)RecommendationService(interface)SchemaService(interface)SearchService(interface)SearchTuningService(interface)ServingConfigService(interface)SessionService(interface)SiteSearchEngineService(interface)UserEventService(interface)UserLicenseService(interface)AclConfig(message)ActionConfig(message)AddContextFileRequest(message)AddContextFileResponse(message)AdvancedCompleteQueryRequest(message)AdvancedCompleteQueryRequest.BoostSpec(message)AdvancedCompleteQueryRequest.BoostSpec.ConditionBoostSpec(message)AdvancedCompleteQueryRequest.SuggestionType(enum)AdvancedCompleteQueryRequest.SuggestionTypeSpec(message)AdvancedCompleteQueryResponse(message)AdvancedCompleteQueryResponse.ContentSuggestion(message)AdvancedCompleteQueryResponse.ContentSuggestion.ContentType(enum)AdvancedCompleteQueryResponse.PersonSuggestion(message)AdvancedCompleteQueryResponse.PersonSuggestion.PersonType(enum)AdvancedCompleteQueryResponse.QuerySuggestion(message)AdvancedCompleteQueryResponse.RecentSearchSuggestion(message)AdvancedSiteSearchConfig(message)AlertPolicyConfig(message)AlertPolicyConfig.AlertEnrollment(message)AlertPolicyConfig.AlertEnrollment.EnrollStates(enum)AlertPolicyResourceConfig(message)AlertPolicyResourceConfig.AlertEnrollment(message)AlertPolicyResourceConfig.AlertEnrollment.EnrollState(enum)AlloyDbSource(message)Answer(message)Answer.AnswerSkippedReason(enum)Answer.Citation(message)Answer.CitationSource(message)Answer.GroundingSupport(message)Answer.QueryUnderstandingInfo(message)Answer.QueryUnderstandingInfo.QueryClassificationInfo(message)Answer.QueryUnderstandingInfo.QueryClassificationInfo.Type(enum)Answer.Reference(message)Answer.Reference.ChunkInfo(message)Answer.Reference.ChunkInfo.DocumentMetadata(message)Answer.Reference.StructuredDocumentInfo(message)Answer.Reference.UnstructuredDocumentInfo(message)Answer.Reference.UnstructuredDocumentInfo.ChunkContent(message)Answer.State(enum)Answer.Step(message)Answer.Step.Action(message)Answer.Step.Action.Observation(message)Answer.Step.Action.Observation.SearchResult(message)Answer.Step.Action.Observation.SearchResult.ChunkInfo(message)Answer.Step.Action.Observation.SearchResult.SnippetInfo(message)Answer.Step.Action.SearchAction(message)Answer.Step.State(enum)AnswerGenerationSpec(message)AnswerGenerationSpec.UserDefinedClassifierSpec(message)AnswerQueryRequest(message)AnswerQueryRequest.AnswerGenerationSpec(message)AnswerQueryRequest.AnswerGenerationSpec.ModelSpec(message)AnswerQueryRequest.AnswerGenerationSpec.PromptSpec(message)AnswerQueryRequest.EndUserSpec(message)AnswerQueryRequest.EndUserSpec.EndUserMetaData(message)AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo(message)AnswerQueryRequest.EndUserSpec.EndUserMetaData.ChunkInfo.DocumentMetadata(message)AnswerQueryRequest.GroundingSpec(message)AnswerQueryRequest.GroundingSpec.FilteringLevel(enum)AnswerQueryRequest.QueryUnderstandingSpec(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryClassificationSpec.Type(enum)AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec(message)AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.ModelSpec.ModelType(enum)AnswerQueryRequest.RelatedQuestionsSpec(message)AnswerQueryRequest.SafetySpec(message)AnswerQueryRequest.SafetySpec.SafetySetting(message)AnswerQueryRequest.SafetySpec.SafetySetting.HarmBlockThreshold(enum)AnswerQueryRequest.SearchSpec(message)AnswerQueryRequest.SearchSpec.SearchParams(message)AnswerQueryRequest.SearchSpec.SearchResultList(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.ChunkInfo.DocumentMetadata(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer(message)AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment(message)AnswerQueryResponse(message)AssistAnswer(message)AssistAnswer.AssistSkippedReason(enum)AssistAnswer.CustomerPolicyEnforcementResult(message)AssistAnswer.CustomerPolicyEnforcementResult.BannedPhraseEnforcementResult(message)AssistAnswer.CustomerPolicyEnforcementResult.ModelArmorEnforcementResult(message)AssistAnswer.CustomerPolicyEnforcementResult.PolicyEnforcementResult(message)AssistAnswer.CustomerPolicyEnforcementResult.Verdict(enum)AssistAnswer.Reply(message)AssistAnswer.State(enum)AssistRequest(message)AssistRequest.AssistSkippingMode(enum)AssistResponse(message)AssistResponse.SessionInfo(message)AssistUserMetadata(message)Assistant(message)Assistant.ActionInfo(message) (obsolète)Assistant.ActionList(message) (obsolète)Assistant.CustomerPolicy(message)Assistant.CustomerPolicy.BannedPhrase(message)Assistant.CustomerPolicy.BannedPhrase.BannedPhraseMatchType(enum)Assistant.CustomerPolicy.ModelArmorConfig(message)Assistant.CustomerPolicy.ModelArmorConfig.FailureMode(enum)Assistant.GenerationConfig(message)Assistant.GenerationConfig.SystemInstruction(message)Assistant.ToolInfo(message)Assistant.ToolList(message)Assistant.WebGroundingType(enum)AssistantContent(message)AssistantContent.Blob(message)AssistantContent.CodeExecutionResult(message)AssistantContent.CodeExecutionResult.Outcome(enum)AssistantContent.ExecutableCode(message)AssistantContent.File(message)AssistantGroundedContent(message)AssistantGroundedContent.ContentMetadata(message)AssistantGroundedContent.ContentMetadata.ContentKind(enum)AssistantGroundedContent.TextGroundingMetadata(message)AssistantGroundedContent.TextGroundingMetadata.Reference(message)AssistantGroundedContent.TextGroundingMetadata.Reference.DocumentMetadata(message)AssistantGroundedContent.TextGroundingMetadata.Segment(message)BAPConfig(message)BAPConfig.ConnectorMode(enum)BatchCreateTargetSiteMetadata(message)BatchCreateTargetSitesRequest(message)BatchCreateTargetSitesResponse(message)BatchGetDocumentsMetadataRequest(message)BatchGetDocumentsMetadataRequest.FhirMatcher(message)BatchGetDocumentsMetadataRequest.Matcher(message)BatchGetDocumentsMetadataRequest.UrisMatcher(message)BatchGetDocumentsMetadataResponse(message)BatchGetDocumentsMetadataResponse.DocumentMetadata(message)BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue(message)BatchGetDocumentsMetadataResponse.State(enum)BatchUpdateUserLicensesMetadata(message)BatchUpdateUserLicensesRequest(message)BatchUpdateUserLicensesRequest.InlineSource(message)BatchUpdateUserLicensesResponse(message)BatchVerifyTargetSitesMetadata(message)BatchVerifyTargetSitesRequest(message)BatchVerifyTargetSitesResponse(message)BigQuerySource(message)BigtableOptions(message)BigtableOptions.BigtableColumn(message)BigtableOptions.BigtableColumnFamily(message)BigtableOptions.Encoding(enum)BigtableOptions.Type(enum)BigtableSource(message)CheckGroundingRequest(message)CheckGroundingResponse(message)CheckGroundingResponse.CheckGroundingFactChunk(message)CheckGroundingResponse.Claim(message)CheckGroundingSpec(message)Chunk(message)Chunk.AnnotationMetadata(message)Chunk.ChunkMetadata(message)Chunk.DocumentMetadata(message)Chunk.PageSpan(message)Chunk.StructureType(enum)Chunk.StructuredContent(message)Citation(message)CitationMetadata(message)CloudSqlSource(message)CmekConfig(message)CmekConfig.NotebookLMState(enum)CmekConfig.State(enum)CollectUserEventRequest(message)Collection(message)CompleteQueryRequest(message)CompleteQueryResponse(message)CompleteQueryResponse.QuerySuggestion(message)CompletionInfo(message)CompletionSuggestion(message)Condition(message)Condition.QueryTerm(message)Condition.TimeRange(message)ConnectorType(enum)ContactDetails(message)Control(message)Control.BoostAction(message)Control.BoostAction.InterpolationBoostSpec(message)Control.BoostAction.InterpolationBoostSpec.AttributeType(enum)Control.BoostAction.InterpolationBoostSpec.ControlPoint(message)Control.BoostAction.InterpolationBoostSpec.InterpolationType(enum)Control.FilterAction(message)Control.PromoteAction(message)Control.RedirectAction(message)Control.SynonymsAction(message)Conversation(message)Conversation.State(enum)ConversationContext(message)ConversationMessage(message)ConverseConversationRequest(message)ConverseConversationResponse(message)CreateAssistantRequest(message)CreateControlRequest(message)CreateConversationRequest(message)CreateDataStoreMetadata(message)CreateDataStoreRequest(message)CreateDocumentRequest(message)CreateEngineMetadata(message)CreateEngineRequest(message)CreateIdentityMappingStoreRequest(message)CreateLicenseConfigRequest(message)CreateSchemaMetadata(message)CreateSchemaRequest(message)CreateSessionRequest(message)CreateSitemapMetadata(message)CreateSitemapRequest(message)CreateTargetSiteMetadata(message)CreateTargetSiteRequest(message)CustomAttribute(message)CustomTuningModel(message)CustomTuningModel.ModelState(enum)DataConnector(message)DataConnector.BlockingReason(enum)DataConnector.ConnectorMode(enum)DataConnector.EndUserConfig(message)DataConnector.FederatedConfig(message)DataConnector.RealtimeSyncConfig(message)DataConnector.RealtimeSyncConfig.StreamingError(message)DataConnector.RealtimeSyncConfig.StreamingError.StreamingErrorReason(enum)DataConnector.SourceEntity(message)DataConnector.State(enum)DataConnector.SyncMode(enum)DataStore(message)DataStore.BillingEstimation(message)DataStore.ConfigurableBillingApproach(enum)DataStore.ContentConfig(enum)DataStore.ServingConfigDataStore(message)DeleteAssistantRequest(message)DeleteCmekConfigMetadata(message)DeleteCmekConfigRequest(message)DeleteCollectionMetadata(message)DeleteCollectionRequest(message)DeleteControlRequest(message)DeleteConversationRequest(message)DeleteDataStoreMetadata(message)DeleteDataStoreRequest(message)DeleteDocumentRequest(message)DeleteEngineMetadata(message)DeleteEngineRequest(message)DeleteIdentityMappingStoreMetadata(message)DeleteIdentityMappingStoreRequest(message)DeleteSchemaMetadata(message)DeleteSchemaRequest(message)DeleteSessionRequest(message)DeleteSitemapMetadata(message)DeleteSitemapRequest(message)DeleteTargetSiteMetadata(message)DeleteTargetSiteRequest(message)DestinationConfig(message)DestinationConfig.Destination(message)DisableAdvancedSiteSearchMetadata(message)DisableAdvancedSiteSearchRequest(message)DisableAdvancedSiteSearchResponse(message)Document(message)Document.AclInfo(message)Document.AclInfo.AccessRestriction(message)Document.Content(message)Document.IndexStatus(message)DocumentInfo(message)DocumentProcessingConfig(message)DocumentProcessingConfig.ChunkingConfig(message)DocumentProcessingConfig.ChunkingConfig.LayoutBasedChunkingConfig(message)DocumentProcessingConfig.ParsingConfig(message)DocumentProcessingConfig.ParsingConfig.DigitalParsingConfig(message)DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig(message)DocumentProcessingConfig.ParsingConfig.OcrParsingConfig(message)DoubleList(message)EnableAdvancedSiteSearchMetadata(message)EnableAdvancedSiteSearchRequest(message)EnableAdvancedSiteSearchResponse(message)Engine(message)Engine.AppType(enum)Engine.ChatEngineConfig(message)Engine.ChatEngineConfig.AgentCreationConfig(message)Engine.ChatEngineMetadata(message)Engine.CommonConfig(message)Engine.ConfigurableBillingApproach(enum)Engine.FeatureState(enum)Engine.MediaRecommendationEngineConfig(message)Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig(message)Engine.MediaRecommendationEngineConfig.MostPopularFeatureConfig(message)Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig(message)Engine.MediaRecommendationEngineConfig.RecommendedForYouFeatureConfig(message)Engine.MediaRecommendationEngineConfig.TrainingState(enum)Engine.SearchEngineConfig(message)FactChunk(message)FetchDomainVerificationStatusRequest(message)FetchDomainVerificationStatusResponse(message)FetchSitemapsRequest(message)FetchSitemapsRequest.Matcher(message)FetchSitemapsRequest.UrisMatcher(message)FetchSitemapsResponse(message)FetchSitemapsResponse.SitemapMetadata(message)FhirStoreSource(message)FirestoreSource(message)GcsSource(message)GetAclConfigRequest(message)GetAnswerRequest(message)GetAssistAnswerRequest(message)GetAssistantRequest(message)GetCmekConfigRequest(message)GetControlRequest(message)GetConversationRequest(message)GetDataConnectorRequest(message)GetDataStoreRequest(message)GetDocumentRequest(message)GetEngineRequest(message)GetIdentityMappingStoreRequest(message)GetLicenseConfigRequest(message)GetSchemaRequest(message)GetSessionRequest(message)GetSiteSearchEngineRequest(message)GetTargetSiteRequest(message)GroundingFact(message)HarmCategory(enum)HealthcareFhirConfig(message)IdentityMappingEntry(message)IdentityMappingEntryOperationMetadata(message)IdentityMappingStore(message)IdentityScheduleConfig(message)IdpConfig(message)IdpConfig.ExternalIdpConfig(message)IdpConfig.IdpType(enum)ImportCompletionSuggestionsMetadata(message)ImportCompletionSuggestionsRequest(message)ImportCompletionSuggestionsRequest.InlineSource(message)ImportCompletionSuggestionsResponse(message)ImportDocumentsMetadata(message)ImportDocumentsRequest(message)ImportDocumentsRequest.InlineSource(message)ImportDocumentsRequest.ReconciliationMode(enum)ImportDocumentsResponse(message)ImportErrorConfig(message)ImportIdentityMappingsRequest(message)ImportIdentityMappingsRequest.InlineSource(message)ImportIdentityMappingsResponse(message)ImportSuggestionDenyListEntriesMetadata(message)ImportSuggestionDenyListEntriesRequest(message)ImportSuggestionDenyListEntriesRequest.InlineSource(message)ImportSuggestionDenyListEntriesResponse(message)ImportUserEventsMetadata(message)ImportUserEventsRequest(message)ImportUserEventsRequest.InlineSource(message)ImportUserEventsResponse(message)IndustryVertical(enum)Interval(message)LicenseConfig(message)LicenseConfig.State(enum)ListAssistantsRequest(message)ListAssistantsResponse(message)ListCmekConfigsRequest(message)ListCmekConfigsResponse(message)ListControlsRequest(message)ListControlsResponse(message)ListConversationsRequest(message)ListConversationsResponse(message)ListCustomModelsRequest(message)ListCustomModelsResponse(message)ListDataStoresRequest(message)ListDataStoresResponse(message)ListDocumentsRequest(message)ListDocumentsResponse(message)ListEnginesRequest(message)ListEnginesResponse(message)ListIdentityMappingStoresRequest(message)ListIdentityMappingStoresResponse(message)ListIdentityMappingsRequest(message)ListIdentityMappingsResponse(message)ListSchemasRequest(message)ListSchemasResponse(message)ListSessionsRequest(message)ListSessionsResponse(message)ListTargetSitesRequest(message)ListTargetSitesResponse(message)ListUserLicensesRequest(message)ListUserLicensesResponse(message)MediaInfo(message)PageInfo(message)PanelInfo(message)Principal(message)Project(message)Project.CustomerProvidedConfig(message)Project.CustomerProvidedConfig.NotebooklmConfig(message)Project.CustomerProvidedConfig.NotebooklmConfig.ModelArmorConfig(message)Project.ServiceTerms(message)Project.ServiceTerms.State(enum)ProvisionProjectMetadata(message)ProvisionProjectRequest(message)ProvisionProjectRequest.SaasParams(message)PurgeCompletionSuggestionsMetadata(message)PurgeCompletionSuggestionsRequest(message)PurgeCompletionSuggestionsResponse(message)PurgeDocumentsMetadata(message)PurgeDocumentsRequest(message)PurgeDocumentsRequest.InlineSource(message)PurgeDocumentsResponse(message)PurgeErrorConfig(message)PurgeIdentityMappingsRequest(message)PurgeIdentityMappingsRequest.InlineSource(message)PurgeSuggestionDenyListEntriesMetadata(message)PurgeSuggestionDenyListEntriesRequest(message)PurgeSuggestionDenyListEntriesResponse(message)PurgeUserEventsMetadata(message)PurgeUserEventsRequest(message)PurgeUserEventsResponse(message)Query(message)RankRequest(message)RankResponse(message)RankingRecord(message)RecommendRequest(message)RecommendResponse(message)RecommendResponse.RecommendationResult(message)RecrawlUrisMetadata(message)RecrawlUrisRequest(message)RecrawlUrisResponse(message)RecrawlUrisResponse.FailureInfo(message)RecrawlUrisResponse.FailureInfo.FailureReason(message)RecrawlUrisResponse.FailureInfo.FailureReason.CorpusType(enum)Reply(message)SafetyRating(message)SafetyRating.HarmProbability(enum)SafetyRating.HarmSeverity(enum)Schema(message)SearchAddOn(enum)SearchInfo(message)SearchLinkPromotion(message)SearchRequest(message)SearchRequest.BoostSpec(message)SearchRequest.BoostSpec.ConditionBoostSpec(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(enum)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(message)SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(enum)SearchRequest.ContentSearchSpec(message)SearchRequest.ContentSearchSpec.ChunkSpec(message)SearchRequest.ContentSearchSpec.ExtractiveContentSpec(message)SearchRequest.ContentSearchSpec.SearchResultMode(enum)SearchRequest.ContentSearchSpec.SnippetSpec(message)SearchRequest.ContentSearchSpec.SummarySpec(message)SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec(message)SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec(message)SearchRequest.DataStoreSpec(message)SearchRequest.DisplaySpec(message)SearchRequest.DisplaySpec.MatchHighlightingCondition(enum)SearchRequest.FacetSpec(message)SearchRequest.FacetSpec.FacetKey(message)SearchRequest.ImageQuery(message)SearchRequest.NaturalLanguageQueryUnderstandingSpec(message)SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior(enum)SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition(enum)SearchRequest.QueryExpansionSpec(message)SearchRequest.QueryExpansionSpec.Condition(enum)SearchRequest.RankingExpressionBackend(enum)SearchRequest.RelevanceScoreSpec(message)SearchRequest.RelevanceThreshold(enum)SearchRequest.SearchAsYouTypeSpec(message)SearchRequest.SearchAsYouTypeSpec.Condition(enum)SearchRequest.SessionSpec(message)SearchRequest.SpellCorrectionSpec(message)SearchRequest.SpellCorrectionSpec.Mode(enum)SearchResponse(message)SearchResponse.Facet(message)SearchResponse.Facet.FacetValue(message)SearchResponse.QueryExpansionInfo(message)SearchResponse.SearchResult(message)SearchResponse.SearchResult.RankSignals(message)SearchResponse.SearchResult.RankSignals.CustomSignal(message)SearchResponse.SessionInfo(message)SearchResponse.Summary(message)SearchResponse.Summary.Citation(message)SearchResponse.Summary.CitationMetadata(message)SearchResponse.Summary.CitationSource(message)SearchResponse.Summary.Reference(message)SearchResponse.Summary.Reference.ChunkContent(message)SearchResponse.Summary.SafetyAttributes(message)SearchResponse.Summary.SummarySkippedReason(enum)SearchResponse.Summary.SummaryWithMetadata(message)SearchTier(enum)SearchUseCase(enum)ServingConfig(message)ServingConfig.GenericConfig(message)ServingConfig.MediaConfig(message)Session(message)Session.State(enum)Session.Turn(message)SetUpDataConnectorMetadata(message)SetUpDataConnectorRequest(message)SingleRegionKey(message)SiteSearchEngine(message)SiteVerificationInfo(message)SiteVerificationInfo.SiteVerificationState(enum)Sitemap(message)SolutionType(enum)SpannerSource(message)StreamAssistRequest(message)StreamAssistRequest.AgentsSpec(message)StreamAssistRequest.AgentsSpec.AgentSpec(message)StreamAssistRequest.GenerationSpec(message)StreamAssistRequest.ToolsSpec(message)StreamAssistRequest.ToolsSpec.ImageGenerationSpec(message)StreamAssistRequest.ToolsSpec.VertexAiSearchSpec(message)StreamAssistRequest.ToolsSpec.VideoGenerationSpec(message)StreamAssistRequest.ToolsSpec.WebGroundingSpec(message)StreamAssistResponse(message)StreamAssistResponse.SessionInfo(message)SubscriptionTerm(enum)SubscriptionTier(enum)SuggestionDenyListEntry(message)SuggestionDenyListEntry.MatchOperator(enum)TargetSite(message)TargetSite.FailureReason(message)TargetSite.FailureReason.QuotaFailure(message)TargetSite.IndexingStatus(enum)TargetSite.Type(enum)Tenant(message)TextInput(message)TrainCustomModelMetadata(message)TrainCustomModelRequest(message)TrainCustomModelRequest.GcsTrainingInput(message)TrainCustomModelResponse(message)TransactionInfo(message)UpdateAclConfigRequest(message)UpdateAssistantRequest(message)UpdateCmekConfigMetadata(message)UpdateCmekConfigRequest(message)UpdateControlRequest(message)UpdateConversationRequest(message)UpdateDataConnectorRequest(message)UpdateDataStoreRequest(message)UpdateDocumentRequest(message)UpdateEngineRequest(message)UpdateLicenseConfigRequest(message)UpdateSchemaMetadata(message)UpdateSchemaRequest(message)UpdateServingConfigRequest(message)UpdateSessionRequest(message)UpdateTargetSiteMetadata(message)UpdateTargetSiteRequest(message)UserEvent(message)UserInfo(message)UserLicense(message)UserLicense.LicenseAssignmentState(enum)WorkspaceConfig(message)WorkspaceConfig.Type(enum)WriteUserEventRequest(message)
AclConfigService
Service de gestion de la configuration des LCA.
| GetAclConfig |
|---|
|
Récupère les
|
| UpdateAclConfig |
|---|
|
Configuration de la liste de contrôle d'accès par défaut à utiliser dans un emplacement du projet d'un client. Les modifications ne s'appliqueront qu'aux nouveaux data stores. Les data stores existants continueront d'utiliser l'ancienne valeur.
|
AssistAnswerService
Service permettant d'interroger les ressources AssistAnswer.
| GetAssistAnswer |
|---|
|
Récupère un
|
AssistantService
Service permettant de gérer la configuration de l'Assistant et d'aider les utilisateurs.
| AddContextFile |
|---|
|
Importe un fichier de contexte à utiliser comme source pour les appels d'assistance au cours de la session.
|
| Assist |
|---|
|
Aide l'utilisateur à répondre à une requête.
|
| CreateAssistant |
|---|
|
Crée un
|
| DeleteAssistant |
|---|
|
Supprime un
|
| GetAssistant |
|---|
|
Récupère un
|
| ListAssistants |
|---|
|
Répertorie tous les
|
| StreamAssist |
|---|
|
Aide l'utilisateur à répondre à une requête en streaming.
|
| UpdateAssistant |
|---|
|
Met à jour un
|
CmekConfigService
Service permettant de gérer les tâches liées à CMEK
| DeleteCmekConfig |
|---|
|
Supprime le provisionnement d'un CmekConfig.
|
| GetCmekConfig |
|---|
|
Récupère les
|
| ListCmekConfigs |
|---|
|
Liste tous les
|
| UpdateCmekConfig |
|---|
|
Provisionne une clé CMEK à utiliser dans un emplacement d'un projet client. Cette méthode effectue également une validation de l'emplacement sur le cmekConfig fourni pour s'assurer que la clé est valide et peut être utilisée dans l'emplacement sélectionné.
|
CollectionService
Service de gestion des Collection.
| DeleteCollection |
|---|
|
Supprime un
|
CompletionService
Service de saisie semi-automatique.
| AdvancedCompleteQuery |
|---|
|
Complète la saisie de l'utilisateur avec des suggestions de mots clés avancées.
|
| CompleteQuery |
|---|
|
Complète la saisie utilisateur spécifiée par des suggestions de mots clés.
|
| ImportCompletionSuggestions |
|---|
|
Importe des
|
| ImportSuggestionDenyListEntries |
|---|
|
Importe tous les
|
| PurgeCompletionSuggestions |
|---|
|
Supprime définitivement tous les
|
| PurgeSuggestionDenyListEntries |
|---|
|
Supprime définitivement tous les
|
ControlService
Service permettant d'effectuer des opérations CRUD sur les contrôles. Les contrôles permettent d'implémenter une logique personnalisée dans le chemin de diffusion. Les contrôles doivent être associés à une configuration de diffusion pour être pris en compte lors d'une requête.
| CreateControl |
|---|
|
Crée un contrôle. Par défaut, 1 000 contrôles sont autorisés pour un data store. Vous pouvez demander à ajuster cette limite. Si le
|
| DeleteControl |
|---|
|
Supprime un contrôle. Si le
|
| GetControl |
|---|
|
Permet d'obtenir un contrôle.
|
| ListControls |
|---|
|
Liste tous les contrôles par
|
| UpdateControl |
|---|
|
Met à jour un contrôle. Impossible de modifier le type d'action
|
ConversationalSearchService
Service de recherche conversationnelle.
| AnswerQuery |
|---|
|
Méthode de requête de réponse.
|
| ConverseConversation |
|---|
|
Converses a conversation.
|
| CreateConversation |
|---|
|
Crée une conversation. Si le
|
| CreateSession |
|---|
|
Crée une session. Si le
|
| DeleteConversation |
|---|
|
Supprime une conversation. Si le
|
| DeleteSession |
|---|
|
Supprime une session. Si le
|
| GetAnswer |
|---|
|
Permet d'obtenir une réponse.
|
| GetConversation |
|---|
|
Obtient une conversation.
|
| GetSession |
|---|
|
Récupère une session.
|
| ListConversations |
|---|
|
Liste toutes les conversations par
|
| ListSessions |
|---|
|
Liste toutes les sessions par
|
| StreamAnswerQuery |
|---|
|
Méthode de requête de réponse (streaming). Il prend un
|
| UpdateConversation |
|---|
|
Met à jour une conversation. Impossible de modifier le type d'action
|
| UpdateSession |
|---|
|
Met à jour une session. Impossible de modifier le type d'action
|
DataConnectorService
Service de gestion des connecteurs de données.
| GetDataConnector |
|---|
|
Récupère les
|
| SetUpDataConnector |
|---|
|
Crée un
|
| UpdateDataConnector |
|---|
|
Met à jour un
|
DataStoreService
Service de gestion de la configuration DataStore.
| CreateDataStore |
|---|
|
Crée un objet DataStore permet de stocker des
|
| DeleteDataStore |
|---|
|
Supprime un
|
| GetDataStore |
|---|
|
Récupère un
|
| ListDataStores |
|---|
|
Liste tous les
|
| UpdateDataStore |
|---|
|
Met à jour un
|
DocumentService
Service permettant d'ingérer les informations Document du site Web du client.
| BatchGetDocumentsMetadata |
|---|
|
Obtient les métadonnées de fraîcheur de l'index pour les
|
| CreateDocument |
|---|
|
Crée un objet
|
| DeleteDocument |
|---|
|
Supprime un
|
| GetDocument |
|---|
|
Récupère un
|
| ImportDocuments |
|---|
|
Importation groupée de plusieurs Remarque : Il est possible qu'un sous-ensemble des
|
| ListDocuments |
|---|
|
Obtient une liste de
|
| PurgeDocuments |
|---|
|
Supprime définitivement tous les Ce processus est asynchrone. Selon le nombre de Pour obtenir la liste des
|
| UpdateDocument |
|---|
|
Met à jour un
|
EngineService
Service de gestion de la configuration Engine.
| CreateEngine |
|---|
|
Crée un objet
|
| DeleteEngine |
|---|
|
Supprime un
|
| GetEngine |
|---|
|
Récupère un
|
| ListEngines |
|---|
|
Liste tous les
|
| UpdateEngine |
|---|
|
Met à jour un
|
GroundedGenerationService
Service de génération ancrée.
| CheckGrounding |
|---|
|
Effectue une vérification de l'ancrage.
|
IdentityMappingStoreService
Service permettant de gérer les magasins de mappage d'identité.
| CreateIdentityMappingStore |
|---|
|
Crée un magasin de mappage d'identité.
|
| DeleteIdentityMappingStore |
|---|
|
Supprime le magasin de mappage d'identité.
|
| GetIdentityMappingStore |
|---|
|
Récupère le Identity Mapping Store.
|
| ImportIdentityMappings |
|---|
|
Importe une liste d'entrées de mappage d'identité dans un magasin de mappage d'identité.
|
| ListIdentityMappingStores |
|---|
|
Liste tous les magasins de mappage d'identité.
|
| ListIdentityMappings |
|---|
|
Liste les mappages d'identité dans un magasin de mappages d'identité.
|
| PurgeIdentityMappings |
|---|
|
Supprime les entrées de mappage d'identité spécifiées ou toutes les entrées d'un magasin de mappage d'identité.
|
LicenseConfigService
Service permettant de gérer les ressources liées à la configuration des licences.
| CreateLicenseConfig |
|---|
|
Crée un
|
| GetLicenseConfig |
|---|
|
Récupère un
|
| UpdateLicenseConfig |
|---|
|
Met à jour le
|
PodcastService
Service de gestion de la configuration Podcast.
ProjectService
Service pour les opérations sur Project.
| ProvisionProject |
|---|
|
Provisionne la ressource de projet. Au cours de ce processus, les systèmes associés seront préparés et initialisés. L'appelant doit lire les Conditions d'utilisation des données et, s'il le souhaite, indiquer dans la demande qu'il accepte les conditions d'utilisation du service.
|
RankService
Service de classement des enregistrements de texte.
| Rang |
|---|
|
Classe une liste d'enregistrements de texte en fonction de la requête d'entrée donnée.
|
RecommendationService
Service permettant de faire des recommandations.
| Recommander |
|---|
|
Effectue une recommandation, qui nécessite un événement utilisateur contextuel.
|
SchemaService
Service de gestion des Schema.
| CreateSchema |
|---|
|
Crée un objet
|
| DeleteSchema |
|---|
|
Supprime un
|
| GetSchema |
|---|
|
Récupère un
|
| ListSchemas |
|---|
|
Obtient une liste de
|
| UpdateSchema |
|---|
|
Met à jour un
|
SearchService
Service de recherche.
| Rechercher |
|---|
|
Effectue une recherche.
|
| SearchLite |
|---|
|
Effectue une recherche. Semblable à la méthode Cette méthode n'est compatible qu'avec la recherche sur des sites Web publics. Si des datastores et des moteurs non associés à la recherche sur le site Web public sont spécifiés, une erreur Cette méthode peut être utilisée pour un onboarding facile sans avoir à implémenter de backend d'authentification. Toutefois, il est fortement recommandé d'utiliser
|
SearchTuningService
Service de réglage de la recherche.
| ListCustomModels |
|---|
|
Obtient la liste de tous les modèles personnalisés.
|
| TrainCustomModel |
|---|
|
Entraîne un modèle personnalisé.
|
ServingConfigService
Service pour les opérations liées à ServingConfig.
| UpdateServingConfig |
|---|
|
Met à jour un ServingConfig. Renvoie une erreur NOT_FOUND si ServingConfig n'existe pas.
|
SessionService
Service permettant de gérer les sessions et les ressources associées.
| CreateSession |
|---|
|
Crée une session. Si le
|
| DeleteSession |
|---|
|
Supprime une session. Si le
|
| GetSession |
|---|
|
Récupère une session.
|
| ListSessions |
|---|
|
Liste toutes les sessions par
|
| UpdateSession |
|---|
|
Met à jour une session. Impossible de modifier le type d'action
|
SiteSearchEngineService
Service permettant de gérer les ressources associées à la recherche sur le site.
| BatchCreateTargetSites |
|---|
|
Crée des
|
| BatchVerifyTargetSites |
|---|
|
Validez la propriété et la validité des sites cibles. Cette API envoie tous les sites cibles du moteur de recherche sur le site pour vérification.
|
| CreateSitemap |
|---|
|
Crée un objet
|
| CreateTargetSite |
|---|
|
Crée un objet
|
| DeleteSitemap |
|---|
|
Supprime un
|
| DeleteTargetSite |
|---|
|
Supprime un
|
| DisableAdvancedSiteSearch |
|---|
|
Passer de la recherche avancée sur le site à la recherche basique sur le site
|
| EnableAdvancedSiteSearch |
|---|
|
Passer de la recherche basique sur site à la recherche avancée sur site
|
| FetchDomainVerificationStatus |
|---|
|
Renvoie la liste des sites cibles avec leur état de validation du domaine. Cette méthode ne peut être appelée que pour un data store dont l'état est BASIC_SITE_SEARCH pour le moment.
|
| FetchSitemaps |
|---|
|
Récupérez les
|
| GetSiteSearchEngine |
|---|
|
Récupère les
|
| GetTargetSite |
|---|
|
Récupère un
|
| ListTargetSites |
|---|
|
Obtient une liste de
|
| RecrawlUris |
|---|
|
Demandez une nouvelle exploration à la demande pour une liste d'URI.
|
| UpdateTargetSite |
|---|
|
Met à jour un
|
UserEventService
Service permettant d'ingérer les actions des utilisateurs finaux sur un site Web dans l'API Discovery Engine.
| CollectUserEvent |
|---|
|
Écrit un seul événement utilisateur à partir du navigateur. Cette méthode utilise une requête GET en raison de la restriction du navigateur concernant l'envoi de données POST à un domaine tiers. Cette méthode n'est utilisée que par le pixel JavaScript de l'API Discovery Engine et Google Tag Manager. Les utilisateurs ne doivent pas appeler cette méthode directement.
|
| ImportUserEvents |
|---|
|
Importation groupée d'événements utilisateur. Le traitement des demandes peut être synchrone. Les événements qui existent déjà sont ignorés. Utilisez cette méthode pour remplir l'historique des événements utilisateur. Operation.response est de type ImportResponse. Notez qu'il est possible qu'un sous-ensemble d'éléments soit inséré correctement. Operation.metadata est de type ImportMetadata.
|
| PurgeUserEvents |
|---|
|
Supprime définitivement tous les événements utilisateur spécifiés par le filtre fourni. Selon le nombre d'événements spécifiés par le filtre, cette opération peut prendre plusieurs heures, voire plusieurs jours. Pour tester un filtre, utilisez d'abord la commande list.
|
| WriteUserEvent |
|---|
|
Écrit un seul événement utilisateur.
|
UserLicenseService
Service de gestion des licences utilisateur.
| BatchUpdateUserLicenses |
|---|
|
Met à jour la licence utilisateur. Cette méthode permet d'attribuer ou de supprimer des licences à des utilisateurs par lot.
|
| ListUserLicenses |
|---|
|
Liste les licences utilisateur.
|
AclConfig
Configuration du contrôle des accès.
| Champs | |
|---|---|
name |
Immuable. Nom complet de la ressource de la configuration ACL. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
idp_config |
Configuration du fournisseur d'identité |
ActionConfig
Informations permettant d'effectuer des actions sur le connecteur.
| Champs | |
|---|---|
is_action_configured |
Uniquement en sortie. Le connecteur contient les paramètres nécessaires et est configuré pour prendre en charge les actions. |
service_name |
Facultatif. Nom de ressource Service Directory (projects/*/locations/*/namespaces/*/services/*) représentant un point de terminaison de réseau VPC utilisé pour se connecter à Obligatoire lorsque VPC Service Controls est activé. |
use_static_secrets |
Facultatif. Indique si des secrets statiques doivent être utilisés pour le connecteur. Si la valeur est "true", les secrets fournis dans action_params seront ignorés. |
Champ d'union Paramètres requis pour les sources compatibles avec OAUTH, c'est-à-dire
|
|
action_params |
Facultatif. Paramètres d'action au format JSON structuré. |
json_action_params |
Facultatif. Paramètres d'action au format de chaîne JSON. |
AddContextFileRequest
Requête pour la méthode AssistantService.AddContextFile.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la session. Format : Si |
file_name |
Obligatoire. Nom du fichier. |
mime_type |
Facultatif. Type de contenu du fichier. Pour en savoir plus, consultez https://www.iana.org/assignments/media-types/media-types.xhtml. Ce champ est obligatoire lorsque la source de données ne fournit pas le type de contenu. |
Champ d'union file. Contenu du fichier. file ne peut être qu'un des éléments suivants : |
|
file_contents |
Contenu du fichier fourni de manière intégrée. |
AddContextFileResponse
Réponse pour la méthode AssistantService.AddContextFile.
| Champs | |
|---|---|
session |
Nom de la session, qu'il s'agisse de celle fournie ou de celle nouvellement créée. Format : |
file_id |
ID du fichier importé. |
token_count |
Obsolète : ce champ ne sera pas défini pour tous les types de fichiers et sera supprimé à terme. Longueur du fichier mesurée en jetons. |
AdvancedCompleteQueryRequest
Message de requête pour la méthode CompletionService.AdvancedCompleteQuery. .
| Champs | |
|---|---|
completion_config |
Obligatoire. Nom de ressource completion_config du data store ou du moteur parent pour lequel la saisie semi-automatique est effectuée, par exemple |
query |
Obligatoire. Saisie "typeahead" utilisée pour récupérer les suggestions. Il ne doit pas dépasser 128 caractères. La requête ne peut pas être vide pour la plupart des types de suggestions. Si elle est vide, une erreur |
query_model |
Spécifie le modèle de requête de saisie semi-automatique, qui ne s'applique qu'au SuggestionType QUERY. Cela remplace tout modèle spécifié dans la section Configuration > Saisie semi-automatique de la console Cloud. Valeurs actuellement acceptées :
Valeurs par défaut :
|
user_pseudo_id |
Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web. Ce champ ne doit PAS avoir de valeur fixe telle que Cet identifiant doit être identique à celui de Le champ doit être une chaîne encodée au format UTF-8, d'une longueur maximale de 128 caractères. |
user_info |
Facultatif. Informations sur l'utilisateur final. Ces informations d'identification doivent être identiques à celles de |
include_tail_suggestions |
Indique si des suggestions de queue longue doivent être renvoyées si aucune suggestion ne correspond à la requête complète. Même si la valeur est définie sur "true", si des suggestions correspondent à la requête complète, elles sont renvoyées et aucune suggestion de queue n'est renvoyée. |
boost_spec |
Facultatif. Spécification permettant d'améliorer les suggestions correspondant à la condition. |
suggestion_types[] |
Facultatif. Types de suggestions à renvoyer. Si ce champ est vide ou non spécifié, des suggestions de requêtes sont renvoyées. Pour le moment, un seul type de suggestion est accepté. |
suggestion_type_specs[] |
Facultatif. Spécification de chaque type de suggestion. |
experiment_ids[] |
Facultatif. ID de test pour cette requête. |
BoostSpec
Spécification permettant d'améliorer les suggestions en fonction de leur état.
| Champs | |
|---|---|
condition_boost_specs[] |
Spécifications du boost de condition. Si une suggestion correspond à plusieurs conditions des spécifications, les valeurs d'amplification de ces spécifications sont toutes appliquées et combinées de manière non linéaire. Le nombre maximal de spécifications est de 20. Remarque : Actuellement, seul le boost de condition de langue est accepté. |
ConditionBoostSpec
Le boost s'applique aux suggestions qui correspondent à une condition.
| Champs | |
|---|---|
condition |
Expression qui spécifie une condition d'optimisation. La syntaxe est la même que celle des expressions de filtre. Pour le moment, la seule condition acceptée est une liste de codes de langue BCP-47. Exemple :
|
boost |
Intensité du boost, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0.0. Définir l'intensité sur 1.0 permet de promouvoir fortement les suggestions. Toutefois, cela ne signifie pas nécessairement que le premier résultat sera une suggestion boostée. Si vous définissez la valeur sur -1,0, les suggestions sont fortement rétrogradées. Toutefois, d'autres suggestions pertinentes peuvent toujours s'afficher. Si vous définissez la valeur sur 0,0, aucune amélioration n'est appliquée. La condition de boost est ignorée. |
SuggestionType
Type de suggestion à renvoyer.
| Enums | |
|---|---|
SUGGESTION_TYPE_UNSPECIFIED |
Valeur par défaut. |
QUERY |
Renvoie des suggestions de requêtes. |
PEOPLE |
Renvoie des suggestions de personnes. |
CONTENT |
Renvoie des suggestions de contenu. |
RECENT_SEARCH |
Renvoie les suggestions de recherche récentes. |
GOOGLE_WORKSPACE |
Renvoie des suggestions Google Workspace. |
SuggestionTypeSpec
Spécification de chaque type de suggestion.
| Champs | |
|---|---|
suggestion_type |
Facultatif. Type de suggestion. |
max_suggestions |
Facultatif. Nombre maximal de suggestions à afficher pour chaque type de suggestion. |
AdvancedCompleteQueryResponse
Message de réponse pour la méthode CompletionService.AdvancedCompleteQuery.
| Champs | |
|---|---|
query_suggestions[] |
Résultats des suggestions de requêtes correspondantes. La liste des résultats est triée et le premier résultat est une suggestion principale. |
tail_match_triggered |
True si toutes les suggestions renvoyées sont des suggestions de queue. Pour que la correspondance de queue soit déclenchée, include_tail_suggestions doit être défini sur "true" dans la requête et aucune suggestion ne doit correspondre à la requête complète. |
people_suggestions[] |
Résultats des suggestions de personnes correspondantes. La liste des résultats est triée et le premier résultat est la suggestion la plus pertinente. |
content_suggestions[] |
Résultats des suggestions de contenu correspondant. La liste des résultats est triée et le premier résultat est la suggestion la plus pertinente. |
recent_search_suggestions[] |
Résultats des suggestions de "recherches récentes" correspondantes. La liste des résultats est triée et le premier résultat est la suggestion la plus pertinente. |
ContentSuggestion
Suggestions en tant que contenu.
| Champs | |
|---|---|
suggestion |
Suggestion pour la requête. |
content_type |
Type de suggestion de contenu. |
document |
Extrait de données du document dans la suggestion. Seul un sous-ensemble de champs sera renseigné. |
data_store |
Nom du dataStore auquel appartient cette suggestion. |
score |
Score de chaque suggestion. Le score est compris dans la plage [0, 1]. |
icon_uri |
URI de l'icône de la suggestion de contenu. |
destination_uri |
URI de destination de la suggestion de contenu. |
ContentType
Type de contenu renvoyé pour les suggestions de contenu.
| Enums | |
|---|---|
CONTENT_TYPE_UNSPECIFIED |
Valeur par défaut. |
GOOGLE_WORKSPACE |
La suggestion provient d'une source Google Workspace. |
THIRD_PARTY |
La suggestion provient d'une source tierce. |
PersonSuggestion
Suggestions de personnes.
| Champs | |
|---|---|
suggestion |
Suggestion pour la requête. |
person_type |
Type de personne. |
document |
Extrait de données du document dans la suggestion. Seul un sous-ensemble de champs est renseigné. |
data_store |
Nom du dataStore auquel appartient cette suggestion. |
score |
Score de chaque suggestion. Le score est compris dans la plage [0, 1]. |
display_photo_uri |
URI de la photo de la suggestion de personne. |
destination_uri |
URI de destination de la suggestion de personne. |
PersonType
Type de personne en fonction de la source.
| Enums | |
|---|---|
PERSON_TYPE_UNSPECIFIED |
Valeur par défaut. |
CLOUD_IDENTITY |
La suggestion provient d'une source GOOGLE_IDENTITY. |
THIRD_PARTY_IDENTITY |
La suggestion provient d'une source THIRD_PARTY_IDENTITY. |
QuerySuggestion
Suggestions en tant que requêtes de recherche.
| Champs | |
|---|---|
suggestion |
Suggestion pour la requête. |
completable_field_paths[] |
Chemins d'accès uniques aux champs de document qui servent de source à cette suggestion si elle a été générée à partir de champs à compléter. Ce champ n'est renseigné que pour le modèle permettant de compléter des documents. |
data_store[] |
Nom du dataStore auquel appartient cette suggestion. |
score |
Score de chaque suggestion. Le score est compris dans la plage [0, 1]. |
RecentSearchSuggestion
Suggestions basées sur l'historique des recherches récentes.
| Champs | |
|---|---|
suggestion |
Suggestion pour la requête. |
recent_search_time |
Heure à laquelle cette réarchitecture récente s'est produite. |
score |
Score de chaque suggestion. Le score est compris dans la plage [0, 1]. |
AdvancedSiteSearchConfig
Données de configuration pour la recherche avancée sur site.
| Champs | |
|---|---|
disable_initial_index |
Si la valeur est définie sur "true", l'indexation initiale est désactivée pour DataStore. |
disable_automatic_refresh |
Si la valeur est définie sur "true", l'actualisation automatique est désactivée pour DataStore. |
AlertPolicyConfig
Configuration des alertes au niveau du connecteur.
| Champs | |
|---|---|
alert_policy_name |
Immuable. Nom complet de la ressource AlertPolicy. |
alert_enrollments[] |
Facultatif. États d'inscription de chaque alerte. |
AlertEnrollment
État de l'inscription à l'alerte.
| Champs | |
|---|---|
alert_id |
Immuable. Identifiant d'une alerte. |
enroll_state |
Obligatoire. État d'inscription d'un client. |
EnrollStates
Énumération de l'état de l'inscription pour l'alerte.
| Enums | |
|---|---|
ENROLL_STATES_UNSPECIFIED |
Valeur par défaut. Utilisé pour les clients qui n'ont pas répondu au règlement sur les alertes. |
ENROLLED |
Le client est inscrit à ce règlement. |
DECLINED |
Le client a refusé cette règle. |
AlertPolicyResourceConfig
Configuration des alertes au niveau des ressources. Utilisé dans : * UserLicense * EngineUserData L'AlertPolicyConfig dans le connecteur de données est utilisé de la même manière. Il n'existe pas de moyen simple de migrer.
| Champs | |
|---|---|
alert_policy |
Immuable. Nom complet de la ressource AlertPolicy. |
alert_enrollments[] |
Facultatif. État d'inscription de chaque alerte. |
contact_details[] |
Facultatif. Coordonnées de chaque règle d'alerte. |
language_code |
Facultatif. Code de langue utilisé pour les notifications |
AlertEnrollment
État de l'inscription à l'alerte.
| Champs | |
|---|---|
alert_id |
Immuable. Identifiant d'une alerte. |
enroll_state |
Obligatoire. État d'inscription d'un client. |
notification_params |
Facultatif. Paramètres utilisés pour instancier une notification. Utilisé pour les notifications déclenchées lors de l'enregistrement. Elles ne sont pas stockées. * E-mails de bienvenue Gemini Business * E-mails d'invitation des utilisateurs Gemini Business |
EnrollState
Énumération de l'état de l'inscription pour l'alerte.
| Enums | |
|---|---|
ENROLL_STATE_UNSPECIFIED |
Valeur par défaut. Utilisé pour les clients qui n'ont pas répondu au règlement sur les alertes. |
ENROLLED |
Le client est inscrit à ce règlement. |
DECLINED |
Le client a refusé cette règle. |
AlloyDbSource
Source AlloyDB à partir de laquelle importer les données.
| Champs | |
|---|---|
project_id |
ID du projet contenant la source AlloyDB. ne doit pas dépasser 128 caractères ; S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
location_id |
Obligatoire. Emplacement AlloyDB à partir duquel copier les données (256 caractères maximum). |
cluster_id |
Obligatoire. Cluster AlloyDB à partir duquel copier les données (256 caractères maximum). |
database_id |
Obligatoire. Base de données AlloyDB à partir de laquelle copier les données (256 caractères maximum). |
table_id |
Obligatoire. Table AlloyDB à partir de laquelle copier les données (256 caractères maximum). |
gcs_staging_dir |
Répertoire Cloud Storage intermédiaire utilisé pour l'importation (limite de 2 000 caractères). Peut être spécifié si vous souhaitez qu'AlloyDB exporte les données vers un répertoire Cloud Storage particulier. Assurez-vous que le compte de service AlloyDB dispose des autorisations d'administrateur Cloud Storage nécessaires pour accéder au répertoire Cloud Storage spécifié. |
Réponse
Définit une réponse.
| Champs | |
|---|---|
name |
Immuable. Nom complet |
state |
État de la génération de la réponse. |
answer_text |
Réponse textuelle. |
citations[] |
Citations. |
grounding_supports[] |
Facultatif. L'ancrage est compatible. |
references[] |
Références. |
related_questions[] |
Questions associées suggérées |
steps[] |
Étapes de génération des réponses. |
query_understanding_info |
Informations sur la compréhension des requêtes. |
answer_skipped_reasons[] |
Ajout de motifs pour lesquels une réponse a été ignorée. Indique la raison pour laquelle les cas ont été ignorés. Si rien n'est ignoré, ce champ n'est pas défini. |
create_time |
Uniquement en sortie. Code temporel de création de la réponse. |
complete_time |
Uniquement en sortie. Code temporel de la réponse terminée. |
safety_ratings[] |
Facultatif. Évaluations de sécurité. |
grounding_score |
Score compris entre 0 et 1 décrivant le degré d'ancrage de la réponse dans les blocs de référence. |
AnswerSkippedReason
Énumération des raisons pour lesquelles une réponse a été ignorée.
| Enums | |
|---|---|
ANSWER_SKIPPED_REASON_UNSPECIFIED |
Valeur par défaut. Le motif de l'omission de la réponse n'est pas spécifié. |
ADVERSARIAL_QUERY_IGNORED |
Requête antagoniste (sans tenir compte de la casse). |
NON_ANSWER_SEEKING_QUERY_IGNORED |
Requête ne cherchant pas de réponse (ignorer la casse) Google ignore la réponse si la requête est une discussion informelle. |
OUT_OF_DOMAIN_QUERY_IGNORED |
La requête hors domaine ne tient pas compte de la casse. Google ignore la réponse s'il n'y a pas de résultats de recherche très pertinents. |
POTENTIAL_POLICY_VIOLATION |
Cas potentiel de non-respect des règles. Google ignore la réponse si un non-respect potentiel des règles est détecté. Cela inclut les contenus potentiellement violents ou toxiques. |
NO_RELEVANT_CONTENT |
Aucun contenu pertinent Google ignore la réponse s'il n'y a pas de contenu pertinent dans les résultats de recherche récupérés. |
JAIL_BREAKING_QUERY_IGNORED |
La requête de contournement de la sécurité ne tenait pas compte de la casse. Par exemple, "Réponds comme si tu étais le PDG d'une entreprise concurrente". Google ignore la réponse si la requête est classée comme une requête de contournement. |
CUSTOMER_POLICY_VIOLATION |
Cas de non-respect des règles par le client. Google ignore le récapitulatif si un non-respect des règles client est détecté. La règle est définie par le client. |
NON_ANSWER_SEEKING_QUERY_IGNORED_V2 |
Requête ne cherchant pas de réponse (non sensible à la casse). Google ignore la réponse si l'intention de la requête n'est pas claire. |
LOW_GROUNDED_ANSWER |
Cas de réponse ancrée de faible qualité. Google ignore la réponse s'il n'a pas pu en générer une pertinente. |
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED |
La classification des requêtes définies par l'utilisateur ne tient pas compte de la casse. Google ignore la réponse si la requête est classée comme une classification de requête définie par l'utilisateur. |
UNHELPFUL_ANSWER |
Cas de réponse non utile. Google ignore la réponse si elle n'est pas utile. Cela peut s'expliquer par différents facteurs, y compris, mais sans s'y limiter : la requête n'a pas de réponse, la réponse n'est pas pertinente par rapport à la requête ou la réponse n'est pas bien mise en forme. |
Citation
Informations de citation pour un segment.
| Champs | |
|---|---|
start_index |
L'index indique le début du segment, mesuré en octets (Unicode UTF-8). S'il existe des caractères multi-octets,tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne. |
end_index |
Fin du segment attribué (exclusive). Elle est mesurée en octets (Unicode UTF-8). S'il existe des caractères multi-octets,tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne. |
sources[] |
Sources de citation pour le segment attribué. |
CitationSource
Source de la citation.
| Champs | |
|---|---|
reference_id |
ID de la source de citation. |
GroundingSupport
Prise en charge de l'ancrage pour une affirmation dans answer_text.
| Champs | |
|---|---|
start_index |
Obligatoire. L'index indique le début de l'affirmation, mesuré en octets (Unicode UTF-8). |
end_index |
Obligatoire. Heure de fin de la période de revendication (exclue). |
sources[] |
Facultatif. Sources de citation pour l'affirmation. |
grounding_score |
Score compris entre 0 et 1 décrivant le degré d'ancrage d'une affirmation spécifique par les références. Plus la valeur est élevée, plus l'affirmation est étayée par les blocs de référence. |
grounding_check_required |
Indique que cette affirmation a nécessité une vérification de l'ancrage. Lorsque le système a décidé que cette affirmation ne nécessitait pas de vérification de l'attribution/de l'ancrage, ce champ est défini sur "false". Dans ce cas, aucune vérification de l'ancrage n'a été effectuée pour l'affirmation. Par conséquent, |
QueryUnderstandingInfo
Informations sur la compréhension des requêtes.
| Champs | |
|---|---|
query_classification_info[] |
Informations sur la classification des requêtes. |
QueryClassificationInfo
Informations sur la classification des requêtes.
| Champs | |
|---|---|
type |
Type de classification de la requête. |
positive |
Résultat de la classification. |
Type
Types de classification des requêtes.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Type de classification de requête non spécifié. |
ADVERSARIAL_QUERY |
Type de classification des requêtes contradictoires. |
NON_ANSWER_SEEKING_QUERY |
Type de classification des requêtes ne cherchant pas de réponse, pour les discussions informelles. |
JAIL_BREAKING_QUERY |
Type de classification des requêtes de contournement. |
NON_ANSWER_SEEKING_QUERY_V2 |
Type de classification des requêtes qui ne cherchent pas de réponse, sans intention claire. |
USER_DEFINED_CLASSIFICATION_QUERY |
Type de classification des requêtes défini par l'utilisateur. |
Référence
Référence.
| Champs | |
|---|---|
Champ d'union content. Contenu des résultats de recherche. content ne peut être qu'un des éléments suivants : |
|
unstructured_document_info |
Informations sur les documents non structurés. |
chunk_info |
Informations sur le fragment. |
structured_document_info |
Informations structurées sur le document. |
ChunkInfo
Informations sur le fragment.
| Champs | |
|---|---|
chunk |
Nom de la ressource du bloc. |
content |
Contenu textuel du bloc. |
document_metadata |
Métadonnées du document. |
relevance_score |
Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation. |
DocumentMetadata
Métadonnées du document.
| Champs | |
|---|---|
document |
Nom de ressource du document. |
uri |
URI du document. |
title |
et le titre. |
page_identifier |
Identifiant de la page. |
struct_data |
Métadonnées JSON structurées du document. Il est renseigné à partir des données structurées du bloc dans le résultat de recherche. |
StructuredDocumentInfo
Informations structurées sur les recherches.
| Champs | |
|---|---|
document |
Nom de ressource du document. |
struct_data |
Données de recherche structurées. |
title |
Uniquement en sortie. Titre du document. |
uri |
Uniquement en sortie. URI du document. |
UnstructuredDocumentInfo
Informations sur les documents non structurés.
| Champs | |
|---|---|
document |
Nom de ressource du document. |
uri |
URI du document. |
title |
et le titre. |
chunk_contents[] |
Liste des contenus de blocs cités issus du contenu du document. |
struct_data |
Métadonnées JSON structurées du document. Il est renseigné à partir des données structurées du bloc dans le résultat de recherche. |
ChunkContent
Contenu segmenté.
| Champs | |
|---|---|
content |
Contenu textuel du bloc. |
page_identifier |
Identifiant de la page. |
relevance_score |
Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation. |
État
Énumération de l'état de la génération de réponses.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Inconnu |
IN_PROGRESS |
La génération de la réponse est en cours. |
FAILED |
La génération de la réponse a échoué. |
SUCCEEDED |
La réponse a bien été générée. |
STREAMING |
La génération de la réponse est en cours. |
Étape
Informations sur l'étape.
| Champs | |
|---|---|
state |
État de l'étape. |
description |
Description de l'étape. |
thought |
La pensée de l'étape. |
actions[] |
Actions. |
Action
Action.
| Champs | |
|---|---|
observation |
Observation. |
Champ d'union action. L'action. action ne peut être qu'un des éléments suivants : |
|
search_action |
Action de recherche. |
Observation
Observation.
| Champs | |
|---|---|
search_results[] |
Résultats de recherche observés par l'action de recherche. Il peut s'agir d'informations sur les extraits ou les blocs, selon le type de citation défini par l'utilisateur. |
SearchResult
| Champs | |
|---|---|
document |
Nom de ressource du document. |
uri |
URI du document. |
title |
et le titre. |
snippet_info[] |
Si citation_type est défini sur DOCUMENT_LEVEL_CITATION, renseignez les extraits au niveau du document. |
chunk_info[] |
Si citation_type est défini sur CHUNK_LEVEL_CITATION et que le mode chunk est activé, renseignez les informations sur le chunk. |
struct_data |
Représentation des données. Données JSON structurées pour le document. Il est renseigné à partir des données structurées du document ou du bloc dans le résultat de recherche. |
ChunkInfo
Informations sur le fragment.
| Champs | |
|---|---|
chunk |
Nom de la ressource du bloc. |
content |
Contenu textuel du bloc. |
relevance_score |
Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation. |
SnippetInfo
Informations sur l'extrait.
| Champs | |
|---|---|
snippet |
Contenu de l'extrait. |
snippet_status |
État de l'extrait défini par l'équipe de recherche. |
SearchAction
Action de recherche.
| Champs | |
|---|---|
query |
Requête de recherche. |
État
Énumération de l'état de l'étape.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Inconnu |
IN_PROGRESS |
L'étape est en cours. |
FAILED |
Échec de l'étape en cours. |
SUCCEEDED |
L'étape a réussi. |
AnswerGenerationSpec
Spécification pour la génération de réponses.
| Champs | |
|---|---|
user_defined_classifier_spec |
Facultatif. Spécification du classificateur spécifié par l'utilisateur. |
UserDefinedClassifierSpec
Spécification du classificateur défini par l'utilisateur.
| Champs | |
|---|---|
enable_user_defined_classifier |
Facultatif. Indique si le classificateur défini par l'utilisateur doit être activé et inclus. |
preamble |
Facultatif. Préambule à utiliser pour le classificateur défini par l'utilisateur. |
model_id |
Facultatif. ID du modèle à utiliser pour le classificateur défini par l'utilisateur. |
task_marker |
Facultatif. Marqueur de tâche à utiliser pour le classificateur défini par l'utilisateur. |
top_p |
Facultatif. Valeur top-p à utiliser pour le classificateur défini par l'utilisateur. |
top_k |
Facultatif. Valeur top-k à utiliser pour le classificateur défini par l'utilisateur. |
temperature |
Facultatif. Valeur de température à utiliser pour le classificateur défini par l'utilisateur. |
seed |
Facultatif. Valeur de départ à utiliser pour le classificateur défini par l'utilisateur. |
AnswerQueryRequest
Message de requête pour la méthode ConversationalSearchService.AnswerQuery.
| Champs | |
|---|---|
serving_config |
Obligatoire. Nom de ressource de la configuration de diffusion de la recherche, par exemple |
query |
Obligatoire. Requête de l'utilisateur actuel. |
session |
Nom de la ressource de session. Facultatif. Lorsque le champ de session n'est pas défini, l'API est en mode sans session. Nous acceptons le mode de session automatique : les utilisateurs peuvent utiliser le symbole générique |
safety_spec |
Spécification du modèle. |
related_questions_spec |
Spécification des questions associées. |
grounding_spec |
Facultatif. Spécification d'ancrage. |
answer_generation_spec |
Spécifications de la génération de réponses. |
search_spec |
Spécification de la recherche. |
query_understanding_spec |
Spécification de la compréhension des requêtes. |
asynchronous_mode |
Obsolète : ce champ est obsolète. L'API Streaming Answer sera compatible. Contrôle du mode asynchrone. Si cette option est activée, la réponse sera renvoyée avec le nom de ressource de la réponse/session sans la réponse finale. Les utilisateurs de l'API doivent effectuer l'interrogation pour obtenir le dernier état de la réponse/session en appelant la méthode |
user_pseudo_id |
Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web. Ce champ ne doit PAS avoir de valeur fixe telle que Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur |
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez la documentation Google Cloud. |
end_user_spec |
Facultatif. Spécification de l'utilisateur final. |
AnswerGenerationSpec
Spécifications de la génération de réponses.
| Champs | |
|---|---|
model_spec |
Spécification du modèle de génération de réponses. |
prompt_spec |
Spécification du prompt de génération de réponses. |
include_citations |
Indique s'il faut inclure les métadonnées de citation dans la réponse. La valeur par défaut est |
answer_language_code |
Code de langue pour la réponse. Utilisez les balises de langue définies par BCP47. Remarque : Il s'agit d'une fonctionnalité expérimentale. |
ignore_adversarial_query |
Indique s'il faut filtrer les requêtes contradictoires. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes adverses. Aucune réponse n'est renvoyée si la requête de recherche est classée comme requête contradictoire. Par exemple, un utilisateur peut poser une question concernant des commentaires négatifs sur l'entreprise ou envoyer une requête conçue pour générer des résultats dangereux ou qui ne respectent pas les règles. Si ce champ est défini sur |
ignore_non_answer_seeking_query |
Indique s'il faut filtrer les requêtes qui ne cherchent pas de réponse. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes visant à obtenir des réponses. Aucune réponse n'est renvoyée si la requête de recherche est classée comme requête ne cherchant pas de réponse. Si ce champ est défini sur |
ignore_jail_breaking_query |
Facultatif. Indique s'il faut filtrer les requêtes de contournement des restrictions. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes de contournement. Aucun résumé n'est renvoyé si la requête de recherche est classée comme une requête de contournement. Un utilisateur peut ajouter des instructions à la requête pour modifier le ton, le style, la langue ou le contenu de la réponse, ou demander au modèle d'agir en tant qu'entité différente (par exemple, "Réponds sur le ton du PDG d'une entreprise concurrente"). Si ce champ est défini sur |
ignore_low_relevant_content |
Indique s'il faut filtrer les requêtes peu pertinentes. Si ce champ est défini sur |
ModelSpec
Spécifications du modèle de génération de réponses.
| Champs | |
|---|---|
model_version |
Version du modèle. Si elle n'est pas définie, le modèle stable par défaut sera utilisé. Les valeurs autorisées sont "stable" et "preview". |
PromptSpec
Spécification du prompt de génération de réponses.
| Champs | |
|---|---|
preamble |
Préambule personnalisé. |
EndUserSpec
Spécification de l'utilisateur final.
| Champs | |
|---|---|
end_user_metadata[] |
Facultatif. Métadonnées de l'utilisateur final. |
EndUserMetaData
Métadonnées de l'utilisateur final.
| Champs | |
|---|---|
Champ d'union content. Contenu des résultats de recherche. content ne peut être qu'un des éléments suivants : |
|
chunk_info |
Informations sur le fragment. |
ChunkInfo
Informations sur le fragment.
| Champs | |
|---|---|
content |
Contenu textuel du bloc. Elle est limitée à 8 000 caractères. |
document_metadata |
Métadonnées du document provenant du bloc actuel. |
DocumentMetadata
Les métadonnées du document contiennent les informations du document du bloc actuel.
| Champs | |
|---|---|
title |
Titre du document. |
GroundingSpec
Spécification d'ancrage.
| Champs | |
|---|---|
include_grounding_supports |
Facultatif. Indique s'il faut inclure grounding_supports dans la réponse. La valeur par défaut est Lorsque ce champ est défini sur |
filtering_level |
Facultatif. Indique s'il faut activer le filtrage en fonction du score d'ancrage et à quel niveau. |
FilteringLevel
Niveau de filtrage basé sur l'ancrage de la réponse.
| Enums | |
|---|---|
FILTERING_LEVEL_UNSPECIFIED |
La valeur par défaut est "aucun filtre". |
FILTERING_LEVEL_LOW |
Filtrer les réponses en fonction d'un seuil bas. |
FILTERING_LEVEL_HIGH |
Filtrer les réponses en fonction d'un seuil élevé. |
QueryUnderstandingSpec
Spécification de la compréhension des requêtes.
| Champs | |
|---|---|
query_classification_spec |
Spécification de la classification des requêtes. |
query_rephraser_spec |
Spécification du reformulateur de requêtes. |
disable_spell_correction |
Facultatif. Indique si la correction orthographique doit être désactivée. La valeur par défaut est |
QueryClassificationSpec
Spécification de la classification des requêtes.
| Champs | |
|---|---|
types[] |
Types de classification des requêtes activés. |
Type
Types de classification des requêtes.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Type de classification de requête non spécifié. |
ADVERSARIAL_QUERY |
Type de classification des requêtes contradictoires. |
NON_ANSWER_SEEKING_QUERY |
Type de classification des requêtes ne cherchant pas de réponse, pour les discussions informelles. |
JAIL_BREAKING_QUERY |
Type de classification des requêtes de contournement. |
NON_ANSWER_SEEKING_QUERY_V2 |
Type de classification des requêtes qui ne cherchent pas de réponse, sans intention claire. |
USER_DEFINED_CLASSIFICATION_QUERY |
Type de classification des requêtes défini par l'utilisateur. |
QueryRephraserSpec
Spécification du reformulateur de requêtes.
| Champs | |
|---|---|
disable |
Désactive le reformulateur de requêtes. |
max_rephrase_steps |
Nombre maximal d'étapes de reformulation. Le nombre maximal d'étapes est de cinq. Si elle n'est pas définie ou est inférieure à 1, elle est définie par défaut sur 1. |
model_spec |
Facultatif. Spécification du modèle de reformulation des requêtes. |
ModelSpec
Spécification du modèle de reformulation des requêtes.
| Champs | |
|---|---|
model_type |
Facultatif. Type de modèle de reformulation de requête activé. Si elle n'est pas définie, la valeur LARGE est utilisée par défaut. |
ModelType
Types de reformulation de requêtes. Actuellement, seules les sélections de modèles à un saut (max_rephrase_steps = 1) sont acceptées. Pour les requêtes multihops (max_rephrase_steps > 1), il n'existe qu'un seul modèle par défaut.
| Enums | |
|---|---|
MODEL_TYPE_UNSPECIFIED |
Type de modèle non spécifié. |
SMALL |
Petit modèle de reformulation des requêtes. Modèle Gemini 1.0 XS. |
LARGE |
Grand modèle de reformulation des requêtes. Modèle Gemini 1.0 Pro. |
RelatedQuestionsSpec
Spécification des questions associées.
| Champs | |
|---|---|
enable |
Active la fonctionnalité de questions associées si la valeur est "true". |
SafetySpec
Spécification de sécurité. Il existe deux cas d'utilisation : 1) lorsque seul safety_spec.enable est défini, le seuil BLOCK_LOW_AND_ABOVE est appliqué à toutes les catégories. 2. Lorsque safety_spec.enable est défini et que certains safety_settings sont définis, seuls les safety_settings spécifiés sont appliqués.
| Champs | |
|---|---|
enable |
Activez le filtrage de sécurité pour la réponse. La valeur par défaut est "false". |
safety_settings[] |
Facultatif. Paramètres de sécurité. Ces paramètres ne sont effectifs que lorsque safety_spec.enable est défini sur "true". |
SafetySetting
Paramètres de sécurité.
| Champs | |
|---|---|
category |
Obligatoire. Catégorie de préjudice. |
threshold |
Obligatoire. Seuil de blocage de préjudice. |
HarmBlockThreshold
Niveaux de seuil de probabilité pour le blocage.
| Enums | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Seuil de blocage de préjudice non spécifié. |
BLOCK_LOW_AND_ABOVE |
Bloquer les seuils faibles et supérieurs (augmenter le nombre de blocages). |
BLOCK_MEDIUM_AND_ABOVE |
Bloquer les seuils moyens et supérieurs. |
BLOCK_ONLY_HIGH |
Bloquer uniquement les seuils élevés (réduire le nombre de blocage). |
BLOCK_NONE |
Ne rien bloquer. |
OFF |
Désactivez le filtre de sécurité. |
SearchSpec
Spécification de la recherche.
| Champs | |
|---|---|
Champ d'union input. Paramètres de recherche permettant de contrôler le comportement de la recherche. Vous pouvez également fournir une liste de résultats de recherche pour générer une réponse. input ne peut être qu'un des éléments suivants : |
|
search_params |
Paramètres de recherche. |
search_result_list |
Liste des résultats de recherche. |
SearchParams
Paramètres de recherche.
| Champs | |
|---|---|
max_return_results |
Nombre de résultats de recherche à renvoyer. La valeur par défaut est 10. |
filter |
La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. L'expression de filtre est sensible à la casse. Il sera utilisé pour filtrer les résultats de recherche, ce qui peut avoir une incidence sur la réponse. Si ce champ n'est pas reconnaissable, un Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété clé définie dans le backend Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client média peut avoir un champ "name" dans son schéma. Dans ce cas, le filtre se présenterait comme suit : filter --> name:'ANY("king kong")` Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez Filtrer. |
boost_spec |
Spécification de boost pour mettre en avant certains documents dans les résultats de recherche, ce qui peut avoir une incidence sur la réponse à la requête. Pour en savoir plus sur l'amplification, consultez Amplification. |
order_by |
Ordre dans lequel les documents sont renvoyés. Les documents peuvent être triés par champ dans un objet Si ce champ n'est pas reconnaissable, un |
search_result_mode |
Spécifie le mode des résultats de recherche. Si aucun mode n'est spécifié, le mode de résultat de recherche est défini par défaut sur |
data_store_specs[] |
Spécifications définissant les dataStores sur lesquels filtrer dans un appel de recherche et les configurations de ces dataStores. Cela n'est pris en compte que pour les moteurs avec plusieurs cas d'utilisation de dataStores. Pour un seul DataStore dans un moteur, ils doivent utiliser les spécifications au niveau supérieur. |
SearchResultList
Liste des résultats de recherche.
| Champs | |
|---|---|
search_results[] |
Résultats de recherche. |
SearchResult
Résultat de recherche.
| Champs | |
|---|---|
Champ d'union content. Contenu des résultats de recherche. content ne peut être qu'un des éléments suivants : |
|
unstructured_document_info |
Informations sur les documents non structurés. |
chunk_info |
Informations sur le fragment. |
ChunkInfo
Informations sur le fragment.
| Champs | |
|---|---|
chunk |
Nom de la ressource du bloc. |
content |
Contenu textuel du bloc. |
document_metadata |
Métadonnées du document provenant du bloc actuel. |
DocumentMetadata
Les métadonnées du document contiennent les informations du document du bloc actuel.
| Champs | |
|---|---|
uri |
URI du document. |
title |
Titre du document. |
UnstructuredDocumentInfo
Informations sur les documents non structurés.
| Champs | |
|---|---|
document |
Nom de ressource du document. |
uri |
URI du document. |
title |
et le titre. |
document_contexts[] |
Liste des contextes de document. Le contenu sera utilisé pour la génération de réponses. Il s'agit du contenu principal du document, qui peut être long et complet. |
extractive_segments[] |
Liste des segments extractifs. |
extractive_answers[] |
Obsolète : ce champ est obsolète et n'aura aucun effet sur la génération de réponses. Veuillez utiliser les champs "document_contexts" et "extractive_segments". Liste des réponses extractives. |
DocumentContext
Contexte du document.
| Champs | |
|---|---|
page_identifier |
Identifiant de la page. |
content |
Contenu du document à utiliser pour générer des réponses. |
ExtractiveAnswer
Réponse extractive. Guide
| Champs | |
|---|---|
page_identifier |
Identifiant de la page. |
content |
Contenu de la réponse extractive. |
ExtractiveSegment
Segment extractif. Guide : la génération de réponses ne l'utilisera que si document_contexts est vide. Il s'agit de brefs extraits.
| Champs | |
|---|---|
page_identifier |
Identifiant de la page. |
content |
Contenu du segment d'extraction. |
AnswerQueryResponse
Message de réponse pour la méthode ConversationalSearchService.AnswerQuery.
| Champs | |
|---|---|
answer |
Objet de ressource de réponse. Si |
session |
Objet de ressource de session. Il ne sera disponible que lorsque le champ de session sera défini et valide dans la requête |
answer_query_token |
ID unique global utilisé pour la journalisation. |
AssistAnswer
Ressource AssistAnswer, partie principale de AssistResponse.
| Champs | |
|---|---|
name |
Immuable. Identifiant. Nom de ressource de Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
state |
État de la génération de la réponse. |
replies[] |
Réponses de l'assistant. |
assist_skipped_reasons[] |
Motifs pour lesquels vous n'avez pas répondu à l'appel d'assistance. |
customer_policy_enforcement_result |
Facultatif. Ce champ contient des informations sur les résultats des différentes vérifications des règles, comme les expressions interdites ou les vérifications Model Armor. Ce champ n'est renseigné que si l'appel d'assistance a été ignoré en raison d'un non-respect des règles. |
AssistSkippedReason
Raisons possibles pour lesquelles vous n'avez pas répondu à un appel d'assistance.
| Enums | |
|---|---|
ASSIST_SKIPPED_REASON_UNSPECIFIED |
Valeur par défaut. Le motif de désactivation n'est pas spécifié. |
NON_ASSIST_SEEKING_QUERY_IGNORED |
L'assistant a ignoré la requête, car elle ne semblait pas chercher de réponse. |
CUSTOMER_POLICY_VIOLATION |
L'assistant a ignoré la requête ou a refusé d'y répondre en raison d'un non-respect des règles concernant les clients (par exemple, la requête ou la réponse contenait une expression interdite). |
CustomerPolicyEnforcementResult
Résultats de l'application des règles relatives aux clients. Contient les résultats des différentes vérifications des règles, comme les vérifications des expressions interdites ou de Model Armor.
| Champs | |
|---|---|
verdict |
Verdict final concernant l'application des règles relatives aux clients. Si une seule règle a bloqué le traitement, le verdict est "BLOCK" (BLOQUÉ). |
policy_results[] |
Résultats de l'application des règles relatives aux clients. Renseigné uniquement si l'appel d'assistance a été ignoré en raison d'un non-respect des règles. Il contient les résultats des filtres qui ont bloqué le traitement de la requête. |
BannedPhraseEnforcementResult
Résultat de l'application des règles client concernant les expressions interdites.
| Champs | |
|---|---|
banned_phrases[] |
Expressions interdites trouvées dans la requête ou la réponse. |
ModelArmorEnforcementResult
Résultat de l'application des règles client pour les règles Model Armor.
| Champs | |
|---|---|
Champ d'union result. Résultat de la règle Model Armor. result ne peut être qu'un des éléments suivants : |
|
model_armor_violation |
Violation Model Armor détectée. |
error |
Erreur renvoyée par Model Armor si l'application de la règle a échoué pour une raison quelconque. |
PolicyEnforcementResult
Résultat de l'application des règles client pour un seul type de règle.
| Champs | |
|---|---|
Champ d'union enforcement_result. Résultat spécifique au type de règlement. Il peut s'agir d'une erreur ou d'informations détaillées sur le résultat de l'application du règlement. enforcement_result ne peut être qu'un des éléments suivants : |
|
banned_phrase_enforcement_result |
Résultat de l'application des règles concernant les expressions interdites. |
model_armor_enforcement_result |
Résultat de l'application des règles Model Armor. |
Évaluation
Verdict concernant l'application des règles relatives aux clients.
| Enums | |
|---|---|
UNSPECIFIED |
Valeur inconnue. |
ALLOW |
Aucune règle n'a été enfreinte. |
BLOCK |
Le traitement a été bloqué par le règlement client. |
Répondre
Partie de la réponse en plusieurs parties de l'appel d'assistance.
| Champs | |
|---|---|
Champ d'union reply. Autres réponses possibles de l'assistant. reply ne peut être qu'un des éléments suivants : |
|
grounded_content |
Texte ou contenu multimédia de réponse ancrée de l'assistant (le cas échéant). |
État
État de la génération de la réponse.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Inconnu |
IN_PROGRESS |
Une opération d'assistance est en cours. |
FAILED |
L'opération d'assistance a échoué. |
SUCCEEDED |
L'opération d'assistance a réussi. |
SKIPPED |
L'opération d'assistance a été ignorée. |
AssistRequest
Requête pour la méthode AssistantService.Assist.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du |
query |
Facultatif. Requête de l'utilisateur actuel. Les requêtes vides ne sont acceptées que si des |
session |
Facultatif. Session à utiliser pour la requête. Si cette option est spécifiée, l'assistant a accès à l'historique des sessions, et la requête et la réponse y sont stockées. Si Format : |
assist_skipping_mode |
Facultatif. Détermine les cas dans lesquels l'assistant ne répondra pas à la requête. Si la réponse est ignorée, les raisons seront listées dans |
file_ids[] |
Facultatif. ID des fichiers à utiliser pour répondre à la demande. Lorsque vous importez un fichier, son ID est renvoyé dans |
user_metadata |
Facultatif. Informations sur l'utilisateur qui lance la requête. |
AssistSkippingMode
Comportements de désactivation disponibles pour les demandes d'assistance.
| Enums | |
|---|---|
ASSIST_SKIPPING_MODE_UNSPECIFIED |
Valeur par défaut. Vous pouvez ignorer la réponse si la requête ne demande pas d'aide. |
REQUEST_ASSIST |
Demandez une réponse à l'Assistant. La réponse peut toujours être ignorée si la requête ne respecte pas les règles. |
AssistResponse
Réponse pour la méthode AssistantService.Assist.
| Champs | |
|---|---|
answer |
Ressource |
session_info |
Informations sur la session. |
assist_token |
ID unique global qui identifie la paire requête/réponse actuelle. Utilisé pour les commentaires et l'assistance. |
SessionInfo
Informations sur la session.
| Champs | |
|---|---|
session |
Nom de la session nouvellement générée ou poursuivie. Format : |
query_id |
ID de la requête correspondant à cet appel d'API Assist. Une session peut comporter plusieurs tours, chacun avec un ID de requête unique. En spécifiant le nom de la session et cet ID de requête dans l'appel de l'API Assist, la demande d'assistance se produit dans le contexte des résultats de recherche de cet appel de recherche. |
AssistUserMetadata
Métadonnées utilisateur de la requête.
| Champs | |
|---|---|
time_zone |
Facultatif. Fuseau horaire IANA, par exemple "Europe/Budapest". |
preferred_language_code |
Facultatif. Langue préférée à utiliser pour répondre si la détection de la langue échoue. Également utilisé comme langue des messages d'erreur créés par les actions, quels que soient les résultats de la détection de la langue. |
Assistant
Ressource Assistant Discovery Engine.
| Champs | |
|---|---|
name |
Immuable. Nom de ressource de l'assistant. Format : Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
display_name |
Obligatoire. Nom à afficher de l'assistant. Il doit s'agir d'une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 128 caractères. |
description |
Facultatif. Description pour obtenir des informations supplémentaires. Il doit s'afficher dans l'interface utilisateur de configuration, et non aux utilisateurs de l'assistant. |
generation_config |
Facultatif. Configuration pour la génération de la réponse de l'assistant. |
google_search_grounding_enabled |
Facultatif. Obsolète. Utilisez plutôt |
web_grounding_type |
Facultatif. Type d'ancrage Web à utiliser. |
enabled_actions |
Facultatif. Obsolète : sera remplacé par |
enabled_tools |
Facultatif. Remarque : pas encore implémenté. Utilisez plutôt |
customer_policy |
Facultatif. Règles applicables aux clients pour l'Assistant. |
ActionInfo
Obsolète : sera remplacé par ToolInfo. Informations permettant d'identifier une action.
| Champs | |
|---|---|
action_name |
Nom de l'action tel que défini par DataConnectorService.QueryAvailableActions. |
action_display_name |
Nom à afficher de l'action. |
ActionList
Obsolète : sera remplacé par ToolList. Actions activées sur un connecteur
| Champs | |
|---|---|
action_info[] |
Liste des actions avec les informations correspondantes. |
CustomerPolicy
Règle définie par le client pour l'assistant.
| Champs | |
|---|---|
banned_phrases[] |
Facultatif. Liste des expressions interdites. |
model_armor_config |
Facultatif. Configuration de Model Armor à utiliser pour désinfecter les requêtes utilisateur et les réponses de l'assistant. |
BannedPhrase
Définition d'une expression interdite définie par le client. Une expression interdite ne doit pas figurer dans la requête utilisateur ni dans la réponse du LLM, sous peine de voir la réponse refusée.
| Champs | |
|---|---|
phrase |
Obligatoire. Contenu de la chaîne brute à interdire. |
match_type |
Facultatif. Type de correspondance pour l'expression interdite. |
ignore_diacritics |
Facultatif. Si la valeur est "true", les signes diacritiques (par exemple, les accents et les trémas) sont ignorés lors de la mise en correspondance des expressions interdites. Par exemple, "cafe" correspondrait à "café". |
BannedPhraseMatchType
Méthode de correspondance pour l'expression interdite.
| Enums | |
|---|---|
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED |
La valeur par défaut est SIMPLE_STRING_MATCH. |
SIMPLE_STRING_MATCH |
L'expression interdite est considérée comme correspondante si elle est trouvée n'importe où dans le texte en tant que sous-chaîne exacte. |
WORD_BOUNDARY_STRING_MATCH |
Une expression interdite ne correspond que si le motif trouvé dans le texte est entouré de délimiteurs de mots. L'expression elle-même peut toujours contenir des délimiteurs de mots. |
ModelArmorConfig
Configuration des modèles Model Armor définis par le client à utiliser pour nettoyer les requêtes utilisateur et les réponses de l'assistant.
| Champs | |
|---|---|
user_prompt_template |
Facultatif. Nom de ressource du modèle Model Armor pour assainir les requêtes utilisateur. Format : Si aucune valeur n'est spécifiée, aucune désinfection ne sera appliquée à la requête utilisateur. |
response_template |
Facultatif. Nom de ressource du modèle Model Armor permettant de nettoyer les réponses de l'assistant. Format : Si aucune valeur n'est spécifiée, aucune désinfection ne sera appliquée à la réponse de l'assistant. |
failure_mode |
Facultatif. Définit le mode d'échec pour la désinfection Model Armor. |
FailureMode
Détermine le comportement lorsque Model Armor ne parvient pas à traiter une requête.
| Enums | |
|---|---|
FAILURE_MODE_UNSPECIFIED |
Mode d'échec non spécifié. Le comportement par défaut est FAIL_CLOSED. |
FAIL_OPEN |
En cas d'échec du traitement de Model Armor, la requête est autorisée à se poursuivre sans aucune modification. |
FAIL_CLOSED |
En cas d'échec du traitement de Model Armor, la requête est rejetée. |
GenerationConfig
Configuration pour la génération de la réponse de l'assistant.
| Champs | |
|---|---|
system_instruction |
Instruction système, également appelée préambule de requête pour les appels LLM. Consultez également https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions. |
default_language |
Langue par défaut à utiliser pour générer la réponse de l'assistant. Utilisez un code de langue ISO 639-1, tel que |
SystemInstruction
Instruction système, également appelée préambule de requête pour les appels LLM.
| Champs | |
|---|---|
additional_system_instruction |
Facultatif. Instruction système supplémentaire qui sera ajoutée à l'instruction système par défaut. |
ToolInfo
Informations permettant d'identifier un outil.
| Champs | |
|---|---|
tool_name |
Nom de l'outil tel que défini par DataConnectorService.QueryAvailableActions. Remarque : |
tool_display_name |
Nom à afficher de l'outil. |
ToolList
Outils activés sur un connecteur
| Champs | |
|---|---|
tool_info[] |
Liste des outils avec les informations correspondantes. |
WebGroundingType
Type d'ancrage Web à utiliser.
| Enums | |
|---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
Paramètre par défaut non spécifié. Cela revient à désactiver la fonctionnalité. |
WEB_GROUNDING_TYPE_DISABLED |
L'ancrage Web est désactivé. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
L'ancrage avec la recherche Google est activé. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
L'ancrage avec la recherche Web Enterprise est activé. |
AssistantContent
Contenu multimodal.
| Champs | |
|---|---|
role |
Producteur du contenu. Valeurs possibles : "model" ou "user". |
thought |
Facultatif. Indique si la partie est une pensée du modèle. |
Champ d'union data. Données contenues. data ne peut être qu'un des éléments suivants : |
|
text |
Texte intégré. |
inline_data |
Données binaires intégrées. |
file |
Un fichier, par exemple un résumé audio. |
executable_code |
Code généré par le modèle et destiné à être exécuté. |
code_execution_result |
Résultat de l'exécution d'un ExecutableCode. |
Blob
Blob intégré.
| Champs | |
|---|---|
mime_type |
Obligatoire. Type de contenu (type MIME) des données générées. |
data |
Obligatoire. Octets bruts. |
CodeExecutionResult
Résultat de l'exécution de ExecutableCode.
| Champs | |
|---|---|
outcome |
Obligatoire. Résultat de l'exécution du code. |
output |
Facultatif. Contient stdout lorsque l'exécution du code est réussie, stderr ou une autre description dans le cas contraire. |
Résultat
Énumération des résultats possibles de l'exécution du code.
| Enums | |
|---|---|
OUTCOME_UNSPECIFIED |
État non spécifié. Cette valeur ne doit pas être utilisée. |
OUTCOME_OK |
L'exécution du code s'est déroulée avec succès. |
OUTCOME_FAILED |
L'exécution du code est terminée, mais a échoué. stderr doit contenir le motif. |
OUTCOME_DEADLINE_EXCEEDED |
L'exécution du code a duré trop longtemps et a été annulée. Une sortie partielle peut être présente ou non. |
ExecutableCode
Code généré par le modèle et destiné à être exécuté par celui-ci.
| Champs | |
|---|---|
code |
Obligatoire. Contenu du code. Actuellement, seul Python est compatible. |
Fichier
Un fichier, par exemple un résumé audio.
| Champs | |
|---|---|
mime_type |
Obligatoire. Type de contenu (type MIME) du fichier. |
file_id |
Obligatoire. ID du fichier. |
AssistantGroundedContent
Un contenu et éventuellement ses informations d'ancrage.
Tous les contenus n'ont pas besoin d'ancrage. Les expressions telles que "Bien sûr, je me ferai un plaisir de le rechercher pour vous" n'ont pas besoin d'ancrage.
| Champs | |
|---|---|
content |
Contenu. |
citation_metadata |
Attribution de la source du contenu généré. Consultez également https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check. |
content_metadata |
Facultatif. Métadonnées du contenu. Actuellement utilisé uniquement pour les réponses des assistants de recherche. |
Champ d'union metadata. Métadonnées d'ancrage pour différents modaux. Pour le moment, il n'accepte que le texte. metadata ne peut être qu'un des éléments suivants : |
|
text_grounding_metadata |
Métadonnées pour l'ancrage basé sur des sources textuelles. |
ContentMetadata
Métadonnées du contenu.
| Champs | |
|---|---|
content_kind |
Type de contenu. Indique à quelle partie de la réponse de l'assistant de recherche appartient ce contenu. |
content_id |
ID du contenu. Il permet de relier les questions de recherche à leurs réponses. Par exemple, les parties de la réponse à une question de recherche auront le même |
ContentKind
Types de contenus possibles. Actuellement utilisé uniquement pour différencier les sections dans la réponse complète d'un assistant de recherche.
| Enums | |
|---|---|
CONTENT_KIND_UNSPECIFIED |
Inconnu |
RESEARCH_PLAN |
Plan de recherche. |
RESEARCH_QUESTION |
Question de recherche. |
RESEARCH_ANSWER |
Réponse à la recherche. |
RESEARCH_REPORT |
Research report. |
RESEARCH_AUDIO_SUMMARY |
Résumé audio de la recherche. |
TextGroundingMetadata
Détails d'ancrage pour les sources de texte.
| Champs | |
|---|---|
segments[] |
Informations d'ancrage pour les parties du texte. |
references[] |
Références pour le texte ancré. |
Référence
Contenu référencé et métadonnées de document associées.
| Champs | |
|---|---|
content |
Contenu textuel référencé. |
document_metadata |
Métadonnées du document. |
DocumentMetadata
Métadonnées du document.
| Champs | |
|---|---|
document |
Nom de ressource du document. |
uri |
URI du document. Elle peut contenir une URL qui redirige vers le site Web en question. |
title |
et le titre. |
page_identifier |
Identifiant de la page. |
domain |
Nom de domaine de l'URI du document. Notez que le champ |
mime_type |
Type MIME du document. https://www.iana.org/assignments/media-types/media-types.xhtml. |
Segment
Informations d'ancrage pour un segment de texte.
| Champs | |
|---|---|
start_index |
Index basé sur zéro indiquant le début du segment, mesuré en octets d'une chaîne UTF-8 (c'est-à-dire que les caractères encodés sur plusieurs octets ont une longueur supérieure à un). |
end_index |
Fin du segment (exclusive). |
reference_indices[] |
Références pour le segment. |
grounding_score |
Score du segment. |
text |
Segment de texte lui-même. |
BAPConfig
Configuration du connecteur BAP.
| Champs | |
|---|---|
supported_connector_modes[] |
Obligatoire. Modes de connecteur compatibles pour la connexion BAP associée. |
enabled_actions[] |
Facultatif. Actions activées sur la connexion BAP associée. |
ConnectorMode
Cas d'utilisation compatibles avec ce connecteur BAP.
| Enums | |
|---|---|
CONNECTOR_MODE_UNSPECIFIED |
Mode du connecteur non spécifié. |
DATA_INGESTION |
Connecteur utilisé pour l'ingestion de données. |
ACTIONS |
Connecteur utilisé pour les actions |
END_USER_AUTHENTICATION |
Connecteur utilisé pour l'authentification des utilisateurs finaux. |
BatchCreateTargetSiteMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.BatchCreateTargetSites. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
BatchCreateTargetSitesRequest
Message de requête pour la méthode SiteSearchEngineService.BatchCreateTargetSites.
| Champs | |
|---|---|
parent |
Obligatoire. Ressource parente partagée par tous les TargetSites en cours de création. |
requests[] |
Obligatoire. Message de requête spécifiant les ressources à créer. Vous pouvez créer jusqu'à 20 TargetSites dans un lot. |
BatchCreateTargetSitesResponse
Message de réponse pour la méthode SiteSearchEngineService.BatchCreateTargetSites.
| Champs | |
|---|---|
target_sites[] |
TargetSites créés. |
BatchGetDocumentsMetadataRequest
Message de requête pour la méthode DocumentService.BatchGetDocumentsMetadata.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple |
matcher |
Obligatoire. Matcher pour les |
FhirMatcher
Matcher pour les Document par nom de ressource FHIR.
| Champs | |
|---|---|
fhir_resources[] |
Obligatoire. Ressources FHIR à faire correspondre. Format : projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |
Matcher
Matcher pour les Document. Actuellement, la correspondance s'effectue par URI exacts.
| Champs | |
|---|---|
Champ d'union matcher. Matcher pour les Document. La matcher ne peut être qu'un des éléments suivants : |
|
uris_matcher |
Moteur de correspondance par URI exacts. |
fhir_matcher |
Matcher par nom de ressource FHIR. |
UrisMatcher
Matcher pour les Document par URI exacts.
| Champs | |
|---|---|
uris[] |
URI exacts à faire correspondre. |
BatchGetDocumentsMetadataResponse
Message de réponse pour la méthode DocumentService.BatchGetDocumentsMetadata.
| Champs | |
|---|---|
documents_metadata[] |
Métadonnées des |
DocumentMetadata
Métadonnées d'un Document.
| Champs | |
|---|---|
matcher_value |
Valeur du comparateur utilisé pour faire correspondre le |
state |
État du document. |
last_refreshed_time |
Code temporel de la dernière indexation de |
data_ingestion_source |
Source d'ingestion des données de Les valeurs autorisées sont les suivantes :
|
MatcherValue
Valeur du comparateur utilisé pour faire correspondre le Document.
| Champs | |
|---|---|
Champ d'union matcher_value. Valeur du comparateur utilisé pour faire correspondre le Document. La matcher_value ne peut être qu'un des éléments suivants : |
|
uri |
Si la correspondance se fait par URI, l'URI de |
fhir_resource |
Format : projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} |
État
État de Document.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Ne doit jamais être défini. |
INDEXED |
L'Document est indexé. |
NOT_IN_TARGET_SITE |
Document n'est pas indexé, car son URI ne figure pas dans TargetSite. |
NOT_IN_INDEX |
Le Document n'est pas indexé. |
BatchUpdateUserLicensesMetadata
Métadonnées liées à la progression de l'opération UserLicenseService.BatchUpdateUserLicenses. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Le nombre de licences utilisateur a bien été modifié. |
failure_count |
Nombre de licences utilisateur qui n'ont pas pu être mises à jour. |
BatchUpdateUserLicensesRequest
Message de requête pour la méthode UserLicenseService.BatchUpdateUserLicenses.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource parent [UserStore][], au format |
delete_unassigned_user_licenses |
Facultatif. Si la valeur est "true", la licence utilisateur sera supprimée si les configurations de licence associées sont supprimées. Par défaut (c'est-à-dire sur "false"), la licence utilisateur sera mise à jour sur l'état "non attribuée". |
Champ d'union source. Obligatoire. Source de l'entrée. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée du contenu d'entrée pour les embeddings de documents. |
InlineSource
Source intégrée pour la configuration d'entrée de la méthode BatchUpdateUserLicenses.
| Champs | |
|---|---|
user_licenses[] |
Obligatoire. Liste des licences utilisateur à modifier. Chaque licence utilisateur doit disposer d'un |
update_mask |
Facultatif. Liste des champs à mettre à jour. |
BatchUpdateUserLicensesResponse
Message de réponse pour la méthode UserLicenseService.BatchUpdateUserLicenses.
| Champs | |
|---|---|
user_licenses[] |
Les licences utilisateur ont bien été mises à jour. |
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
BatchVerifyTargetSitesMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.BatchVerifyTargetSites. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
BatchVerifyTargetSitesRequest
Message de requête pour la méthode SiteSearchEngineService.BatchVerifyTargetSites.
| Champs | |
|---|---|
parent |
Obligatoire. Ressource parente partagée par tous les TargetSites en cours de validation. |
BatchVerifyTargetSitesResponse
Ce type ne comporte aucun champ.
Message de réponse pour la méthode SiteSearchEngineService.BatchVerifyTargetSites.
BigQuerySource
Source BigQuery à partir de laquelle importer les données.
| Champs | |
|---|---|
project_id |
ID ou numéro du projet contenant la source BigQuery. ne doit pas dépasser 128 caractères ; S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
dataset_id |
Obligatoire. Ensemble de données BigQuery à partir duquel copier les données (limite de 1 024 caractères). |
table_id |
Obligatoire. Table BigQuery à partir de laquelle copier les données (limite de 1 024 caractères). |
gcs_staging_dir |
Répertoire Cloud Storage intermédiaire utilisé pour l'importation (limite de 2 000 caractères). Peut être spécifié si vous souhaitez que BigQuery exporte les données vers un répertoire Cloud Storage particulier. |
data_schema |
Schéma à utiliser lors de l'analyse des données de la source. Valeurs acceptées pour les importations d'événements utilisateur :
Valeurs acceptées pour les importations de documents :
|
Champ d'union partition. Informations sur le partitionnement de la table BigQuery. Laissez ce champ vide si la table BigQuery n'est pas partitionnée. partition ne peut être qu'un des éléments suivants : |
|
partition_date |
_PARTITIONDATE de la table partitionnée par date BigQuery au format AAAA-MM-JJ. |
BigtableOptions
Objet Bigtable Options contenant des informations pour faciliter l'importation.
| Champs | |
|---|---|
key_field_name |
Nom du champ utilisé pour enregistrer la valeur de la clé de ligne dans le document. Le nom doit correspondre au modèle |
families |
Mappage des noms de famille à un objet contenant des informations au niveau des familles de colonnes pour la famille de colonnes donnée. Si une famille n'est pas présente dans cette carte, elle sera ignorée. |
BigtableColumn
Colonne de Bigtable.
| Champs | |
|---|---|
qualifier |
Obligatoire. Qualificatif de la colonne. Si elle ne peut pas être décodée avec utf-8, utilisez plutôt une chaîne encodée en base64. |
field_name |
Nom du champ à utiliser pour cette colonne dans le document. Le nom doit correspondre au modèle |
encoding |
Mode d'encodage des valeurs lorsque le type n'est pas
|
type |
Type de valeurs dans cette famille de colonnes. Les valeurs doivent être encodées à l'aide de la fonction |
BigtableColumnFamily
Famille de colonnes de Bigtable.
| Champs | |
|---|---|
field_name |
Nom du champ à utiliser pour cette famille de colonnes dans le document. Le nom doit correspondre au modèle |
encoding |
Mode d'encodage des valeurs lorsque le type n'est pas STRING. Les valeurs d'encodage acceptées sont les suivantes :
|
type |
Type de valeurs dans cette famille de colonnes. Les valeurs doivent être encodées à l'aide de la fonction |
columns[] |
Liste d'objets contenant des informations au niveau des colonnes pour chacune d'elles. Si une colonne n'est pas présente dans cette liste, elle sera ignorée. |
Encodage
Mode d'encodage d'une colonne ou d'une famille de colonnes Bigtable.
| Enums | |
|---|---|
ENCODING_UNSPECIFIED |
L'encodage n'est pas spécifié. |
TEXT |
Encodage du texte. |
BINARY |
Encodage binaire. |
Type
Type de valeurs dans une colonne ou une famille de colonnes Bigtable. Les valeurs doivent être encodées à l'aide de la fonction HBase Bytes.toBytes lorsque la valeur d'encodage est définie sur BINARY.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Le type n'est pas spécifié. |
STRING |
Type de chaîne. |
NUMBER |
Type numérique. |
INTEGER |
Type entier. |
VAR_INTEGER |
Type entier de longueur variable. |
BIG_NUMERIC |
Type BigDecimal. |
BOOLEAN |
Type booléen. |
JSON |
Type JSON. |
BigtableSource
Source Cloud Bigtable pour importer des données.
| Champs | |
|---|---|
project_id |
ID du projet contenant la source Bigtable. ne doit pas dépasser 128 caractères ; S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
instance_id |
Obligatoire. ID de l'instance Cloud Bigtable à importer. |
table_id |
Obligatoire. ID de la table Cloud Bigtable à importer. |
bigtable_options |
Obligatoire. Options Bigtable contenant les informations nécessaires lors de l'analyse des données dans des structures typées. Par exemple, les annotations de type de colonne. |
CheckGroundingRequest
Message de requête pour la méthode GroundedGenerationService.CheckGrounding.
| Champs | |
|---|---|
grounding_config |
Obligatoire. Nom de ressource de la configuration d'ancrage, par exemple |
answer_candidate |
Réponse candidate à vérifier. Il peut comporter jusqu'à 4 096 jetons. |
facts[] |
Liste des faits pour la vérification de la mise à la terre. Nous acceptons jusqu'à 200 faits. |
grounding_spec |
Configuration de la vérification de l'ancrage. |
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez la documentation Google Cloud. |
CheckGroundingResponse
Message de réponse pour la méthode GroundedGenerationService.CheckGrounding.
| Champs | |
|---|---|
cited_chunks[] |
Liste des faits cités dans toutes les affirmations de la réponse candidate. Elles sont issues des faits fournis dans la demande. |
cited_facts[] |
Liste des faits cités dans toutes les affirmations de la réponse candidate. Elles sont issues des faits fournis dans la demande. |
claims[] |
Textes de revendication et informations de citation pour toutes les revendications dans la réponse candidate. |
support_score |
Score de soutien pour la réponse candidate saisie. Plus le score est élevé, plus la fraction d'affirmations étayées par les faits fournis est importante. Cette valeur est toujours définie lorsqu'une réponse est renvoyée. |
CheckGroundingFactChunk
Bloc d'informations pour la vérification de l'ancrage.
| Champs | |
|---|---|
chunk_text |
Contenu textuel du bloc de faits. Ne doit pas dépasser 10 000 caractères. |
Revendication
Texte et informations de citation pour une affirmation dans la réponse candidate.
| Champs | |
|---|---|
claim_text |
Texte de l'affirmation dans la réponse candidate. Toujours fourni, que des citations ou des anticitation soient trouvées ou non. |
citation_indices[] |
Liste des index (dans "cited_chunks") spécifiant les citations associées à l'affirmation. Par exemple, [1,3,4] signifie que les faits cités dans cited_chunks[1], cited_chunks[3] et cited_chunks[4] soutiennent l'affirmation. Une citation d'un fait indique que l'affirmation est étayée par ce fait. |
start_pos |
Position indiquant le début de l'affirmation dans la réponse candidate, mesurée en octets. Notez que cette valeur n'est pas mesurée en caractères. Elle doit donc être affichée dans l'interface utilisateur en gardant à l'esprit que certains caractères peuvent prendre plus d'un octet. Par exemple, si le texte de la revendication contient des caractères non ASCII, les positions de début et de fin varient selon qu'elles sont mesurées en caractères (en fonction du langage de programmation) ou en octets (indépendamment du langage de programmation). |
end_pos |
Position indiquant la fin de l'affirmation dans la réponse candidate, exclusive, en octets. Notez que cette valeur n'est pas mesurée en caractères et doit donc être affichée telle quelle. Par exemple, si le texte de la revendication contient des caractères non ASCII, les positions de début et de fin varient selon qu'elles sont mesurées en caractères (en fonction du langage de programmation) ou en octets (indépendamment du langage de programmation). |
grounding_check_required |
Indique que cette affirmation a nécessité une vérification de l'ancrage. Lorsque le système décide que cette affirmation ne nécessite pas de vérification de l'attribution/de l'ancrage, ce champ est défini sur "false". Dans ce cas, aucune vérification de l'ancrage n'a été effectuée pour l'affirmation. Par conséquent, |
score |
Score de confiance pour l'affirmation dans la réponse candidate, dans la plage [0, 1]. Cette valeur n'est définie que lorsque |
CheckGroundingSpec
Spécification pour la vérification de l'ancrage.
| Champs | |
|---|---|
citation_threshold |
Seuil (dans [0,1]) utilisé pour déterminer si un fait doit être cité pour une affirmation dans la réponse candidate. Si vous choisissez un seuil plus élevé, vous obtiendrez moins de citations, mais elles seront très pertinentes. Si vous choisissez un seuil plus bas, vous obtiendrez plus de citations, mais elles seront moins pertinentes. Si elle n'est pas définie, le seuil est défini par défaut sur 0,6. |
enable_claim_level_score |
Indicateur de contrôle qui active le score d'ancrage au niveau de l'affirmation dans la réponse. |
Bloc
Le bloc capture toutes les informations brutes sur les métadonnées des éléments à recommander ou à rechercher en mode bloc.
| Champs | |
|---|---|
name |
Nom complet de la ressource du bloc. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
id |
ID unique du bloc actuel. |
content |
Le contenu est une chaîne provenant d'un document (contenu analysé). |
document_metadata |
Métadonnées du document provenant du bloc actuel. |
derived_struct_data |
Uniquement en sortie. Ce champ est OUTPUT_ONLY. Il contient des données dérivées qui ne figurent pas dans le document d'entrée d'origine. |
page_span |
Étendue de la page du bloc. |
chunk_metadata |
Uniquement en sortie. Métadonnées du bloc actuel. |
data_urls[] |
Uniquement en sortie. URL des données d'image si le bloc actuel contient des images. Les URL de données se composent de quatre parties : un préfixe (data:), un type MIME indiquant le type de données, un jeton base64 facultatif si les données ne sont pas textuelles et les données elles-mêmes : data:[ |
annotation_contents[] |
Uniquement en sortie. Contenu des annotations si le bloc actuel en contient. |
annotation_metadata[] |
Uniquement en sortie. Les métadonnées d'annotation incluent le contenu structuré du bloc actuel. |
relevance_score |
Uniquement en sortie. Représente le score de pertinence basé sur la similarité. Plus le score est élevé, plus le bloc est pertinent. Le score est compris dans la plage [-1,0, 1,0]. Renseigné uniquement sur |
AnnotationMetadata
Les métadonnées d'annotation incluent le contenu structuré du bloc actuel.
| Champs | |
|---|---|
structured_content |
Uniquement en sortie. Informations sur le contenu structuré. |
image_id |
Uniquement en sortie. L'ID de l'image est fourni si le contenu structuré est basé sur une image. |
ChunkMetadata
Métadonnées du bloc actuel. Ce champ n'est renseigné que dans l'API SearchService.Search.
| Champs | |
|---|---|
previous_chunks[] |
Les blocs précédents du bloc actuel. Le nombre est contrôlé par |
next_chunks[] |
Les blocs suivants du bloc actuel. Le nombre est contrôlé par |
DocumentMetadata
Les métadonnées du document contiennent les informations du document du bloc actuel.
| Champs | |
|---|---|
uri |
URI du document. |
title |
Titre du document. |
mime_type |
Type MIME du document. https://www.iana.org/assignments/media-types/media-types.xhtml. |
struct_data |
Représentation des données. Données JSON structurées pour le document. Il doit être conforme au |
PageSpan
Étendue de la page du bloc.
| Champs | |
|---|---|
page_start |
Page de début du bloc. |
page_end |
Page de fin du bloc. |
StructureType
Définit les types de contenu structuré pouvant être extraits.
| Enums | |
|---|---|
STRUCTURE_TYPE_UNSPECIFIED |
Valeur par défaut. |
SHAREHOLDER_STRUCTURE |
Structure des actionnaires. |
SIGNATURE_STRUCTURE |
Structure de la signature. |
CHECKBOX_STRUCTURE |
Structure de la case à cocher. |
StructuredContent
Informations sur le contenu structuré.
| Champs | |
|---|---|
structure_type |
Uniquement en sortie. Type de structure du contenu structuré. |
content |
Uniquement en sortie. Contenu du contenu structuré. |
Citation
Attributions de source pour le contenu.
| Champs | |
|---|---|
start_index |
Uniquement en sortie. Index de début du contenu. |
end_index |
Uniquement en sortie. Index de fin du contenu. |
uri |
Uniquement en sortie. URL de référence de l'attribution. |
title |
Uniquement en sortie. Titre de l'attribution. |
license |
Uniquement en sortie. Licence de l'attribution. |
publication_date |
Uniquement en sortie. Date de publication de l'attribution. |
CitationMetadata
Ensemble d'attributions de sources pour un contenu.
| Champs | |
|---|---|
citations[] |
Uniquement en sortie. Liste des citations. |
CloudSqlSource
Source Cloud SQL à partir de laquelle importer les données.
| Champs | |
|---|---|
project_id |
ID du projet contenant la source Cloud SQL. ne doit pas dépasser 128 caractères ; S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
instance_id |
Obligatoire. Instance Cloud SQL à partir de laquelle copier les données (limite de 256 caractères). |
database_id |
Obligatoire. Base de données Cloud SQL à partir de laquelle copier les données, avec une limite de longueur de 256 caractères. |
table_id |
Obligatoire. Table Cloud SQL à partir de laquelle copier les données (limite de 256 caractères). |
gcs_staging_dir |
Répertoire Cloud Storage intermédiaire utilisé pour l'importation (limite de 2 000 caractères). Peut être spécifié si vous souhaitez que Cloud SQL exporte les données vers un répertoire Cloud Storage particulier. Assurez-vous que le compte de service Cloud SQL dispose des autorisations d'administrateur Cloud Storage nécessaires pour accéder au répertoire Cloud Storage spécifié. |
offload |
Option d'exportation sans serveur. L'activation de cette option entraînera des coûts supplémentaires. Pour en savoir plus, cliquez ici. |
CmekConfig
Configurations utilisées pour activer le chiffrement des données CMEK avec des clés Cloud KMS.
| Champs | |
|---|---|
name |
Obligatoire. Nom de CmekConfig au format |
kms_key |
Obligatoire. Nom de ressource de la clé KMS qui sera utilisée pour chiffrer les ressources |
kms_key_version |
Uniquement en sortie. Nom de ressource de la version de clé KMS qui sera utilisée pour chiffrer les ressources |
state |
Uniquement en sortie. États de CmekConfig. |
is_default |
Uniquement en sortie. CmekConfig par défaut pour le client. |
last_rotation_timestamp_micros |
Uniquement en sortie. Code temporel de la dernière rotation des clés. |
single_region_keys[] |
Facultatif. CMEK monorégionales requises pour certaines fonctionnalités VAIS. |
notebooklm_state |
Uniquement en sortie. Indique si le corpus NotebookLM est prêt à être utilisé. |
NotebookLMState
États de NotebookLM.
| Enums | |
|---|---|
NOTEBOOK_LM_STATE_UNSPECIFIED |
L'état de NotebookLM est inconnu. |
NOTEBOOK_LM_NOT_READY |
NotebookLM n'est pas prêt. |
NOTEBOOK_LM_READY |
NotebookLM est prêt à être utilisé. |
NOTEBOOK_LM_NOT_ENABLED |
NotebookLM n'est pas activé. |
État
États de CmekConfig.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
L'état de CmekConfig est inconnu. |
CREATING |
CmekConfig est en cours de création. |
ACTIVE |
CmekConfig peut être utilisé avec les data stores. |
KEY_ISSUE |
CmekConfig n'est pas disponible, probablement parce que la clé KMS a été révoquée. |
DELETING |
La suppression de CmekConfig est en cours. |
DELETE_FAILED |
Échec de la suppression de CmekConfig. |
UNUSABLE |
CmekConfig n'est pas utilisable, probablement en raison d'un problème interne. |
ACTIVE_ROTATING |
La version de clé KMS est en cours de rotation. |
DELETED |
La clé KMS est supprimée de manière réversible. Une règle de nettoyage sera appliquée à terme. |
EXPIRED |
La clé KMS a expiré, ce qui signifie qu'elle a été désactivée pendant plus de 30 jours. Le client peut appeler DeleteCmekConfig pour définir l'état sur "SUPPRIMÉ". |
CollectUserEventRequest
Message de requête pour la méthode CollectUserEvent.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente. Si l'action de collecte d'événements utilisateur est appliquée au niveau |
user_event |
Obligatoire. URL encodée du fichier proto UserEvent, avec une limite de longueur de 2 000 000 de caractères. |
uri |
URL incluant les paramètres CGI, mais excluant le fragment de hachage, avec une limite de 5 000 caractères. Cette information est souvent plus utile que l'URL de provenance, car de nombreux navigateurs n'envoient que le domaine pour les requêtes tierces. |
ets |
Horodatage de l'événement en millisecondes. Cela empêche la mise en cache par le navigateur des requêtes GET identiques. Le nom est abrégé pour réduire le nombre d'octets de la charge utile. |
Collection
Une collection est un conteneur permettant de configurer des ressources et l'accès à un ensemble de DataStores.
| Champs | |
|---|---|
name |
Immuable. Nom complet de la ressource Collection. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
display_name |
Obligatoire. Nom à afficher de la collection. Ce champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
create_time |
Uniquement en sortie. Code temporel de création de |
CompleteQueryRequest
Message de requête pour la méthode CompletionService.CompleteQuery.
| Champs | |
|---|---|
data_store |
Obligatoire. Nom de ressource du data store parent pour lequel la saisie semi-automatique est effectuée, par exemple |
query |
Obligatoire. Saisie "typeahead" utilisée pour récupérer les suggestions. Il ne doit pas dépasser 128 caractères. |
query_model |
Spécifie le modèle de données d'autocomplétion. Cela remplace tout modèle spécifié dans la section Configuration > Saisie semi-automatique de la console Cloud. Valeurs actuellement acceptées :
Valeurs par défaut :
|
user_pseudo_id |
Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web. Ce champ ne doit PAS avoir de valeur fixe telle que Cet identifiant doit être identique à celui de Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur |
include_tail_suggestions |
Indique si des suggestions de queue longue doivent être renvoyées si aucune suggestion ne correspond à la requête complète. Même si la valeur est définie sur "true", si des suggestions correspondent à la requête complète, elles sont renvoyées et aucune suggestion de queue n'est renvoyée. |
CompleteQueryResponse
Message de réponse pour la méthode CompletionService.CompleteQuery.
| Champs | |
|---|---|
query_suggestions[] |
Résultats des suggestions de requêtes correspondantes. La liste des résultats est triée et le premier résultat est une suggestion principale. |
tail_match_triggered |
True si toutes les suggestions renvoyées sont des suggestions de queue. Pour que la correspondance de queue soit déclenchée, include_tail_suggestions doit être défini sur "true" dans la requête et aucune suggestion ne doit correspondre à la requête complète. |
QuerySuggestion
Suggestions en tant que requêtes de recherche.
| Champs | |
|---|---|
suggestion |
Suggestion pour la requête. |
completable_field_paths[] |
Chemins d'accès uniques aux champs de document qui servent de source à cette suggestion si elle a été générée à partir de champs à compléter. Ce champ n'est renseigné que pour le modèle permettant de compléter des documents. |
CompletionInfo
Informations détaillées sur la finalisation, y compris le jeton d'attribution de la finalisation et les informations sur la finalisation après clic.
| Champs | |
|---|---|
selected_suggestion |
L'utilisateur final |
selected_position |
Position |
CompletionSuggestion
Suggestions de saisie semi-automatique importées depuis le client.
| Champs | |
|---|---|
suggestion |
Obligatoire. Texte de la suggestion. |
language_code |
Code de langue BCP-47 de cette suggestion. |
group_id |
Si deux suggestions ont le même groupId, elles ne seront pas renvoyées ensemble. À la place, celui qui est le mieux classé sera renvoyé. Cela peut être utilisé pour dédupliquer les suggestions sémantiquement identiques. |
group_score |
Score de cette suggestion dans son groupe. |
alternative_phrases[] |
Autres expressions correspondantes pour cette suggestion. |
Champ d'union ranking_info. Métriques de classement de cette suggestion. ranking_info ne peut être qu'un des éléments suivants : |
|
global_score |
Score global de cette suggestion. Contrôlez la façon dont cette suggestion sera évaluée / classée. |
frequency |
Fréquence de cette suggestion. Sera utilisé pour classer les suggestions lorsque le score n'est pas disponible. |
Condition
Définit les circonstances à vérifier avant d'autoriser un comportement
| Champs | |
|---|---|
query_terms[] |
Rechercher uniquement une liste de termes correspondant à la requête. Ne peut pas être défini lorsque 10 termes de requête maximum. |
active_time_range[] |
Plage(s) horaire(s) indiquant quand la condition est active. 10 périodes au maximum. |
query_regex |
Facultatif. Expression régulière de la requête pour correspondre à l'intégralité de la requête de recherche. Ne peut pas être défini lorsque |
QueryTerm
Outil de correspondance pour les requêtes de recherche
| Champs | |
|---|---|
value |
Valeur de requête spécifique à comparer Doit être en minuscules et au format UTF-8. Peut comporter au maximum trois termes séparés par un espace si full_match est défini sur "true". Ne peut pas être une chaîne vide. Ne doit pas dépasser 5 000 caractères. |
full_match |
Indique si la requête de recherche doit correspondre exactement au terme de la requête. |
TimeRange
Utilisé pour les conditions dépendantes du temps.
| Champs | |
|---|---|
start_time |
Début de la période. La plage est inclusive. |
end_time |
Fin de la période. La plage est inclusive. Il doit s'agir d'une date future. |
ConnectorType
Type de connecteur.
| Enums | |
|---|---|
CONNECTOR_TYPE_UNSPECIFIED |
Valeur par défaut. |
THIRD_PARTY |
Connecteur tiers vers une application tierce. |
GCP_FHIR |
Le connecteur de données établit la connexion entre le magasin FHIR et le magasin de données VAIS. |
BIG_QUERY |
Connecteur BigQuery. |
GCS |
Connecteur Google Cloud Storage. |
GOOGLE_MAIL |
Connecteur Gmail. |
GOOGLE_CALENDAR |
Connecteur Google Agenda. |
GOOGLE_DRIVE |
Connecteur Google Drive. |
NATIVE_CLOUD_IDENTITY |
Connecteur Cloud Identity natif pour la recherche de personnes, optimisé par l'API People. |
THIRD_PARTY_FEDERATED |
Connecteur fédéré : il s'agit d'un connecteur tiers qui n'ingère pas de données. La recherche est optimisée par l'API de l'application tierce. |
THIRD_PARTY_EUA |
Connecteur utilisé pour les fonctionnalités d'authentification des utilisateurs finaux. |
GCNV |
Connecteur Google Cloud NetApp Volumes. |
ContactDetails
Coordonnées stockées au niveau de la ressource. Si les informations de contact au niveau du projet et de la ressource sont renseignées, celles au niveau de la ressource remplaceront celles au niveau du projet.
| Champs | |
|---|---|
email_address |
Facultatif. Adresse e-mail du contact. |
Contrôle
Définit un comportement conditionnel à utiliser lors de la diffusion. Pour être pris en compte au moment de la diffusion, ils doivent être associés à un ServingConfig. Actions autorisées en fonction de SolutionType.
| Champs | |
|---|---|
name |
Immuable. Nom complet |
display_name |
Obligatoire. Nom lisible. Identifiant utilisé dans les vues de l'UI. Doit être une chaîne encodée au format UTF-8. La limite de longueur est de 128 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
associated_serving_config_ids[] |
Uniquement en sortie. Liste de tous les ID |
solution_type |
Obligatoire. Immuable. Solution à laquelle appartient le contrôle. Doit être compatible avec le secteur de la ressource. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
use_cases[] |
Spécifie le cas d'utilisation du contrôle. Affecte les champs de conditions qui peuvent être définis. S'applique uniquement à |
conditions[] |
Détermine quand l'action associée sera déclenchée. Omettez-le pour toujours appliquer l'action. Actuellement, une seule condition peut être spécifiée. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
Champ d'union Obligatoire. |
|
boost_action |
Définit un contrôle de type boost |
filter_action |
Définit un contrôle de type filtre. Non compatible actuellement avec les recommandations. |
redirect_action |
Définit un contrôle de type redirection. |
synonyms_action |
Traite un groupe de termes comme des synonymes les uns des autres. |
promote_action |
Mettez en avant certains liens en fonction de requêtes déclencheurs prédéfinies. |
BoostAction
Ajuste l'ordre des produits dans la liste renvoyée.
| Champs | |
|---|---|
boost |
Intensité du boost, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0.0 (No-op). |
filter |
Obligatoire. Spécifie les produits auxquels appliquer le boost. Si aucun filtre n'est fourni, tous les produits seront mis en avant (No-op). Documentation sur la syntaxe : https://cloud.google.com/retail/docs/filter-and-order. La longueur maximale est de 5 000 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
data_store |
Obligatoire. Indique les documents de quel data store peuvent être boostés par cette commande. Nom complet du data store, par exemple projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
Champ d'union boost_spec. Spécifications de boosting de valeur constante ou de boosting basé sur un classement personnalisé. boost_spec ne peut être qu'un des éléments suivants : |
|
fixed_boost |
Facultatif. Intensité du boost, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0.0 (No-op). |
interpolation_boost_spec |
Facultatif. Spécification complexe pour le classement personnalisé basé sur la valeur d'un attribut défini par le client. |
InterpolationBoostSpec
Spécification du classement personnalisé basé sur la valeur d'un attribut spécifié par le client. Il offre plus de contrôles pour un classement personnalisé que la simple combinaison (condition, boost) ci-dessus.
| Champs | |
|---|---|
field_name |
Facultatif. Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost. |
attribute_type |
Facultatif. Type d'attribut à utiliser pour déterminer le montant de l'augmentation. La valeur de l'attribut peut être dérivée de la valeur du champ field_name spécifié. Dans le cas d'un attribut numérique, c'est simple : attribute_value = numerical_field_value. Dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value). |
interpolation_type |
Facultatif. Type d'interpolation à appliquer pour connecter les points de contrôle listés ci-dessous. |
control_points[] |
Facultatif. Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par le biais de l'interpolation_type ci-dessus) passe par les points de contrôle listés ici. |
AttributeType
Attribut(ou fonction) auquel le classement personnalisé doit être appliqué.
| Enums | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
Type d'attribut non spécifié. |
NUMERICAL |
La valeur du champ numérique sera utilisée pour mettre à jour dynamiquement le montant du boost. Dans ce cas, la valeur d'attribut (valeur x) du point de contrôle sera la valeur réelle du champ numérique pour lequel boost_amount est spécifié. |
FRESHNESS |
Dans le cas d'utilisation de la fraîcheur, la valeur de l'attribut correspond à la durée entre l'heure actuelle et la date spécifiée dans le champ "datetime". La valeur doit être au format XSD dayTimeDuration (sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]]. Par exemple, 5D, 3DT12H30M, T24H. |
ControlPoint
Points de contrôle utilisés pour définir la courbe. La courbe définie par ces points de contrôle ne peut qu'augmenter ou diminuer de manière monotone(les valeurs constantes sont acceptables).
| Champs | |
|---|---|
attribute_value |
Facultatif. Peut être l'une des valeurs suivantes : 1. Valeur numérique du champ. 2. Spécification de la durée de fraîcheur : la valeur doit être mise en forme en tant que valeur |
boost_amount |
Facultatif. Valeur comprise entre -1 et 1 permettant d'augmenter le score si la valeur de l'attribut correspond à la valeur spécifiée ci-dessus. |
InterpolationType
Type d'interpolation à appliquer. La valeur par défaut est "linéaire" (linéaire par morceaux).
| Enums | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
Le type d'interpolation n'est pas spécifié. Dans ce cas, la valeur par défaut est "Linéaire". |
LINEAR |
Une interpolation linéaire par morceaux sera appliquée. |
FilterAction
Indique les produits qui peuvent être inclus dans les résultats. Utilise le même filtre que l'amplification.
| Champs | |
|---|---|
filter |
Obligatoire. Filtre à appliquer aux résultats de la condition de correspondance. Documentation sur la syntaxe requise : https://cloud.google.com/retail/docs/filter-and-order. La longueur maximale est de 5 000 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
data_store |
Obligatoire. Indique les documents de data store pouvant être filtrés par cette commande. Nom complet du data store, par exemple projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
PromoteAction
Mettez en avant certains liens en fonction de requêtes déclencheurs.
Exemple : Promouvoir le lien vers un magasin de chaussures lorsque l'utilisateur recherche le mot clé shoe. Le lien peut se trouver en dehors du data store associé.
| Champs | |
|---|---|
data_store |
Obligatoire. Datastore auquel cette promotion est associée. |
search_link_promotion |
Obligatoire. Promotion associée à cette action. |
RedirectAction
Redirige un client vers l'URI fourni.
| Champs | |
|---|---|
redirect_uri |
Obligatoire. URI vers lequel l'acheteur sera redirigé. Obligatoire. L'URI ne doit pas comporter plus de 2 000 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
SynonymsAction
Crée un ensemble de termes qui serviront de synonymes les uns pour les autres.
Par exemple, "heureux" sera également considéré comme "content", et "content" sera également considéré comme "heureux".
| Champs | |
|---|---|
synonyms[] |
Définit un ensemble de synonymes. Vous pouvez spécifier jusqu'à 100 synonymes. Vous devez spécifier au moins deux synonymes. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée. |
Conversation
Définition du proto de conversation externe.
| Champs | |
|---|---|
name |
Immuable. Nom complet |
state |
État de la conversation. |
user_pseudo_id |
Identifiant unique permettant de suivre les utilisateurs. |
messages[] |
Messages de conversation. |
start_time |
Uniquement en sortie. Heure de début de la conversation. |
end_time |
Uniquement en sortie. Heure à laquelle la conversation s'est terminée. |
État
Énumération de l'état de la conversation.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Inconnu |
IN_PROGRESS |
La conversation est actuellement ouverte. |
COMPLETED |
La conversation est terminée. |
ConversationContext
Définit le contexte de la conversation
| Champs | |
|---|---|
context_documents[] |
Liste actuelle des documents que l'utilisateur voit. Il contient les références aux ressources du document. |
active_document |
Document actif actuellement ouvert par l'utilisateur. Il contient la référence de la ressource du document. |
ConversationMessage
Définit un message de conversation.
| Champs | |
|---|---|
create_time |
Uniquement en sortie. Code temporel de création du message. |
Champ d'union
|
|
user_input |
Entrée de texte de l'utilisateur. |
reply |
Réponse à la recherche. |
ConverseConversationRequest
Message de requête pour la méthode ConversationalSearchService.ConverseConversation.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la conversation à récupérer. Format : |
query |
Obligatoire. Entrée utilisateur actuelle. |
serving_config |
Nom de ressource de la configuration de diffusion à utiliser. Format : |
conversation |
Conversation à utiliser par la session automatique uniquement. Le champ du nom sera ignoré, car nous attribuons automatiquement un nouveau nom à la conversation dans la session automatique. |
safe_search |
Indique si la recherche sécurisée doit être activée. |
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez la documentation Google Cloud. |
summary_spec |
Spécification permettant de configurer le récapitulatif renvoyé dans la réponse. |
filter |
La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. L'expression de filtre est sensible à la casse. Il sera utilisé pour filtrer les résultats de recherche, ce qui peut avoir une incidence sur la réponse récapitulative. Si ce champ n'est pas reconnaissable, un Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété clé définie dans le backend Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client média peut avoir un champ "name" (nom) dans son schéma. Dans ce cas, le filtre se présenterait comme suit : filter --> name:'ANY("king kong")` Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez Filtrer. |
boost_spec |
Spécification d'augmentation pour mettre en avant certains documents dans les résultats de recherche, ce qui peut avoir une incidence sur la réponse de la conversation. Pour en savoir plus sur l'amplification, consultez Amplification. |
ConverseConversationResponse
Message de réponse pour la méthode ConversationalSearchService.ConverseConversation.
| Champs | |
|---|---|
reply |
Réponse à la requête actuelle. |
conversation |
Conversation mise à jour incluant la réponse. |
search_results[] |
Résultats de recherche. |
CreateAssistantRequest
Requête pour la méthode AssistantService.CreateAssistant.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente. Format : |
assistant |
Obligatoire. |
assistant_id |
Obligatoire. ID à utiliser pour Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. |
CreateControlRequest
Requête pour la méthode CreateControl.
| Champs | |
|---|---|
parent |
Obligatoire. Nom complet de la ressource du data store parent. Format : |
control |
Obligatoire. Contrôle à créer. |
control_id |
Obligatoire. ID à utiliser pour le contrôle, qui constituera le composant final du nom de ressource du contrôle. Cette valeur doit comporter entre 1 et 63 caractères. Les caractères valides sont /[a-z][0-9]-_/. |
CreateConversationRequest
Requête pour la méthode CreateConversation.
| Champs | |
|---|---|
parent |
Obligatoire. Nom complet de la ressource du data store parent. Format : |
conversation |
Obligatoire. Conversation à créer. |
CreateDataStoreMetadata
Métadonnées liées à la progression de l'opération DataStoreService.CreateDataStore. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
CreateDataStoreRequest
Requête pour la méthode DataStoreService.CreateDataStore.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
data_store |
Obligatoire. |
data_store_id |
Obligatoire. ID à utiliser pour Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
create_advanced_site_search |
Indicateur booléen indiquant si l'utilisateur souhaite créer directement un data store avancé pour la recherche sur le site. Cet indicateur sera ignoré si le data store n'est pas configuré en tant que recherche sur le site (vertical GENERIC et content_config PUBLIC_WEBSITE). |
skip_default_schema_creation |
Indicateur booléen indiquant s'il faut ignorer la création du schéma par défaut pour le data store. N'activez cette option que si vous êtes certain que le schéma par défaut est incompatible avec votre cas d'utilisation. Si la valeur est "true", vous devez créer manuellement un schéma pour le data store avant de pouvoir ingérer des documents. Cette option ne peut pas être spécifiée si |
Champ d'union cmek_options. Options CMEK pour DataStore. Si vous définissez ce champ, vous remplacerez la configuration CmekConfig par défaut, le cas échéant. cmek_options ne peut être qu'un des éléments suivants : |
|
cmek_config_name |
Nom de ressource de CmekConfig à utiliser pour protéger ce DataStore. |
disable_cmek |
DataStore sans protections CMEK. Si une configuration CmekConfig par défaut est définie pour le projet, la définition de ce champ remplacera également la configuration CmekConfig par défaut. |
CreateDocumentRequest
Message de requête pour la méthode DocumentService.CreateDocument.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
document |
Obligatoire. |
document_id |
Obligatoire. ID à utiliser pour Si l'appelant n'est pas autorisé à créer le La valeur de ce champ doit être unique parmi tous les Ce champ doit être conforme à la norme RFC-1034 et ne pas dépasser 128 caractères. Dans le cas contraire, une erreur |
CreateEngineMetadata
Métadonnées liées à la progression de l'opération EngineService.CreateEngine. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
CreateEngineRequest
Requête pour la méthode EngineService.CreateEngine.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
engine |
Obligatoire. |
engine_id |
Obligatoire. ID à utiliser pour Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
CreateIdentityMappingStoreRequest
Message de requête pour IdentityMappingStoreService.CreateIdentityMappingStore
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de la collection parente, par exemple |
identity_mapping_store_id |
Obligatoire. ID du magasin de mappage d'identité à créer. L'ID ne doit contenir que des lettres (a-z, A-Z), des chiffres (0-9), des traits de soulignement (_) et des tirets (-). La longueur maximale est de 63 caractères. |
identity_mapping_store |
Obligatoire. Magasin de mappage d'identité à créer. |
Champ d'union cmek_options. Options CMEK pour le magasin de mappage des identités. Si vous définissez ce champ, vous remplacerez la configuration CmekConfig par défaut, le cas échéant. cmek_options ne peut être qu'un des éléments suivants : |
|
cmek_config_name |
Nom de ressource de CmekConfig à utiliser pour protéger ce magasin de mappage d'identité. |
disable_cmek |
Magasin de mappage des identités sans protections CMEK. Si une configuration CmekConfig par défaut est définie pour le projet, la définition de ce champ remplacera également la configuration CmekConfig par défaut. |
CreateLicenseConfigRequest
Message de requête pour la méthode LicenseConfigService.CreateLicenseConfig.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
license_config |
Obligatoire. |
license_config_id |
Facultatif. ID à utiliser pour |
CreateSchemaMetadata
Métadonnées pour l'opération de longue durée "Créer un schéma".
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
CreateSchemaRequest
Message de requête pour la méthode SchemaService.CreateSchema.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource du data store parent, au format |
schema |
Obligatoire. |
schema_id |
Obligatoire. ID à utiliser pour Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. |
CreateSessionRequest
Requête pour la méthode CreateSession.
| Champs | |
|---|---|
parent |
Obligatoire. Nom complet de la ressource du data store parent. Format : |
session |
Obligatoire. Session à créer. |
CreateSitemapMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.CreateSitemap. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
CreateSitemapRequest
Message de requête pour la méthode SiteSearchEngineService.CreateSitemap.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente de |
sitemap |
Obligatoire. |
CreateTargetSiteMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.CreateTargetSite. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
CreateTargetSiteRequest
Message de requête pour la méthode SiteSearchEngineService.CreateTargetSite.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource parente de |
target_site |
Obligatoire. |
CustomAttribute
Attribut personnalisé qui n'est pas explicitement modélisé dans une ressource, par exemple UserEvent.
| Champs | |
|---|---|
text[] |
Valeurs textuelles de cet attribut personnalisé. Par exemple, Une chaîne vide n'est pas autorisée. Dans le cas contraire, une erreur Vous ne devez définir qu'un seul élément |
numbers[] |
Valeurs numériques de cet attribut personnalisé. Par exemple, Vous ne devez définir qu'un seul élément |
CustomTuningModel
Métadonnées décrivant un modèle personnalisé ajusté.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource du modèle. Format : Le modèle doit être une chaîne alphanumérique de 40 caractères maximum. |
display_name |
Nom à afficher du modèle. |
model_version |
Version du modèle. |
model_state |
État du modèle (par exemple, |
create_time |
Obsolète : code temporel de la création du modèle. |
training_start_time |
Code temporel de l'entraînement du modèle. |
metrics |
Métriques du modèle entraîné. |
error_message |
Actuellement, ce champ n'est renseigné que si l'état du modèle est |
ModelState
État du modèle.
| Enums | |
|---|---|
MODEL_STATE_UNSPECIFIED |
Valeur par défaut. |
TRAINING_PAUSED |
L'entraînement du modèle est suspendu. |
TRAINING |
Le modèle est en cours d'entraînement. |
TRAINING_COMPLETE |
L'entraînement du modèle est terminé. |
READY_FOR_SERVING |
Le modèle est prêt à être diffusé. |
TRAINING_FAILED |
L'entraînement du modèle a échoué. |
NO_IMPROVEMENT |
L'entraînement du modèle s'est terminé avec succès, mais les métriques ne se sont pas améliorées. |
INPUT_VALIDATION_FAILED |
Échec de la validation des données d'entrée. L'entraînement du modèle n'a pas démarré. |
DataConnector
Gère la connexion aux sources de données externes pour tous les magasins de données regroupés sous un Collection. Il s'agit d'une ressource singleton de Collection. L'initialisation n'est prise en charge que par la méthode DataConnectorService.SetUpDataConnector, qui crée un Collection et initialise son DataConnector.
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom complet de la ressource du connecteur de données. Format : |
state |
Uniquement en sortie. État du connecteur. |
data_source |
Obligatoire. Nom de la source de données. Valeurs autorisées : |
remove_param_keys[] |
Facultatif. Spécifie les clés à supprimer du champ "params". Ce paramètre n'est actif que lorsque "params" est inclus dans "update_mask" dans une requête UpdateDataConnectorRequest. La suppression est prioritaire si une clé figure à la fois dans "remove_param_keys" et dans le champ "params" de la requête. |
refresh_interval |
Obligatoire. Intervalle d'actualisation pour la synchronisation des données. Si la durée est définie sur 0, les données sont synchronisées en temps réel. La fonctionnalité de streaming n'est pas encore disponible. La durée minimale est de 30 minutes et la durée maximale de sept jours. Si l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle sera désactivée. |
next_sync_time |
Définit l'heure planifiée de la prochaine synchronisation des données. Ce champ nécessite l'heure, les minutes et le fuseau horaire de la base de données des fuseaux horaires IANA. Cette option est utilisée lorsque le connecteur de données a un intervalle d'actualisation supérieur à un jour. Si les heures ou les minutes ne sont pas spécifiées, nous considérerons que l'heure de synchronisation est 0:00. L'utilisateur doit fournir un fuseau horaire pour éviter toute ambiguïté. |
entities[] |
Liste des entités de la source de données connectée à ingérer. |
create_time |
Uniquement en sortie. Code temporel de création de |
latest_pause_time |
Uniquement en sortie. Code temporel le plus récent auquel cette |
last_sync_time |
Uniquement en sortie. Pour les connecteurs périodiques uniquement, il s'agit de la dernière fois qu'une synchronisation des données a été effectuée. |
update_time |
Uniquement en sortie. Code temporel de la dernière mise à jour de |
errors[] |
Uniquement en sortie. Erreurs d'initialisation ou de la dernière exécution du connecteur. |
sync_mode |
Mode de synchronisation des données compatible avec le connecteur de données. |
kms_key_name |
Uniquement en entrée. Clé KMS à utiliser pour protéger les DataStores gérés par ce connecteur. Doit être défini pour les requêtes qui doivent respecter les protections des règles d'administration CMEK. Si ce champ est défini et traité correctement, les DataStores créés par ce connecteur seront protégés par la clé KMS. |
destination_configs[] |
Facultatif. Toutes les destinations cibles utilisées pour se connecter à des services tiers. |
action_state |
Uniquement en sortie. État du connecteur d'action. Cela indique si le connecteur d'action est en cours d'initialisation, actif ou a rencontré des erreurs. |
action_config |
Facultatif. Configurez les actions pour que le connecteur les prenne en charge. |
end_user_config |
Facultatif. Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs EULA. |
federated_config |
Facultatif. Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs hybrides compatibles avec le mode FEDERATED. Ce champ ne doit être défini que si le connecteur est un connecteur hybride et que nous souhaitons activer le mode FÉDÉRÉ. |
connector_modes[] |
Facultatif. Modes activés pour ce connecteur. L'état par défaut est CONNECTOR_MODE_UNSPECIFIED. |
static_ip_enabled |
Facultatif. Indique si le client a activé les adresses IP statiques pour ce connecteur. |
static_ip_addresses[] |
Uniquement en sortie. Adresses IP statiques utilisées par ce connecteur. |
blocking_reasons[] |
Uniquement en sortie. Actions utilisateur qui doivent être effectuées avant que le connecteur puisse commencer à synchroniser les données. |
identity_refresh_interval |
Intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès pour les documents ingérés par ce connecteur. Si cette règle n'est pas configurée, la liste de contrôle des accès sera actualisée à l'intervalle par défaut de 30 minutes. L'intervalle d'actualisation de l'identité peut être d'au moins 30 minutes et d'au plus 7 jours. |
identity_schedule_config |
Configuration des exécutions de synchronisation des données d'identité. Il contient l'intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès des documents ingérés par ce connecteur. |
private_connectivity_project_id |
Uniquement en sortie. ID du projet locataire associé aux connecteurs de connectivité privée. Ce projet doit être ajouté à la liste d'autorisation pour que le connecteur fonctionne. |
bap_config |
Facultatif. Configuration permettant d'établir une connexion BAP. |
connector_type |
Uniquement en sortie. Type de connecteur. Chaque source ne peut être associée qu'à un seul type. Par exemple, salesforce, confluence et jira ont le type de connecteur THIRD_PARTY. Une fois défini par le système, il ne peut plus être modifié. |
realtime_state |
Uniquement en sortie. État de la synchronisation en temps réel |
alert_policy_configs[] |
Facultatif. Configuration des alertes au niveau du connecteur. |
realtime_sync_config |
Facultatif. Configuration de la synchronisation en temps réel. |
acl_enabled |
Facultatif. Indique si le connecteur sera créé avec une configuration de LCA. Actuellement, ce champ ne concerne que les connecteurs Cloud Storage et BigQuery. |
create_eua_saas |
Facultatif. Indique si le connecteur END USER AUTHENTICATION est créé dans SaaS. |
auto_run_disabled |
Facultatif. Indique si le connecteur est désactivé pour l'exécution automatique. Elle peut être utilisée pour suspendre la synchronisation périodique et en temps réel. Mise à jour : avec l'introduction de incremental_sync_disabled, auto_run_disabled est utilisé pour mettre en pause/désactiver uniquement les synchronisations complètes. |
incremental_sync_disabled |
Facultatif. Indique si les synchronisations incrémentielles sont suspendues pour ce connecteur. Cela est indépendant de auto_run_disabled. Applicable uniquement aux connecteurs tiers. Lorsque l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle est désactivée (c'est-à-dire définie sur "true"). |
incremental_refresh_interval |
Facultatif. Intervalle d'actualisation spécifique aux synchronisations incrémentielles des données. Si elle n'est pas définie, les synchronisations incrémentielles utiliseront la valeur par défaut de l'environnement, qui est de trois heures. La durée minimale est de 30 minutes et la durée maximale de sept jours. Applicable uniquement aux connecteurs tiers. Si l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle sera désactivée. |
hybrid_ingestion_disabled |
Facultatif. Si le connecteur est un connecteur hybride, détermine si l'ingestion est activée et si les ressources appropriées sont provisionnées lors de la création du connecteur. Si le connecteur n'est pas un connecteur hybride, ce champ est ignoré. |
Champ d'union Paramètres requis pour toutes les sources de données :
Paramètres requis pour les sources compatibles avec OAUTH, c'est-à-dire
Paramètres requis pour les sources qui acceptent l'authentification de base par jeton d'API, c'est-à-dire
Exemple : Paramètre facultatif permettant de spécifier le type d'autorisation à utiliser pour la prise en charge de plusieurs types d'autorisation :
|
|
params |
Paramètres requis du connecteur de données au format JSON structuré. |
json_params |
Paramètres requis du connecteur de données au format chaîne JSON. |
BlockingReason
Actions utilisateur qui doivent être effectuées avant que le connecteur puisse commencer à synchroniser les données.
| Enums | |
|---|---|
BLOCKING_REASON_UNSPECIFIED |
Valeur par défaut. |
ALLOWLIST_STATIC_IP |
Le connecteur exige que le client ajoute des adresses IP statiques à la liste d'autorisation. |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
Le connecteur exige que le client ajoute notre projet à la liste d'autorisation dans son rattachement de service. |
ALLOWLIST_SERVICE_ACCOUNT |
Le connecteur exige que le client ajoute le compte de service à la liste d'autorisation de son projet. |
ConnectorMode
Modes activés pour ce connecteur. INGESTION, ACTIONS, FEDERATED, OR EUA
| Enums | |
|---|---|
CONNECTOR_MODE_UNSPECIFIED |
Mode du connecteur non spécifié. |
DATA_INGESTION |
Connecteur utilisé pour l'ingestion de données. |
ACTIONS |
Connecteur utilisé pour les actions. |
FEDERATED |
Connecteur utilisé pour la recherche fédérée. |
EUA |
Connecteur utilisé pour l'authentification des utilisateurs finaux. |
FEDERATED_AND_EUA |
Connecteur hybride utilisé pour la recherche fédérée et l'authentification des utilisateurs finaux. |
EndUserConfig
Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs EULA.
| Champs | |
|---|---|
additional_params |
Facultatif. Tous les paramètres supplémentaires nécessaires pour l'EUA. |
tenant |
Facultatif. Projet locataire auquel le connecteur est associé. |
Champ d'union auth_config. Configuration de l'authentification pour les connecteurs d'EUA. auth_config ne peut être qu'un des éléments suivants : |
|
auth_params |
Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs EUA. |
json_auth_params |
Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs EUA au format chaîne JSON. |
FederatedConfig
Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs hybrides compatibles avec le mode FEDERATED.
| Champs | |
|---|---|
additional_params |
Facultatif. Tous les paramètres supplémentaires nécessaires pour FEDERATED. |
Champ d'union auth_config. Configuration de l'authentification pour les connecteurs FEDERATED. auth_config ne peut être qu'un des éléments suivants : |
|
auth_params |
Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs FÉDÉRÉS. |
json_auth_params |
Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs FEDERATED au format de chaîne JSON. |
RealtimeSyncConfig
Configuration de la synchronisation en temps réel pour stocker des paramètres supplémentaires.
| Champs | |
|---|---|
webhook_uri |
Facultatif. URL du webhook permettant au connecteur de spécifier des paramètres supplémentaires pour la synchronisation en temps réel. |
realtime_sync_secret |
Facultatif. ID du secret Secret Manager utilisé pour le secret du webhook. |
streaming_error |
Facultatif. Détails de l'erreur de streaming. |
StreamingError
Détails de l'erreur de streaming.
| Champs | |
|---|---|
streaming_error_reason |
Facultatif. Erreur de streaming. |
error |
Facultatif. Détails de l'erreur. |
StreamingErrorReason
Types généraux d'erreurs de streaming.
| Enums | |
|---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
Le motif de l'erreur de streaming n'est pas spécifié. |
STREAMING_SETUP_ERROR |
Une erreur s'est produite lors de la configuration des ressources pour la synchronisation en temps réel. |
STREAMING_SYNC_ERROR |
Une erreur s'est produite lors de l'exécution de la synchronisation en temps réel pour le connecteur. |
INGRESS_ENDPOINT_REQUIRED |
Un point de terminaison d'Ingress est requis lorsque vous configurez la synchronisation en temps réel dans une connectivité privée. |
SourceEntity
Représente une entité dans la source de données. Par exemple, l'objet Account dans Salesforce.
| Champs | |
|---|---|
entity_name |
Nom de l'entité. Valeurs acceptées par source de données :
|
key_property_mappings |
Attributs pour l'indexation. Clé : nom du champ. Valeur : propriété clé à laquelle mapper un champ, par exemple
|
data_store |
Uniquement en sortie. Nom complet de la ressource du data store associé pour l'entité source. Format : |
starting_schema |
Facultatif. Schéma de début à utiliser pour le Ce champ n'est utilisé que par l'API [SetUpDataConnector][] et sera ignoré s'il est utilisé dans d'autres API. Ce champ sera omis de toutes les réponses d'API, y compris l'API [GetDataConnector][]. Pour récupérer le schéma d'un Le schéma fourni sera validé par rapport à certaines règles. Pour en savoir plus, consultez ce document. |
healthcare_fhir_config |
Facultatif. Configuration pour le secteur |
Champ d'union
|
|
params |
Paramètres de l'entité pour faciliter l'ingestion de données au format JSON structuré. |
json_params |
Paramètres de l'entité pour faciliter l'ingestion de données au format JSON. |
État
État du connecteur.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valeur par défaut. |
CREATING |
Le connecteur est en cours de configuration. |
ACTIVE |
Le connecteur a bien été configuré et attend la prochaine synchronisation. |
FAILED |
Le connecteur est en erreur. Vous trouverez les détails de l'erreur dans DataConnector.errors. Si l'erreur est impossible à corriger, le DataConnector peut être supprimé par l'API [CollectionService.DeleteCollection]. |
RUNNING |
Le connecteur synchronise activement les enregistrements de la source de données. |
WARNING |
Le connecteur a fini d'exécuter une synchronisation, mais des erreurs non fatales ont été détectées. |
INITIALIZATION_FAILED |
Échec de l'initialisation du connecteur. Les causes potentielles incluent des erreurs d'exécution ou des problèmes dans le pipeline asynchrone, qui empêchent la requête d'atteindre les services en aval (à l'exception de certains types de connecteurs). |
UPDATING |
Le connecteur est en cours de mise à jour. |
SyncMode
Définit le mode de synchronisation des données accepté par le connecteur de données.
| Enums | |
|---|---|
PERIODIC |
Le connecteur synchronise les données périodiquement en fonction de refresh_interval. Utilisez-le avec auto_run_disabled pour suspendre la synchronisation périodique ou indiquer une synchronisation ponctuelle. |
STREAMING |
Les données seront synchronisées en temps réel. |
UNSPECIFIED |
Cette valeur s'affiche pour les connecteurs qui n'ingèrent pas de données. |
DataStore
DataStore capture les paramètres et configurations globaux au niveau DataStore.
| Champs | |
|---|---|
name |
Immuable. Identifiant. Nom complet de la ressource du data store. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
display_name |
Obligatoire. Nom à afficher du data store. Ce champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
industry_vertical |
Immuable. Secteur d'activité auquel le data store est associé. |
solution_types[] |
Solutions auxquelles le data store est inscrit. Solutions disponibles pour chaque
|
default_schema_id |
Uniquement en sortie. ID de l' |
content_config |
Immuable. Configuration du contenu du data store. Si ce champ n'est pas défini, le comportement du serveur est défini par défaut sur |
create_time |
Uniquement en sortie. Code temporel de création de |
advanced_site_search_config |
Facultatif. Configuration de la recherche avancée sur le site. |
kms_key_name |
Uniquement en entrée. Clé KMS à utiliser pour protéger ce DataStore lors de sa création. Doit être défini pour les requêtes qui doivent respecter les protections des règles d'administration CMEK. Si ce champ est défini et traité correctement, le DataStore sera protégé par la clé KMS, comme indiqué dans le champ cmek_config. |
cmek_config |
Uniquement en sortie. Informations liées à CMEK pour DataStore. |
billing_estimation |
Uniquement en sortie. Estimation de la taille des données pour la facturation. |
acl_enabled |
Immuable. Indique si les données de Lorsque la LCA est activée pour Actuellement, les LCA ne sont compatibles qu'avec le secteur |
workspace_config |
Configuration permettant de stocker la configuration du type de data store pour les données de l'espace de travail. Ce paramètre doit être défini lorsque |
document_processing_config |
Configuration pour la compréhension et l'enrichissement des documents. |
starting_schema |
Schéma de début à utiliser pour ce Ce champ n'est utilisé que par l'API Le schéma fourni sera validé par rapport à certaines règles. Pour en savoir plus, consultez ce document. |
healthcare_fhir_config |
Facultatif. Configuration pour le secteur |
serving_config_data_store |
Facultatif. Stocke la configuration de diffusion au niveau du DataStore. |
identity_mapping_store |
Immuable. Nom complet de la ressource |
is_infobot_faq_data_store |
Facultatif. Si cette valeur est définie, ce DataStore est un DataStore de questions fréquentes Infobot. |
configurable_billing_approach |
Facultatif. Configuration de l'approche de facturation configurable. Vous devriez voir ce qui suit : |
BillingEstimation
Estimation de la taille des données par data store.
| Champs | |
|---|---|
structured_data_size |
Taille des données structurées en octets. |
unstructured_data_size |
Taille des données non structurées en octets. |
website_data_size |
Taille des données pour les sites Web en octets. |
structured_data_update_time |
Horodatage de la dernière mise à jour des données structurées. |
unstructured_data_update_time |
Horodatage de la dernière mise à jour des données non structurées. |
website_data_update_time |
Horodatage de la dernière mise à jour pour les sites Web. |
ConfigurableBillingApproach
Configuration de l'approche de facturation configurable.
| Enums | |
|---|---|
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED |
Valeur par défaut. Pour l'approche de facturation non configurable Spark et non Spark. |
CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE |
Utilisez la facturation par abonnement de base + dépassement pour l'indexation du cœur pour le stockage sans intégration. |
CONFIGURABLE_CONSUMPTION_EMBEDDING |
Utilisez la facturation à la consommation avec paiement à l'usage pour le module complémentaire de stockage pour l'intégration. |
ContentConfig
Configuration du contenu du data store.
| Enums | |
|---|---|
CONTENT_CONFIG_UNSPECIFIED |
Valeur par défaut. |
NO_CONTENT |
Ne contient que des documents sans Document.content. |
CONTENT_REQUIRED |
Ne contient que les documents avec Document.content. |
PUBLIC_WEBSITE |
Le data store est utilisé pour la recherche sur les sites Web publics. |
GOOGLE_WORKSPACE |
Le data store est utilisé pour la recherche dans l'espace de travail. Les détails du data store de l'espace de travail sont spécifiés dans WorkspaceConfig. |
ServingConfigDataStore
Stocke les informations concernant les configurations de diffusion au niveau DataStore.
| Champs | |
|---|---|
disabled_for_serving |
Facultatif. Si la valeur est "true", DataStore ne sera pas disponible pour répondre aux requêtes de recherche. |
DeleteAssistantRequest
Message de requête pour la méthode AssistantService.DeleteAssistant.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de Si l'appelant n'est pas autorisé à supprimer le Si le |
DeleteCmekConfigMetadata
Métadonnées liées à la progression de l'opération CmekConfigService.DeleteCmekConfig. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteCmekConfigRequest
Message de requête pour la méthode CmekConfigService.DeleteCmekConfig.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du |
DeleteCollectionMetadata
Métadonnées liées à la progression de l'opération [CollectionService.UpdateCollection][]. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteCollectionRequest
Message de requête pour la méthode CollectionService.DeleteCollection.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Collection, au format |
DeleteControlRequest
Requête pour la méthode DeleteControl.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du contrôle à supprimer. Format : |
DeleteConversationRequest
Requête pour la méthode DeleteConversation.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la conversation à supprimer. Format : |
DeleteDataStoreMetadata
Métadonnées liées à la progression de l'opération DataStoreService.DeleteDataStore. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteDataStoreRequest
Message de requête pour la méthode DataStoreService.DeleteDataStore.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à supprimer le Si le |
DeleteDocumentRequest
Message de requête pour la méthode DocumentService.DeleteDocument.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à supprimer le Si le |
DeleteEngineMetadata
Métadonnées liées à la progression de l'opération EngineService.DeleteEngine. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteEngineRequest
Message de requête pour la méthode EngineService.DeleteEngine.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à supprimer le Si le |
DeleteIdentityMappingStoreMetadata
Métadonnées liées à la progression de l'opération IdentityMappingStoreService.DeleteIdentityMappingStore. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteIdentityMappingStoreRequest
Message de requête pour IdentityMappingStoreService.DeleteIdentityMappingStore
| Champs | |
|---|---|
name |
Obligatoire. Nom du magasin de mappage des identités à supprimer. Format : |
DeleteSchemaMetadata
Métadonnées pour le LRO DeleteSchema.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteSchemaRequest
Message de requête pour la méthode SchemaService.DeleteSchema.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource du schéma, au format |
DeleteSessionRequest
Requête pour la méthode DeleteSession.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la session à supprimer. Format : |
DeleteSitemapMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.DeleteSitemap. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteSitemapRequest
Message de requête pour la méthode SiteSearchEngineService.DeleteSitemap.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
DeleteTargetSiteMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.DeleteTargetSite. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DeleteTargetSiteRequest
Message de requête pour la méthode SiteSearchEngineService.DeleteTargetSite.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
DestinationConfig
Définit les points de terminaison cibles utilisés pour se connecter à des sources tierces.
| Champs | |
|---|---|
key |
Facultatif. Identifiant unique de destination compatible avec le connecteur. |
destinations[] |
Facultatif. Destinations de la clé correspondante. |
Champ d'union destination_config_params. Paramètres supplémentaires pour cette configuration de destination. destination_config_params ne peut être qu'un des éléments suivants : |
|
params |
Facultatif. Paramètres supplémentaires pour cette configuration de destination au format JSON structuré. |
json_params |
Paramètres supplémentaires pour cette configuration de destination au format JSON. |
Destination
Définit un point de terminaison cible
| Champs | |
|---|---|
port |
Facultatif. Numéro de port cible accepté par la destination. |
Champ d'union destination. Destination du point de terminaison. destination ne peut être qu'un des éléments suivants : |
|
host |
Hôte routable publiquement. |
DisableAdvancedSiteSearchMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.DisableAdvancedSiteSearch. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
DisableAdvancedSiteSearchRequest
Message de requête pour la méthode SiteSearchEngineService.DisableAdvancedSiteSearch.
| Champs | |
|---|---|
site_search_engine |
Obligatoire. Nom complet de la ressource |
DisableAdvancedSiteSearchResponse
Ce type ne comporte aucun champ.
Message de réponse pour la méthode SiteSearchEngineService.DisableAdvancedSiteSearch.
Document
Le document capture toutes les informations brutes sur les métadonnées des éléments à recommander ou à rechercher.
| Champs | |
|---|---|
name |
Immuable. Nom complet de la ressource du document. Format : Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
id |
Immuable. Identifiant du document. L'ID doit être conforme à la norme RFC-1034 et ne pas dépasser 128 caractères. |
schema_id |
Identifiant du schéma situé dans le même data store. |
content |
Données non structurées associées à ce document. Le contenu ne peut être défini et doit l'être que si ce document se trouve dans un data store |
parent_document_id |
Identifiant du document parent. Actuellement, la hiérarchie de documents est limitée à deux niveaux. L'ID doit être conforme à la norme RFC-1034 et ne pas dépasser 63 caractères. |
derived_struct_data |
Uniquement en sortie. Ce champ est OUTPUT_ONLY. Il contient des données dérivées qui ne figurent pas dans le document d'entrée d'origine. |
acl_info |
Informations sur le contrôle des accès au document. |
index_time |
Uniquement en sortie. Date et heure de la dernière indexation du document. Si ce champ est défini, le document peut être renvoyé dans les résultats de recherche. Ce champ est OUTPUT_ONLY. Si ce champ n'est pas renseigné, cela signifie que le document n'a jamais été indexé. |
index_status |
Uniquement en sortie. État d'indexation du document.
|
Champ d'union data. Représentation des données. Vous devez fournir struct_data ou json_data. Sinon, une erreur INVALID_ARGUMENT est générée. data ne peut être qu'un des éléments suivants : |
|
struct_data |
Données JSON structurées pour le document. Il doit être conforme au |
json_data |
Représentation de la chaîne JSON du document. Il doit être conforme au |
AclInfo
Informations sur les LCA du document.
| Champs | |
|---|---|
readers[] |
Lecteurs du document. |
AccessRestriction
AclRestriction pour modéliser des restrictions d'héritage complexes.
Exemple : Modélisation d'un héritage "Autorisation requise pour les deux", où l'utilisateur doit avoir accès au document parent pour accéder à un document enfant.
Hiérarchie des documents : espace S → page P.
Lecteurs : Espace_S : groupe_1, utilisateur_1 Page_P : groupe_2, groupe_3, utilisateur_2
Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }
Restriction de la LCA Page_P. { "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" } ], } ] } }
| Champs | |
|---|---|
principals[] |
Liste des comptes principaux. |
idp_wide |
Tous les utilisateurs du fournisseur d'identité. |
Contenu
Données non structurées associées à ce document.
| Champs | |
|---|---|
mime_type |
Type MIME du contenu. Types acceptés :
Les types suivants ne sont acceptés que si l'analyseur de mise en page est activé dans le data store :
Consultez https://www.iana.org/assignments/media-types/media-types.xhtml. |
Champ d'union content. Contenu du document non structuré. content ne peut être qu'un des éléments suivants : |
|
raw_bytes |
Contenu représenté sous forme de flux d'octets. La valeur ne doit pas dépasser 1 000 000 octets (1 Mo / environ 0,95 Mio). Remarque : Comme pour tous les champs |
uri |
URI du contenu. Seuls les URI Cloud Storage (par exemple, |
IndexStatus
État de l'indexation du document.
| Champs | |
|---|---|
index_time |
Heure à laquelle le document a été indexé. Si ce champ est renseigné, cela signifie que le document a été indexé. |
error_samples[] |
Exemple d'erreurs rencontrées lors de l'indexation du document. Si ce champ est renseigné, le document n'est pas indexé en raison d'erreurs. |
pending_message |
Immuable. Le message indique que l'indexation des documents est en cours. Si ce champ est renseigné, l'index du document est en attente. |
DocumentInfo
Informations détaillées sur le document associées à un événement utilisateur.
| Champs | |
|---|---|
promotion_ids[] |
ID des promotions associées à ce document. Actuellement, ce champ est limité à un ID maximum. |
joined |
Uniquement en sortie. Indique si le document référencé se trouve dans le data store. |
Champ d'union
|
|
id |
ID de ressource |
name |
Nom complet de la ressource |
uri |
URI |
quantity |
Quantité du document associé à l'événement utilisateur. La valeur par défaut est 1. Par exemple, ce champ est défini sur "2" si deux quantités du même document sont impliquées dans un événement Obligatoire pour les événements des types suivants :
|
conversion_value |
Facultatif. Valeur de conversion associée à ce document. Doit être défini si Par exemple, une valeur de 1 000 signifie que 1 000 secondes ont été passées à consulter un document pour le type de conversion |
DocumentProcessingConfig
Ressource singleton de DataStore. S'il est vide lorsque DataStore est créé et que DataStore est défini sur DataStore.ContentConfig.CONTENT_REQUIRED, l'analyseur par défaut sera défini sur l'analyseur numérique.
| Champs | |
|---|---|
name |
Nom complet de la ressource de configuration du traitement des documents. Format : |
chunking_config |
Indique si le mode de segmentation est activé. |
default_parsing_config |
Configurations de l'analyseur de documents par défaut. Si ce champ n'est pas spécifié, nous le configurerons en tant que DigitalParsingConfig par défaut. La configuration d'analyse par défaut sera appliquée à tous les types de fichiers pour l'analyse de documents. |
parsing_config_overrides |
Mappez le type de fichier pour remplacer la configuration d'analyse par défaut en fonction du type de fichier. Clés compatibles :
|
ChunkingConfig
Configuration pour la configuration de segmentation.
| Champs | |
|---|---|
Champ d'union chunk_mode. Configurations supplémentaires qui définissent le comportement du découpage. chunk_mode ne peut être qu'un des éléments suivants : |
|
layout_based_chunking_config |
Configuration de la segmentation basée sur la mise en page. |
LayoutBasedChunkingConfig
Configuration de la segmentation basée sur la mise en page.
| Champs | |
|---|---|
chunk_size |
Taille limite des jetons pour chaque bloc. Valeurs acceptées : de 100 à 500 (inclus). La valeur par défaut est 500. |
include_ancestor_headings |
Indique si des en-têtes de différents niveaux doivent être ajoutés aux fragments au milieu du document pour éviter toute perte de contexte. Valeur par défaut : "False". |
ParsingConfig
Configurations associées appliquées à un type spécifique d'analyseur de documents.
| Champs | |
|---|---|
Champ d'union type_dedicated_config. Configurations pour les types de traitement de documents. type_dedicated_config ne peut être qu'un des éléments suivants : |
|
digital_parsing_config |
Configurations appliquées à l'analyseur numérique. |
ocr_parsing_config |
Configurations appliquées au parseur OCR. Pour le moment, cela ne s'applique qu'aux PDF. |
layout_parsing_config |
Configurations appliquées à l'analyseur de mise en page. |
DigitalParsingConfig
Ce type ne comporte aucun champ.
Configurations d'analyse numérique des documents.
LayoutParsingConfig
Configurations d'analyse de la mise en page pour les documents.
| Champs | |
|---|---|
enable_table_annotation |
Facultatif. Si la valeur est "true", l'annotation basée sur un LLM est ajoutée au tableau lors de l'analyse. |
enable_image_annotation |
Facultatif. Si la valeur est "true", l'annotation basée sur un LLM est ajoutée à l'image lors de l'analyse. |
structured_content_types[] |
Facultatif. Contient les types de structures requis à extraire du document. Valeurs autorisées :
|
exclude_html_elements[] |
Facultatif. Liste des éléments HTML à exclure du contenu analysé. |
exclude_html_classes[] |
Facultatif. Liste des classes HTML à exclure du contenu analysé. |
exclude_html_ids[] |
Facultatif. Liste des ID HTML à exclure du contenu analysé. |
enable_get_processed_document |
Facultatif. Si la valeur est "true", le document traité sera disponible pour l'API GetProcessedDocument. |
OcrParsingConfig
Configurations d'analyse OCR pour les documents.
| Champs | |
|---|---|
enhanced_document_elements[] |
[OBSOLÈTE] Ce champ est obsolète. Pour utiliser le traitement amélioré des éléments de document supplémentaires, veuillez passer à |
use_native_text |
Si la valeur est "true", le texte natif sera utilisé au lieu du texte OCR sur les pages contenant du texte natif. |
DoubleList
Liste double.
| Champs | |
|---|---|
values[] |
Valeurs doubles. |
EnableAdvancedSiteSearchMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.EnableAdvancedSiteSearch. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
EnableAdvancedSiteSearchRequest
Message de requête pour la méthode SiteSearchEngineService.EnableAdvancedSiteSearch.
| Champs | |
|---|---|
site_search_engine |
Obligatoire. Nom complet de la ressource |
EnableAdvancedSiteSearchResponse
Ce type ne comporte aucun champ.
Message de réponse pour la méthode SiteSearchEngineService.EnableAdvancedSiteSearch.
Moteur
Métadonnées décrivant les paramètres d'entraînement et de diffusion d'un Engine.
| Champs | |
|---|---|
name |
Immuable. Identifiant. Nom complet de la ressource du moteur. Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. Le format |
display_name |
Obligatoire. Nom à afficher du moteur. Doit être lisible par l'humain. Chaîne encodée en UTF-8 avec une limite de 1 024 caractères. |
create_time |
Uniquement en sortie. Code temporel de la création du moteur de recommandations. |
update_time |
Uniquement en sortie. Horodatage de la dernière mise à jour du moteur de recommandation. |
data_store_ids[] |
Facultatif. Datastores associés à ce moteur. Les moteurs de type Si Notez que lorsqu'il est utilisé dans |
solution_type |
Obligatoire. Les solutions du moteur. |
industry_vertical |
Facultatif. Secteur d'activité enregistré par le moteur. La restriction du secteur d'activité "Moteur" est basée sur |
common_config |
Spécification de configuration courante qui spécifie les métadonnées du moteur. |
app_type |
Facultatif. Immuable. Type d'application que représente cette ressource de moteur. REMARQUE : Il s'agit d'un nouveau concept indépendant du secteur d'activité ou du type de solution existants. |
disable_analytics |
Facultatif. Indique si les données analytiques doivent être désactivées pour les recherches effectuées sur ce moteur. |
features |
Facultatif. Configuration des fonctionnalités permettant au moteur d'activer ou de désactiver des fonctionnalités. Clés compatibles :
|
configurable_billing_approach |
Facultatif. Configuration de l'approche de facturation configurable. |
Champ d'union engine_config. Spécifications de configuration supplémentaires qui définissent le comportement du moteur. engine_config ne peut être qu'un des éléments suivants : |
|
chat_engine_config |
Configurations du Chat Engine. Ne s'applique que si |
search_engine_config |
Configurations du moteur de recherche. Ne s'applique que si |
media_recommendation_engine_config |
Configurations pour le moteur Media. Applicable uniquement aux data stores avec les secteurs |
Champ d'union engine_metadata. Métadonnées du moteur permettant de surveiller son état. engine_metadata ne peut être qu'un des éléments suivants : |
|
chat_engine_metadata |
Uniquement en sortie. Informations supplémentaires sur le Chat Engine. Ne s'applique que si |
AppType
L'application du moteur.
| Enums | |
|---|---|
APP_TYPE_UNSPECIFIED |
Toutes les applications non spécifiées. |
APP_TYPE_INTRANET |
Type d'application pour la recherche sur l'intranet et Agentspace. |
ChatEngineConfig
Configurations pour un Chat Engine.
| Champs | |
|---|---|
agent_creation_config |
La configuration génère l'agent Dialogflow associé à ce moteur. Notez que ces configurations sont utilisées une seule fois par le service Dialogflow et lui sont transmises. Cela signifie qu'ils ne peuvent pas être récupérés à l'aide des API |
dialogflow_agent_to_link |
Nom de ressource d'un agent Dialogflow existant à associer à ce Chat Engine. Les clients peuvent soit fournir Format : Notez que les |
allow_cross_region |
Facultatif. Si le signal est défini sur "true", l'agent et le moteur peuvent se trouver à des emplacements différents. Sinon, ils doivent se trouver au même emplacement. Par défaut, l'indicateur est défini sur "false". Notez que les |
AgentCreationConfig
Configurations permettant de générer un agent Dialogflow.
Notez que ces configurations sont utilisées une seule fois par le service Dialogflow et lui sont transmises. Cela signifie qu'ils ne peuvent pas être récupérés à l'aide des API EngineService.GetEngine ou EngineService.ListEngines après la création du moteur.
| Champs | |
|---|---|
business |
Nom de l'entreprise, de l'organisation ou de toute autre entité que l'agent représente. Utilisé pour l'invite LLM du connecteur de connaissances et pour la recherche de connaissances. |
default_language_code |
Obligatoire. Langue par défaut de l'agent en tant que tag de langue. Consultez la section Langues acceptées pour obtenir la liste des codes de langue actuellement compatibles. |
time_zone |
Obligatoire. Le fuseau horaire de l'agent à partir de la base de données de fuseaux horaires, par exemple, Amérique/New_York, Europe/Paris. |
location |
Emplacement de l'agent à créer. Les valeurs acceptées sont "global", "us" et "eu". Si aucune valeur n'est fournie, le moteur US créera l'agent en utilisant us-central-1 par défaut, tandis que le moteur EU créera l'agent en utilisant eu-west-1 par défaut. |
ChatEngineMetadata
Informations supplémentaires sur un Chat Engine. Les champs de ce message sont en sortie uniquement.
| Champs | |
|---|---|
dialogflow_agent |
Nom de ressource d'un agent Dialogflow auquel ce Chat Engine fait référence. Format : |
CommonConfig
Configurations courantes d'un moteur.
| Champs | |
|---|---|
company_name |
Nom de l'entreprise, de l'établissement ou de l'entité associés au moteur. Cela peut aider à améliorer les fonctionnalités liées aux LLM. |
ConfigurableBillingApproach
Configuration de l'approche de facturation configurable.
| Enums | |
|---|---|
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED |
Valeur par défaut. Pour l'approche de facturation non configurable Spark et non Spark. Modèle de tarification général. |
CONFIGURABLE_BILLING_APPROACH_ENABLED |
L'approche de facturation suit les configurations spécifiées par le client. |
FeatureState
État de la fonctionnalité pour le moteur.
| Enums | |
|---|---|
FEATURE_STATE_UNSPECIFIED |
L'état de la fonctionnalité n'est pas spécifié. |
FEATURE_STATE_ON |
La fonctionnalité est activée pour être accessible. |
FEATURE_STATE_OFF |
La fonctionnalité est désactivée et donc inaccessible. |
MediaRecommendationEngineConfig
Spécifications de configuration supplémentaires pour un moteur de recommandation de contenus multimédias.
| Champs | |
|---|---|
type |
Obligatoire. Type de moteur (par exemple, Ce champ et Valeurs actuellement acceptées : |
optimization_objective |
Objectif d'optimisation (par exemple, Ce champ et Valeurs actuellement acceptées : Si aucune valeur n'est spécifiée, nous choisissons une valeur par défaut en fonction du type de moteur. La valeur par défaut dépend du type de recommandation :
|
optimization_objective_config |
Nom et valeur du seuil personnalisé pour l'objectif d'optimisation du taux de conversion. Pour target_field |
training_state |
État d'entraînement du moteur (par exemple, Étant donné qu'une partie du coût d'exécution du service est liée à la fréquence d'entraînement, cela peut être utilisé pour déterminer quand entraîner le moteur afin de contrôler les coûts. Si aucune valeur n'est spécifiée, la valeur par défaut pour la méthode |
engine_features_config |
Facultatif. Configuration des fonctionnalités supplémentaires du moteur. |
EngineFeaturesConfig
Plus de configurations de fonctionnalités pour le type de moteur sélectionné.
| Champs | |
|---|---|
Champ d'union type_dedicated_config. Configurations liées aux fonctionnalités appliquées à un type spécifique de moteurs de recommandation de contenu multimédia. type_dedicated_config ne peut être qu'un des éléments suivants : |
|
recommended_for_you_config |
Configuration de la fonctionnalité du moteur "Recommandé pour vous". |
most_popular_config |
Configuration des fonctionnalités du moteur les plus populaires. |
MostPopularFeatureConfig
Configurations de caractéristiques requises pour créer un moteur "Les plus populaires".
| Champs | |
|---|---|
time_window_days |
Période pendant laquelle le moteur est interrogé lors de l'entraînement et de la prédiction. Entiers positifs uniquement. La valeur correspond aux événements des X derniers jours. Actuellement requis pour le moteur |
OptimizationObjectiveConfig
Seuil personnalisé pour l'objectif d'optimisation cvr.
| Champs | |
|---|---|
target_field |
Obligatoire. Nom du champ à cibler. Valeurs actuellement acceptées : |
target_field_value_float |
Obligatoire. Seuil à appliquer à la cible (par exemple, 0,5). |
RecommendedForYouFeatureConfig
Configurations de fonctionnalités supplémentaires pour créer un moteur recommended-for-you.
| Champs | |
|---|---|
context_event_type |
Type d'événement avec lequel le moteur est interrogé au moment de la prédiction. Si la valeur est définie sur |
TrainingState
État d'entraînement du moteur.
| Enums | |
|---|---|
TRAINING_STATE_UNSPECIFIED |
État d'entraînement non spécifié. |
PAUSED |
L'entraînement du moteur est suspendu. |
TRAINING |
Le moteur est en cours d'entraînement. |
SearchEngineConfig
Configurations d'un moteur de recherche.
| Champs | |
|---|---|
search_tier |
Niveau de fonctionnalité de recherche de ce moteur. Les prix peuvent varier d'un niveau à l'autre. Pour en savoir plus, consultez la documentation sur les tarifs. En l'absence de spécification, la valeur par défaut est |
search_add_ons[] |
Module complémentaire activé par ce moteur de recherche. |
FactChunk
Morceau de fait.
| Champs | |
|---|---|
chunk_text |
Contenu textuel du bloc de faits. Ne doit pas dépasser 10 000 caractères. |
source |
Source à partir de laquelle ce bloc de faits a été récupéré. Si le bloc a été récupéré à partir des GroundingFacts fournis dans la requête, ce champ contient l'index du fait spécifique à partir duquel il a été récupéré. |
index |
Index de ce fragment. Actuellement utilisé uniquement pour le mode streaming. |
source_metadata |
Informations plus précises sur la référence source. |
uri |
URI de la source. |
title |
Titre de la source. |
domain |
Domaine de la source. |
FetchDomainVerificationStatusRequest
Message de requête pour la méthode SiteSearchEngineService.FetchDomainVerificationStatus.
| Champs | |
|---|---|
site_search_engine |
Obligatoire. Ressource du moteur de recherche sur le site à partir de laquelle nous récupérons l'état de validation du domaine. |
page_size |
Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée. |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
FetchDomainVerificationStatusResponse
Message de réponse pour la méthode SiteSearchEngineService.FetchDomainVerificationStatus.
| Champs | |
|---|---|
target_sites[] |
Liste des TargetSites contenant l'état de validation du site. |
next_page_token |
Jeton pouvant être envoyé en tant que |
total_size |
Nombre total d'éléments correspondant à la requête. Cette information sera toujours fournie dans la réponse. |
FetchSitemapsRequest
Message de requête pour la méthode SiteSearchEngineService.FetchSitemaps.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente de |
matcher |
Facultatif. Si spécifié, récupère les |
Matcher
Matcher pour les Sitemap. Actuellement, seul le comparateur d'URI est compatible.
| Champs | |
|---|---|
Champ d'union matcher. Matcher pour les Sitemap. La matcher ne peut être qu'un des éléments suivants : |
|
uris_matcher |
Matcher par URI de sitemap. |
UrisMatcher
Matcher pour les Sitemap par leurs URI.
| Champs | |
|---|---|
uris[] |
URI |
FetchSitemapsResponse
Message de réponse pour la méthode SiteSearchEngineService.FetchSitemaps.
| Champs | |
|---|---|
sitemaps_metadata[] |
Liste des |
SitemapMetadata
Contient un Sitemap et ses métadonnées.
| Champs | |
|---|---|
sitemap |
|
FhirStoreSource
Données d'importation de la source Cloud FhirStore.
| Champs | |
|---|---|
fhir_store |
Obligatoire. Nom complet de la ressource du magasin FHIR à partir duquel importer des données, au format |
gcs_staging_dir |
Répertoire Cloud Storage intermédiaire utilisé pour l'importation (limite de 2 000 caractères). Peut être spécifié si vous souhaitez que FhirStore exporte les données vers un répertoire Cloud Storage particulier. |
resource_types[] |
Types de ressources FHIR à importer. Les types de ressources doivent être un sous-ensemble de tous les types de ressources FHIR acceptés. Par défaut, tous les types de ressources FHIR compatibles sont utilisés si ce champ est vide. |
update_from_latest_predefined_schema |
Facultatif. Indique s'il faut mettre à jour le schéma DataStore vers le dernier schéma prédéfini. Si la valeur est "true", le schéma DataStore sera mis à jour pour inclure tous les champs ou types de ressources FHIR qui ont été ajoutés depuis la dernière importation, et les ressources FHIR correspondantes seront importées depuis le store FHIR. Notez que ce champ ne peut pas être utilisé conjointement avec |
FirestoreSource
Données d'importation de la source Firestore.
| Champs | |
|---|---|
project_id |
ID du projet dans lequel se trouve la source Cloud SQL (limite de 128 caractères). S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
database_id |
Obligatoire. Base de données Firestore à partir de laquelle copier les données, avec une limite de 256 caractères. |
collection_id |
Obligatoire. Collection (ou entité) Firestore à partir de laquelle copier les données,avec une limite de 1 500 caractères. |
gcs_staging_dir |
Répertoire Cloud Storage intermédiaire utilisé pour l'importation (limite de 2 000 caractères). Peut être spécifié si vous souhaitez que Firestore exporte les données vers un répertoire Cloud Storage particulier. Assurez-vous que le compte de service Firestore dispose des autorisations d'administrateur Cloud Storage nécessaires pour accéder au répertoire Cloud Storage spécifié. |
GcsSource
Emplacement Cloud Storage pour le contenu d'entrée.
| Champs | |
|---|---|
input_uris[] |
Obligatoire. URI Cloud Storage pour les fichiers d'entrée. Chaque URI peut comporter jusqu'à 2 000 caractères. Les URI peuvent correspondre au chemin d'accès complet à l'objet (par exemple, Une requête peut contenir au maximum 100 fichiers (ou 100 000 fichiers si |
data_schema |
Schéma à utiliser lors de l'analyse des données de la source. Valeurs acceptées pour les importations de documents :
Valeurs acceptées pour les importations d'événements utilisateur :
|
GetAclConfigRequest
Message de requête pour la méthode GetAclConfigRequest.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de Si l'appelant n'est pas autorisé à accéder au |
GetAnswerRequest
Requête pour la méthode GetAnswer.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la réponse à récupérer. Format : |
GetAssistAnswerRequest
Message de requête pour la méthode AssistAnswerService.GetAssistAnswer.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de |
GetAssistantRequest
Message de requête pour la méthode AssistantService.GetAssistant.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de |
GetCmekConfigRequest
Message de requête pour la méthode GetCmekConfigRequest.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de Si l'appelant n'est pas autorisé à accéder au |
GetControlRequest
Requête pour la méthode GetControl.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du contrôle à récupérer. Format : |
GetConversationRequest
Requête pour la méthode GetConversation.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la conversation à récupérer. Format : |
GetDataConnectorRequest
Requête pour la méthode DataConnectorService.GetDataConnector.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
GetDataStoreRequest
Message de requête pour la méthode DataStoreService.GetDataStore.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
GetDocumentRequest
Message de requête pour la méthode DocumentService.GetDocument.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder à Si le |
GetEngineRequest
Message de requête pour la méthode EngineService.GetEngine.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource |
GetIdentityMappingStoreRequest
Message de requête pour IdentityMappingStoreService.GetIdentityMappingStore
| Champs | |
|---|---|
name |
Obligatoire. Nom du magasin de mappage d'identité à obtenir. Format : |
GetLicenseConfigRequest
Message de requête pour la méthode LicenseConfigService.GetLicenseConfig.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
GetSchemaRequest
Message de requête pour la méthode SchemaService.GetSchema.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource du schéma, au format |
GetSessionRequest
Requête pour la méthode GetSession.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de la session à récupérer. Format : |
include_answer_details |
Facultatif. Si la valeur est "true", la session complète, y compris tous les détails des réponses, sera renvoyée. |
GetSiteSearchEngineRequest
Message de requête pour la méthode SiteSearchEngineService.GetSiteSearchEngine.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource de Si l'appelant n'est pas autorisé à accéder à [SiteSearchEngine], qu'il existe ou non, une erreur PERMISSION_DENIED est renvoyée. |
GetTargetSiteRequest
Message de requête pour la méthode SiteSearchEngineService.GetTargetSite.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource Si l'appelant n'est pas autorisé à accéder au Si le |
GroundingFact
Ancrage factuel.
| Champs | |
|---|---|
fact_text |
Contenu textuel du fait. Ne doit pas dépasser 10 000 caractères. |
attributes |
Attributs associés au fait. Les attributs courants incluent |
HarmCategory
Catégories de préjudice qui bloquent le contenu.
| Enums | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
La catégorie de préjudice n'est pas spécifiée. |
HARM_CATEGORY_HATE_SPEECH |
La catégorie de préjudice est "incitation à la haine". |
HARM_CATEGORY_DANGEROUS_CONTENT |
La catégorie de préjudice est "contenu dangereux". |
HARM_CATEGORY_HARASSMENT |
La catégorie de préjudice est "harcèlement". |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
La catégorie de préjudice est "contenu à caractère sexuel explicite". |
HARM_CATEGORY_CIVIC_INTEGRITY |
La catégorie de préjudice est "intégrité civique". |
HealthcareFhirConfig
Configurer le data store pour le secteur HEALTHCARE_FHIR.
| Champs | |
|---|---|
enable_configurable_schema |
Indique si le schéma configurable doit être activé pour le secteur Si la valeur est définie sur |
enable_static_indexing_for_batch_ingestion |
Indique s'il faut activer l'indexation statique pour l'ingestion par lot Si la valeur est définie sur |
IdentityMappingEntry
Entrée de mappage d'identité qui mappe une identité externe à une identité interne.
| Champs | |
|---|---|
external_identity |
Obligatoire. Identité en dehors du fournisseur d'identité du client. La limite de longueur de l'identité externe est de 100 caractères. |
Champ d'union identity_provider_id. Champ d'union identity_provider_id. L'ID du fournisseur d'identité peut être un utilisateur ou un groupe. identity_provider_id ne peut être qu'un des éléments suivants : |
|
user_id |
Identifiant utilisateur. Pour un compte utilisateur Google Workspace, user_id doit correspondre à l'adresse e-mail de l'utilisateur Google Workspace. Pour un fournisseur d'identité non Google, user_id correspond à l'identifiant utilisateur mappé configuré lors de la configuration du pool d'employés. |
group_id |
Identifiant du groupe. Pour un compte utilisateur Google Workspace, group_id doit correspondre à l'adresse e-mail du groupe Google Workspace. Pour un fournisseur d'identité non Google, group_id correspond à l'identifiant de groupe mappé configuré lors de la configuration du pool de collaborateurs. |
IdentityMappingEntryOperationMetadata
Métadonnées IdentityMappingEntry LongRunningOperation pour IdentityMappingStoreService.ImportIdentityMappings et IdentityMappingStoreService.PurgeIdentityMappings
| Champs | |
|---|---|
success_count |
Nombre d'IdentityMappingEntries traitées avec succès. |
failure_count |
Nombre d'IdentityMappingEntries dont le traitement a échoué. |
total_count |
Nombre total d'IdentityMappingEntries traités. |
IdentityMappingStore
Magasin de mappage d'identité contenant des entrées de mappage d'identité.
| Champs | |
|---|---|
name |
Immuable. Nom complet de la ressource du magasin de mappages d'identité. Format : |
kms_key_name |
Uniquement en entrée. Clé KMS à utiliser pour protéger ce magasin de mappage des identités au moment de la création. Doit être défini pour les requêtes qui doivent respecter les protections des règles d'administration CMEK. Si ce champ est défini et traité correctement, le magasin de mappage des identités sera protégé par la clé KMS, comme indiqué dans le champ cmek_config. |
cmek_config |
Uniquement en sortie. Informations liées aux CMEK pour le magasin de mappage des identités. |
IdentityScheduleConfig
Configuration des exécutions de synchronisation des données d'identité.
| Champs | |
|---|---|
refresh_interval |
Facultatif. Intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès pour les documents ingérés par ce connecteur. Si cette règle n'est pas configurée, la liste de contrôle des accès sera actualisée à l'intervalle par défaut de 30 minutes. L'intervalle d'actualisation de l'identité peut être d'au moins 30 minutes et d'au plus 7 jours. |
next_sync_time |
Facultatif. Heure UTC à laquelle la prochaine synchronisation des données devrait commencer pour le connecteur de données. Les clients ne peuvent spécifier que l'heure et la minute pour planifier la synchronisation des données. Cette option est utilisée lorsque le connecteur de données a un intervalle d'actualisation supérieur à un jour. |
IdpConfig
Configuration du fournisseur d'identité
| Champs | |
|---|---|
idp_type |
Type de fournisseur d'identité configuré. |
external_idp_config |
Configuration du fournisseur d'identité externe. |
ExternalIdpConfig
Configuration d'un fournisseur d'identité tiers
| Champs | |
|---|---|
workforce_pool_name |
Nom du pool d'employés. Exemple : "locations/global/workforcePools/pool_id" |
IdpType
Type de fournisseur d'identité.
| Enums | |
|---|---|
IDP_TYPE_UNSPECIFIED |
Valeur par défaut. La recherche de LCA n'est pas activée. |
GSUITE |
Fournisseur first party de Google. |
THIRD_PARTY |
Fournisseur tiers |
ImportCompletionSuggestionsMetadata
Métadonnées liées à la progression de l'opération ImportCompletionSuggestions. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Nombre de |
failure_count |
Nombre de |
ImportCompletionSuggestionsRequest
Message de requête pour la méthode CompletionService.ImportCompletionSuggestions.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store parent pour lequel importer les suggestions de saisie semi-automatique des clients. Respecte le modèle |
error_config |
Emplacement souhaité des erreurs survenues lors de l'importation. |
Champ d'union source. Source des suggestions de saisie semi-automatique. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée pour les entrées de suggestions. |
gcs_source |
Emplacement Cloud Storage pour le contenu d'entrée. |
bigquery_source |
Source d'entrée BigQuery. |
InlineSource
Source intégrée pour CompletionSuggestions.
| Champs | |
|---|---|
suggestions[] |
Obligatoire. Liste de toutes les entrées de la liste de blocage à importer. 1 000 articles maximum. |
ImportCompletionSuggestionsResponse
Réponse de la méthode CompletionService.ImportCompletionSuggestions. Si l'opération de longue durée est terminée, ce message est renvoyé par le champ google.longrunning.Operations.response si l'opération a réussi.
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
error_config |
Emplacement souhaité des erreurs survenues lors de l'importation. |
ImportDocumentsMetadata
Métadonnées liées à la progression de l'opération ImportDocuments. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Nombre d'entrées traitées avec succès. |
failure_count |
Nombre d'entrées ayant rencontré des erreurs lors du traitement. |
total_count |
Nombre total d'entrées traitées. |
ImportDocumentsRequest
Message de requête pour les méthodes d'importation.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple |
error_config |
Emplacement souhaité des erreurs survenues lors de l'importation. |
reconciliation_mode |
Mode de rapprochement entre les documents existants et ceux à importer. La valeur par défaut est |
update_mask |
Indique les champs des documents importés fournis à mettre à jour. Si elle n'est pas définie, tous les champs sont mis à jour par défaut. |
auto_generate_ids |
Indique si les ID des documents doivent être générés automatiquement en leur absence. Si la valeur est définie sur Sources de données compatibles :
|
id_field |
Ce champ indique le champ ou la colonne d'ID à utiliser comme identifiants uniques des documents. Pour Les valeurs du champ JSON ou de la colonne du tableau sont utilisées comme Ne définissez ce champ que lorsque Si elle n'est pas définie, la valeur par défaut Sources de données compatibles :
|
force_refresh_content |
Facultatif. Indique si le contenu non structuré des documents doit être actualisé de force. Si la valeur est définie sur |
Champ d'union source. Obligatoire. Source de l'entrée. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée pour le contenu d'entrée des documents. |
gcs_source |
Emplacement Cloud Storage pour le contenu d'entrée. |
bigquery_source |
Source d'entrée BigQuery. |
fhir_store_source |
Source d'entrée FhirStore. |
spanner_source |
Source d'entrée Spanner. |
cloud_sql_source |
Source d'entrée Cloud SQL. |
firestore_source |
Source d'entrée Firestore. |
alloy_db_source |
Source d'entrée AlloyDB. |
bigtable_source |
Source d'entrée Cloud Bigtable. |
InlineSource
Source intégrée de la configuration d'entrée pour la méthode ImportDocuments.
| Champs | |
|---|---|
documents[] |
Obligatoire. Liste des documents à mettre à jour ou à créer. Chaque document doit comporter un |
ReconciliationMode
Indique comment les documents importés sont réconciliés avec les documents existants créés ou importés auparavant.
| Enums | |
|---|---|
RECONCILIATION_MODE_UNSPECIFIED |
La valeur par défaut est INCREMENTAL. |
INCREMENTAL |
Insère de nouveaux documents ou met à jour les documents existants. |
FULL |
Calcule la différence et remplace l'ensemble de données de documents complet. Les documents existants peuvent être supprimés s'ils ne sont pas présents dans l'emplacement source. Lorsque vous utilisez ce mode, l'ensemble de données ciblé n'est pas mis hors service. Tout document qui doit rester inchangé ou être mis à jour continuera d'être diffusé pendant l'opération. |
ImportDocumentsResponse
Réponse de ImportDocumentsRequest. Si l'opération de longue durée est terminée, ce message est renvoyé par le champ google.longrunning.Operations.response si l'opération a réussi.
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
error_config |
Si cette option est définie, elle renvoie la destination des erreurs complètes de la requête. |
ImportErrorConfig
Configuration de la destination pour les erreurs liées à l'importation.
| Champs | |
|---|---|
Champ d'union destination. Obligatoire. Destination des erreurs. destination ne peut être qu'un des éléments suivants : |
|
gcs_prefix |
Préfixe Cloud Storage pour les erreurs d'importation. Il doit s'agir d'un répertoire Cloud Storage existant et vide. Les erreurs d'importation sont écrites dans des fichiers fragmentés de ce répertoire, une par ligne, sous forme de message |
ImportIdentityMappingsRequest
Message de requête pour IdentityMappingStoreService.ImportIdentityMappings
| Champs | |
|---|---|
identity_mapping_store |
Obligatoire. Nom du magasin de mappage d'identité dans lequel importer les entrées de mappage d'identité. Format : |
Champ d'union source. Source de l'entrée. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée à partir de laquelle importer les entrées de mappage d'identité. |
InlineSource
Source intégrée à partir de laquelle importer les entrées de mappage d'identité.
| Champs | |
|---|---|
identity_mapping_entries[] |
Vous ne pouvez pas importer plus de 10 000 entrées à la fois. |
ImportIdentityMappingsResponse
Message de réponse pour IdentityMappingStoreService.ImportIdentityMappings
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
ImportSuggestionDenyListEntriesMetadata
Métadonnées liées à la progression de l'opération ImportSuggestionDenyListEntries. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
ImportSuggestionDenyListEntriesRequest
Message de requête pour la méthode CompletionService.ImportSuggestionDenyListEntries.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store parent pour lequel importer les entrées de la liste de refus. Suit le modèle projects/*/locations/*/collections/*/dataStores/*. |
Champ d'union source. Source de la liste SuggestionDenyList mise à jour. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée pour le contenu d'entrée des entrées de la liste des suggestions refusées. |
gcs_source |
Emplacement Cloud Storage pour le contenu d'entrée. Vous ne pouvez spécifier qu'un seul fichier contenant toutes les entrées à importer. Valeurs
|
InlineSource
Source intégrée pour SuggestionDenyListEntry.
| Champs | |
|---|---|
entries[] |
Obligatoire. Liste de toutes les entrées de la liste de blocage à importer. 1 000 articles maximum. |
ImportSuggestionDenyListEntriesResponse
Message de réponse pour la méthode CompletionService.ImportSuggestionDenyListEntries.
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
imported_entries_count |
Nombre d'entrées de la liste de refus importées. |
failed_entries_count |
Nombre d'entrées de la liste de refus qui n'ont pas pu être importées. |
ImportUserEventsMetadata
Métadonnées liées à la progression de l'opération d'importation. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Nombre d'entrées traitées avec succès. |
failure_count |
Nombre d'entrées ayant rencontré des erreurs lors du traitement. |
ImportUserEventsRequest
Message de requête pour la requête ImportUserEvents.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource DataStore parent, au format |
error_config |
Emplacement souhaité des erreurs survenues lors de l'importation. Ne peut pas être défini pour les importations d'événements utilisateur intégrées. |
Champ d'union source. Obligatoire : source d'entrée souhaitée pour les données d'événement utilisateur. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée du contenu d'entrée pour UserEvents. |
gcs_source |
Emplacement Cloud Storage pour le contenu d'entrée. |
bigquery_source |
Source d'entrée BigQuery. |
InlineSource
Source intégrée pour la configuration d'entrée de la méthode ImportUserEvents.
| Champs | |
|---|---|
user_events[] |
Obligatoire. Liste des événements utilisateur à importer. Nous recommandons de ne pas dépasser 10 000 éléments. |
ImportUserEventsResponse
Réponse à ImportUserEventsRequest. Si l'opération de longue durée a réussi, ce message est renvoyé par le champ google.longrunning.Operations.response.
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
error_config |
Indique la destination des erreurs complètes si ce champ a été défini dans la requête. |
joined_events_count |
Nombre d'événements utilisateur importés avec des documents existants complets. |
unjoined_events_count |
Nombre d'événements utilisateur importés, mais dont les informations sur le document n'ont pas été trouvées dans la branche existante. |
IndustryVertical
Secteur associé à DataStore.
| Enums | |
|---|---|
INDUSTRY_VERTICAL_UNSPECIFIED |
Valeur utilisée lorsqu'elle n'est pas définie. |
GENERIC |
Catégorie générique pour les documents qui ne sont pas spécifiques à un secteur d'activité. |
MEDIA |
Secteur d'activité des médias. |
HEALTHCARE_FHIR |
Secteur Healthcare FHIR. |
Intervalle
Intervalle à virgule flottante.
| Champs | |
|---|---|
Champ d'union Cette valeur ne doit pas être supérieure à la valeur maximale. Dans le cas contraire, une erreur |
|
minimum |
Limite inférieure incluse. |
exclusive_minimum |
Limite inférieure exclusive. |
Champ d'union Ce champ ne doit pas être inférieur à la valeur minimale. Dans le cas contraire, une erreur |
|
maximum |
Limite supérieure inclusive. |
exclusive_maximum |
Limite supérieure exclusive. |
LicenseConfig
Informations sur les licences des utilisateurs.
| Champs | |
|---|---|
name |
Immuable. Identifiant. Nom complet de la configuration de licence. Format : |
license_count |
Obligatoire. Nombre de licences achetées. |
subscription_tier |
Obligatoire. Informations sur le niveau d'abonnement pour la configuration de la licence. |
state |
Uniquement en sortie. État de la configuration de la licence. |
auto_renew |
Facultatif. Indique si la configuration de la licence doit être renouvelée automatiquement à la date de fin. |
start_date |
Obligatoire. Date de début. |
end_date |
Facultatif. Date de fin prévue. |
subscription_term |
Obligatoire. Période d'abonnement. |
free_trial |
Facultatif. Indique si la configuration de licence concerne un essai sans frais. |
alert_policy_resource_config |
Facultatif. Configuration de la règle d'alerte pour cette configuration de licence. |
gemini_bundle |
Uniquement en sortie. Indique si la configuration de licence concerne le bundle Gemini. |
État
Énumération de l'état de la configuration de la licence.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valeur par défaut. La configuration de la licence n'existe pas. |
ACTIVE |
La configuration de la licence est effective et utilisée. |
EXPIRED |
La configuration de la licence a expiré. |
NOT_STARTED |
La configuration de la licence n'a pas encore commencé et sa date de début est dans le futur. |
ListAssistantsRequest
Message de requête pour la méthode AssistantService.ListAssistants.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente. Format : |
page_size |
Nombre maximal de |
page_token |
Jeton de page Lors de la pagination, tous les autres paramètres fournis à |
ListAssistantsResponse
Message de réponse pour la méthode AssistantService.ListAssistants.
| Champs | |
|---|---|
assistants[] |
Tous les |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListCmekConfigsRequest
Message de requête pour la méthode CmekConfigService.ListCmekConfigs.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource de l'emplacement parent, par exemple Si l'appelant n'est pas autorisé à lister les |
ListCmekConfigsResponse
Message de réponse pour la méthode CmekConfigService.ListCmekConfigs.
| Champs | |
|---|---|
cmek_configs[] |
Tous les |
ListControlsRequest
Requête pour la méthode ListControls.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store. Format : |
page_size |
Facultatif. Nombre maximal de résultats sur une page. Si aucune valeur n'est spécifiée, la valeur par défaut est 50. La valeur maximale autorisée est de 1 000. |
page_token |
Facultatif. Jeton de page reçu d'un appel |
filter |
Facultatif. Filtre à appliquer aux résultats de la liste. Fonctionnalités prises en charge :
|
ListControlsResponse
Réponse pour la méthode ListControls.
| Champs | |
|---|---|
controls[] |
Tous les contrôles pour un data store donné. |
next_page_token |
Jeton de pagination. S'il n'est pas renvoyé, cela indique la dernière page. |
ListConversationsRequest
Requête pour la méthode ListConversations.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store. Format : |
page_size |
Nombre maximal de résultats sur une page. Si aucune valeur n'est spécifiée, la valeur par défaut est 50. La valeur maximale autorisée est de 1 000. |
page_token |
Jeton de page reçu d'un appel |
filter |
Filtre à appliquer aux résultats de la liste. Les fonctionnalités compatibles sont les suivantes : user_pseudo_id et state. Exemple : "user_pseudo_id = some_id" |
order_by |
Liste de champs séparés par une virgule selon lesquels trier les résultats, dans l'ordre croissant. Utilisez "desc" après un nom de champ pour l'ordre décroissant. Champs acceptés : * Exemple : "update_time desc" "create_time" |
ListConversationsResponse
Réponse pour la méthode ListConversations.
| Champs | |
|---|---|
conversations[] |
Toutes les conversations pour un data store donné. |
next_page_token |
Jeton de pagination. S'il n'est pas renvoyé, cela indique la dernière page. |
ListCustomModelsRequest
Message de requête pour la méthode SearchTuningService.ListCustomModels.
| Champs | |
|---|---|
data_store |
Obligatoire. Nom de ressource du data store parent, tel que |
ListCustomModelsResponse
Message de réponse pour la méthode SearchTuningService.ListCustomModels.
| Champs | |
|---|---|
models[] |
Liste des modèles de réglage personnalisé. |
ListDataStoresRequest
Message de requête pour la méthode DataStoreService.ListDataStores.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple Si l'appelant n'est pas autorisé à lister les |
page_size |
Nombre maximal de Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée. |
page_token |
Jeton de page Lors de la pagination, tous les autres paramètres fournis à |
filter |
Filtrez par type de solution . Par exemple : |
ListDataStoresResponse
Message de réponse pour la méthode DataStoreService.ListDataStores.
| Champs | |
|---|---|
data_stores[] |
Tous les |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListDocumentsRequest
Message de requête pour la méthode DocumentService.ListDocuments.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource de branche parente, par exemple Si l'appelant n'est pas autorisé à lister les |
page_size |
Nombre maximal de Si ce champ est négatif, une erreur |
page_token |
Jeton de page Lors de la pagination, tous les autres paramètres fournis à |
ListDocumentsResponse
Message de réponse pour la méthode DocumentService.ListDocuments.
| Champs | |
|---|---|
documents[] |
Les |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListEnginesRequest
Message de requête pour la méthode EngineService.ListEngines.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
page_size |
Facultatif. Non compatible |
page_token |
Facultatif. Non compatible |
filter |
Facultatif. Filtrer par type de solution. Par exemple : solution_type=SOLUTION_TYPE_SEARCH |
ListEnginesResponse
Message de réponse pour la méthode EngineService.ListEngines.
| Champs | |
|---|---|
engines[] |
Tous les |
next_page_token |
Non compatible |
ListIdentityMappingStoresRequest
Message de requête pour IdentityMappingStoreService.ListIdentityMappingStores
| Champs | |
|---|---|
parent |
Obligatoire. Parent des magasins de mappage d'identité à lister. Format : |
page_size |
Nombre maximal de IdentityMappingStores à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est de 1 000. Les valeurs supérieures à 1 000 sont réduites à 1 000. |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
ListIdentityMappingStoresResponse
Message de réponse pour IdentityMappingStoreService.ListIdentityMappingStores
| Champs | |
|---|---|
identity_mapping_stores[] |
Magasins de mappage d'identité |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListIdentityMappingsRequest
Message de requête pour IdentityMappingStoreService.ListIdentityMappings
| Champs | |
|---|---|
identity_mapping_store |
Obligatoire. Nom du magasin de mappage d'identité dans lequel lister les entrées de mappage d'identité. Format : |
page_size |
Nombre maximal de IdentityMappings à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 2 000. La valeur maximale autorisée est de 10 000. Les valeurs supérieures à 10 000 sont réduites à 10 000. |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
ListIdentityMappingsResponse
Message de réponse pour IdentityMappingStoreService.ListIdentityMappings
| Champs | |
|---|---|
identity_mapping_entries[] |
Entrées de mappage d'identité. |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListSchemasRequest
Message de requête pour la méthode SchemaService.ListSchemas.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource du data store parent, au format |
page_size |
Nombre maximal de Si aucune valeur n'est spécifiée, 100 La valeur maximale est 1 000. Les valeurs supérieures sont définies sur 1 000. |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
ListSchemasResponse
Message de réponse pour la méthode SchemaService.ListSchemas.
| Champs | |
|---|---|
schemas[] |
Les |
next_page_token |
Jeton pouvant être envoyé en tant que |
ListSessionsRequest
Requête pour la méthode ListSessions.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store. Format : |
page_size |
Nombre maximal de résultats sur une page. Si aucune valeur n'est spécifiée, la valeur par défaut est 50. La valeur maximale autorisée est de 1 000. |
page_token |
Jeton de page reçu d'un appel |
filter |
Liste de champs séparés par une virgule sur lesquels filtrer, dans la grammaire EBNF. Voici les champs acceptés :
Exemples :
|
order_by |
Liste de champs séparés par une virgule selon lesquels trier les résultats, dans l'ordre croissant. Utilisez "desc" après un nom de champ pour l'ordre décroissant. Champs acceptés :
Exemple :
|
ListSessionsResponse
Réponse pour la méthode ListSessions.
| Champs | |
|---|---|
sessions[] |
Toutes les sessions d'un data store donné. |
next_page_token |
Jeton de pagination. S'il n'est pas renvoyé, cela indique la dernière page. |
ListTargetSitesRequest
Message de requête pour la méthode SiteSearchEngineService.ListTargetSites.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du moteur de recherche sur le site parent, par exemple Si l'appelant n'est pas autorisé à lister les |
page_size |
Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée. |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
ListTargetSitesResponse
Message de réponse pour la méthode SiteSearchEngineService.ListTargetSites.
| Champs | |
|---|---|
target_sites[] |
Liste des TargetSites. |
next_page_token |
Jeton pouvant être envoyé en tant que |
total_size |
Nombre total d'éléments correspondant à la requête. Cette information sera toujours fournie dans la réponse. |
ListUserLicensesRequest
Message de requête pour UserLicenseService.ListUserLicenses.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource parent [UserStore][], au format |
page_size |
Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, la valeur par défaut est 10. La valeur maximale est 50. Les valeurs supérieures sont réduites à 50. Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée. |
page_token |
Facultatif. Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
filter |
Facultatif. Filtre pour la demande de liste. Champs acceptés :
Exemples :
|
ListUserLicensesResponse
Message de réponse pour UserLicenseService.ListUserLicenses.
| Champs | |
|---|---|
user_licenses[] |
Tous les |
next_page_token |
Jeton pouvant être envoyé en tant que |
MediaInfo
Informations sur les événements utilisateur spécifiques aux médias.
| Champs | |
|---|---|
media_progress_duration |
Le temps de progression du contenu multimédia en secondes, le cas échéant. Par exemple, si l'utilisateur final a regardé 90 secondes d'une vidéo, |
media_progress_percentage |
La progression du contenu multimédia ne doit être calculée qu'à l'aide de Cette valeur doit être comprise entre Si ce n'est pas une lecture ou si la progression ne peut pas être calculée (par exemple, une diffusion en direct en cours), ce champ doit être défini sur "non défini". |
PageInfo
Informations détaillées sur la page.
| Champs | |
|---|---|
pageview_id |
Identifiant unique d'une vue de page Web. Cette valeur doit rester la même pour tous les événements utilisateur déclenchés à partir de la même page vue. Par exemple, une vue de page d'informations sur un article peut déclencher plusieurs événements lorsque l'utilisateur parcourt la page. La propriété Lorsque vous utilisez le reporting des événements côté client avec le pixel JavaScript et Google Tag Manager, cette valeur est renseignée automatiquement. |
page_category |
Catégorie la plus spécifique associée à une page de catégorie. Pour représenter le chemin d'accès complet d'une catégorie, utilisez le signe ">" pour séparer les différentes hiérarchies. Si ">" fait partie du nom de la catégorie, remplacez-le par un ou plusieurs autres caractères. Les pages de catégorie incluent des pages spéciales telles que les pages d'offres ou de promotions. Par exemple, une page d'offre spéciale peut avoir la hiérarchie de catégories suivante : Obligatoire pour les événements |
uri |
URL complète (window.location.href) de la page actuelle de l'utilisateur. Lorsque vous utilisez le reporting des événements côté client avec le pixel JavaScript et Google Tag Manager, cette valeur est renseignée automatiquement. La longueur ne doit pas dépasser 5 000 caractères. |
referrer_uri |
URL de provenance de la page actuelle. Lorsque vous utilisez le reporting des événements côté client avec le pixel JavaScript et Google Tag Manager, cette valeur est renseignée automatiquement. Toutefois, certaines restrictions de confidentialité du navigateur peuvent entraîner la suppression de ce champ. |
PanelInfo
Informations détaillées sur le panneau associées à un événement utilisateur.
| Champs | |
|---|---|
panel_id |
Obligatoire. ID du panneau. |
display_name |
Nom à afficher du panneau. |
documents[] |
Facultatif. ID des documents associés à ce panneau. |
panel_position |
Position ordonnée du panneau, s'il est présenté à l'utilisateur avec d'autres panneaux. Si cette valeur est définie, |
total_panels |
Nombre total de panneaux affichés à l'utilisateur, y compris celui-ci. Doit être défini si |
Compte principal
Identifiant principal d'un utilisateur ou d'un groupe.
| Champs | |
|---|---|
Champ d'union principal. Principal du champ d'union. Le compte principal peut être un utilisateur ou un groupe. principal ne peut être qu'un des éléments suivants : |
|
user_id |
Identifiant utilisateur. Pour un compte utilisateur Google Workspace, user_id doit correspondre à l'adresse e-mail de l'utilisateur Google Workspace. Pour un compte utilisateur de fournisseur d'identité non Google, user_id correspond à l'identifiant utilisateur mappé configuré lors de la configuration du pool d'employés. |
group_id |
Identifiant du groupe. Pour un compte utilisateur Google Workspace, group_id doit correspondre à l'adresse e-mail du groupe Google Workspace. Pour un compte utilisateur de fournisseur d'identité non Google, group_id correspond à l'identifiant de groupe mappé configuré lors de la configuration du pool d'identités des employés. |
external_entity_id |
Pour les identités d'applications tierces qui ne sont pas présentes dans le fournisseur d'identité du client. |
Projet
Métadonnées et configurations d'un projet Google Cloud dans le service.
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom complet de la ressource du projet, par exemple |
create_time |
Uniquement en sortie. Horodatage de la création de ce projet. |
provision_completion_time |
Uniquement en sortie. Code temporel indiquant la date à laquelle ce projet a été provisionné. Une valeur vide signifie que ce projet est toujours en cours de provisionnement et n'est pas prêt à être utilisé. |
service_terms_map |
Uniquement en sortie. Carte des conditions d'utilisation. La clé est le |
customer_provided_config |
Facultatif. Configurations fournies par le client. |
CustomerProvidedConfig
Configurations fournies par le client.
| Champs | |
|---|---|
notebooklm_config |
Facultatif. Configuration des paramètres NotebookLM. |
NotebooklmConfig
Configuration pour NotebookLM.
| Champs | |
|---|---|
model_armor_config |
Configuration Model Armor à utiliser pour désinfecter les requêtes utilisateur et les réponses du LLM. |
ModelArmorConfig
Configuration des modèles Model Armor définis par le client à utiliser pour nettoyer les requêtes utilisateur et les réponses LLM.
| Champs | |
|---|---|
user_prompt_template |
Facultatif. Nom de ressource du modèle Model Armor pour assainir les requêtes utilisateur. Format : projects/{project}/locations/{location}/templates/{template_id}. Si ce champ n'est pas spécifié, aucune désinfection ne sera appliquée à la requête utilisateur. |
response_template |
Facultatif. Nom de ressource du modèle Model Armor permettant d'assainir les réponses des LLM. Format : projects/{project}/locations/{location}/templates/{template_id}. Si aucune valeur n'est spécifiée, aucune désinfection ne sera appliquée à la réponse du LLM. |
ServiceTerms
Métadonnées sur les conditions d'utilisation.
| Champs | |
|---|---|
id |
Identifiant unique des présentes conditions d'utilisation. Termes disponibles :
|
version |
Chaîne de version des conditions d'utilisation. Pour connaître les valeurs acceptables, consultez les commentaires de |
state |
Indique si le projet a accepté ou refusé les conditions d'utilisation du service, ou si la réponse est toujours en attente. |
accept_time |
Dernière date à laquelle le projet a accepté les conditions d'utilisation. |
decline_time |
Date et heure auxquelles le projet a refusé ou révoqué l'acceptation des conditions d'utilisation. |
État
L'accord stipule les présentes conditions d'utilisation.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valeur par défaut de l'énumération. Cette valeur n'est pas réellement utilisée. |
TERMS_ACCEPTED |
Le projet a accepté les conditions d'utilisation. |
TERMS_PENDING |
Le projet est en attente d'examen et d'acceptation des conditions d'utilisation. |
TERMS_DECLINED |
Le projet a refusé ou révoqué l'acceptation des conditions d'utilisation. |
ProvisionProjectMetadata
Ce type ne comporte aucun champ.
Métadonnées associées à une opération de provisionnement de projet.
ProvisionProjectRequest
Requête pour la méthode ProjectService.ProvisionProject.
| Champs | |
|---|---|
name |
Obligatoire. Nom complet de la ressource d'un |
accept_data_use_terms |
Obligatoire. Définissez la valeur sur |
data_use_terms_version |
Obligatoire. Version des Conditions d'utilisation des données que l'appelant a lues et pour lesquelles il souhaite donner son consentement. La version acceptable est |
saas_params |
Facultatif. Paramètres pour Agentspace. |
SaasParams
Paramètres pour Agentspace.
| Champs | |
|---|---|
accept_biz_qos |
Facultatif. Définissez la valeur sur |
is_biz |
Facultatif. Indique si la requête actuelle concerne l'édition Business (true) ou non (false). |
PurgeCompletionSuggestionsMetadata
Métadonnées liées à la progression de l'opération PurgeCompletionSuggestions. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
PurgeCompletionSuggestionsRequest
Message de requête pour la méthode CompletionService.PurgeCompletionSuggestions.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store parent pour lequel les suggestions de saisie doivent être supprimées. Suit le modèle projects/*/locations/*/collections/*/dataStores/*. |
PurgeCompletionSuggestionsResponse
Message de réponse pour la méthode CompletionService.PurgeCompletionSuggestions.
| Champs | |
|---|---|
purge_succeeded |
Indique si les suggestions de saisie ont bien été supprimées. |
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
PurgeDocumentsMetadata
Métadonnées liées à la progression de l'opération PurgeDocuments. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Nombre d'entrées supprimées. |
failure_count |
Nombre d'entrées ayant rencontré des erreurs lors du traitement. |
ignored_count |
Nombre d'entrées ignorées, car elles n'ont pas été trouvées. |
PurgeDocumentsRequest
Message de requête pour la méthode DocumentService.PurgeDocuments.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente, par exemple |
filter |
Obligatoire. Filtrez les documents correspondants à supprimer. La seule valeur actuellement acceptée est |
error_config |
Emplacement souhaité des erreurs rencontrées lors de la suppression. |
force |
Exécute réellement la purge. Si |
Champ d'union source. Source d'entrée souhaitée pour la suppression des documents en fonction de leurs ID. source ne peut être qu'un des éléments suivants : |
|
gcs_source |
Emplacement Cloud Storage pour le contenu d'entrée. |
inline_source |
Source intégrée pour le contenu à supprimer. |
InlineSource
Source intégrée pour la configuration d'entrée de la méthode DocumentService.PurgeDocuments.
| Champs | |
|---|---|
documents[] |
Obligatoire. Liste des noms complets des ressources des documents à supprimer. Au format |
PurgeDocumentsResponse
Message de réponse pour la méthode DocumentService.PurgeDocuments. Si l'opération de longue durée aboutit, ce message est renvoyé par le champ google.longrunning.Operations.response.
| Champs | |
|---|---|
purge_count |
Nombre total de documents supprimés à la suite de l'opération. |
purge_sample[] |
Exemple de noms de documents qui seront supprimés. N'est renseigné que si la valeur de |
PurgeErrorConfig
Configuration de la destination pour les erreurs liées à la suppression.
| Champs | |
|---|---|
Champ d'union destination. Obligatoire. Destination des erreurs. destination ne peut être qu'un des éléments suivants : |
|
gcs_prefix |
Préfixe Cloud Storage pour les erreurs de suppression. Il doit s'agir d'un répertoire Cloud Storage existant et vide. Les erreurs de suppression sont écrites dans des fichiers fragmentés de ce répertoire, une par ligne, sous la forme d'un message |
PurgeIdentityMappingsRequest
Message de requête pour IdentityMappingStoreService.PurgeIdentityMappings
| Champs | |
|---|---|
identity_mapping_store |
Obligatoire. Nom du magasin de mappage d'identité à partir duquel supprimer les entrées de mappage d'identité. Format : |
filter |
Filtrez les mappages d'identité correspondants à supprimer. Le champ permettant le filtrage est le suivant : * Exemples :
Les champs de filtrage sont supposés avoir un AND implicite. Ne doit pas être utilisé avec une source. Une erreur sera générée si les deux sont fournis. |
Champ d'union source. Source de l'entrée. source ne peut être qu'un des éléments suivants : |
|
inline_source |
Source intégrée à partir de laquelle supprimer les entrées de mappage d'identité. |
force |
Exécute réellement la purge. Si |
InlineSource
Source intégrée à partir de laquelle supprimer les entrées de mappage d'identité.
| Champs | |
|---|---|
identity_mapping_entries[] |
Vous pouvez supprimer jusqu'à 10 000 entrées à la fois. |
PurgeSuggestionDenyListEntriesMetadata
Métadonnées liées à la progression de l'opération PurgeSuggestionDenyListEntries. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
PurgeSuggestionDenyListEntriesRequest
Message de requête pour la méthode CompletionService.PurgeSuggestionDenyListEntries.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du data store parent pour lequel importer les entrées de la liste de refus. Suit le modèle projects/*/locations/*/collections/*/dataStores/*. |
PurgeSuggestionDenyListEntriesResponse
Message de réponse pour la méthode CompletionService.PurgeSuggestionDenyListEntries.
| Champs | |
|---|---|
purge_count |
Nombre d'entrées de la liste de blocage des suggestions supprimées définitivement. |
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement de la demande. |
PurgeUserEventsMetadata
Métadonnées liées à la progression de l'opération PurgeUserEvents. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
success_count |
Nombre d'entrées supprimées. |
failure_count |
Nombre d'entrées ayant rencontré des erreurs lors du traitement. |
PurgeUserEventsRequest
Message de requête pour la méthode PurgeUserEvents.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de ressource du catalogue sous lequel les événements sont créés. Il a le format suivant : |
filter |
Obligatoire. Chaîne de filtre permettant de spécifier les événements à supprimer (limite de 5 000 caractères). Les champs éligibles pour le filtrage sont les suivants :
Remarque : Cette API ne permet d'effacer que les données d'une période de 30 jours maximum. Exemples :
Les champs de filtrage sont supposés avoir un AND implicite. |
force |
Le champ |
PurgeUserEventsResponse
Réponse à PurgeUserEventsRequest. Si l'opération de longue durée aboutit, ce message est renvoyé par le champ google.longrunning.Operations.response.
| Champs | |
|---|---|
purge_count |
Nombre total d'événements supprimés à la suite de l'opération. |
Requête
Définit une requête saisie par l'utilisateur.
| Champs | |
|---|---|
query_id |
Uniquement en sortie. ID unique de la requête. |
Champ d'union content. Contenu de la requête. content ne peut être qu'un des éléments suivants : |
|
text |
Texte brut. |
RankRequest
Message de requête pour la méthode RankService.Rank.
| Champs | |
|---|---|
ranking_config |
Obligatoire. Nom de ressource de la configuration du service de classement, par exemple |
model |
Identifiant du modèle à utiliser. Il s'agit de l'un des éléments suivants :
Si aucune valeur n'est spécifiée, la valeur par défaut est |
top_n |
Nombre de résultats à renvoyer. Si cette valeur n'est pas définie ou n'est pas supérieure à zéro, tous les résultats sont renvoyés. |
query |
Requête à utiliser. |
records[] |
Obligatoire. Liste des enregistrements à classer. |
ignore_record_details_in_response |
Si la valeur est "true", la réponse ne contient que l'ID et le score de l'enregistrement. Par défaut, la valeur est "false" et la réponse contient les détails de l'enregistrement. |
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez la documentation Google Cloud. |
RankResponse
Message de réponse pour la méthode RankService.Rank.
| Champs | |
|---|---|
records[] |
Liste des enregistrements triés par score décroissant. |
RankingRecord
Message d'enregistrement pour la méthode RankService.Rank.
| Champs | |
|---|---|
id |
Identifiant unique représentant l'enregistrement. |
title |
Titre de l'enregistrement. Vide par défaut. Vous devez définir au moins l'une des valeurs |
content |
Contenu de l'enregistrement. Vide par défaut. Vous devez définir au moins l'une des valeurs |
score |
Score de cet enregistrement en fonction de la requête donnée et du modèle sélectionné. Le score sera arrondi à deux décimales. Si le score est proche de 0, il est arrondi à 0,0001 pour éviter de renvoyer une valeur non définie. |
RecommendRequest
Message de requête pour la méthode "Recommend".
| Champs | |
|---|---|
serving_config |
Obligatoire. Nom complet de la ressource d'un Une configuration de diffusion par défaut est créée en même temps que votre moteur de recommandations. L'ID du moteur est utilisé comme ID de la configuration de diffusion par défaut. Par exemple, pour le moteur |
user_event |
Obligatoire. Contexte concernant l'utilisateur, ce qu'il regarde et l'action qu'il a effectuée pour déclencher la requête de recommandation. Notez que ces informations détaillées sur l'événement utilisateur ne seront pas ingérées dans les journaux userEvent. Par conséquent, une requête d'écriture userEvent distincte est requise pour la journalisation des événements. Ne définissez pas |
page_size |
Nombre maximal de résultats sur une page. Définissez cette propriété sur le nombre de résultats de recommandation nécessaires. Si la valeur est zéro, le service choisit une valeur par défaut raisonnable. La valeur maximale autorisée est de 100. Les valeurs supérieures à 100 sont définies sur 100. |
filter |
Filtre permettant de limiter les résultats de recommandation (5 000 caractères maximum). Pour le moment, seules les expressions de filtre sur l'attribut Exemples :
Si la valeur de
Si votre filtre bloque tous les résultats, l'API renvoie les documents populaires génériques (non filtrés). Si vous ne souhaitez obtenir que des résultats correspondant exactement aux filtres, définissez Notez que l'API ne renvoie jamais de |
validate_only |
Utilisez le mode validation uniquement pour cette requête de recommandation. Si la valeur est définie sur |
params |
Paramètres supplémentaires spécifiques au domaine pour les recommandations. Valeurs autorisées :
|
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez Exigences relatives aux libellés. |
RecommendResponse
Message de réponse pour la méthode Recommend.
| Champs | |
|---|---|
results[] |
Une liste de documents recommandés. L'ordre représente le classement (du document le plus pertinent au moins pertinent). |
attribution_token |
Jeton d'attribution unique. Cette valeur doit être incluse dans les journaux |
missing_ids[] |
ID des documents de la requête qui manquaient dans la branche par défaut associée à la ServingConfig demandée. |
validate_only |
True si |
RecommendationResult
RecommendationResult représente un résultat de recommandation générique avec des métadonnées associées.
| Champs | |
|---|---|
id |
ID de ressource du document recommandé. |
document |
Définie si |
metadata |
Métadonnées ou annotations supplémentaires du document. Valeurs possibles :
|
RecrawlUrisMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.RecrawlUris. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
invalid_uris[] |
URI uniques de la requête dont le format n'est pas valide. Échantillon limité à 1 000. |
invalid_uris_count |
Nombre total d'URI uniques au format incorrect dans la requête. |
noindex_uris[] |
URI sans balise Meta d'index. Échantillon limité à 1 000. |
noindex_uris_count |
Nombre total d'URI sans balise Meta d'index. |
uris_not_matching_target_sites[] |
Les URI uniques de la requête qui ne correspondent à aucun TargetSite dans le DataStore ne correspondent qu'aux TargetSites qui n'ont pas été entièrement indexés ou à un TargetSite de type EXCLUDE. Échantillon limité à 1 000. |
uris_not_matching_target_sites_count |
Nombre total d'URI ne correspondant à aucun TargetSite. |
valid_uris_count |
Nombre total d'URI uniques dans la requête qui ne figurent pas dans invalid_uris. |
success_count |
Nombre total d'URI explorées jusqu'à présent. |
pending_count |
Nombre total d'URI qui n'ont pas encore été explorés. |
quota_exceeded_count |
Nombre total d'URI refusées en raison de ressources d'indexation insuffisantes. |
RecrawlUrisRequest
Message de requête pour la méthode SiteSearchEngineService.RecrawlUris.
| Champs | |
|---|---|
site_search_engine |
Obligatoire. Nom complet de la ressource |
uris[] |
Obligatoire. Liste des URI à explorer. Au maximum 10 000 URI sont acceptées. Sinon, une erreur INVALID_ARGUMENT est renvoyée. Chaque URI doit correspondre à au moins un |
site_credential |
Facultatif. ID d'identifiant à utiliser pour l'exploration. |
RecrawlUrisResponse
Message de réponse pour la méthode SiteSearchEngineService.RecrawlUris.
| Champs | |
|---|---|
failure_samples[] |
Détails pour un échantillon de 10 |
failed_uris[] |
URI qui n'ont pas été explorés avant la fin de l'opération de longue durée. |
FailureInfo
Détails expliquant pourquoi une URI spécifique n'a pas pu être explorée. Chaque FailureInfo contient une FailureReason par CorpusType.
| Champs | |
|---|---|
uri |
URI qui n'a pas pu être exploré. |
failure_reasons[] |
Liste des raisons d'échec par type de corpus (par exemple, ordinateur, mobile). |
FailureReason
Détails expliquant pourquoi l'exploration a échoué pour un CorpusType spécifique, par exemple : L'exploration sur ORDINATEUR et sur MOBILE peut échouer pour différentes raisons.
| Champs | |
|---|---|
corpus_type |
DESKTOP, MOBILE ou CORPUS_TYPE_UNSPECIFIED. |
error_message |
Raison pour laquelle l'URI n'a pas été explorée. |
CorpusType
CorpusType pour l'opération d'exploration ayant échoué.
| Enums | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
Valeur par défaut. |
DESKTOP |
Indique une tentative d'exploration de la version pour ordinateur d'une page. |
MOBILE |
Indique une tentative d'exploration de la version mobile d'une page. |
Répondre
Définit un message de réponse à l'utilisateur.
| Champs | |
|---|---|
summary |
Résumé basé sur les résultats de recherche. |
SafetyRating
Score de sécurité correspondant au contenu généré.
| Champs | |
|---|---|
category |
Uniquement en sortie. Catégorie de préjudice. |
probability |
Uniquement en sortie. Niveaux de probabilité de préjudice dans le contenu. |
probability_score |
Uniquement en sortie. Score de probabilité de préjudice. |
severity |
Uniquement en sortie. Niveaux de gravité des préjudices dans le contenu. |
severity_score |
Uniquement en sortie. Score de gravité du préjudice. |
blocked |
Uniquement en sortie. Indique si le contenu a été filtré en raison de cette classification. |
HarmProbability
Niveaux de probabilité de préjudice dans le contenu.
| Enums | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
La probabilité de préjudice n'est pas spécifiée. |
NEGLIGIBLE |
Niveau de préjudice négligeable. |
LOW |
Niveau de préjudice faible. |
MEDIUM |
Niveau de préjudice moyen. |
HIGH |
Préjudice élevé. |
HarmSeverity
Niveaux de gravité des préjudices.
| Enums | |
|---|---|
HARM_SEVERITY_UNSPECIFIED |
La gravité du préjudice n'est pas spécifiée. |
HARM_SEVERITY_NEGLIGIBLE |
Niveau de gravité des préjudices négligeable. |
HARM_SEVERITY_LOW |
Niveau de gravité des préjudices faible. |
HARM_SEVERITY_MEDIUM |
Niveau de gravité des préjudices moyen. |
HARM_SEVERITY_HIGH |
Niveau de gravité élevé des préjudices. |
Schéma
Définit la structure et la mise en page d'un type de données de document.
| Champs | |
|---|---|
name |
Immuable. Nom complet de la ressource du schéma, au format Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères. |
Champ d'union schema. Représentation du schéma. Vous devez fournir struct_schema ou json_schema. Sinon, une erreur INVALID_ARGUMENT est générée. schema ne peut être qu'un des éléments suivants : |
|
struct_schema |
Représentation structurée du schéma. |
json_schema |
Représentation JSON du schéma. |
SearchAddOn
Module complémentaire qui fournit des fonctionnalités de recherche supplémentaires.
| Enums | |
|---|---|
SEARCH_ADD_ON_UNSPECIFIED |
Valeur par défaut lorsque l'énumération n'est pas spécifiée. Cette méthode n'est pas valide. |
SEARCH_ADD_ON_LLM |
Module complémentaire Grand modèle de langage. |
SearchInfo
Informations détaillées sur la recherche.
| Champs | |
|---|---|
search_query |
Requête de recherche de l'utilisateur. Pour en savoir plus, consultez La valeur doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 5 000 caractères. Dans le cas contraire, une erreur Au moins l'un des éléments |
order_by |
Ordre dans lequel les produits sont renvoyés, le cas échéant. Consultez La valeur doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 1 000 caractères. Dans le cas contraire, une erreur Cette option ne peut être définie que pour les événements |
offset |
Valeur entière spécifiant le décalage actuel pour la pagination (emplacement de départ indexé sur 0, parmi les produits jugés pertinents par l'API). Pour en savoir plus, consultez Si ce champ est négatif, une erreur Cette option ne peut être définie que pour les événements |
SearchLinkPromotion
Le proto de promotion inclut l'URI et d'autres informations utiles pour afficher la promotion.
| Champs | |
|---|---|
title |
Obligatoire. Titre de la promotion. La longueur maximale est fixée à 160 caractères. |
uri |
Facultatif. URL de la page que l'utilisateur souhaite promouvoir. Doit être défini pour la recherche sur site. Pour les autres secteurs, cette étape est facultative. |
document |
Facultatif. Le |
image_uri |
Facultatif. URL de la vignette de la promotion. |
description |
Facultatif. Description de la promotion. La longueur maximale est fixée à 200 caractères. |
enabled |
Facultatif. La promotion activée sera renvoyée pour toutes les configurations de diffusion associées au parent du contrôle auquel cette promotion est associée. Cette option n'est utilisée que pour la recherche de base sur le site. |
SearchRequest
Message de requête pour la méthode SearchService.Search.
| Champs | |
|---|---|
serving_config |
Obligatoire. Nom de ressource de la configuration de diffusion de la recherche, par exemple |
branch |
Nom de ressource de la branche, par exemple Utilisez |
query |
Requête de recherche brute. |
image_query |
Requête d'image brute. |
page_size |
Nombre maximal de
Si ce champ est négatif, une erreur |
page_token |
Jeton de page reçu d'un appel Lors de la pagination, tous les autres paramètres fournis à |
offset |
Entier à index zéro spécifiant le décalage actuel (c'est-à-dire l'emplacement du résultat de départ parmi les Si ce champ est négatif, une erreur Un décalage important peut être plafonné à un seuil raisonnable. |
one_box_page_size |
Nombre maximal de résultats à renvoyer pour OneBox. Cela s'applique à chaque type de OneBox individuellement. Le nombre par défaut est 10. |
data_store_specs[] |
Spécifications qui définissent les |
filter |
La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. L'expression de filtre est sensible à la casse. Si ce champ n'est pas reconnaissable, un Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété clé définie dans le backend Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client média peut avoir un champ "name" (nom) dans son schéma. Dans ce cas, le filtre se présenterait comme suit : filter --> name:'ANY("king kong")` Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez Filtrer. |
canonical_filter |
Filtre par défaut appliqué lorsqu'un utilisateur effectue une recherche sans cocher de filtres sur la page de recherche. Filtre appliqué à chaque requête de recherche lorsque l'amélioration de la qualité, telle que l'expansion de la requête, est nécessaire. Si une requête ne génère pas suffisamment de résultats, ce filtre sera utilisé pour déterminer s'il faut activer ou non le flux d'expansion de la requête. Le filtre d'origine sera toujours utilisé pour la recherche élargie de la requête. Ce champ est fortement recommandé pour obtenir une qualité de recherche élevée. Pour en savoir plus sur la syntaxe des filtres, consultez |
order_by |
Ordre dans lequel les documents sont renvoyés. Les documents peuvent être triés par champ dans un objet Pour en savoir plus sur l'ordre des résultats de recherche sur le Web, consultez Ordre des résultats de recherche sur le Web. Pour en savoir plus sur l'ordre des résultats de recherche liés à la santé, consultez Ordre des résultats de recherche liés à la santé. Si ce champ n'est pas reconnaissable, un |
user_info |
Informations sur l'utilisateur final. Fortement recommandé pour l'analyse et la personnalisation. |
language_code |
Le code de langue BCP-47 ("en-US" ou "sr-Latn", par exemple). Pour en savoir plus, consultez Champs standards. Ce champ permet de mieux interpréter la requête. Si aucune valeur n'est spécifiée, le code de langue de la requête est détecté automatiquement, ce qui peut ne pas être exact. |
facet_specs[] |
Spécifications des facettes pour la recherche par facettes. Si ce paramètre est vide, aucun facette n'est renvoyé. Vous ne pouvez pas saisir plus de 100 valeurs. Dans le cas contraire, une erreur |
boost_spec |
Spécifiez un boost pour certains documents. Pour en savoir plus sur l'amplification, consultez Amplification. |
params |
Paramètres de recherche supplémentaires. Pour la recherche sur les sites Web publics uniquement, les valeurs acceptées sont les suivantes :
Pour connaître les codes disponibles, consultez Codes pays.
|
query_expansion_spec |
Spécification de l'extension des requêtes qui indique les conditions dans lesquelles l'extension des requêtes se produit. |
spell_correction_spec |
Spécification de la correction orthographique qui indique le mode d'application de la correction orthographique. |
user_pseudo_id |
Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web. Ce champ ne doit PAS avoir de valeur fixe telle que Cet identifiant doit être identique à celui de Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur |
content_search_spec |
Spécification permettant de configurer le comportement de la recherche de contenu. |
ranking_expression |
Facultatif. L'expression de classement contrôle le classement personnalisé des documents récupérés. Cela remplace Si
Fonctions compatibles :
Variables de fonction :
Exemple d'expression de classement : Si le document comporte un champ d'intégration doc_embedding, l'expression de classement peut être Si
Voici quelques exemples de formules de classement qui utilisent les types d'expressions de classement acceptés :
Les signaux suivants sont acceptés :
|
ranking_expression_backend |
Facultatif. Backend à utiliser pour l'évaluation de l'expression de classement. |
safe_search |
Indique si la recherche sécurisée doit être activée. Cette fonctionnalité n'est disponible que pour la recherche sur site Web. |
user_labels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez la documentation Google Cloud. |
natural_language_query_understanding_spec |
Facultatif. Configuration des fonctionnalités de compréhension des requêtes en langage naturel, comme l'extraction des filtres de champs structurés à partir de la requête. Pour en savoir plus, consultez cette documentation. Si |
search_as_you_type_spec |
Configuration de la recherche au fur et à mesure de la saisie. Compatible uniquement avec le secteur |
display_spec |
Facultatif. Configuration de la fonctionnalité d'affichage, comme la mise en surbrillance des correspondances dans les résultats de recherche. |
session |
Nom de la ressource de session. Facultatif. La session permet aux utilisateurs d'effectuer des appels d'API /search multitours ou de coordonner les appels d'API /search et /answer. Exemple 1 (appels d'API /search multitours) : appelez l'API /search avec l'ID de session généré lors du premier appel. Ici, la requête de recherche précédente est prise en compte dans la pertinence de la requête. Par exemple, si la première requête est "Quels ont été les résultats d'Alphabet en 2022 ?" et que la requête actuelle est "Et en 2023 ?", elle sera interprétée comme "Quels ont été les résultats d'Alphabet en 2023 ?". Exemple 2 (coordination entre les appels d'API /search et /answer) : appelez l'API /answer avec l'ID de session généré lors du premier appel. Ici, la génération de la réponse se fait dans le contexte des résultats de recherche du premier appel à la recherche. La fonctionnalité de recherche multitour est actuellement en disponibilité générale privée. Veuillez utiliser la version v1alpha ou v1beta en attendant que nous lancions cette fonctionnalité en disponibilité générale publique. Vous pouvez également demander à être ajouté à la liste d'autorisation auprès de l'équipe d'assistance Google. |
session_spec |
Spécification de la session. Ne peut être utilisé que lorsque |
relevance_threshold |
Seuil de pertinence des résultats de recherche. Utilisez le seuil défini par Google par défaut, en trouvant un équilibre entre précision et rappel pour fournir des résultats très précis et une couverture complète des informations pertinentes. Cette fonctionnalité n'est pas disponible pour la recherche dans le secteur de la santé. |
relevance_score_spec |
Facultatif. Spécification pour renvoyer le score de pertinence. |
BoostSpec
Spécifiez un boost pour certains documents.
| Champs | |
|---|---|
condition_boost_specs[] |
Spécifications du boost de condition. Si un document correspond à plusieurs conditions dans les spécifications, les scores d'amplification de ces spécifications sont tous appliqués et combinés de manière non linéaire. Le nombre maximal de spécifications est de 20. |
ConditionBoostSpec
Le boost s'applique aux documents qui correspondent à une condition.
| Champs | |
|---|---|
condition |
Expression qui spécifie une condition d'optimisation. La syntaxe et les champs acceptés sont les mêmes que ceux d'une expression de filtre. Pour en savoir plus sur la syntaxe et les limites, consultez Exemples :
|
boost |
Intensité du boosting de la condition, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0.0. Définir la valeur sur 1.0 permet de promouvoir fortement le document. Toutefois, cela ne signifie pas nécessairement que le document boosté sera toujours considéré comme le meilleur résultat, ni que d'autres documents seront forcément exclus. De plus, des résultats peuvent toujours être affichés, même si aucun article ne correspond à la condition. De plus, les résultats nettement plus pertinents pour la requête de recherche peuvent toujours l'emporter sur vos documents très privilégiés mais non pertinents. Si vous définissez la valeur sur -1,0, le document est fortement rétrogradé. Toutefois, les résultats très pertinents peuvent toujours être affichés. Le document devra faire face à une concurrence en amont pour obtenir un classement assez élevé, mais il n'est pas complètement bloqué. Si vous définissez la valeur sur 0,0, aucune amélioration n'est appliquée. La condition de boost est ignorée. Seule l'une des combinaisons (condition, boost) ou la spécification boost_control_spec ci-dessous est définie. Si les deux sont définis, l'augmentation globale est ignorée et la spécification boost_control_spec plus précise est appliquée. |
boost_control_spec |
Spécification complexe pour le classement personnalisé basé sur la valeur d'un attribut défini par le client. |
BoostControlSpec
Spécification du classement personnalisé basé sur la valeur d'un attribut spécifié par le client. Il offre plus de contrôles pour un classement personnalisé que la simple combinaison (condition, boost) ci-dessus.
| Champs | |
|---|---|
field_name |
Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost. |
attribute_type |
Type d'attribut à utiliser pour déterminer le montant de l'augmentation. La valeur de l'attribut peut être dérivée de la valeur du champ field_name spécifié. Dans le cas d'un attribut numérique, c'est simple : attribute_value = numerical_field_value. Dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value). |
interpolation_type |
Type d'interpolation à appliquer pour connecter les points de contrôle listés ci-dessous. |
control_points[] |
Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par le biais de l'interpolation_type ci-dessus) passe par les points de contrôle listés ici. |
AttributeType
Attribut(ou fonction) auquel le classement personnalisé doit être appliqué.
| Enums | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
Type d'attribut non spécifié. |
NUMERICAL |
La valeur du champ numérique sera utilisée pour mettre à jour dynamiquement le montant du boost. Dans ce cas, la valeur d'attribut (valeur x) du point de contrôle sera la valeur réelle du champ numérique pour lequel boost_amount est spécifié. |
FRESHNESS |
Dans le cas d'utilisation de la fraîcheur, la valeur de l'attribut correspond à la durée entre l'heure actuelle et la date spécifiée dans le champ "datetime". La valeur doit être au format XSD dayTimeDuration (sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]]. Par exemple, 5D, 3DT12H30M, T24H. |
ControlPoint
Points de contrôle utilisés pour définir la courbe. La courbe définie par ces points de contrôle ne peut qu'augmenter ou diminuer de manière monotone(les valeurs constantes sont acceptables).
| Champs | |
|---|---|
attribute_value |
Peut être l'une des valeurs suivantes : 1. Valeur numérique du champ. 2. Spécification de la durée de fraîcheur : la valeur doit être mise en forme en tant que valeur |
boost_amount |
Valeur comprise entre -1 et 1 permettant d'augmenter le score si la valeur de l'attribut correspond à la valeur spécifiée ci-dessus. |
InterpolationType
Type d'interpolation à appliquer. La valeur par défaut est "linéaire" (linéaire par morceaux).
| Enums | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
Le type d'interpolation n'est pas spécifié. Dans ce cas, la valeur par défaut est "Linéaire". |
LINEAR |
Une interpolation linéaire par morceaux sera appliquée. |
ContentSearchSpec
Spécification permettant de configurer le comportement de la recherche de contenu.
| Champs | |
|---|---|
snippet_spec |
Si |
summary_spec |
Si |
extractive_content_spec |
Si aucune extractive_content_spec n'est fournie, aucune réponse extractive ne figurera dans la réponse de recherche. |
search_result_mode |
Spécifie le mode des résultats de recherche. Si aucun mode n'est spécifié, le mode de résultat de recherche est défini par défaut sur |
chunk_spec |
Spécifie la spécification du bloc à renvoyer à partir de la réponse de recherche. Disponible uniquement si |
ChunkSpec
Spécifie la spécification du bloc à renvoyer à partir de la réponse de recherche. Disponible uniquement si SearchRequest.ContentSearchSpec.search_result_mode est défini sur CHUNKS
| Champs | |
|---|---|
num_previous_chunks |
Nombre de blocs précédents à renvoyer du bloc actuel. La valeur maximale autorisée est de 3. Si aucune valeur n'est spécifiée, aucun bloc précédent ne sera renvoyé. |
num_next_chunks |
Nombre de blocs suivants à renvoyer du bloc actuel. La valeur maximale autorisée est de 3. Si aucune valeur n'est spécifiée, aucun autre bloc ne sera renvoyé. |
ExtractiveContentSpec
Spécification permettant de configurer le contenu extractif dans une réponse de recherche.
| Champs | |
|---|---|
max_extractive_answer_count |
Nombre maximal de réponses extractives renvoyées dans chaque résultat de recherche. Une réponse extractive est une réponse littérale extraite du document d'origine. Elle fournit une réponse précise et pertinente par rapport au contexte de la requête de recherche. Si le nombre de réponses correspondantes est inférieur à Au maximum cinq réponses sont renvoyées pour chaque |
max_extractive_segment_count |
Nombre maximal de segments extractifs renvoyés dans chaque résultat de recherche. Ne s'applique que si Un segment extractif est un segment de texte extrait du document d'origine qui est pertinent pour la requête de recherche et, en général, plus verbeux qu'une réponse extractive. Le segment peut ensuite être utilisé comme entrée pour les LLM afin de générer des résumés et des réponses. Si le nombre de segments correspondants est inférieur à |
return_extractive_segment_score |
Indique s'il faut renvoyer le score de confiance des segments extractifs dans chaque résultat de recherche. Cette fonctionnalité n'est disponible que pour les nouveaux datastores ou ceux ajoutés à la liste d'autorisation. Pour ajouter votre data store à la liste d'autorisation, contactez votre ingénieur client. La valeur par défaut est |
num_previous_segments |
Indique si les segments adjacents doivent également être inclus pour chaque segment sélectionné. Renvoie au maximum |
num_next_segments |
Renvoie au maximum |
SearchResultMode
Spécifie le mode des résultats de recherche. Si aucun mode n'est spécifié, le mode de résultat de recherche est défini par défaut sur DOCUMENTS.
| Enums | |
|---|---|
SEARCH_RESULT_MODE_UNSPECIFIED |
Valeur par défaut. |
DOCUMENTS |
Renvoie les documents dans les résultats de recherche. |
CHUNKS |
Renvoie des blocs dans le résultat de la recherche. Disponible uniquement si DocumentProcessingConfig.chunking_config est spécifié. |
SnippetSpec
Spécification permettant de configurer des extraits dans une réponse de recherche.
| Champs | |
|---|---|
max_snippet_count |
[OBSOLÈTE] Ce champ est obsolète. Pour contrôler le retour d'extrait, utilisez le champ |
reference_only |
[OBSOLÈTE] Ce champ est obsolète et n'aura aucun effet sur l'extrait. |
return_snippet |
Si |
SummarySpec
Spécification permettant de configurer un résumé renvoyé dans une réponse de recherche.
| Champs | |
|---|---|
summary_result_count |
Nombre de meilleurs résultats à partir desquels générer le résumé. Si le nombre de résultats renvoyés est inférieur à Vous pouvez utiliser au maximum 10 résultats pour le mode "Documents" ou 50 pour le mode "Blocs" afin de générer un résumé. Le mode "chunks" est utilisé lorsque |
include_citations |
Indique si les citations doivent être incluses dans le résumé. La valeur par défaut est Lorsque ce champ est défini sur Exemple de résumé incluant des citations : BigQuery est l'entrepôt de données d'entreprise sans serveur et entièrement géré de Google Cloud [1]. BigQuery est compatible avec tous les types de données, fonctionne sur plusieurs clouds et intègre des technologies de machine learning et d'informatique décisionnelle, le tout dans une plate-forme unifiée [2, 3]. Les numéros de citation font référence aux résultats de recherche renvoyés et sont indexés à partir de 1. Par exemple, [1] signifie que la phrase est attribuée au premier résultat de recherche. [2, 3] signifie que la phrase est attribuée aux deuxième et troisième résultats de recherche. |
ignore_adversarial_query |
Indique s'il faut filtrer les requêtes contradictoires. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes adverses. Aucun résumé n'est renvoyé si la requête de recherche est classée comme requête contradictoire. Par exemple, un utilisateur peut poser une question concernant des commentaires négatifs sur l'entreprise ou envoyer une requête conçue pour générer des résultats dangereux ou qui ne respectent pas les règles. Si ce champ est défini sur |
ignore_non_summary_seeking_query |
Indique s'il faut filtrer les requêtes qui ne cherchent pas à obtenir un résumé. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes visant à obtenir un résumé. Aucun résumé n'est renvoyé si la requête de recherche est classée comme ne cherchant pas de résumé. Par exemple, |
ignore_low_relevant_content |
Indique s'il faut filtrer les requêtes peu pertinentes. La valeur par défaut est Si ce champ est défini sur |
ignore_jail_breaking_query |
Facultatif. Indique s'il faut filtrer les requêtes de contournement des restrictions. La valeur par défaut est Google utilise la classification des requêtes de recherche pour détecter les requêtes de contournement. Aucun résumé n'est renvoyé si la requête de recherche est classée comme une requête de contournement. Un utilisateur peut ajouter des instructions à la requête pour modifier le ton, le style, la langue ou le contenu de la réponse, ou demander au modèle d'agir en tant qu'entité différente (par exemple, "Réponds sur le ton du PDG d'une entreprise concurrente"). Si ce champ est défini sur |
model_prompt_spec |
Si elle est spécifiée, la spécification sera utilisée pour modifier la requête fournie au LLM. |
language_code |
Code de langue du résumé. Utilisez les balises de langue définies par BCP47. Remarque : Il s'agit d'une fonctionnalité expérimentale. |
model_spec |
Si elle est spécifiée, la spécification sera utilisée pour modifier la spécification du modèle fournie au LLM. |
use_semantic_chunks |
Si la valeur est "true", la réponse sera générée à partir des blocs les plus pertinents des meilleurs résultats de recherche. Cette fonctionnalité améliorera la qualité des résumés. Notez que si cette fonctionnalité est activée, tous les premiers résultats de recherche ne seront pas référencés ni inclus dans la liste de références. L'index des sources de citation ne pointe donc que vers les résultats de recherche figurant dans la liste de références. |
ModelPromptSpec
Spécification de la requête à utiliser avec le modèle.
| Champs | |
|---|---|
preamble |
Texte au début de la requête qui donne des instructions à l'assistant. Des exemples sont disponibles dans le guide de l'utilisateur. |
ModelSpec
Spécification du modèle.
| Champs | |
|---|---|
version |
Version du modèle utilisée pour générer le résumé. Les valeurs compatibles sont :
|
DataStoreSpec
Structure permettant de définir les data stores à filtrer dans un appel de recherche et les configurations de ces data stores. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.
| Champs | |
|---|---|
data_store |
Obligatoire. Nom complet de la ressource |
filter |
Facultatif. Spécification de filtre permettant de filtrer les documents dans le data store spécifié par le champ "data_store". Pour en savoir plus sur le filtrage, consultez Filtrage. |
boost_spec |
Facultatif. Spécifiez un boost pour certains documents. Pour en savoir plus sur l'amplification, consultez Amplification. |
custom_search_operators |
Facultatif. Opérateurs de recherche personnalisés qui, s'ils sont spécifiés, seront utilisés pour filtrer les résultats des datastores de l'espace de travail. Pour en savoir plus sur les opérateurs de recherche personnalisés, consultez SearchOperators. |
DisplaySpec
Spécifie les fonctionnalités à afficher, comme la mise en surbrillance des correspondances.
| Champs | |
|---|---|
match_highlighting_condition |
Condition dans laquelle la mise en surbrillance des correspondances doit se produire. |
MatchHighlightingCondition
Énumération décrivant la condition dans laquelle la mise en surbrillance des correspondances doit se produire.
| Enums | |
|---|---|
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED |
Le comportement du serveur est identique à celui de MATCH_HIGHLIGHTING_DISABLED. |
MATCH_HIGHLIGHTING_DISABLED |
Désactive la mise en surbrillance des correspondances dans tous les documents. |
MATCH_HIGHLIGHTING_ENABLED |
Permet de mettre en surbrillance les correspondances dans tous les documents. |
FacetSpec
Spécification d'attribut permettant d'effectuer une recherche par attribut.
| Champs | |
|---|---|
facet_key |
Obligatoire. Spécification de la clé de facette. |
limit |
Nombre maximal de valeurs d'attributs renvoyées pour cet attribut. Si aucune valeur n'est spécifiée, la valeur par défaut est 20. La valeur maximale autorisée est de 300. Les valeurs supérieures à 300 sont réduites à 300. Pour l'agrégation dans la recherche médicale, lorsque [FacetKey.key] est défini sur "healthcare_aggregation_key", la limite est remplacée par 10 000 en interne, quelle que soit la valeur définie ici. Si ce champ est négatif, une erreur |
excluded_filter_keys[] |
Liste des clés à exclure lors de la création de facettes. Par défaut, Si vous indiquez une clé d'attribut dans ce champ, ses valeurs peuvent apparaître en tant que résultats d'attributs, même si elles sont filtrées dans les résultats de recherche. L'utilisation de ce champ n'a aucune incidence sur les résultats de recherche renvoyés. Par exemple, supposons qu'il existe 100 documents avec l'attribut de couleur "Rouge" et 200 documents avec l'attribut de couleur "Bleu". Une requête contenant le filtre "color:ANY("Red")" et ayant "color" comme Si "color" figure dans "excludedFilterKeys", la requête renvoie les valeurs d'attribut "Red" avec le nombre 100 et "Blue" avec le nombre 200, car la clé "color" est désormais exclue du filtre. Comme ce champ n'affecte pas les résultats de recherche, ils sont toujours correctement filtrés pour ne renvoyer que les documents "Rouge". Vous ne pouvez pas saisir plus de 100 valeurs. Dans le cas contraire, une erreur |
enable_dynamic_position |
Active la position dynamique pour cet attribut. Si la valeur est "true", la position de cette facette parmi toutes les facettes de la réponse est déterminée automatiquement. Si les facettes dynamiques sont activées, elles sont regroupées. Si la valeur est définie sur "false", la position de cet attribut dans la réponse est la même que dans la requête. Il est classé avant les attributs dont la position dynamique est activée et tous les attributs dynamiques. Par exemple, vous pouvez toujours vouloir que le facette de note soit renvoyée dans la réponse, mais il n'est pas nécessaire de toujours l'afficher en haut. Dans ce cas, vous pouvez définir enable_dynamic_position sur "true" afin que la position du facette de note dans la réponse soit déterminée automatiquement. Autre exemple, en supposant que vous ayez les facettes suivantes dans la requête :
Vous avez également activé les facettes dynamiques, ce qui génère une facette |
FacetKey
Spécifie comment un facette est calculée.
| Champs | |
|---|---|
key |
Obligatoire. Clés de facette textuelles et numériques acceptées dans l'objet |
intervals[] |
Ne définissez cette option que si les valeurs doivent être réparties dans des intervalles. Doit être défini pour les facettes avec des valeurs numériques. Ne doit pas être défini pour une facette avec des valeurs de texte. Le nombre maximal d'intervalles est de 30. |
restricted_values[] |
N'obtient la facette que pour les valeurs restreintes spécifiées. (uniquement compatible avec les champs textuels) Par exemple, supposons que "category" comporte trois valeurs : "Action > 2022", "Action > 2021" et "Sci-Fi > 2022". Si vous définissez "restricted_values" sur "Action > 2022", la facette "category" ne contient que "Action > 2022". (uniquement compatible avec les champs textuels) Le maximum est de 10. |
prefixes[] |
N'obtient que les valeurs de facette qui commencent par le préfixe de chaîne donné. Par exemple, supposons que "category" comporte trois valeurs : "Action > 2022", "Action > 2021" et "Sci-Fi > 2022". Si vous définissez "prefixes" sur "Action", la facette "category" ne contient que "Action > 2022" et "Action > 2021". (uniquement compatible avec les champs textuels) Le maximum est de 10. |
contains[] |
N'obtient que les valeurs de facette contenant les chaînes données. Par exemple, supposons que "category" comporte trois valeurs : "Action > 2022", "Action > 2021" et "Sci-Fi > 2022". Si vous définissez "contient" sur "2022", la facette "category" ne contient que "Action > 2022" et "Sci-Fi > 2022". (uniquement compatible avec les champs textuels) Le maximum est de 10. |
case_insensitive |
"True" pour rendre les clés de facette insensibles à la casse lors de l'obtention des valeurs de facette avec des préfixes ou des valeurs "contains", "false" dans le cas contraire. |
order_by |
Ordre dans lequel les documents sont renvoyés. Les valeurs autorisées sont les suivantes :
Si ce champ n'est pas défini, les valeurs textuelles sont triées dans l'ordre naturel, et les intervalles numériques sont triés dans l'ordre indiqué par |
ImageQuery
Spécifie l'entrée de la requête d'image.
| Champs | |
|---|---|
Champ d'union
|
|
image_bytes |
Octets de l'image encodés en base64. Formats d'image acceptés : JPEG, PNG et BMP. |
NaturalLanguageQueryUnderstandingSpec
Spécification permettant d'activer les fonctionnalités de compréhension du langage naturel pour les demandes de recherche.
| Champs | |
|---|---|
filter_extraction_condition |
Condition dans laquelle l'extraction du filtre doit avoir lieu. Le comportement du serveur est défini par défaut sur |
geo_search_query_detection_field_names[] |
Noms de champs utilisés pour le filtrage basé sur la localisation, lorsque des filtres de géolocalisation sont détectés dans les requêtes de recherche en langage naturel. Valide uniquement lorsque FilterExtractionCondition est défini sur Si ce champ est défini, il remplace les noms de champs définis dans |
extracted_filter_behavior |
Facultatif. Contrôle le comportement d'application des filtres extraits à la recherche. Le comportement par défaut dépend de la demande. Pour la recherche structurée dans un seul datastore, la valeur par défaut est |
allowed_field_names[] |
Facultatif. Liste d'autorisation des champs pouvant être utilisés pour l'extraction de filtres en langage naturel. Par défaut, si ce paramètre n'est pas spécifié, tous les champs indexables peuvent être utilisés pour l'extraction de filtres en langage naturel (mais leur utilisation n'est pas garantie). Si des champs sont spécifiés dans allowed_field_names, seuls les champs marqués comme indexables dans le schéma et spécifiés dans la liste d'autorisation seront éligibles à l'extraction de filtres en langage naturel. Remarque : Pour la recherche multidatastore, cette option n'est pas encore disponible et sera ignorée. |
ExtractedFilterBehavior
Énumération décrivant comment les filtres extraits sont appliqués à la recherche.
| Enums | |
|---|---|
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED |
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED utilisera le comportement par défaut pour les filtres extraits. Pour une recherche unique dans le datastore, l'option par défaut consiste à appliquer des filtres stricts. Pour la recherche multidatastore, la valeur par défaut consiste à appliquer des boosts faibles. |
HARD_FILTER |
Applique tous les filtres extraits en tant que filtres stricts sur les résultats. Les résultats qui ne respectent pas les filtres extraits ne seront pas renvoyés dans l'ensemble de résultats. |
SOFT_BOOST |
Applique tous les filtres extraits en tant que boosts modérés. Les résultats qui passent les filtres seront mis en avant et apparaîtront plus haut dans l'ensemble de résultats. |
FilterExtractionCondition
Énumération décrivant la condition dans laquelle l'extraction du filtre doit avoir lieu.
| Enums | |
|---|---|
CONDITION_UNSPECIFIED |
Le comportement du serveur est défini par défaut sur DISABLED. |
DISABLED |
Désactive l'extraction des filtres de langage naturel. |
ENABLED |
Active l'extraction des filtres de langage naturel. |
QueryExpansionSpec
Spécification permettant de déterminer dans quelles conditions l'expansion de requête doit avoir lieu.
| Champs | |
|---|---|
condition |
Condition dans laquelle l'extension de requête doit se produire. Valeur par défaut : |
pin_unexpanded_results |
Indique si les résultats non développés doivent être épinglés. Si ce champ est défini sur "true", les produits non étendus s'affichent toujours en haut des résultats de recherche, suivis des résultats étendus. |
Condition
Énumération décrivant la condition dans laquelle l'expansion de requête doit se produire.
| Enums | |
|---|---|
CONDITION_UNSPECIFIED |
Condition d'expansion des requêtes non spécifiée. Dans ce cas, le comportement du serveur est défini par défaut sur Condition.DISABLED. |
DISABLED |
L'extension des requêtes est désactivée. Seule la requête de recherche exacte est utilisée, même si SearchResponse.total_size est égal à zéro. |
AUTO |
Extension automatique des requêtes générée par l'API Search. |
RankingExpressionBackend
Backend à utiliser pour l'évaluation de l'expression de classement.
| Enums | |
|---|---|
RANKING_EXPRESSION_BACKEND_UNSPECIFIED |
Option par défaut pour les valeurs non spécifiées/inconnues. |
BYOE |
Obsolète : utilisez plutôt |
CLEARBOX |
Obsolète : utilisez plutôt |
RANK_BY_EMBEDDING |
Classement par modèle d'embedding personnalisé, la méthode par défaut pour évaluer l'expression de classement. |
RANK_BY_FORMULA |
Classement par formule personnalisée. |
RelevanceScoreSpec
Spécification pour renvoyer le score de pertinence du document.
| Champs | |
|---|---|
return_relevance_score |
Facultatif. Indique s'il faut renvoyer le score de pertinence pour les résultats de recherche. Plus le score est élevé, plus le document est pertinent par rapport à la requête. |
RelevanceThreshold
Seuil de pertinence des résultats de recherche. Plus le seuil de pertinence est élevé, plus les résultats pertinents sont affichés et moins de résultats sont renvoyés.
| Enums | |
|---|---|
RELEVANCE_THRESHOLD_UNSPECIFIED |
Valeur par défaut. Dans ce cas, le comportement du serveur est défini par défaut sur le seuil défini par Google. |
LOWEST |
Seuil de pertinence le plus bas. |
LOW |
Seuil de pertinence faible. |
MEDIUM |
Seuil de pertinence moyen. |
HIGH |
Seuil de pertinence élevé. |
SearchAsYouTypeSpec
Spécification pour la recherche pendant la saisie dans les requêtes de recherche.
| Champs | |
|---|---|
condition |
Condition dans laquelle la saisie semi-automatique doit se produire. Valeur par défaut : |
Condition
Énumération décrivant les conditions dans lesquelles la recherche à mesure de la saisie doit avoir lieu.
| Enums | |
|---|---|
CONDITION_UNSPECIFIED |
Le comportement du serveur est défini par défaut sur Condition.DISABLED. |
DISABLED |
Désactive l'affichage instantané des résultats. |
ENABLED |
Active l'affichage instantané des résultats. |
AUTO |
Permet de basculer automatiquement entre les modes de recherche "au fur et à mesure de la saisie" et "standard". Idéal pour les implémentations à une seule API (par exemple, la suppression des rebonds). |
SessionSpec
Spécification de la session.
La fonctionnalité de recherche multitour est actuellement en disponibilité générale privée. Veuillez utiliser la version v1alpha ou v1beta en attendant que nous lancions cette fonctionnalité en disponibilité générale publique. Vous pouvez également demander à être ajouté à la liste d'autorisation auprès de l'équipe d'assistance Google.
| Champs | |
|---|---|
query_id |
Si cette option est définie, le résultat de la recherche est stocké dans le "tour" spécifié par cet ID de requête. Exemple : Supposons que la session se présente comme suit : 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" } } } L'utilisateur peut appeler l'API /search avec une requête comme celle-ci : session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } L'API stocke ensuite le résultat de recherche, associé au dernier tour. Le résultat de recherche stocké peut être utilisé par un appel d'API /answer ultérieur (avec l'ID de session et l'ID de requête spécifiés). Il est également possible d'appeler /search et /answer en parallèle avec le même ID de session et ID de requête. |
search_result_persistence_count |
Nombre de meilleurs résultats de recherche à conserver. Les résultats de recherche persistants peuvent être utilisés pour l'appel d'API /answer suivant. Ce champ est semblable au champ 10 résultats maximum en mode Documents ou 50 en mode Blocs. |
SpellCorrectionSpec
Spécification de la correction orthographique des requêtes.
| Champs | |
|---|---|
mode |
Mode dans lequel la correction orthographique remplace la requête de recherche d'origine. La valeur par défaut est |
Mode
Énumération décrivant le mode dans lequel la correction orthographique doit avoir lieu.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Mode de correction orthographique non spécifié. Dans ce cas, le comportement du serveur est défini par défaut sur Mode.AUTO. |
SUGGESTION_ONLY |
L'API Search essaie de trouver une suggestion orthographique. Si une suggestion est trouvée, elle est placée dans SearchResponse.corrected_query. La suggestion orthographique ne sera pas utilisée comme requête de recherche. |
AUTO |
Correction orthographique automatique intégrée à l'API Search. La recherche sera basée sur la requête corrigée, si elle est trouvée. |
SearchResponse
Message de réponse pour la méthode SearchService.Search.
| Champs | |
|---|---|
results[] |
Liste des documents correspondants. L'ordre représente le classement. |
facets[] |
Résultats des facettes demandées par l'utilisateur. |
total_size |
Estimation du nombre total d'éléments correspondants, quelle que soit la pagination. Le nombre de |
attribution_token |
Jeton de recherche unique. Il doit être inclus dans les journaux |
redirect_uri |
URI d'une page de redirection définie par le client. Si une action de redirection est déclenchée, aucune recherche n'est effectuée, et seuls |
next_page_token |
Jeton pouvant être envoyé en tant que |
corrected_query |
Contient la requête corrigée par le correcteur orthographique, le cas échéant. Si le type de correction orthographique est AUTOMATIC, les résultats de recherche sont basés sur corrected_query. Sinon, la requête d'origine est utilisée pour la recherche. |
summary |
Un résumé dans les résultats de recherche. Ce champ n'est renvoyé que si |
query_expansion_info |
Informations sur l'expansion de la requête pour les résultats renvoyés. |
session_info |
Informations sur la session. Défini uniquement si |
search_link_promotions[] |
Promotions pour la recherche sur site. |
Attribut
Résultat d'attribut.
| Champs | |
|---|---|
key |
Clé de cet attribut. Par exemple, |
values[] |
Valeurs d'attribut pour ce champ. |
dynamic_facet |
Indique si le facette est générée de manière dynamique. |
FacetValue
Valeur de facette contenant les noms des valeurs et leur nombre.
| Champs | |
|---|---|
count |
Nombre d'articles associés à cette valeur d'attribut. |
Champ d'union facet_value. Valeur de facette contenant des valeurs. facet_value ne peut être qu'un des éléments suivants : |
|
value |
Valeur textuelle d'un attribut, par exemple "Noir" pour l'attribut "couleurs". |
interval |
Valeur d'intervalle pour un facette, par exemple [10, 20) pour la facette "prix". Il correspond à |
QueryExpansionInfo
Informations décrivant l'expansion de la requête, y compris si elle a eu lieu.
| Champs | |
|---|---|
expanded_query |
Booléen indiquant si l'extension de la requête a eu lieu. |
pinned_result_count |
Nombre de résultats épinglés. Ce champ n'est défini que lorsque l'expansion a lieu et que |
SearchResult
Représente les résultats de recherche.
| Champs | |
|---|---|
id |
|
document |
Extrait de données du document dans la réponse de recherche. Seuls les champs marqués comme |
chunk |
Données de bloc dans la réponse de recherche si |
model_scores |
Uniquement en sortie. Google a fourni les scores disponibles. |
rank_signals |
Facultatif. Ensemble de signaux de classement associés au résultat. |
RankSignals
Ensemble de signaux de classement.
| Champs | |
|---|---|
default_rank |
Facultatif. Rang par défaut du résultat. |
custom_signals[] |
Facultatif. Liste des signaux clearbox personnalisés. |
keyword_similarity_score |
Facultatif. Ajustement de la correspondance des mots clés. |
relevance_score |
Facultatif. Ajustement de la pertinence sémantique. |
semantic_similarity_score |
Facultatif. Ajustement de la similarité sémantique. |
pctr_rank |
Facultatif. Ajustement du taux de conversion prévu sous forme de classement. |
topicality_rank |
Facultatif. Ajustement de la pertinence thématique sous forme de classement. |
document_age |
Facultatif. Âge du document en heures. |
boosting_factor |
Facultatif. Combinaison de boosts personnalisés pour un document. |
CustomSignal
Signal clearbox personnalisé représenté par une paire nom/valeur.
| Champs | |
|---|---|
name |
Facultatif. Nom du signal. |
value |
Facultatif. Valeur flottante représentant le signal de classement (par exemple, 1,25 pour BM25). |
SessionInfo
Informations sur la session.
| Champs | |
|---|---|
name |
Nom de la session. Si le mode de session automatique est utilisé (lorsque |
query_id |
ID de requête correspondant à cet appel de l'API Search. Une session peut comporter plusieurs tours, chacun avec un ID de requête unique. En spécifiant le nom de la session et cet ID de requête dans l'appel de l'API Answer, la réponse est générée dans le contexte des résultats de recherche de cet appel de recherche. |
Résumé
Résumé des N premiers résultats de recherche spécifiés par la spécification du résumé.
| Champs | |
|---|---|
summary_text |
Contenu du résumé. |
summary_skipped_reasons[] |
Autres raisons pour lesquelles le résumé a été ignoré. Indique la raison pour laquelle les cas ont été ignorés. Si rien n'est ignoré, ce champ n'est pas défini. |
safety_attributes |
Ensemble de catégories d'attributs de sécurité et de leurs scores de confiance associés. |
summary_with_metadata |
Résumé avec des informations sur les métadonnées. |
Citation
Informations de citation pour un segment.
| Champs | |
|---|---|
start_index |
L'index indique le début du segment, mesuré en octets/Unicode. |
end_index |
Fin du segment attribué (exclusive). |
sources[] |
Sources de citation pour le segment attribué. |
CitationMetadata
Métadonnées de citation.
| Champs | |
|---|---|
citations[] |
Citations pour les segments. |
CitationSource
Source de la citation.
| Champs | |
|---|---|
reference_index |
Index de référence du document à partir de SummaryWithMetadata.references. Il est indexé à zéro et la valeur sera nulle si l'index de référence n'est pas défini explicitement. |
Référence
Référence au document.
| Champs | |
|---|---|
title |
Titre du document. |
document |
Obligatoire. |
uri |
URI Cloud Storage ou HTTP pour le document. |
chunk_contents[] |
Liste des contenus de blocs cités issus du contenu du document. |
ChunkContent
Contenu segmenté.
| Champs | |
|---|---|
content |
Contenu textuel du bloc. |
page_identifier |
Identifiant de la page. |
SafetyAttributes
Catégories d'attributs de sécurité et leurs scores de confiance associés.
| Champs | |
|---|---|
categories[] |
Noms à afficher des catégories d'attributs de sécurité associées au contenu généré. L'ordre correspond aux scores. |
scores[] |
Les scores de confiance de chaque catégorie, une valeur supérieure, signifie une confiance plus élevée. L'ordre correspond aux catégories. |
SummarySkippedReason
Énumération des raisons pour lesquelles le résumé a été ignoré.
| Enums | |
|---|---|
SUMMARY_SKIPPED_REASON_UNSPECIFIED |
Valeur par défaut. Le motif d'omission du résumé n'est pas spécifié. |
ADVERSARIAL_QUERY_IGNORED |
Requête antagoniste (sans tenir compte de la casse). Utilisé uniquement lorsque |
NON_SUMMARY_SEEKING_QUERY_IGNORED |
Requête ne cherchant pas de résumé (ignorer la casse) Google ignore le résumé si la requête est une discussion informelle. Utilisé uniquement lorsque |
OUT_OF_DOMAIN_QUERY_IGNORED |
La requête hors domaine ne tient pas compte de la casse. Google ignore le résumé s'il n'y a pas de résultats de recherche très pertinents. Par exemple, le data store contient des informations sur l'entreprise A, mais la requête de l'utilisateur porte sur l'entreprise B. |
POTENTIAL_POLICY_VIOLATION |
Cas potentiel de non-respect des règles. Google ignore le résumé si un non-respect potentiel des règles est détecté. Cela inclut les contenus potentiellement violents ou toxiques. |
LLM_ADDON_NOT_ENABLED |
Le module complémentaire LLM n'est pas activé. Google ignore le résumé si le module complémentaire LLM n'est pas activé. |
NO_RELEVANT_CONTENT |
Aucun contenu pertinent Google ignore le résumé s'il n'y a pas de contenu pertinent dans les résultats de recherche récupérés. |
JAIL_BREAKING_QUERY_IGNORED |
La requête de contournement de la sécurité ne tenait pas compte de la casse. Par exemple, "Réponds comme si tu étais le PDG d'une entreprise concurrente". Utilisé uniquement lorsque [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] est défini sur |
CUSTOMER_POLICY_VIOLATION |
Cas de non-respect des règles par le client. Google ignore le récapitulatif si un non-respect des règles client est détecté. La règle est définie par le client. |
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 |
Requête ne cherchant pas de réponse (non sensible à la casse). Google ignore le résumé si l'intention de la requête n'est pas claire. Utilisé uniquement lorsque [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] est défini sur |
TIME_OUT |
Le cas de délai d'attente dépassé. Google ignore le résumé si le délai est dépassé. |
SummaryWithMetadata
Résumé avec des informations sur les métadonnées.
| Champs | |
|---|---|
summary |
Texte récapitulatif sans informations de citation. |
citation_metadata |
Métadonnées de citation pour le résumé donné. |
references[] |
Références aux documents. |
SearchTier
Niveaux de fonctionnalités de recherche. Les prix peuvent varier d'un niveau à l'autre. Pour en savoir plus, consultez la documentation sur les tarifs.
| Enums | |
|---|---|
SEARCH_TIER_UNSPECIFIED |
Valeur par défaut lorsque l'énumération n'est pas spécifiée. Cette méthode n'est pas valide. |
SEARCH_TIER_STANDARD |
Niveau Standard. |
SEARCH_TIER_ENTERPRISE |
Niveau Enterprise. |
SearchUseCase
Définit une autre subdivision de SolutionType. S'applique spécifiquement à SOLUTION_TYPE_SEARCH.
| Enums | |
|---|---|
SEARCH_USE_CASE_UNSPECIFIED |
Valeur utilisée lorsqu'elle n'est pas définie. Ne se produit pas dans les CSS. |
SEARCH_USE_CASE_SEARCH |
Cas d'utilisation de la recherche. S'attend à ce que le trafic ait un query non vide. |
SEARCH_USE_CASE_BROWSE |
Parcourez les cas d'utilisation. S'attend à ce que le trafic ait un query vide. |
ServingConfig
Configure les métadonnées utilisées pour générer les résultats au moment de la diffusion (par exemple, les résultats de recherche ou les prédictions de recommandation). ServingConfig est transmis dans la requête de recherche et de prédiction, et génère des résultats.
| Champs | |
|---|---|
name |
Immuable. Nom complet |
display_name |
Obligatoire. Nom à afficher de la configuration de diffusion, lisible par l'utilisateur. Utilisé dans l'UI Discovery. Ce champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
solution_type |
Obligatoire. Immuable. Spécifie le type de solution auquel une configuration de diffusion peut être associée. |
model_id |
ID du modèle à utiliser lors de la diffusion. Pour le moment, seuls les RecommendationModels sont acceptés. Peut être modifié, mais uniquement pour un modèle compatible (par exemple, "Autres susceptibles de vous plaire" CTR vers "Autres susceptibles de vous plaire" CVR). Obligatoire lorsque |
diversity_level |
Le degré de diversité à utiliser dans les résultats du modèle de recommandation (par exemple,
Si ce paramètre n'est pas spécifié, nous choisissons une valeur par défaut en fonction du type de modèle de recommandation. Valeur par défaut : Ne peut être défini que si |
ranking_expression |
L'expression de classement contrôle le classement personnalisé des documents récupérés. Pour ce faire, l'intégration de documents est nécessaire. Le paramètre d'expression de classement dans ServingConfig s'applique à toutes les requêtes de recherche traitées par la configuration de diffusion. Toutefois, si L'expression de classement est une fonction unique ou plusieurs fonctions jointes par un signe "+".
Fonctions compatibles :
Variables de fonction :
Exemple d'expression de classement : Si le document comporte un champ d'intégration doc_embedding, l'expression de classement peut être |
create_time |
Uniquement en sortie. Code temporel de création de ServingConfig. |
update_time |
Uniquement en sortie. Horodatage de mise à jour de ServingConfig. |
filter_control_ids[] |
Filtrez les contrôles à utiliser dans le chemin de diffusion. Tous les contrôles de filtre déclenchés seront appliqués. Les commandes de filtrage doivent se trouver dans le même data store que la configuration de diffusion. 20 sélecteurs de filtre maximum. |
boost_control_ids[] |
Contrôles d'amplification à utiliser dans le chemin de diffusion. Tous les contrôles de boost déclenchés seront appliqués. Les contrôles d'amplification doivent se trouver dans le même data store que la configuration de diffusion. Vous pouvez ajouter jusqu'à 20 commandes de boosting. |
redirect_control_ids[] |
ID des commandes de redirection. Seule la première action de redirection déclenchée est appliquée, même si plusieurs s'appliquent. Le nombre maximal de spécifications est de 100. Ne peut être défini que si |
synonyms_control_ids[] |
Spécifications des synonymes de conditions. Si plusieurs conditions de synonymes correspondent, tous les contrôles de synonymes correspondants de la liste seront exécutés. Le nombre maximal de spécifications est de 100. Ne peut être défini que si |
oneway_synonyms_control_ids[] |
Spécifications des synonymes unidirectionnels de conditions. Si plusieurs conditions de synonymes unidirectionnels correspondent, tous les contrôles de synonymes unidirectionnels correspondants de la liste seront exécutés. Le nombre maximal de spécifications est de 100. Ne peut être défini que si |
dissociate_control_ids[] |
La condition n'associe pas de spécifications. Si plusieurs conditions de non-association correspondent, toutes les commandes de non-association correspondantes de la liste seront exécutées. L'ordre n'a pas d'importance. Le nombre maximal de spécifications est de 100. Ne peut être défini que si |
replacement_control_ids[] |
Spécifications de remplacement des conditions. Elles sont appliquées dans l'ordre indiqué dans la liste. Un terme déjà remplacé ne peut pas l'être à nouveau. Le nombre maximal de spécifications est de 100. Ne peut être défini que si |
ignore_control_ids[] |
Spécifications d'ignorance de la condition. Si plusieurs conditions d'ignorance correspondent, tous les contrôles d'ignorance correspondants de la liste seront exécutés. L'ordre n'a pas d'importance. Le nombre maximal de spécifications est de 100. |
promote_control_ids[] |
Spécifications de la promotion conditionnelle. Le nombre maximal de spécifications est de 100. |
answer_generation_spec |
Facultatif. Spécification pour la génération de réponses. |
Champ d'union vertical_config. Configuration spécifique au secteur d'activité. vertical_config ne peut être qu'un des éléments suivants : |
|
media_config |
MediaConfig de la configuration de diffusion. |
generic_config |
GenericConfig de la configuration de diffusion. |
GenericConfig
Spécifie les configurations requises pour la découverte générique.Actuellement, nous acceptons les configurations suivantes :
content_search_spec: configuration pour la recherche de contenu générique.
| Champs | |
|---|---|
content_search_spec |
Spécifie le comportement attendu de la recherche de contenu. Uniquement valide pour les data store pour lesquels la recherche de contenu est activée. |
MediaConfig
Spécifie les configurations requises pour la découverte de contenus multimédias. Nous acceptons actuellement :
demote_content_watched: seuil de rétrogradation du contenu regardé. Les clients peuvent spécifier s'ils souhaitent utiliser la rétrogradation du contenu regardé ou la page d'informations consultée. Avec la rétrogradation du contenu regardé, les clients doivent spécifier si les minutes ou le pourcentage de contenu regardé dépassent le seuil. Si c'est le cas, le contenu sera rétrogradé dans les résultats de recommandation.promote_fresh_content: jours limites pour la promotion de nouveaux contenus. Les clients peuvent indiquer s'ils utilisent une promotion de fraîcheur du contenu. Si le contenu a été publié au cours des jours limites, il sera mis en avant dans le résultat de la recommandation. Ne peut être défini que siSolutionTypeestSOLUTION_TYPE_RECOMMENDATION.
| Champs | |
|---|---|
demotion_event_type |
Spécifie le type d'événement utilisé pour rétrograder un résultat de recommandation. Valeurs actuellement acceptées :
Si cette option n'est pas définie, la rétrogradation de l'historique des vidéos regardées ne sera pas appliquée. La rétrogradation pour contenu non actualisé sera toujours appliquée. |
demote_content_watched_past_days |
Facultatif. Indique le nombre de jours à prendre en compte pour rétrograder le contenu regardé. Si la valeur est définie sur zéro ou n'est pas définie, la valeur par défaut est de 365 jours (valeur maximale). |
content_freshness_cutoff_days |
Spécifie la fraîcheur du contenu utilisé pour le résultat de la recommandation. Les contenus seront rétrogradés s'ils ont été publiés il y a plus de jours que le nombre de jours après la publication pour rétrograder le contenu. |
Champ d'union demote_content_watched. Spécifiez le seuil de rétrogradation du contenu regardé. Il peut s'agir d'un pourcentage ou d'une valeur en minutes. Cette valeur doit être définie pour le type d'événement media-complete. La demote_content_watched ne peut être qu'un des éléments suivants : |
|
content_watched_percentage_threshold |
Spécifie le seuil de pourcentage de contenu regardé pour la rétrogradation. La valeur seuil doit être comprise entre 0 et 1, 0 (inclus). |
content_watched_seconds_threshold |
Spécifie le seuil de minutes de visionnage de contenu pour la rétrogradation. |
Session
Définition du proto de session externe.
| Champs | |
|---|---|
name |
Immuable. Nom complet |
display_name |
Facultatif. Nom à afficher de la session. Ce champ permet d'identifier la session dans l'UI. Par défaut, le nom à afficher correspond au texte de la première requête de la session. |
state |
État de la session. |
user_pseudo_id |
Identifiant unique permettant de suivre les utilisateurs. |
turns[] |
Tours. |
labels[] |
Facultatif. Libellés de la session. Peut être défini comme filtre dans ListSessionsRequest. |
start_time |
Uniquement en sortie. Heure de début de la session. |
end_time |
Uniquement en sortie. Heure de fin de la session. |
is_pinned |
Facultatif. Si la session est épinglée, elle s'affiche en haut de la liste des sessions. |
État
Énumération de l'état de la session.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
État non spécifié. |
IN_PROGRESS |
La session est actuellement ouverte. |
Tour
Représente un tour, y compris une requête de l'utilisateur et une réponse du service.
| Champs | |
|---|---|
query |
Facultatif. Requête de l'utilisateur. Ne peut pas être défini si ce tour ne fait que régénérer une réponse à un autre tour. |
answer |
Facultatif. Nom de ressource de la réponse à la requête de l'utilisateur. Ne doit être défini que si la réponse a été générée lors de ce tour (appel d'API /answer). |
assist_answer |
Uniquement en sortie. Nom de ressource de la réponse de l'Assistant à la requête de l'utilisateur. Ne doit être défini que si un appel d'assistance (appel d'API /assist) a eu lieu lors de ce tour. Format : |
detailed_answer |
Uniquement en sortie. Dans l'API |
detailed_assist_answer |
Uniquement en sortie. Dans l'API |
query_config |
Facultatif. Représente les métadonnées liées à la configuration de la requête, par exemple le modèle et la version LLM utilisés, les paramètres du modèle (température, paramètres d'ancrage, etc.). Le préfixe "google." est réservé aux fonctionnalités développées par Google. |
SetUpDataConnectorMetadata
Ce type ne comporte aucun champ.
Métadonnées pour la méthode DataConnectorService.SetUpDataConnector.
SetUpDataConnectorRequest
Requête pour la méthode DataConnectorService.SetUpDataConnector.
| Champs | |
|---|---|
parent |
Obligatoire. Parent de |
collection_id |
Obligatoire. ID à utiliser pour Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée. |
collection_display_name |
Obligatoire. Nom à afficher de Doit être lisible par un humain et utilisé pour afficher les collections dans le tableau de bord de la console. Chaîne encodée en UTF-8 avec une limite de 1 024 caractères. |
data_connector |
Obligatoire. Le |
SingleRegionKey
Métadonnées pour les clés CMEK à région unique.
| Champs | |
|---|---|
kms_key |
Obligatoire. Nom de ressource de clé KMS à région unique qui sera utilisé pour chiffrer les ressources |
SiteSearchEngine
SiteSearchEngine capture les configurations persistantes de recherche sur site au niveau du DataStore. Il s'agit d'une valeur singleton par data store.
| Champs | |
|---|---|
name |
Nom complet de la ressource du moteur de recherche sur le site. Format : |
SiteVerificationInfo
Informations de validation pour les sites cibles dans la recherche avancée sur site.
| Champs | |
|---|---|
site_verification_state |
État de validation du site indiquant la propriété et la validité. |
verify_time |
Heure de la dernière validation du site. |
SiteVerificationState
État de validation du site.
| Enums | |
|---|---|
SITE_VERIFICATION_STATE_UNSPECIFIED |
La valeur par défaut est "VERIFIED". |
VERIFIED |
La propriété du site a été validée. |
UNVERIFIED |
La validation de la propriété du site est en attente ou a échoué. |
EXEMPTED |
Site exempté de validation, par exemple un site Web public ouvert à tous. |
Sitemap
Plan du site pour le moteur SiteSearchEngine.
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom complet de la ressource du sitemap. |
create_time |
Uniquement en sortie. Date/Heure de création du sitemap. |
Champ d'union feed. Sources de flux acceptées. feed ne peut être qu'un des éléments suivants : |
|
uri |
URI public du sitemap, par exemple |
SolutionType
Type de solution.
| Enums | |
|---|---|
SOLUTION_TYPE_UNSPECIFIED |
Valeur par défaut. |
SOLUTION_TYPE_RECOMMENDATION |
Utilisé pour Recommendations AI. |
SOLUTION_TYPE_SEARCH |
Utilisé pour la recherche Discovery. |
SOLUTION_TYPE_CHAT |
Utilisé pour les cas d'utilisation liés à l'agent d'IA générative. |
SOLUTION_TYPE_GENERATIVE_CHAT |
Utilisé pour les cas d'utilisation liés à l'agent de chat génératif. Il n'est utilisé que pour le moteur de chat génératif. Les data stores associés doivent être enregistrés avec la solution SOLUTION_TYPE_CHAT. |
SpannerSource
Source Spanner pour l'importation de données
| Champs | |
|---|---|
project_id |
ID du projet contenant la source Spanner. ne doit pas dépasser 128 caractères ; S'il n'est pas spécifié, l'ID du projet est hérité de la requête parente. |
instance_id |
Obligatoire. ID d'instance de la table Spanner source. |
database_id |
Obligatoire. ID de base de données de la table Spanner source. |
table_id |
Obligatoire. Nom de la table de la base de données Spanner à importer. |
enable_data_boost |
Indique si le data boost doit être appliqué à l'exportation Spanner. L'activation de cette option entraînera des coûts supplémentaires. Pour en savoir plus, cliquez ici. |
StreamAssistRequest
Requête pour la méthode AssistantService.StreamAssist.
| Champs | |
|---|---|
name |
Obligatoire. Nom de ressource du |
query |
Facultatif. Requête de l'utilisateur actuel. Les requêtes vides ne sont acceptées que si des |
session |
Facultatif. Session à utiliser pour la requête. Si cette option est spécifiée, l'assistant a accès à l'historique des sessions, et la requête et la réponse y sont stockées. Si Format : |
user_metadata |
Facultatif. Informations sur l'utilisateur qui lance la requête. |
agents_spec |
Facultatif. Spécification des agents utilisés pour traiter la requête. |
tools_spec |
Facultatif. Spécification des outils utilisés pour traiter la demande. |
generation_spec |
Facultatif. Spécification de la configuration de génération pour la requête. |
AgentsSpec
Spécification des agents utilisés pour traiter la requête.
| Champs | |
|---|---|
agent_specs[] |
Facultatif. Spécification des agents utilisés pour traiter la requête. |
AgentSpec
Spécification d'un agent.
| Champs | |
|---|---|
agent_id |
Obligatoire. ID permettant d'identifier la ressource d'agent qui traite la demande. Ce champ doit être conforme à la norme RFC-1034 et ne pas comporter plus de 63 caractères. |
GenerationSpec
Spécification de la génération de l'Assistant pour la requête. Cela permet de remplacer la configuration de génération par défaut au niveau du moteur.
| Champs | |
|---|---|
model_id |
Facultatif. ID du modèle Vertex AI utilisé pour le modèle génératif. Si aucune valeur n'est définie, le modèle Assistant par défaut sera utilisé. |
ToolsSpec
Spécification des outils utilisés pour traiter la demande.
| Champs | |
|---|---|
vertex_ai_search_spec |
Facultatif. Spécification de l'outil Vertex AI Search. |
web_grounding_spec |
Facultatif. Spécification de l'outil d'ancrage Web. Si le champ est présent, l'ancrage avec la recherche sur le Web est activé. Ne fonctionne que si |
image_generation_spec |
Facultatif. Spécification de l'outil de génération d'images. |
video_generation_spec |
Facultatif. Spécification de l'outil de génération de vidéos. |
ImageGenerationSpec
Ce type ne comporte aucun champ.
Spécification de l'outil de génération d'images.
VertexAiSearchSpec
Spécification de l'outil Vertex AI Search.
| Champs | |
|---|---|
data_store_specs[] |
Facultatif. Spécifications définissant les |
filter |
Facultatif. La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. L'expression de filtre est sensible à la casse. Si ce champ n'est pas reconnaissable, un Le filtrage dans Vertex AI Search s'effectue en mappant la clé de filtre LHS à une propriété clé définie dans le backend Vertex AI Search. Ce mappage est défini par le client dans son schéma. Par exemple, un client média peut avoir un champ "name" (nom) dans son schéma. Dans ce cas, le filtre se présenterait comme suit : filter --> name:'ANY("king kong")` Pour en savoir plus sur le filtrage, y compris sur la syntaxe et les opérateurs de filtre, consultez Filtrer. |
VideoGenerationSpec
Ce type ne comporte aucun champ.
Spécification de l'outil de génération de vidéos.
WebGroundingSpec
Ce type ne comporte aucun champ.
Spécification de l'outil d'ancrage Web.
StreamAssistResponse
Réponse pour la méthode AssistantService.StreamAssist.
| Champs | |
|---|---|
answer |
Objet de ressource de réponse de l'assistance contenant des parties de la réponse finale de l'assistant à la requête de l'utilisateur. Absent si la réponse actuelle n'ajoute rien aux Observez Si l'état est |
session_info |
Informations sur la session. Inclus uniquement dans la réponse StreamAssistResponse finale du flux de réponse. |
assist_token |
ID unique global qui identifie la paire actuelle de requête et de flux de réponses. Utilisé pour les commentaires et l'assistance. |
SessionInfo
Informations sur la session.
| Champs | |
|---|---|
session |
Nom de la session nouvellement générée ou poursuivie. Format : |
SubscriptionTerm
Période d'abonnement. LINT.IfChange
| Enums | |
|---|---|
SUBSCRIPTION_TERM_UNSPECIFIED |
Valeur par défaut, ne pas utiliser. |
SUBSCRIPTION_TERM_ONE_MONTH |
1 mois. |
SUBSCRIPTION_TERM_ONE_YEAR |
1 an. |
SUBSCRIPTION_TERM_THREE_YEARS |
3 ans. |
SubscriptionTier
Informations sur le niveau d'abonnement.
| Enums | |
|---|---|
SUBSCRIPTION_TIER_UNSPECIFIED |
Valeur par défaut. |
SUBSCRIPTION_TIER_SEARCH |
Niveau de recherche. Le niveau Recherche permet d'accéder aux fonctionnalités de recherche VAIS et NotebookLM. |
SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT |
Niveau Recherche et assistant. Le niveau Recherche + Assistant permet d'accéder aux fonctionnalités de recherche VAIS, NotebookLM et de l'assistant. |
SUBSCRIPTION_TIER_NOTEBOOK_LM |
Niveau NotebookLM. Les abonnés NotebookLM ne peuvent accéder qu'aux fonctionnalités NotebookLM. |
SUBSCRIPTION_TIER_FRONTLINE_WORKER |
Niveau "Travailleur de première ligne". |
SUBSCRIPTION_TIER_AGENTSPACE_STARTER |
Niveau Agentspace Starter. |
SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS |
Niveau Agentspace Business. |
SUBSCRIPTION_TIER_ENTERPRISE |
Niveau Enterprise. |
SUBSCRIPTION_TIER_EDU |
Niveau EDU. |
SUBSCRIPTION_TIER_EDU_PRO |
Niveau EDU Pro. |
SUBSCRIPTION_TIER_EDU_EMERGING |
Niveau Marché émergent EDU. |
SUBSCRIPTION_TIER_EDU_PRO_EMERGING |
Niveau Marché émergent EDU Pro. |
SuggestionDenyListEntry
Entrée de la liste de refus de suggestions identifiant l'expression à bloquer dans les suggestions et l'opération appliquée à l'expression.
| Champs | |
|---|---|
block_phrase |
Obligatoire. Expression à bloquer dans les suggestions affichées. Il peut comporter jusqu'à 125 caractères. |
match_operator |
Obligatoire. Opérateur de correspondance à appliquer à cette expression. Indique si l'expression exacte doit être bloquée ou si toutes les suggestions contenant cette expression doivent l'être. |
MatchOperator
Opérateur permettant de faire correspondre les suggestions générées.
| Enums | |
|---|---|
MATCH_OPERATOR_UNSPECIFIED |
Valeur par défaut. Ne doit pas être utilisé |
EXACT_MATCH |
Si la suggestion correspond exactement à la block_phrase, bloquez-la. |
CONTAINS |
Si la suggestion contient la block_phrase, bloquez-la. |
TargetSite
Site cible pour le SiteSearchEngine.
| Champs | |
|---|---|
name |
Uniquement en sortie. Nom complet de la ressource du site cible. |
provided_uri_pattern |
Obligatoire. Uniquement en entrée. Modèle d'URI fourni par l'utilisateur à partir duquel le |
type |
Type de site cible (par exemple, si le site doit être inclus ou exclu). |
exact_match |
Immuable. Si la valeur est définie sur "false", un uri_pattern est généré pour inclure toutes les pages dont l'adresse contient le provided_uri_pattern. Si la valeur est définie sur "true", un uri_pattern est généré pour essayer de correspondre exactement au provided_uri_pattern ou simplement à la page spécifique si le provided_uri_pattern est spécifique. provided_uri_pattern est toujours normalisé pour générer le modèle URI à utiliser par le moteur de recherche. |
generated_uri_pattern |
Uniquement en sortie. Il est généré par le système en fonction du provided_uri_pattern. |
root_domain_uri |
Uniquement en sortie. Domaine racine du provided_uri_pattern. |
site_verification_info |
Uniquement en sortie. État de la validation de la propriété et de la validité du site. |
indexing_status |
Uniquement en sortie. État de l'indexation. |
update_time |
Uniquement en sortie. Date et heure de la dernière mise à jour du site cible. |
failure_reason |
Uniquement en sortie. Motif de l'échec. |
FailureReason
Motifs d'échec de l'indexation de la recherche sur le site.
| Champs | |
|---|---|
Champ d'union failure. Motif de l'échec. failure ne peut être qu'un des éléments suivants : |
|
quota_failure |
Échec en raison d'un quota insuffisant. |
QuotaFailure
Échec en raison d'un quota insuffisant.
| Champs | |
|---|---|
total_required_quota |
Ce nombre est une estimation du quota total dont ce projet a besoin pour terminer l'indexation. |
IndexingStatus
Énumération de l'état d'indexation du site cible.
| Enums | |
|---|---|
INDEXING_STATUS_UNSPECIFIED |
La valeur par défaut est "SUCCEEDED". |
PENDING |
Le site cible se trouve dans la file d'attente des mises à jour et sera traité par le pipeline d'indexation. |
FAILED |
Le site cible n'est pas indexé. |
SUCCEEDED |
Le site cible a été indexé. |
DELETING |
Le site cible précédemment indexé a été marqué comme devant être supprimé. Il s'agit d'un état transitoire qui peut entraîner : 1) la suppression du site cible si la désindexation réussit ; 2) le retour à l'état "SUCCEEDED" (RÉUSSI) si la désindexation échoue. |
CANCELLABLE |
La modification du site cible est en attente, mais peut être annulée. |
CANCELLED |
La modification du site cible a été annulée. |
Type
Types de sites cibles possibles.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Cette valeur n'est pas utilisée. Dans ce cas, le comportement du serveur est défini par défaut sur Type.INCLUDE. |
INCLUDE |
Incluez le site cible. |
EXCLUDE |
Excluez le site cible. |
Locataire
Informations sur le locataire pour une source de connecteur. Cela inclut certaines des informations stockées dans le message d'identifiant, mais se limite à ce qui est nécessaire pour fournir à l'utilisateur une liste des locataires accessibles.
| Champs | |
|---|---|
id |
ID de l'instance du locataire. Exemples : Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). |
uri |
URI du locataire, le cas échéant. Par exemple, l'URI d'une instance Jira est https://my-jira-instance.atlassian.net, et un locataire Slack n'a pas d'URI. |
display_name |
Nom à afficher facultatif pour le locataire, par exemple "Mon équipe Slack". |
TextInput
Définit la saisie de texte.
| Champs | |
|---|---|
input |
Saisie de texte. |
context |
Contexte de conversation de l'entrée. |
TrainCustomModelMetadata
Métadonnées liées à la progression de l'opération TrainCustomModel. Cette valeur est renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
TrainCustomModelRequest
Message de requête pour la méthode SearchTuningService.TrainCustomModel.
| Champs | |
|---|---|
data_store |
Obligatoire. Nom de ressource du data store, par exemple |
model_type |
Modèle à entraîner. Les valeurs compatibles sont :
|
error_config |
Emplacement souhaité des erreurs survenues lors de l'ingestion et de l'entraînement des données. |
model_id |
Si vous n'en fournissez pas, un UUID sera généré. |
Champ d'union training_input. Entrées pour l'entraînement de modèle. training_input ne peut être qu'un des éléments suivants : |
|
gcs_training_input |
Entrée d'entraînement Cloud Storage. |
GcsTrainingInput
Entrée des données d'entraînement Cloud Storage.
| Champs | |
|---|---|
corpus_data_path |
Données du corpus Cloud Storage pouvant être associées aux données d'entraînement. Le format du chemin d'accès aux données est Pour le modèle d'optimisation de la recherche, chaque ligne doit comporter l'ID, le titre et le texte. Exemple : |
query_data_path |
Données de requête GCS pouvant être associées aux données d'entraînement. Le format du chemin d'accès aux données est Pour le modèle d'optimisation de la recherche, chaque ligne doit comporter l'_id et le texte. Exemple : {"_id": "query1", "text": "example query"} |
train_data_path |
Chemin d'accès Cloud Storage des données d'entraînement dont le format doit être Pour le modèle d'optimisation de la recherche, l'en-tête du fichier TSV doit contenir l'ID de requête, l'ID de corpus et le score. Le score doit être un nombre compris dans
|
test_data_path |
Données de test Cloud Storage. Même format que train_data_path. S'il n'est pas fourni, une répartition aléatoire 80/20 entre les données d'entraînement et de test sera effectuée sur train_data_path. |
TrainCustomModelResponse
Réponse de TrainCustomModelRequest. Ce message est renvoyé par le champ google.longrunning.Operations.response.
| Champs | |
|---|---|
error_samples[] |
Exemple d'erreurs rencontrées lors du traitement des données. |
error_config |
Si cette option est définie, elle renvoie la destination des erreurs complètes de la requête. |
model_status |
État du modèle entraîné. Les valeurs possibles sont les suivantes :
|
metrics |
Métriques du modèle entraîné. |
model_name |
Nom complet de CustomTuningModel. |
TransactionInfo
Une transaction représente l'intégralité de la transaction d'achat.
| Champs | |
|---|---|
currency |
Obligatoire. Code de devise. Utilisez le code ISO-4217 à trois caractères. |
transaction_id |
ID de la transaction (128 caractères maximum). |
value |
Obligatoire. Valeur totale non nulle associée à la transaction. Cette valeur peut inclure les frais de livraison, les taxes ou d'autres ajustements à la valeur totale que vous souhaitez inclure. |
tax |
Toutes les taxes associées à la transaction. |
cost |
Tous les coûts associés aux produits. Il peut s'agir de coûts de fabrication, de frais de port non supportés par l'utilisateur final ou de tout autre coût, de sorte que : |
discount_value |
Valeur totale des remises appliquées à cette transaction. Ce chiffre doit être exclu de Par exemple, si un utilisateur a payé un montant de Cela signifie que le bénéfice est calculé de la même manière, quelle que soit la valeur de la remise, et que |
UpdateAclConfigRequest
Message de requête pour la méthode UpdateAclConfig.
| Champs | |
|---|---|
acl_config |
|
UpdateAssistantRequest
Message de requête pour la méthode AssistantService.UpdateAssistant.
| Champs | |
|---|---|
assistant |
Obligatoire. Le champ Si l'appelant n'est pas autorisé à mettre à jour le Si le |
update_mask |
Liste des champs à mettre à jour. |
UpdateCmekConfigMetadata
Métadonnées liées à la progression de l'opération CmekConfigService.UpdateCmekConfig. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
UpdateCmekConfigRequest
Message de requête pour la méthode UpdateCmekConfig. rpc.
| Champs | |
|---|---|
config |
Obligatoire. Ressource CmekConfig. |
set_default |
Définissez le CmekConfig suivant comme valeur par défaut à utiliser pour les ressources enfants si aucune n'est spécifiée. |
UpdateControlRequest
Requête pour la méthode UpdateControl.
| Champs | |
|---|---|
control |
Obligatoire. Contrôle à mettre à jour. |
update_mask |
Facultatif. Indique les champs de l' Si cette règle n'est pas configurée ou est vide, tous les champs acceptés sont mis à jour. |
UpdateConversationRequest
Requête pour la méthode UpdateConversation.
| Champs | |
|---|---|
conversation |
Obligatoire. Conversation à mettre à jour. |
update_mask |
Indique les champs de l' Si cette règle n'est pas configurée ou est vide, tous les champs acceptés sont mis à jour. |
UpdateDataConnectorRequest
Message de requête pour la méthode DataConnectorService.UpdateDataConnector.
| Champs | |
|---|---|
data_connector |
Obligatoire. Si l'appelant n'est pas autorisé à mettre à jour le Si |
update_mask |
Indique les champs de l' Voici les chemins de champ acceptés :
Remarque : La compatibilité de ces champs peut varier en fonction du type de connecteur. Par exemple, tous les connecteurs ne sont pas compatibles avec Si un chemin de champ non accepté ou inconnu est fourni, la requête renvoie une erreur INVALID_ARGUMENT. |
UpdateDataStoreRequest
Message de requête pour la méthode DataStoreService.UpdateDataStore.
| Champs | |
|---|---|
data_store |
Obligatoire. Si l'appelant n'est pas autorisé à mettre à jour le Si le |
update_mask |
Indique les champs de l' Si un champ non accepté ou inconnu est fourni, une erreur INVALID_ARGUMENT est renvoyée. |
UpdateDocumentRequest
Message de requête pour la méthode DocumentService.UpdateDocument.
| Champs | |
|---|---|
document |
Obligatoire. Document à mettre à jour ou à créer. Si l'appelant n'est pas autorisé à modifier le Si le |
allow_missing |
Si la valeur est définie sur |
update_mask |
Indique les champs du document importé fourni à mettre à jour. Si elle n'est pas définie, tous les champs sont mis à jour par défaut. |
UpdateEngineRequest
Message de requête pour la méthode EngineService.UpdateEngine.
| Champs | |
|---|---|
engine |
Obligatoire. Si l'appelant n'est pas autorisé à mettre à jour le Si le |
update_mask |
Indique les champs de l' Si un champ non accepté ou inconnu est fourni, une erreur INVALID_ARGUMENT est renvoyée. |
UpdateLicenseConfigRequest
Message de requête pour la méthode LicenseConfigService.UpdateLicenseConfig.
| Champs | |
|---|---|
license_config |
Obligatoire. |
update_mask |
Facultatif. Indique les champs de l' Si un champ non accepté ou inconnu est fourni, une erreur INVALID_ARGUMENT est renvoyée. |
UpdateSchemaMetadata
Métadonnées pour l'opération de longue durée UpdateSchema.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
UpdateSchemaRequest
Message de requête pour la méthode SchemaService.UpdateSchema.
| Champs | |
|---|---|
schema |
Obligatoire. |
allow_missing |
Si elle est définie sur "true" et que la |
UpdateServingConfigRequest
Requête pour la méthode UpdateServingConfig.
| Champs | |
|---|---|
serving_config |
Obligatoire. ServingConfig à mettre à jour. |
update_mask |
Indique les champs de l' Si cette règle n'est pas configurée, tous les champs acceptés sont mis à jour. |
UpdateSessionRequest
Requête pour la méthode UpdateSession.
| Champs | |
|---|---|
session |
Obligatoire. Session à mettre à jour. |
update_mask |
Indique les champs de l' Si cette règle n'est pas configurée ou est vide, tous les champs acceptés sont mis à jour. |
UpdateTargetSiteMetadata
Métadonnées liées à la progression de l'opération SiteSearchEngineService.UpdateTargetSite. Cette valeur sera renvoyée par le champ google.longrunning.Operation.metadata.
| Champs | |
|---|---|
create_time |
Heure de création de l'opération. |
update_time |
Date et heure de la dernière mise à jour de l'opération. Si l'opération est terminée, il s'agit également de l'heure de fin. |
UpdateTargetSiteRequest
Message de requête pour la méthode SiteSearchEngineService.UpdateTargetSite.
| Champs | |
|---|---|
target_site |
Obligatoire. Site cible à mettre à jour. Si l'appelant n'est pas autorisé à mettre à jour le Si le |
UserEvent
UserEvent capture toutes les informations de métadonnées dont l'API Discovery Engine a besoin pour connaître la façon dont les utilisateurs finaux interagissent avec votre site Web.
| Champs | |
|---|---|
event_type |
Obligatoire. Type d'événement utilisateur. Les valeurs autorisées sont les suivantes : Valeurs génériques :
Valeurs liées au commerce :
Valeurs liées aux médias :
Valeur de conversion personnalisée :
|
conversion_type |
Facultatif. Type de conversion. Obligatoire si Ne définissez pas le champ si |
user_pseudo_id |
Obligatoire. Identifiant unique permettant d'effectuer le suivi des visiteurs. Par exemple, cela peut être implémenté avec un cookie HTTP, qui doit pouvoir identifier de manière unique un visiteur sur un seul appareil. Cet identifiant unique ne doit pas changer si le visiteur se connecte ou se déconnecte du site Web. Ne définissez pas le champ sur le même ID fixe pour différents utilisateurs. L'historique des événements de ces utilisateurs est alors mélangé, ce qui dégrade la qualité du modèle. Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur Ce champ ne doit pas contenir d'informations permettant d'identifier personnellement l'utilisateur ni de données utilisateur. Nous vous recommandons d'utiliser l'ID client Google Analytics pour ce champ. |
engine |
Nom de ressource Facultatif. Obligatoire uniquement pour les événements utilisateur produits par |
data_store |
Nom complet de la ressource Facultatif. Ce paramètre n'est obligatoire que pour les événements utilisateur dont le data store ne peut pas être déterminé par |
event_time |
Obligatoire uniquement pour la méthode |
user_info |
Informations sur l'utilisateur final. |
direct_user_request |
Doit être défini sur "true" si la demande est effectuée directement par l'utilisateur final. Dans ce cas, Ce signalement ne doit être défini que si la requête API est effectuée directement par l'utilisateur final, par exemple à partir d'une application mobile (et non si une passerelle ou un serveur traite et envoie les événements utilisateur). Il ne doit pas être défini lorsque vous utilisez la balise JavaScript dans |
session_id |
Identifiant unique permettant de suivre une session de visiteur. La longueur est limitée à 128 octets. Une session est une agrégation du comportement d'un utilisateur final sur une période donnée. Voici une recommandation générale pour renseigner session_id :
|
page_info |
Métadonnées de la page, telles que les catégories et d'autres informations essentielles pour certains types d'événements, comme |
attribution_token |
Jeton permettant d'attribuer une réponse d'API à une ou plusieurs actions utilisateur pour déclencher l'événement. Vivement recommandé pour les événements utilisateur résultant de La valeur doit être l'une des suivantes :
Ce jeton nous permet d'attribuer précisément une page vue ou une conversion à l'événement et à la réponse de prédiction spécifique contenant le produit sur lequel l'utilisateur a cliqué ou qu'il a acheté. Si l'utilisateur clique sur le produit K dans les résultats de recommandation, transmettez |
filter |
La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des documents filtrés. Par exemple, pour les événements De même, pour les événements La valeur doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 1 000 caractères. Dans le cas contraire, une erreur |
documents[] |
Liste des Ce champ est facultatif, sauf pour les types d'événements suivants :
Dans un événement |
panel |
Métadonnées du panneau associées à cet événement utilisateur. |
search_info |
Détails Ce champ doit être défini pour l'événement |
completion_info |
Détails Ce champ doit être défini pour l'événement |
transaction_info |
Métadonnées de transaction (le cas échéant) associées à cet événement utilisateur. |
tag_ids[] |
Liste des identifiants des groupes de test indépendants auxquels appartient cet événement utilisateur. Il permet de faire la distinction entre les événements utilisateur associés à différentes configurations de test. |
promotion_ids[] |
ID des promotions si l'événement y est associé. Actuellement, ce champ est limité à un ID maximum. |
attributes |
Fonctionnalités d'événement utilisateur supplémentaires à inclure dans le modèle de recommandation. Ces attributs ne doivent PAS contenir de données nécessitant une analyse ou un traitement supplémentaires (par exemple, du code JSON ou d'autres encodages). Si vous fournissez des attributs personnalisés pour les événements utilisateur ingérés, incluez-les également dans les événements utilisateur que vous associez aux requêtes de prédiction. La mise en forme des attributs personnalisés doit être cohérente entre les événements importés et ceux fournis avec les demandes de prédiction. L'API Discovery Engine peut ainsi utiliser ces attributs personnalisés lors de l'entraînement des modèles et de la diffusion des prédictions, ce qui contribue à améliorer la qualité des recommandations. Ce champ doit répondre à tous les critères ci-dessous, sinon une erreur
Pour les recommandations de produits, |
media_info |
Informations spécifiques au média. |
panels[] |
Facultatif. Liste des panneaux associés à cet événement. Utilisé pour les données d'impression au niveau de la page. |
UserInfo
Informations sur un utilisateur final.
| Champs | |
|---|---|
user_id |
Fortement recommandé pour les utilisateurs connectés. Identifiant unique de l'utilisateur connecté, tel qu'un nom d'utilisateur. Ne définissez pas de mot de passe pour les utilisateurs anonymes. Utilisez toujours une valeur hachée pour cet ID. Ne définissez pas le champ sur le même ID fixe pour différents utilisateurs. L'historique des événements de ces utilisateurs est alors mélangé, ce qui dégrade la qualité du modèle. Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur |
user_agent |
User-agent tel qu'inclus dans l'en-tête HTTP. Le champ doit être une chaîne encodée au format UTF-8 et ne doit pas comporter plus de 1 000 caractères. Dans le cas contraire, une erreur Cette valeur ne doit pas être définie lorsque vous utilisez le signalement d'événements côté client avec GTM ou la balise JavaScript dans |
time_zone |
Facultatif. Fuseau horaire IANA, par exemple "Europe/Budapest". |
UserLicense
Informations sur la licence utilisateur attribuée par l'administrateur.
| Champs | |
|---|---|
user_principal |
Obligatoire. Immuable. Le nom principal de l'utilisateur, qui peut être une adresse e-mail ou un autre identifiant principal. Ce champ n'est pas modifiable. Les administrateurs attribuent des licences en fonction du nom d'utilisateur principal. |
user_profile |
Facultatif. Profil utilisateur. Nous utilisons le nom complet de l'utilisateur(prénom + nom) comme profil utilisateur. |
license_assignment_state |
Uniquement en sortie. État de l'attribution de la licence à l'utilisateur. Si une configuration de licence est attribuée à l'utilisateur, la licence lui sera attribuée lors de sa connexion. Si l'état d'attribution de licence de l'utilisateur est "Non attribué" ou "Non spécifié", aucune configuration de licence ne lui sera associée. |
license_config |
Facultatif. Nom complet de la ressource de l'abonnement(LicenseConfig) attribué à l'utilisateur. |
create_time |
Uniquement en sortie. Code temporel de création de l'utilisateur. |
update_time |
Uniquement en sortie. Horodatage de la mise à jour de l'utilisateur. |
last_login_time |
Uniquement en sortie. Date et heure de la dernière connexion de l'utilisateur. Si l'utilisateur ne s'est pas encore connecté, ce champ sera vide. |
LicenseAssignmentState
Énumération de l'état de l'attribution de licence.
| Enums | |
|---|---|
LICENSE_ASSIGNMENT_STATE_UNSPECIFIED |
Valeur par défaut. |
ASSIGNED |
Licence attribuée à l'utilisateur. |
UNASSIGNED |
Aucune licence n'est attribuée à l'utilisateur. Obsolète, traduit par NO_LICENSE. |
NO_LICENSE |
Aucune licence n'est attribuée à l'utilisateur. |
NO_LICENSE_ATTEMPTED_LOGIN |
L'utilisateur a tenté de se connecter, mais aucune licence ne lui a été attribuée. Cet état n'est utilisé que lorsqu'un utilisateur se connecte pour la première fois, mais qu'aucune licence ne peut lui être attribuée. Les utilisateurs déjà connectés, mais auxquels aucune licence ne peut être attribuée, se verront attribuer l'état NO_LICENSE(l'administrateur peut désattribuer la licence). |
BLOCKED |
L'utilisateur ne peut pas attribuer de licence. |
WorkspaceConfig
Configuration permettant de stocker la configuration du type de data store pour les données de l'espace de travail
| Champs | |
|---|---|
type |
Source de données Google Workspace. |
dasher_customer_id |
Numéro client Dasher obscurci. |
super_admin_service_account |
Facultatif. Compte de service super-administrateur de l'espace de travail qui sera utilisé pour générer le jeton d'accès. Pour le moment, nous ne l'utilisons que pour l'ingestion de données du connecteur Google Drive natif. |
super_admin_email_address |
Facultatif. Adresse e-mail du super-administrateur de l'espace de travail qui sera utilisée pour générer le jeton d'accès. Pour le moment, nous ne l'utilisons que pour l'ingestion de données du connecteur Google Drive natif. |
Type
Spécifie le type d'application Workspace compatible avec ce DataStore
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
La valeur par défaut est un type d'espace de travail non spécifié. |
GOOGLE_DRIVE |
Le datastore Workspace contient des données Drive |
GOOGLE_MAIL |
Workspace Data Store contient des données Mail |
GOOGLE_SITES |
Le datastore Workspace contient des données Sites |
GOOGLE_CALENDAR |
Workspace Data Store contient des données Agenda |
GOOGLE_CHAT |
Workspace Data Store contient des données Chat |
GOOGLE_GROUPS |
Workspace Data Store contient des données sur les groupes |
GOOGLE_KEEP |
Le datastore Workspace contient des données Keep |
GOOGLE_PEOPLE |
Le datastore Workspace contient des données sur les personnes |
WriteUserEventRequest
Message de requête pour la méthode WriteUserEvent.
| Champs | |
|---|---|
parent |
Obligatoire. Nom de la ressource parente. Si l'action d'écriture d'un événement utilisateur est appliquée au niveau |
write_async |
Si la valeur est définie sur "true", l'événement utilisateur est écrit de manière asynchrone après validation, et l'API répond sans attendre l'écriture. |
user_event |
Obligatoire. Événement utilisateur à écrire. |