KnowledgeSourceParams Class

Base type for knowledge source runtime parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobKnowledgeSourceParams, FabricDataAgentKnowledgeSourceParams, FabricOntologyKnowledgeSourceParams, FileKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, IndexedSharePointKnowledgeSourceParams, IndexedSqlKnowledgeSourceParams, McpServerKnowledgeSourceParams, RemoteSharePointKnowledgeSourceParams, SearchIndexKnowledgeSourceParams, WebKnowledgeSourceParams, WorkIQKnowledgeSourceParams

Constructor

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

Variables

Name	Description
knowledge_source_name	str The name of the index the params apply to. Required.
include_references	bool Indicates whether references should be included for data retrieved from this source.
include_reference_source_data	bool Indicates whether references should include the structured data obtained during retrieval in their payload.
always_query_source	bool Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
fail_on_error	bool Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
reranker_threshold	float The reranker threshold all retrieved documents must meet to be included in the response.
max_output_documents	int Limits the maximum number of documents returned from this knowledge source.
kind	str or KnowledgeSourceKind The type of the knowledge source. Required. Known values are: "searchIndex", "azureBlob", "indexedSharePoint", "indexedOneLake", "indexedSql", "web", "remoteSharePoint", "workIQ", "file", "mcpServer", "fabricDataAgent", and "fabricOntology".
enable_image_serving	bool Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.

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

always_query_source

Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.

always_query_source: bool | None

enable_image_serving

Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.

enable_image_serving: bool | None

fail_on_error

Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.

fail_on_error: bool | None

include_reference_source_data

Indicates whether references should include the structured data obtained during retrieval in their payload.

include_reference_source_data: bool | None

include_references

Indicates whether references should be included for data retrieved from this source.

include_references: bool | None

kind

"searchIndex", "azureBlob", "indexedSharePoint", "indexedOneLake", "indexedSql", "web", "remoteSharePoint", "workIQ", "file", "mcpServer", "fabricDataAgent", and "fabricOntology".

kind: str

knowledge_source_name

The name of the index the params apply to. Required.

knowledge_source_name: str

max_output_documents

Limits the maximum number of documents returned from this knowledge source.

max_output_documents: int | None

reranker_threshold

The reranker threshold all retrieved documents must meet to be included in the response.

reranker_threshold: float | None