REST Resource: projects.locations.dataStores

Recurso: DataStore

DataStore captura la configuración y los parámetros globales a nivel de DataStore.

Representación 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)
}
Campos
name

string

Inmutable. Es el identificador. Es el nombre completo del recurso del almacén de datos. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
displayName

string

Obligatorio. Es el nombre visible del almacén de datos.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
industryVertical

enum (IndustryVertical)

Inmutable. Es la vertical de la industria en la que se registra el almacén de datos.
solutionTypes[]

enum (SolutionType)

Son las soluciones en las que se inscribe el almacén de datos. Soluciones disponibles para cada industryVertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION y SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH se inscribe automáticamente. No se pueden inscribir otras soluciones.
defaultSchemaId

string

Solo salida. Es el ID del Schema predeterminado asociado a este almacén de datos.
contentConfig

enum (ContentConfig)

Inmutable. Es la configuración del contenido del almacén de datos. Si no se configura este campo, el comportamiento predeterminado del servidor será ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se creó el objeto DataStore.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

Opcional. Es la configuración para la búsqueda avanzada en el sitio.
languageInfo

object (LanguageInfo)

Es la información del idioma de DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Opcional. Es la configuración de la comprensión de consultas de lenguaje natural.
kmsKeyName

string

Solo entrada. Es la clave de KMS que se usará para proteger este DataStore en el momento de la creación.

Se debe configurar para las solicitudes que deben cumplir con las protecciones de la política de la organización de CMEK.

Si este campo se configura y procesa correctamente, el DataStore estará protegido por la clave de KMS, como se indica en el campo cmekConfig.
cmekConfig

object (CmekConfig)

Solo salida. Es la información relacionada con la CMEK para el DataStore.
idpConfig

object (IdpConfig)

Solo salida. Es la configuración del proveedor de identidad a nivel del almacén de datos.
billingEstimation

object (BillingEstimation)

Solo salida. Es una estimación del tamaño de los datos para la facturación.
aclEnabled

boolean

Inmutable. Indica si los datos de DataStore tienen información de LCA. Si se configura como true, los datos de origen deben tener una ACL. La LCA se transferirá cuando los métodos DocumentService.ImportDocuments transfieran datos.

Cuando la LCA está habilitada para DataStore, no se puede acceder a Document llamando a DocumentService.GetDocument o DocumentService.ListDocuments.

Actualmente, la LCA solo se admite en la vertical de la industria de GENERIC con una configuración de contenido que no sea de PUBLIC_WEBSITE.
workspaceConfig

object (WorkspaceConfig)

Es la configuración para almacenar la configuración del tipo de almacén de datos para los datos del espacio de trabajo. Se debe configurar cuando DataStore.content_config se establece como DataStore.ContentConfig.GOOGLE_WORKSPACE.
documentProcessingConfig

object (DocumentProcessingConfig)

Es la configuración para la comprensión y el enriquecimiento de documentos.
startingSchema

object (Schema)

Es el esquema de inicio que se usará para este DataStore cuando se aprovisione. Si no se establece, se usará un esquema especializado vertical predeterminado.

Este campo solo lo usa la API de dataStores.create y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API de dataStores.create. Para recuperar el esquema de un DataStore, usa la API de SchemaService.GetSchema.

El esquema proporcionado se validará según ciertas reglas del esquema. Obtén más información en este documento.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Es la configuración para la vertical de HEALTHCARE_FHIR.
servingConfigDataStore

object (ServingConfigDataStore)

Opcional. Almacena la configuración de la publicación a nivel de DataStore.
identityMappingStore

string

Inmutable. Es el nombre del recurso completamente calificado del IdentityMappingStore asociado. Este campo solo se puede establecer para DataStores con aclEnabled y un IdP de THIRD_PARTY o GSUITE. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}.
isInfobotFaqDataStore

boolean

Opcional. Si se configura, este DataStore es un DataStore de preguntas frecuentes de Infobot.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Es la configuración para el enfoque de facturación configurable. Ver

Métodos

completeQuery

 Completa la entrada del usuario especificada con sugerencias de palabras clave.

create

 Crea un DataStore.

delete

 Borra un DataStore.

get

 Obtienes una DataStore.

getCompletionConfig

 Obtiene un CompletionConfig.

getDocumentProcessingConfig

 Obtienes una DocumentProcessingConfig.

getSiteSearchEngine

 Obtiene el SiteSearchEngine.

list

 Enumera todos los DataStore asociados al proyecto.

patch

 Actualiza un DataStore

updateCompletionConfig

 Actualiza los CompletionConfig.

updateDocumentProcessingConfig

 Actualiza la DocumentProcessingConfig.