Compartilhar via

KnowledgeSourceParams Class

KnowledgeSourceParams.

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

All required parameters must be populated in order to send to server.

Constructor

KnowledgeSourceParams(*, knowledge_source_name: str, include_references: bool | None = None, include_reference_source_data: bool | None = None, always_query_source: bool | None = None, reranker_threshold: float | None = None, **kwargs: Any)

Keyword-Only Parameters

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.

Default value: None
include_reference_source_data
bool

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

Default value: None
always_query_source
bool

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

Default value: None
reranker_threshold
float

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

Default value: None

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.
reranker_threshold
float

The reranker threshold all retrieved documents must meet to be included in the response.
kind
str or KnowledgeSourceKind

The type of the knowledge source. Required. Known values are: "searchIndex", "azureBlob", "web", "remoteSharePoint", "indexedSharePoint", and "indexedOneLake".

Methods

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize

Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, dict[str, typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: True
key_transformer
<xref:function>

A key transformer function.

Returns

Type Description
dict

A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> Self

Parameters

Name Description
data
Required
str

A str using RestAPI structure. JSON by default.
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description
Self

An instance of this model

Exceptions

Type Description
DeserializationError

if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> Self

Parameters

Name Description
data
Required
dict

A dict using RestAPI structure
key_extractors
<xref:function>

A key extractor function.

Default value: None
content_type
str

JSON by default, set application/xml if XML.

Default value: None

Returns

Type Description
Self

An instance of this model

Exceptions

Type Description
DeserializationError

if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Return the JSON that would be sent to server from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name Description
keep_readonly
bool

If you want to serialize the readonly attributes

Default value: False

Returns

Type Description
dict

A dict JSON compatible object