Compartilhar via

KnowledgeBaseRetrievalRequest Class

The input contract for the retrieval request.

Constructor

KnowledgeBaseRetrievalRequest(*, messages: list['_models.KnowledgeBaseMessage'] | None = None, intents: list['_models.KnowledgeRetrievalIntent'] | None = None, max_runtime_in_seconds: int | None = None, max_output_size: int | None = None, retrieval_reasoning_effort: _models.KnowledgeRetrievalReasoningEffort | None = None, include_activity: bool | None = None, output_mode: str | _models.KnowledgeRetrievalOutputMode | None = None, knowledge_source_params: list['_models.KnowledgeSourceParams'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
messages
list[KnowledgeBaseMessage]

A list of chat message style input.

Default value: None
intents
list[KnowledgeRetrievalIntent]

A list of intended queries to execute without model query planning.

Default value: None
max_runtime_in_seconds
int

The maximum runtime in seconds.

Default value: None
max_output_size
int

Limits the maximum size of the content in the output.

Default value: None
retrieval_reasoning_effort
KnowledgeRetrievalReasoningEffort
Default value: None
include_activity
bool

Indicates retrieval results should include activity information.

Default value: None
output_mode
str or KnowledgeRetrievalOutputMode

The output configuration for this retrieval. Known values are: "extractiveData" and "answerSynthesis".

Default value: None
knowledge_source_params
list[KnowledgeSourceParams]

A list of runtime parameters for the knowledge sources.

Default value: None

Variables

Name Description
messages
list[KnowledgeBaseMessage]

A list of chat message style input.
intents
list[KnowledgeRetrievalIntent]

A list of intended queries to execute without model query planning.
max_runtime_in_seconds
int

The maximum runtime in seconds.
max_output_size
int

Limits the maximum size of the content in the output.
retrieval_reasoning_effort
KnowledgeRetrievalReasoningEffort
include_activity
bool

Indicates retrieval results should include activity information.
output_mode
str or KnowledgeRetrievalOutputMode

The output configuration for this retrieval. Known values are: "extractiveData" and "answerSynthesis".
knowledge_source_params
list[KnowledgeSourceParams]

A list of runtime parameters for the knowledge sources.

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