KnowledgeSourceIngestionParameters Class

Consolidates all general ingestion settings for knowledge sources.

Constructor

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

Variables

Name	Description
identity	SearchIndexerDataIdentity An explicit identity to use for this knowledge source.
embedding_model	KnowledgeSourceVectorizer Optional vectorizer configuration for vectorizing content.
chat_completion_model	KnowledgeBaseModel Optional chat completion model for image verbalization or context extraction.
disable_image_verbalization	bool Indicates whether image verbalization should be disabled. Default is false.
ingestion_schedule	IndexingSchedule Optional schedule for data ingestion.
content_extraction_mode	str or KnowledgeSourceContentExtractionMode Optional content extraction mode. Default is 'minimal'. Known values are: "minimal" and "standard".
ai_services	AIServices Optional AI Services configuration for content processing.

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

ai_services

Optional AI Services configuration for content processing.

ai_services: _models.AIServices | None

chat_completion_model

Optional chat completion model for image verbalization or context extraction.

chat_completion_model: _indexes_models3.KnowledgeBaseModel | None

content_extraction_mode

"minimal" and "standard".

content_extraction_mode: str | _indexes_models3.KnowledgeSourceContentExtractionMode | None

disable_image_verbalization

Indicates whether image verbalization should be disabled. Default is false.

disable_image_verbalization: bool | None

embedding_model

Optional vectorizer configuration for vectorizing content.

embedding_model: _models.KnowledgeSourceVectorizer | None

identity

An explicit identity to use for this knowledge source.

identity: _indexes_models3.SearchIndexerDataIdentity | None

ingestion_schedule

Optional schedule for data ingestion.

ingestion_schedule: _indexes_models3.IndexingSchedule | None