Repor Documentos (API REST de Pré-visualização)
Aplica-se a: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview
Importante
2023-07-01-Preview (sem alterações).
2021-04-30-Preview (sem alterações).
06-2020-30-Pré-visualização (sem alterações).
05-05-06-Preview 2019 adiciona suporte para cenários de reposição.
Repor Documentos é uma API assíncrona. Permite-lhe reprocessar seletivamente documentos da sua origem de dados.
A API aceita dois tipos de identificadores de documentos como entrada. São chaves de documento (chaves que identificam exclusivamente documentos num índice de pesquisa) e identificadores de documentos de origem de dados (chaves que identificam exclusivamente documentos numa origem de dados). Invocar a API adiciona as chaves de documento ou os identificadores de documentos de origem de dados para serem repostos para os metadados do indexador. Na próxima execução agendada ou a pedido do indexador, o indexador processa apenas os documentos de reposição.
- Para indexadores com um conjunto de competências e melhoramento incremental ativado, a API limpa a cache e volta a executar o conjunto de competências completo apenas para os documentos especificados.
- Para indexadores sem um conjunto de competências, a API lê o documento de origem da origem de dados e atualiza/insere os conteúdos no índice.
Se utilizar chaves de documento para repor documentos e as chaves do documento forem referenciadas num mapeamento de campos de indexador, o indexador utiliza o mapeamento de campos para localizar o campo adequado na origem de dados subjacente.
A API funciona para todos os indexadores (com ou sem um conjunto de competências). Pode invocá-lo através de um pedido HTTP POST. Se a chamada for bem-sucedida, receberá uma resposta 204 NoContent. Especifique o nome do indexador a atualizar no URI do pedido:
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parâmetros do URI
| Parâmetro | Description |
|---|---|
| nome do serviço | Obrigatório. Defina-o como o nome exclusivo e definido pelo utilizador do seu serviço de pesquisa. |
| nome do indexador | Obrigatório. O URI do pedido especifica o nome do indexador a atualizar. |
| api-version | Obrigatório. A versão de pré-visualização atual é 2023-07-01-Preview. Veja Versões da API para obter mais versões. |
| substituir | Opcional. Este parâmetro determina se as operações consecutivas de Reposição do Documento são combinadas ou substituídas. A predefinição é falso. Quando falso, o payload da chamada de chaves de documento ou identificadores de documentos de origem de dados é adicionado à lista de chaves já em fila para reprocessamento. Se for verdade, o payload da chamada de chaves de documento ou identificadores de documentos de origem de dados substitui a lista existente, incluindo limpar a lista de documentos de reposição se definir as chaves como nulas. |
Cabeçalhos do Pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
| Campos | Description |
|---|---|
| Content-Type | Obrigatório. Defina esta opção como application/json |
| api-key | Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Uma chave de api é uma cadeia exclusiva gerada pelo sistema que autentica o pedido no seu serviço de pesquisa. Os pedidos de reposição têm de incluir um api-key cabeçalho definido para a sua chave de administrador (em oposição a uma chave de consulta). Veja Ligar à Pesquisa de IA do Azure com a autenticação de chaves para obter detalhes. |
Corpo do Pedido
O corpo deve conter uma lista de chaves de documento ou uma lista de identificadores de documentos de origem de dados que o indexador procura na origem de dados.
O seguinte JSON é uma representação de alto nível das partes principais da definição.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
O pedido contém as seguintes propriedades e tenha em atenção que um e apenas um de "documentKeys" e "datasourceDocumentIds" devem ser fornecidos:
| Propriedade | Descrição |
|---|---|
| documentKeys | Este é o conjunto de chaves de documento que o indexador reprocessa seletivamente da respetiva origem de dados. Por predefinição, chamar esta ação várias vezes acrescenta os conjuntos de chaves do documento. Este comportamento pode ser alterado para substituir em vez de acrescentar através do parâmetro URI de substituição (ver acima). Se quiser que o indexador deixe de tentar processar documentos de reposição, pode definir "documentKeys" para uma lista vazia "[]". Isto resulta no indexador a retomar a indexação regular com base na marca de água elevada. As chaves de documento ou chaves de documento inválidas que não existem são ignoradas. |
| datasourceDocumentIds | Este é o conjunto de identificadores de documentos de origem de dados que o indexador reprocessa seletivamente a partir da respetiva origem de dados. Por predefinição, chamar esta ação várias vezes acrescenta os conjuntos de identificadores de documentos da origem de dados. Este comportamento pode ser alterado para substituir em vez de acrescentar através do parâmetro URI de substituição (ver acima). Se quiser que o indexador deixe de tentar processar documentos de reposição, pode definir "datasourceDocumentIds" para uma lista vazia "[]". Isto resulta no indexador a retomar a indexação regular com base na marca de água elevada. Os identificadores de documentos de origem de dados ou identificadores de documentos de origem de dados inválidos que não existem são ignorados. |
Resposta
204 Sem Conteúdo para um pedido com êxito.