REST Resource: projects.locations.dataStores

Recurso: DataStore

DataStore captura los ajustes y las configuraciones 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. Identificador. Nombre de recurso completo 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 1024 caracteres.

displayName

string

Obligatorio. 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 devuelve un error INVALID_ARGUMENT.

industryVertical

enum (IndustryVertical)

Inmutable. El vertical del sector en el que se registra el almacén de datos.

solutionTypes[]

enum (SolutionType)

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

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

string

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

contentConfig

enum (ContentConfig)

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

createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de la creación de DataStore.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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. Configuración de la búsqueda avanzada en el sitio.

languageInfo

object (LanguageInfo)

Información de idioma de DataStore.

naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Opcional. Configuración de la comprensión de consultas en lenguaje natural.

kmsKeyName

string

Solo de entrada. Clave de KMS que se usará para proteger este almacén de datos en el momento de la creación.

Se debe definir en las solicitudes que deban cumplir las protecciones de la política de organización de CMEK.

Si este campo se define y se procesa correctamente, el almacén de datos estará protegido por la clave de KMS, tal como se indica en el campo cmekConfig.

cmekConfig

object (CmekConfig)

Solo de salida. Información relacionada con CMEK de DataStore.

idpConfig

object (IdpConfig)

Solo de salida. Configuración de proveedor de identidades a nivel de almacén de datos.

billingEstimation

object (BillingEstimation)

Solo de salida. Estimación del tamaño de los datos para la facturación.

aclEnabled

boolean

Inmutable. Si los datos de DataStore tienen información de LCA. Si se define como true, los datos de origen deben tener una lista de control de acceso. Los LCA se ingieren cuando los datos se ingieren mediante métodos de DocumentService.ImportDocuments.

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

Actualmente, las listas de control de acceso solo se admiten en el vertical de la industria GENERIC con una configuración de contenido que no sea PUBLIC_WEBSITE.

workspaceConfig

object (WorkspaceConfig)

Configuración para almacenar la configuración del tipo de almacén de datos de los datos del espacio de trabajo. Este valor debe definirse cuando DataStore.content_config se define como DataStore.ContentConfig.GOOGLE_WORKSPACE.

documentProcessingConfig

object (DocumentProcessingConfig)

Configuración de la comprensión y el enriquecimiento de documentos.

startingSchema

object (Schema)

El esquema de inicio que se usará para este DataStore al aprovisionarlo. Si no se define, se usará un esquema especializado vertical predeterminado.

Este campo solo lo usa la API 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 dataStores.create. Para recuperar el esquema de un DataStore, usa la API SchemaService.GetSchema.

El esquema proporcionado se validará según determinadas reglas del esquema. Consulta más información en este documento.

healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Configuración de la vertical HEALTHCARE_FHIR.

servingConfigDataStore

object (ServingConfigDataStore)

Opcional. Almacena la configuración de servicio a nivel de DataStore.

identityMappingStore

string

Inmutable. Nombre de recurso completo del IdentityMappingStore asociado. Este campo solo se puede definir en DataStores con aclEnabled con el proveedor de identidades THIRD_PARTY o GSUITE. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}.

isInfobotFaqDataStore

boolean

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

configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Configuración del método de facturación configurable. Consulta

Métodos

completeQuery

Completa la información introducida por el usuario con sugerencias de palabras clave.

create

Crea un DataStore.

delete

Elimina un DataStore.

get

Obtiene un DataStore.

getCompletionConfig

Consigue una insignia CompletionConfig

getDocumentProcessingConfig

Obtiene un DocumentProcessingConfig.

getSiteSearchEngine

Obtiene el SiteSearchEngine.

list

Lista todos los DataStores asociados al proyecto.

patch

Actualiza un DataStore

updateCompletionConfig

Actualiza los CompletionConfig.

updateDocumentProcessingConfig

Actualiza el DocumentProcessingConfig.