Redefinir documentos (API REST de versão prévia)
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).
2020-06-30-Preview (sem alterações).
2019-05-06-Preview adiciona suporte para cenários de redefinição.
Redefinir Documentos é uma API assíncrona. Ele permite que você reprocesse seletivamente documentos de sua fonte de dados.
A API aceita dois tipos de identificadores de documento como entrada. São chaves de documento (chaves que identificam documentos exclusivamente em um índice de pesquisa) e identificadores de documento de fonte de dados (chaves que identificam documentos exclusivamente em uma fonte de dados). Invocar a API adiciona as chaves de documento ou os identificadores de documento da fonte de dados a serem redefinidos para os metadados do indexador. Na próxima execução agendada ou sob demanda do indexador, o indexador processa apenas os documentos de redefinição.
- Para indexadores com um conjunto de habilidades e enriquecimento incremental habilitado, a API limpa o cache e executa novamente o conjunto de habilidades completo apenas para os documentos especificados.
- Para indexadores sem um conjunto de habilidades, a API lê o documento de origem da fonte de dados e atualiza/insere o conteúdo no índice.
Se você usar chaves de documento para redefinir documentos e suas chaves de documento forem referenciadas em um mapeamento de campo do indexador, o indexador usará o mapeamento de campo para localizar o campo apropriado na fonte de dados subjacente.
A API funciona para todos os indexadores (com ou sem um conjunto de habilidades). Você pode invocá-lo usando uma solicitação HTTP POST. Se a chamada for bem-sucedida, você obterá uma resposta NoContent 204. Especifique o nome do indexador a ser atualizado no URI de solicitação:
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 de URI
| Parâmetro | Descrição |
|---|---|
| nome do serviço | Obrigatórios. Defina isso como o nome exclusivo definido pelo usuário do serviço de pesquisa. |
| nome do indexador | Obrigatórios. O URI de solicitação especifica o nome do indexador a ser atualizado. |
| api-version | Obrigatórios. A versão prévia atual é 2023-07-01-Preview. Consulte Versões de API para obter mais versões. |
| overwrite | Opcional. Esse parâmetro determina se as operações de Redefinição de Documento consecutivas são combinadas ou substituídas. O padrão é false. Quando false, o conteúdo da chamada de chaves de documento ou identificadores de documento de fonte de dados é adicionado à lista de chaves já enfileiradas para reprocessamento. Se for true, o conteúdo da chamada de chaves de documento ou identificadores de documento de fonte de dados substituirá a lista existente, incluindo a limpeza da lista de documentos de redefinição se você definir as chaves como nulas. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais
| Campos | Descrição |
|---|---|
| Tipo de conteúdo | Obrigatórios. Defina-o como application/json |
| chave de API | Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. As solicitações de redefinição devem incluir um api-key cabeçalho definido como sua chave de administrador (em vez de uma chave de consulta). Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes. |
Corpo da solicitação
O corpo deve conter uma lista de chaves de documento ou uma lista de identificadores de documento de fonte de dados que o indexador procura na fonte de dados.
O JSON a seguir é uma representação de alto nível das partes main da definição.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
A solicitação contém as seguintes propriedades e observe que uma e apenas uma de "documentKeys" e "datasourceDocumentIds" devem ser fornecidas:
| Propriedade | Descrição |
|---|---|
| documentKeys | Esse é o conjunto de chaves de documento que o indexador reprocessa seletivamente de sua fonte de dados. Por padrão, chamar essa ação várias vezes acrescenta os conjuntos de chaves do documento. Esse comportamento pode ser alterado para substituir em vez de acrescentar por meio do parâmetro URI de substituição (consulte acima). Se você quiser que o indexador pare de tentar processar documentos de redefinição, defina "documentKeys" como uma lista vazia "[]". Isso faz com que o indexador retome a indexação regular com base na marca d'água alta. Chaves de documento inválidas ou chaves de documento que não existem são ignoradas. |
| datasourceDocumentIds | Esse é o conjunto de identificadores de documento de fonte de dados que o indexador reprocessa seletivamente de sua fonte de dados. Por padrão, chamar essa ação várias vezes acrescenta os conjuntos de identificadores de documento da fonte de dados. Esse comportamento pode ser alterado para substituir em vez de acrescentar por meio do parâmetro URI de substituição (consulte acima). Se você quiser que o indexador pare de tentar processar documentos de redefinição, poderá definir "datasourceDocumentIds" como uma lista vazia "[]". Isso faz com que o indexador retome a indexação regular com base na marca d'água alta. Identificadores de documentos de fonte de dados inválidos ou identificadores de documento de fonte de dados que não existem são ignorados. |
Resposta
204 Nenhum conteúdo para uma solicitação bem-sucedida.