QueryDTO Class

POST body schema to query the knowledgebase.

Inheritance

msrest.serialization.Model

QueryDTO

Constructor

QueryDTO(*, qna_id: str = None, question: str = None, top: int = None, user_id: str = None, is_test: bool = None, score_threshold: float = None, context=None, ranker_type: str = None, strict_filters=None, strict_filters_compound_operation_type=None, answer_span_request=None, **kwargs)

Parameters

Name	Description
qna_id Required	str Exact qnaId to fetch from the knowledgebase, this field takes priority over question.
question Required	str User question to query against the knowledge base.
top Required	int Max number of answers to be returned for the question.
user_id Required	str Unique identifier for the user.
is_test Required	bool Query against the test index.
score_threshold Required	float Minimum threshold score for answers.
context Required	QueryDTOContext Context object with previous QnA's information.
ranker_type Required	str Optional field. Set to 'QuestionOnly' for using a question only Ranker.
strict_filters Required	list[MetadataDTO] Find QnAs that are associated with the given list of metadata.
strict_filters_compound_operation_type Required	str or StrictFiltersCompoundOperationType Optional field. Set to 'OR' for using OR operation for strict filters. Possible values include: 'AND', 'OR'
answer_span_request Required	QueryDTOAnswerSpanRequest To configure Answer span prediction feature.

Keyword-Only Parameters

Name	Description
qna_id Required
question Required
top Required
user_id Required
is_test Required
score_threshold Required
context Required
ranker_type Required
strict_filters Required
strict_filters_compound_operation_type Required
answer_span_request Required

Methods

as_dict	Return a dict that can be JSONify 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 azure 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.
validate	Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify 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=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

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

deserialize(data, content_type=None)

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
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

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)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. default value: None
key_extractors	default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure 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=False, **kwargs)

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

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error