Method: projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData

Define o padrão de URI para mapeamento de dados de documentos em um DataStore de pesquisa avançada no site.

Solicitação HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:setUriPatternDocumentData

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
siteSearchEngine

string

Obrigatório. Nome completo do recurso do SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "documentDataMap": {
    string: {
      object
    },
    ...
  },
  "emptyDocumentDataMap": boolean,
  "schema": {
    object
  }
}
Campos
documentDataMap

map (key: string, value: object (Struct format))

Dados de documentos com chave definida por padrão de URI. Cada entrada precisa ser consistente com o Schema. Por exemplo: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } }

documentDataMap = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }

emptyDocumentDataMap

boolean

Se for verdadeiro, limpa o mapa de dados do documento. Se for "true", SetUriPatternDocumentDataRequest.document_data_map precisa estar vazio.

schema

object (Struct format)

Opcional. Se não for fornecido, o Schema atual será usado. Se fornecido, valida e atualiza o Schema. Se a validação falhar, um erro será retornado.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte Authentication Overview.