KnowledgeSourceStatus Class

Represents the status and synchronization history of a knowledge source.

Constructor

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

Variables

Name	Description
kind	str or KnowledgeSourceKind Identifies the Knowledge Source kind directly from the Status response. Known values are: "searchIndex", "azureBlob", "indexedOneLake", and "web".
synchronization_status	str or KnowledgeSourceSynchronizationStatus The current synchronization status. Required. Known values are: "creating", "active", and "deleting".
synchronization_interval	str The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.
current_synchronization_state	SynchronizationState Current synchronization state that spans multiple indexer runs.
last_synchronization_state	CompletedSynchronizationState Details of the last completed synchronization. Null on first sync.
statistics	KnowledgeSourceStatistics Statistical information about the knowledge source synchronization history. Null on first sync.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
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: D[k] if k in D, else d. :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 D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :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 D.

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: D[k] if k in D, else d. :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	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D'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 D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :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 D's values

Attributes

current_synchronization_state

Current synchronization state that spans multiple indexer runs.

current_synchronization_state: _models.SynchronizationState | None

kind

Identifies the Knowledge Source kind directly from the Status response. Known values are: "searchIndex", "azureBlob", "indexedOneLake", and "web".

kind: str | _indexes_models3.KnowledgeSourceKind | None

last_synchronization_state

Details of the last completed synchronization. Null on first sync.

last_synchronization_state: _models.CompletedSynchronizationState | None

statistics

Statistical information about the knowledge source synchronization history. Null on first sync.

statistics: _models.KnowledgeSourceStatistics | None

synchronization_interval

The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.

synchronization_interval: str | None

synchronization_status

"creating", "active", and "deleting".

synchronization_status: str | _indexes_models3.KnowledgeSourceSynchronizationStatus

Feedback

Was this page helpful?