SearchIndexerError interface

Represents an item- or document-level indexing error.

Properties

details

Additional, verbose details about the error to assist in debugging the indexer. This may not be always available.

documentationLink

A link to a troubleshooting guide for these classes of errors. This may not be always available.

errorMessage

The message describing the error that occurred while processing the item.

key

The key of the item for which indexing failed.

name

The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.

statusCode

The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.

Property Details

details

Additional, verbose details about the error to assist in debugging the indexer. This may not be always available.

details?: string

Property Value

string

A link to a troubleshooting guide for these classes of errors. This may not be always available.

documentationLink?: string

Property Value

string

errorMessage

The message describing the error that occurred while processing the item.

errorMessage: string

Property Value

string

key

The key of the item for which indexing failed.

key?: string

Property Value

string

name

The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available.

name?: string

Property Value

string

statusCode

The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.

statusCode: number

Property Value

number