Indexers - Reset Docs

Služba:
Search Service
Verze rozhraní API:
2026-05-01-preview

Obnoví konkrétní dokumenty ve zdroji dat, které mají být selektivně znovu přijaty indexerem.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview
S volitelnými parametry: 
POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2026-05-01-preview&overwrite={overwrite}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string (uri)

Adresa URL koncového bodu vyhledávací služby.
indexerName
 path True

string

Název indexeru.
api-version
 query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.
overwrite
 query

boolean

Pokud je hodnota false, klíče nebo id budou připojeny k existujícím klíčům. Pokud je hodnota true, budou do fronty k opětovnému ingestování zařazeny pouze klíče nebo ID v této datové části.

Hlavička požadavku

Name Vyžadováno Typ Description
Accept

Accept

Hlavička Accept.
x-ms-client-request-id

string (uuid)

Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Text požadavku

Name Typ Description
datasourceDocumentIds

string[]

identifikátory dokumentů datových zdrojů, které mají být resetovány
documentKeys

string[]

Klíče dokumentu, které mají být resetovány

Odpovědi

Name Typ Description
204 No Content

Pro tento požadavek není k dispozici žádný obsah, který by se měl odeslat, ale záhlaví mohou být užitečná.
Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchServiceResetDocs

Ukázkový požadavek

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


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

Ukázková odpověď

Stavový kód:
204

Definice

Name Description
Accept

Hlavička Accept.
DocumentKeysOrIds

Typ klíčových Idy.
ErrorAdditionalInfo

Další informace o chybě při správě prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Accept

Výčet

Hlavička Accept.

Hodnota Description
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objekt

Typ klíčových Idy.

Name Typ Description
datasourceDocumentIds

string[]

identifikátory dokumentů datových zdrojů, které mají být resetovány
documentKeys

string[]

Klíče dokumentu, které mají být resetovány

ErrorAdditionalInfo

Objekt

Další informace o chybě při správě prostředků

Name Typ Description
info

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name Typ Description
error

ErrorDetail

Objekt chyby.