REST Resource: projects.locations.dataStores

Ressource : DataStore

DataStore capture les paramètres et configurations globaux au niveau DataStore.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "industryVertical": enum (IndustryVertical),
  "solutionTypes": [
    enum (SolutionType)
  ],
  "defaultSchemaId": string,
  "contentConfig": enum (ContentConfig),
  "createTime": string,
  "advancedSiteSearchConfig": {
    object (AdvancedSiteSearchConfig)
  },
  "languageInfo": {
    object (LanguageInfo)
  },
  "naturalLanguageQueryUnderstandingConfig": {
    object (NaturalLanguageQueryUnderstandingConfig)
  },
  "kmsKeyName": string,
  "cmekConfig": {
    object (CmekConfig)
  },
  "idpConfig": {
    object (IdpConfig)
  },
  "billingEstimation": {
    object (BillingEstimation)
  },
  "aclEnabled": boolean,
  "workspaceConfig": {
    object (WorkspaceConfig)
  },
  "documentProcessingConfig": {
    object (DocumentProcessingConfig)
  },
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },
  "servingConfigDataStore": {
    object (ServingConfigDataStore)
  },
  "identityMappingStore": string,
  "isInfobotFaqDataStore": boolean,
  "configurableBillingApproach": enum (ConfigurableBillingApproach)
}
Champs
name

string

Immuable. Identifiant. Nom complet de la ressource du data store. Format : projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

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.
displayName

string

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.
industryVertical

enum (IndustryVertical)

Immuable. Secteur d'activité auquel le data store est associé.
solutionTypes[]

enum (SolutionType)

Solutions auxquelles le data store est inscrit. Solutions disponibles pour chaque industryVertical :

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION et SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH : SOLUTION_TYPE_SEARCH est automatiquement inscrit. Les autres solutions ne peuvent pas être enregistrées.
defaultSchemaId

string

Uniquement en sortie. ID de l'Schema par défaut associé à ce data store.
contentConfig

enum (ContentConfig)

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 ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de DataStore.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

Facultatif. Configuration de la recherche avancée sur le site.
languageInfo

object (LanguageInfo)

Informations sur la langue pour DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Facultatif. Configuration pour la compréhension des requêtes en langage naturel.
kmsKeyName

string

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 cmekConfig.
cmekConfig

object (CmekConfig)

Uniquement en sortie. Informations liées à CMEK pour DataStore.
idpConfig

object (IdpConfig)

Uniquement en sortie. Configuration du fournisseur d'identité au niveau du data store.
billingEstimation

object (BillingEstimation)

Uniquement en sortie. Estimation de la taille des données pour la facturation.
aclEnabled

boolean

Immuable. Indique si les données de DataStore contiennent des informations de LCA. Si la valeur est définie sur true, les données sources doivent disposer d'une ACL. Les LCA seront ingérées lorsque les données seront ingérées par les méthodes DocumentService.ImportDocuments.

Lorsque la LCA est activée pour DataStore, il est impossible d'accéder à Document en appelant DocumentService.GetDocument ou DocumentService.ListDocuments.

Actuellement, les LCA ne sont compatibles qu'avec le secteur GENERIC et la configuration de contenu non PUBLIC_WEBSITE.
workspaceConfig

object (WorkspaceConfig)

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 DataStore.content_config est défini sur DataStore.ContentConfig.GOOGLE_WORKSPACE.
documentProcessingConfig

object (DocumentProcessingConfig)

Configuration pour la compréhension et l'enrichissement des documents.
startingSchema

object (Schema)

Schéma de début à utiliser pour ce DataStore lors de son provisionnement. Si cette option n'est pas définie, un schéma vertical spécialisé par défaut sera utilisé.

Ce champ n'est utilisé que par l'API dataStores.create et sera ignoré s'il est utilisé dans d'autres API. Ce champ sera omis de toutes les réponses d'API, y compris de l'API dataStores.create. Pour récupérer le schéma d'un DataStore, utilisez plutôt l'API SchemaService.GetSchema.

Le schéma fourni sera validé par rapport à certaines règles. Pour en savoir plus, consultez ce document.
healthcareFhirConfig

object (HealthcareFhirConfig)

Facultatif. Configuration pour le secteur HEALTHCARE_FHIR.
servingConfigDataStore

object (ServingConfigDataStore)

Facultatif. Stocke la configuration de diffusion au niveau du DataStore.
identityMappingStore

string

Immuable. Nom complet de la ressource IdentityMappingStore associée. Ce champ ne peut être défini que pour les DataStores aclEnabled avec un IdP THIRD_PARTY ou GSUITE. Format : projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}.
isInfobotFaqDataStore

boolean

Facultatif. Si cette valeur est définie, ce DataStore est un DataStore de questions fréquentes Infobot.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Facultatif. Configuration de l'approche de facturation configurable. Vous devriez voir ce qui suit :

Méthodes

completeQuery

 Complète la saisie utilisateur spécifiée par des suggestions de mots clés.

create

 Crée un objet DataStore.

delete

 Supprime un DataStore.

get

 Récupère un DataStore.

getCompletionConfig

 Récupère un CompletionConfig.

getDocumentProcessingConfig

 Récupère un DocumentProcessingConfig.

getSiteSearchEngine

 Récupère les SiteSearchEngine.

list

 Liste tous les DataStore associés au projet.

patch

 Met à jour un DataStore

updateCompletionConfig

 Met à jour les CompletionConfig.

updateDocumentProcessingConfig

 Met à jour l'objet DocumentProcessingConfig.