KnowledgeSourceIngestionParameters Class

Consolidates all general ingestion settings for knowledge sources.

Constructor

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

Variables

Name Description
identity

An explicit identity to use for this knowledge source.

embedding_model

Optional vectorizer configuration for vectorizing content.

chat_completion_model

Optional chat completion model for image verbalization or context extraction.

disable_image_verbalization

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

ingestion_schedule

Optional schedule for data ingestion.

ingestion_permission_options

Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source.

content_extraction_mode

Optional content extraction mode. Default is 'minimal'. Known values are: "minimal" and "standard".

ai_services

Optional AI Services configuration for content processing.

asset_store

Optional asset store configuration for storing extracted assets such as images.

freshness_policy

Optional freshness policy for biasing retrieval toward newer documents.

network_access_mode

Optional network access mode for ingestion. Set to 'private' to run ingestion in a private execution environment that can reach data sources and dependencies over a private network. Default is 'public'. This is a create-time setting and cannot be changed after the knowledge source is created. Known values are: "public" and "private".

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

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

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

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

keys

keys() -> KeysView[str]

Returns

Type Description

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

an object providing a view on the mapping's values

Attributes

ai_services

Optional AI Services configuration for content processing.

ai_services: _models.AIServices | None

asset_store

Optional asset store configuration for storing extracted assets such as images.

asset_store: _models.AssetStore | 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

freshness_policy

Optional freshness policy for biasing retrieval toward newer documents.

freshness_policy: _models.FreshnessPolicy | None

identity

An explicit identity to use for this knowledge source.

identity: _indexes_models3.SearchIndexerDataIdentity | None

ingestion_permission_options

Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source.

ingestion_permission_options: list[typing.Union[str, ForwardRef('_indexes_models3.KnowledgeSourceIngestionPermissionOption')]] | None

ingestion_schedule

Optional schedule for data ingestion.

ingestion_schedule: _indexes_models3.IndexingSchedule | None

network_access_mode

Optional network access mode for ingestion. Set to 'private' to run ingestion in a private execution environment that can reach data sources and dependencies over a private network. Default is 'public'. This is a create-time setting and cannot be changed after the knowledge source is created. Known values are: "public" and "private".

network_access_mode: str | _models.KnowledgeSourceNetworkAccessMode | None