KnowledgeSourceParams Class

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

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

Keyword-Only Parameters

Returns

Remove all items from the dictionary.

clear() -> None

copy() -> Model

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

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

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

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]

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

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() -> ValuesView[Any]

Returns

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

always_query_source: bool | None

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

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

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

include_reference_source_data: bool | None

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

include_references: bool | None

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

kind: str

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

knowledge_source_name: str

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

max_output_documents: int | None

Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.

never_query_source: bool | None

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

reranker_threshold: float | None

Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies. Known values are: "rerank" and "none".

results_processing: str | _indexes_models3.KnowledgeSourceResultsProcessing | None