QueryDTO Klas

POST-hoofdtekstschema om een query uit te voeren op de Knowledge Base.

Overname

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

qna_id

str

Vereist

Exacte qnaId om op te halen uit de knowledge base. Dit veld heeft prioriteit boven vraag.

question

str

Vereist

Vraag van de gebruiker om een query uit te voeren op de Knowledge Base.

top

int

Vereist

Maximum aantal antwoorden dat moet worden geretourneerd voor de vraag.

user_id

str

Vereist

Unieke id voor de gebruiker.

is_test

bool

Vereist

Voer een query uit op de testindex.

score_threshold

float

Vereist

Minimale drempelwaarde voor antwoorden.

context

QueryDTOContext

Vereist

Contextobject met eerdere QnA-gegevens.

ranker_type

str

Vereist

Optioneel veld. Ingesteld op 'QuestionOnly' voor het gebruik van een alleen-vraag Ranker.

strict_filters

list[MetadataDTO]

Vereist

Zoek QnA's die zijn gekoppeld aan de opgegeven lijst met metagegevens.

strict_filters_compound_operation_type

str of StrictFiltersCompoundOperationType

Vereist

Optioneel veld. Ingesteld op 'OR' voor het gebruik van OF-bewerking voor strikte filters. Mogelijke waarden zijn: 'AND', 'OR'

answer_span_request

QueryDTOAnswerSpanRequest

Vereist

De voorspellingsfunctie antwoordbereik configureren.

Methoden

as_dict	Retourneer een dict die JSONify kan zijn met behulp van json.dump. Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren. Bekijk de drie voorbeelden in dit bestand: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.
enable_additional_properties_sending
from_dict	Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourneert de JSON die vanuit dit model naar Azure wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.
validate	Valideer dit model recursief en retourneer een lijst met ValidationError.

as_dict

Retourneer een dict die JSONify kan zijn met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

key_transformer

<xref:function>

Een sleuteltransformatorfunctie.

keep_readonly

standaardwaarde: True

Retouren

Een dict JSON-compatibel object

Retourtype

dict

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

deserialize(data, content_type=None)

Parameters

data

str

Vereist

Een str met behulp van restAPI-structuur. JSON standaard.

content_type

str

standaardwaarde: None

JSON standaard: stel application/xml in als XML.

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

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

Parameters

data

dict

Vereist

Een dict met behulp van de RestAPI-structuur

content_type

str

standaardwaarde: None

JSON standaard: stel application/xml in als XML.

key_extractors

standaardwaarde: None

Retouren

Een exemplaar van dit model

Uitzonderingen

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retourneert de JSON die vanuit dit model naar Azure wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly

bool

standaardwaarde: False

Als u de alleen-lezen kenmerken wilt serialiseren

Retouren

Een dict JSON-compatibel object

Retourtype

dict

validate

Valideer dit model recursief en retourneer een lijst met ValidationError.

validate()

Retouren

Een lijst met validatiefouten

Retourtype

list