Documenten opnieuw instellen (PREVIEW REST API)

  • Artikel

Van toepassing op: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview

Belangrijk

2023-07-01-Preview (geen wijzigingen).

2021-04-30-Preview (geen wijzigingen).

2020-06-30-Preview (geen wijzigingen).

2019-05-06-Preview voegt ondersteuning toe voor scenario's voor opnieuw instellen.

Documenten opnieuw instellen is een asynchrone API. Hiermee kunt u documenten uit uw gegevensbron selectief opnieuw verwerken.

De API accepteert twee typen document-id's als invoer. Dit zijn documentsleutels (sleutels waarmee documenten in een zoekindex uniek worden geïdentificeerd) en document-id's van gegevensbronnen (sleutels waarmee documenten in een gegevensbron uniek worden geïdentificeerd). Als u de API aanroept, worden de documentsleutels of document-id's van de gegevensbron toegevoegd die opnieuw moeten worden ingesteld in de metagegevens van de indexeerfunctie. Bij de volgende geplande of on-demand uitvoering van de indexeerfunctie verwerkt de indexeerfunctie alleen de documenten voor opnieuw instellen.

  • Voor indexeerfuncties waarvoor een vaardighedenset en incrementele verrijking is ingeschakeld, wist de API de cache en voert de volledige vaardighedenset voor alleen de opgegeven documenten opnieuw uit.
  • Voor indexeerfuncties zonder vaardighedenset leest de API het brondocument uit de gegevensbron en wordt de inhoud in de index bijgewerkt/ingevoegd.

Als u documentsleutels gebruikt om documenten opnieuw in te stellen en naar uw documentsleutels wordt verwezen in een indexeerfunctieveldtoewijzing, gebruikt de indexeerfunctie veldtoewijzing om het juiste veld in de onderliggende gegevensbron te vinden.

De API werkt voor alle indexeerfuncties (met of zonder vaardighedenset). U kunt deze aanroepen met behulp van een HTTP POST-aanvraag. Als de aanroep slaagt, krijgt u een 204 NoContent-antwoord. Geef de naam op van de indexeerfunctie die moet worden bijgewerkt voor de aanvraag-URI:

POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
naam van indexeerfunctie Vereist. De aanvraag-URI geeft de naam op van de indexeerfunctie die moet worden bijgewerkt.
api-versie Vereist. De huidige preview-versie is 2023-07-01-Preview. Zie API-versies voor meer versies.
Overschrijven Optioneel. Deze parameter bepaalt of opeenvolgende documentherstelbewerkingen worden gecombineerd of overschreven. De standaardinstelling is onwaar. Als onwaar is, wordt de nettolading van documentsleutels of document-id's van de gegevensbron toegevoegd aan de lijst met sleutels die al in de wachtrij staan voor herverwerking. Als dit waar is, wordt de bestaande lijst overschreven door de nettolading van documentsleutels of document-id's van de aanroep, inclusief het wissen van de lijst met opnieuw instellen van documenten als u de sleutels instelt op null.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Description
Content-Type Vereist. Stel dit in op application/json
api-key Optioneel als u Azure-rollen gebruikt en er een Bearer-token is opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Aanvragen voor opnieuw instellen moeten een api-key koptekst bevatten die is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

De hoofdtekst moet een lijst met documentsleutels of een lijst met document-id's van de gegevensbron bevatten waarnaar de indexeerfunctie in de gegevensbron zoekt.

De volgende JSON is een weergave op hoog niveau van de belangrijkste onderdelen van de definitie.

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

Aanvraag bevat de volgende eigenschappen en houd er rekening mee dat er slechts één documentKeys en datasourceDocumentIds moet worden opgegeven:

Eigenschap Beschrijving
documentKeys Dit is de set documentsleutels die de indexeerfunctie selectief opnieuw verwerkt vanuit de gegevensbron. Als u deze actie meerdere keren aanroept, worden de documentsleutelsets standaard toegevoegd. Dit gedrag kan worden gewijzigd om te overschrijven in plaats van toe te voegen via de URI-parameter overschrijven (zie hierboven). Als u wilt dat de indexeerfunctie stopt met het verwerken van het opnieuw instellen van documenten, kunt u 'documentKeys' instellen op een lege lijst '[]'. Dit heeft tot gevolg dat de indexeerfunctie de reguliere indexering hervat op basis van de hoogwatermarkering. Ongeldige documentsleutels of documentsleutels die niet bestaan, worden genegeerd.
datasourceDocumentIds Dit is de set document-id's van de gegevensbron die de indexeerfunctie selectief opnieuw verwerkt uit de gegevensbron. Als u deze actie meerdere keren aanroept, worden standaard de document-id's van de gegevensbron aan elkaar toegevoegd. Dit gedrag kan worden gewijzigd om te overschrijven in plaats van toe te voegen via de URI-parameter overschrijven (zie hierboven). Als u wilt dat de indexeerfunctie stopt met het verwerken van opnieuw instellen van documenten, kunt u 'datasourceDocumentIds' instellen op een lege lijst '[]'. Dit heeft tot gevolg dat de indexeerfunctie de reguliere indexering hervat op basis van de hoogwatermarkering. Ongeldige document-id's van gegevensbronnen of document-id's van gegevensbronnen die niet bestaan, worden genegeerd.

Antwoord

204 Geen inhoud voor een geslaagde aanvraag.

Zie ook