KnowledgeSourceSynchronizationError Class

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

Constructor

KnowledgeSourceSynchronizationError(*args: Any, **kwargs: Any)

Variables

Name Description
doc_id
str

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

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

Name of the ingestion or processing component reporting the error.
error_message
str

Human-readable, customer-visible error message. Required.
details
str

Additional contextual information about the failure.
documentation_link
str

A link to relevant troubleshooting documentation.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from the dictionary.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

a set-like object providing a view on the mapping's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on the mapping's values

Attributes

details

Additional contextual information about the failure.

details: str | None

doc_id

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

doc_id: str | None

A link to relevant troubleshooting documentation.

documentation_link: str | None

error_message

Human-readable, customer-visible error message. Required.

error_message: str

name

Name of the ingestion or processing component reporting the error.

name: str | None

status_code

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

status_code: int | None