KnowledgeSourceSynchronizationError interface

Package:

@azure/search-documents

Represents a document-level indexing error encountered during a knowledge source synchronization run.

Properties

details	Additional contextual information about the failure.
docId	The unique identifier for the failed document or item within the synchronization run.
documentationLink	A link to relevant troubleshooting documentation.
errorMessage	Human-readable, customer-visible error message.
name	Name of the ingestion or processing component reporting the error.
statusCode	HTTP-like status code representing the failure category (e.g., 400).

Property Details

details

Additional contextual information about the failure.

details?: string

Property Value

string

docId

The unique identifier for the failed document or item within the synchronization run.

docId?: string

Property Value

string

documentationLink

A link to relevant troubleshooting documentation.

documentationLink?: string

Property Value

string

errorMessage

Human-readable, customer-visible error message.

errorMessage: string

Property Value

string

name

Name of the ingestion or processing component reporting the error.

name?: string

Property Value

string

statusCode

HTTP-like status code representing the failure category (e.g., 400).

statusCode?: number

Property Value

number