Share via

QueryDTO Kelas

  • Referensi

Skema isi POST untuk mengkueri pangkalan pengetahuan.

Warisan
Model
QueryDTO

Konstruktor

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)

Parameter

qna_id
str
Diperlukan

QnaId yang tepat untuk diambil dari pangkalan pengetahuan, bidang ini lebih diprioritaskan daripada pertanyaan.

question
str
Diperlukan

Pertanyaan pengguna untuk mengkueri terhadap Pangkalan Pengetahuan.

top
int
Diperlukan

Jumlah maksimum jawaban yang akan dikembalikan untuk pertanyaan tersebut.

user_id
str
Diperlukan

Pengidentifikasi unik untuk pengguna.

is_test
bool
Diperlukan

Kueri terhadap indeks pengujian.

score_threshold
float
Diperlukan

Skor ambang minimum untuk jawaban.

context
QueryDTOContext
Diperlukan

Objek konteks dengan informasi QnA sebelumnya.

ranker_type
str
Diperlukan

Bidang opsional. Atur ke 'QuestionOnly' untuk menggunakan Ranker pertanyaan saja.

strict_filters
list[MetadataDTO]
Diperlukan

Temukan QnA yang terkait dengan daftar metadata yang diberikan.

strict_filters_compound_operation_type
str atau StrictFiltersCompoundOperationType
Diperlukan

Bidang opsional. Atur ke 'OR' untuk menggunakan operasi OR untuk filter ketat. Nilai yang mungkin termasuk: 'AND', 'OR'

answer_span_request
QueryDTOAnswerSpanRequest
Diperlukan

Untuk mengonfigurasi fitur prediksi rentang Jawaban.

Metode

as_dict

Mengembalikan dict yang dapat berupa JSONify menggunakan json.dump.

Penggunaan tingkat lanjut mungkin secara opsional menggunakan panggilan balik sebagai parameter:

Kunci adalah nama atribut yang digunakan dalam Python. Attr_desc adalah dict metadata. Saat ini berisi 'jenis' dengan jenis msrest dan 'kunci' dengan kunci yang dikodekan RestAPI. Nilai adalah nilai saat ini dalam objek ini.

String yang dikembalikan akan digunakan untuk menserialisasikan kunci. Jika jenis pengembalian adalah daftar, ini dianggap sebagai dict hasil hierarkis.

Lihat tiga contoh dalam file ini:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True.
deserialize

Uraikan str menggunakan sintaks RestAPI dan kembalikan model.
enable_additional_properties_sending
from_dict

Mengurai dict menggunakan ekstraktor kunci yang diberikan mengembalikan model.

Secara default, pertimbangkan ekstraktor kunci (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor, dan last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Kembalikan JSON yang akan dikirim ke azure dari model ini.

Ini adalah alias untuk as_dict(full_restapi_key_transformer, keep_readonly=False).

Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True.
validate

Validasi model ini secara rekursif dan kembalikan daftar ValidationError.

as_dict

Mengembalikan dict yang dapat berupa JSONify menggunakan json.dump.

Penggunaan tingkat lanjut mungkin secara opsional menggunakan panggilan balik sebagai parameter:

Kunci adalah nama atribut yang digunakan dalam Python. Attr_desc adalah dict metadata. Saat ini berisi 'jenis' dengan jenis msrest dan 'kunci' dengan kunci yang dikodekan RestAPI. Nilai adalah nilai saat ini dalam objek ini.

String yang dikembalikan akan digunakan untuk menserialisasikan kunci. Jika jenis pengembalian adalah daftar, ini dianggap sebagai dict hasil hierarkis.

Lihat tiga contoh dalam file ini:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True.

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

Parameter

key_transformer
<xref:function>

Fungsi transformator kunci.

keep_readonly
nilai default: True

Mengembalikan

Objek yang kompatibel dengan JSON dict

Tipe hasil

dict

deserialize

Uraikan str menggunakan sintaks RestAPI dan kembalikan model.

deserialize(data, content_type=None)

Parameter

data
str
Diperlukan

Str menggunakan struktur RestAPI. JSON secara default.

content_type
str
nilai default: None

JSON secara default, atur aplikasi/xml jika XML.

Mengembalikan

Contoh model ini

Pengecualian

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Mengurai dict menggunakan ekstraktor kunci yang diberikan mengembalikan model.

Secara default, pertimbangkan ekstraktor kunci (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor, dan last_rest_key_case_insensitive_extractor)

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

Parameter

data
dict
Diperlukan

Dict menggunakan struktur RestAPI

content_type
str
nilai default: None

JSON secara default, atur aplikasi/xml jika XML.

key_extractors
nilai default: None

Mengembalikan

Contoh model ini

Pengecualian

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Kembalikan JSON yang akan dikirim ke azure dari model ini.

Ini adalah alias untuk as_dict(full_restapi_key_transformer, keep_readonly=False).

Jika Anda menginginkan serialisasi XML, Anda dapat meneruskan kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameter

keep_readonly
bool
nilai default: False

Jika Anda ingin menserialisasikan atribut readonly

Mengembalikan

Objek yang kompatibel dengan JSON dict

Tipe hasil

dict

validate

Validasi model ini secara rekursif dan kembalikan daftar ValidationError.

validate()

Mengembalikan

Daftar kesalahan validasi

Tipe hasil

list