Indexers - Reset Docs

Service:
Search Service
API-versie:
2026-05-01-preview

Hiermee worden specifieke documenten in de gegevensbron opnieuw ingesteld die selectief opnieuw moeten worden opgenomen door de indexeerfunctie.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview
Met optionele parameters: 
POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview&overwrite={overwrite}

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

De eindpunt-URL van de zoekservice.
indexerName
 path True

string

De naam van de indexeerder.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
overwrite
 query

boolean

Als ze onwaar zijn, worden sleutels of id's toegevoegd aan bestaande sleutels. Als dit waar is, worden alleen de sleutels of id's in deze payload in de wachtrij geplaatst om opnieuw te worden opgenomen.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.
x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name Type Description
datasourceDocumentIds

string[]

Document-ID's van gegevensbronnen die opnieuw moeten worden ingesteld
documentKeys

string[]

Documentsleutels die opnieuw moeten worden ingesteld

Antwoorden

Name Type Description
204 No Content

Er is geen inhoud om voor dit verzoek te verzenden, maar de headers kunnen nuttig zijn.
Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://search.azure.com/.default

Voorbeelden

SearchServiceResetDocs

Voorbeeldaanvraag

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2026-05-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

Voorbeeldrespons

Statuscode:
204

Definities

Name Description
Accept

De Accepteer kop.
DocumentKeysOrIds

Het type sleutels OrIds.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

Het foutdetail.
ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Accept

Opsomming

De Accepteer kop.

Waarde Description
application/json;odata.metadata=minimal

DocumentKeysOrIds

Object

Het type sleutels OrIds.

Name Type Description
datasourceDocumentIds

string[]

Document-ID's van gegevensbronnen die opnieuw moeten worden ingesteld
documentKeys

string[]

Documentsleutels die opnieuw moeten worden ingesteld

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

Het foutdetail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.
code

string

De foutcode.
details

ErrorDetail[]

De foutgegevens.
message

string

Het foutbericht.
target

string

Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.