REST Resource: projects.locations.dataStores

Recurso: DataStore

O DataStore captura configurações globais no 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)
  },
  "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

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

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
displayName

string

Obrigatório. O nome de exibição do repositório de dados.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
industryVertical

enum (IndustryVertical)

Imutável. O setor em que o repositório de dados está registrado.
solutionTypes[]

enum (SolutionType)

As soluções registradas pelo repositório de dados. Soluções disponíveis para cada industryVertical:

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

string

Apenas saída. O ID do Schema padrão associado a este repositório de dados.
contentConfig

enum (ContentConfig)

Imutável. A configuração de conteúdo do repositório de dados. Se esse campo não for definido, o comportamento padrão do servidor será ContentConfig.NO_CONTENT.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o DataStore foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. 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 pesquisa avançada no site.
languageInfo

object (LanguageInfo)

Informações de idioma para o DataStore.
naturalLanguageQueryUnderstandingConfig

object (NaturalLanguageQueryUnderstandingConfig)

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

string

Somente entrada. A chave do KMS a ser usada para proteger este DataStore no momento da criação.

Precisa ser definido para solicitações que precisam obedecer às proteções da política da organização da CMEK.

Se esse campo for definido e processado com sucesso, o DataStore será protegido pela chave do KMS, conforme indicado no campo "cmekConfig".
cmekConfig

object (CmekConfig)

Apenas saída. Informações relacionadas à CMEK para o DataStore.
idpConfig

object (IdpConfig)

Apenas saída. Configuração do provedor de identidade no nível do repositório de dados.
billingEstimation

object (BillingEstimation)

Apenas saída. Estimativa do tamanho dos dados para faturamento.
aclEnabled

boolean

Imutável. Se os dados em DataStore têm informações de ACL. Se definido como true, os dados de origem precisam ter ACL. A ACL será ingerida quando os dados forem ingeridos pelos métodos DocumentService.ImportDocuments.

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

No momento, as ACLs são aceitas apenas na categoria 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 repositório de dados para dados do espaço de trabalho. Isso precisa ser definido quando DataStore.content_config é definido como DataStore.ContentConfig.GOOGLE_WORKSPACE.
documentProcessingConfig

object (DocumentProcessingConfig)

Configuração para entendimento e enriquecimento de documentos.
startingSchema

object (Schema)

O esquema inicial a ser usado para este DataStore ao provisioná-lo. Se não for definido, um esquema vertical especializado padrão será usado.

Esse campo é usado apenas pela API dataStores.create e será ignorado se usado em outras APIs. Esse campo será omitido de todas as respostas da API, incluindo a API dataStores.create. Para recuperar um esquema de um DataStore, use a API SchemaService.GetSchema.

O esquema fornecido será validado de acordo com determinadas regras. Saiba mais neste documento.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Configuração para a categoria HEALTHCARE_FHIR.
servingConfigDataStore

object (ServingConfigDataStore)

Opcional. Armazena a configuração de veiculação no nível do DataStore.
identityMappingStore

string

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

boolean

Opcional. Se definido, esse DataStore será um DataStore de perguntas frequentes do Infobot.
configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Configuração para uma abordagem de faturamento configurável. Ver

Métodos

completeQuery

 Completa a entrada do usuário especificada com sugestões de palavras-chave.

create

 Cria uma DataStore.

delete

 Exclui um DataStore.

get

 Recebe um DataStore.

getCompletionConfig

 Recebe um CompletionConfig

getDocumentProcessingConfig

 Recebe um DocumentProcessingConfig.

getSiteSearchEngine

 Recebe o SiteSearchEngine.

list

 Lista todos os DataStores associados ao projeto.

patch

 Atualiza um DataStore

updateCompletionConfig

 Atualiza os CompletionConfigs.

updateDocumentProcessingConfig

 Atualiza o DocumentProcessingConfig.