REST Resource: projects.locations.dataStores

Recurso: DataStore

O DataStore captura definições e configurações globais ao nível do DataStore.

Representação 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)
  },
  "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

Imutável. Identificador. O nome completo do recurso do armazenamento de dados. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
displayName

string

Obrigatório. O nome a apresentar da loja de dados.

Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
industryVertical

enum (IndustryVertical)

Imutável. A vertical do setor que a base de dados regista.
solutionTypes[]

enum (SolutionType)

As soluções que o arquivo de dados inscreve. Soluções disponíveis para cada industryVertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION e SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH está inscrito automaticamente. Não é possível inscrever outras soluções.
defaultSchemaId

string

Apenas saída. O ID do Schema predefinido associado a este arquivo de dados.
contentConfig

enum (ContentConfig)

Imutável. A configuração de conteúdo do arquivo de dados. Se este campo não for definido, o comportamento do servidor é predefinido para ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

Apenas saída. Data/hora de criação do DataStore.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
advancedSiteSearchConfig

object (AdvancedSiteSearchConfig)

Opcional. Configuração para a pesquisa no site avançada.
languageInfo

object (LanguageInfo)

Informações de idioma para o DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

Opcional. Configuração para a compreensão de consultas de linguagem natural.
kmsKeyName

string

Apenas entrada. A chave do KMS a usar para proteger este DataStore no momento da criação.

Tem de ser definido para pedidos que têm de estar em conformidade com as proteções da política organizacional da CMEK.

Se este campo estiver definido e for processado com êxito, o DataStore é protegido pela chave do KMS, conforme indicado no campo cmekConfig.
cmekConfig

object (CmekConfig)

Apenas saída. Informações relacionadas com a CMEK para o DataStore.
billingEstimation

object (BillingEstimation)

Apenas saída. Estimativa do tamanho dos dados para faturação.
aclEnabled

boolean

Imutável. Se os dados no ficheiro DataStore têm informações da LCA. Se estiver definido como true, os dados de origem têm de ter uma ACL. A ACL é carregada quando os dados são carregados através de métodos DocumentService.ImportDocuments.

Quando a ACL está ativada para o elemento DataStore, não é possível aceder ao elemento Document chamando DocumentService.GetDocument ou DocumentService.ListDocuments.

Atualmente, a ACL só é suportada no setor vertical GENERIC com uma configuração de conteúdo não PUBLIC_WEBSITE.
workspaceConfig

object (WorkspaceConfig)

Configuração para armazenar a configuração do tipo de armazenamento de dados para dados do Workspace. Tem de ser definido quando DataStore.content_config está definido como DataStore.ContentConfig.GOOGLE_WORKSPACE.
documentProcessingConfig

object (DocumentProcessingConfig)

Configuração para a interpretação e o enriquecimento de documentos.
startingSchema

object (Schema)

O esquema de início a usar para este DataStore quando o aprovisionar. Se não estiver definida, é usado um esquema especializado vertical predefinido.

Este campo só é usado pela API dataStores.create e é ignorado se for usado noutras APIs. Este campo é omitido de todas as respostas da API, incluindo a API dataStores.create. Para obter um esquema de um DataStore, use a API SchemaService.GetSchema.

O esquema fornecido é validado em função de determinadas regras no esquema. Saiba mais neste documento.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Configuração para o vertical HEALTHCARE_FHIR.
servingConfigDataStore

object (ServingConfigDataStore)

Opcional. Armazena a configuração de publicação ao nível do DataStore.
identityMappingStore

string

Imutável. O nome do recurso totalmente qualificado do IdentityMappingStore associado. Este campo só pode ser definido para DataStores com aclEnabled com THIRD_PARTY ou GSUITE IdP. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}.
isInfobotFaqDataStore

boolean

Opcional. Se estiver definido, este DataStore é um DataStore de Perguntas frequentes do Infobot.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Configuração para uma abordagem de faturação configurável. Consulte

Métodos

completeQuery

 Conclui a entrada do utilizador especificada com sugestões de palavras-chave.

create

 Cria um DataStore.

delete

 Elimina um DataStore.

get

 Obtém um DataStore.

getSiteSearchEngine

 Recebe o SiteSearchEngine.

list

 Apresenta todos os DataStores associados ao projeto.

patch

 Atualiza um DataStore