SearchIndex Kelas

Mewakili definisi indeks pencarian, yang menjelaskan bidang dan perilaku pencarian indeks.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.

Warisan

azure.search.documents.indexes._generated._serialization.Model

SearchIndex

Konstruktor

SearchIndex(**kwargs)

Variabel

Nama	Deskripsi
name	str Wajib diisi. Nama indeks.
fields	list[SearchField] Wajib diisi. Bidang indeks.
scoring_profiles	list[ScoringProfile] Profil penilaian untuk indeks.
default_scoring_profile	str Nama profil penilaian yang akan digunakan jika tidak ada yang ditentukan dalam kueri. Jika properti ini tidak diatur dan tidak ada profil penilaian yang ditentukan dalam kueri, maka penilaian default (tf-idf) akan digunakan.
cors_options	CorsOptions Opsi untuk mengontrol Berbagi Sumber Daya Lintas Asal (CORS) untuk indeks.
suggesters	list[SearchSuggester] Pemberi saran untuk indeks.
analyzers	list[LexicalAnalyzer] Penganalisis untuk indeks.
tokenizers	list[LexicalTokenizer] Tokenizer untuk indeks.
token_filters	list[TokenFilter] Filter token untuk indeks.
char_filters	list[CharFilter] Karakter memfilter indeks.
encryption_key	SearchResourceEncryptionKey Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk menyediakan tingkat enkripsi tidak aktif tambahan untuk data Anda saat Anda menginginkan jaminan penuh bahwa tidak ada orang, bahkan Microsoft, yang dapat mendekripsi data Anda dalam Azure Cognitive Search. Setelah Anda mengenkripsi data Anda, data tersebut akan selalu tetap dienkripsi. Azure Cognitive Search akan mengabaikan upaya untuk menyetel properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi; Data Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
similarity	SimilarityAlgorithm Jenis algoritma kesamaan yang akan digunakan saat menilai dan memberi peringkat dokumen yang cocok dengan kueri pencarian. Algoritma kesamaan hanya dapat ditentukan pada waktu pembuatan indeks dan tidak dapat dimodifikasi pada indeks yang ada. Jika null, algoritma ClassicSimilarity digunakan.
semantic_search	SemanticSearch Menentukan parameter untuk indeks pencarian yang memengaruhi kemampuan semantik.
vector_search	VectorSearch Menentukan parameter untuk indeks pencarian yang memengaruhi penilaian di ruang vektor.
e_tag	str ETag indeks.

Metode

as_dict	Mengembalikan dict yang dapat diserialisasikan 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 'type' dengan jenis msrest dan 'key' 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	Mengembalikan JSON yang akan dikirim ke server 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.

as_dict

Mengembalikan dict yang dapat diserialisasikan 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 'type' dengan jenis msrest dan 'key' 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameter

Nama	Deskripsi
key_transformer	<xref:function> Fungsi transformator kunci.
keep_readonly	nilai default: True

Mengembalikan

Jenis	Deskripsi
dict	Objek yang kompatibel dengan JSON dict

deserialize

Uraikan str menggunakan sintaks RestAPI dan kembalikan model.

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

Parameter

Nama	Deskripsi
data Diperlukan	str str menggunakan struktur RestAPI. JSON secara default.
content_type	str JSON secara default, atur aplikasi/xml jika XML. nilai default: None

Mengembalikan

Jenis	Deskripsi
	Contoh model ini

Pengecualian

Jenis	Deskripsi
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

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: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameter

Nama	Deskripsi
data Diperlukan	dict Dict menggunakan struktur RestAPI
content_type	str JSON secara default, atur aplikasi/xml jika XML. nilai default: None
key_extractors	nilai default: None

Mengembalikan

Jenis	Deskripsi
	Contoh model ini

Pengecualian

Jenis	Deskripsi
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Mengembalikan JSON yang akan dikirim ke server 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: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameter

Nama	Deskripsi
keep_readonly	bool Jika Anda ingin menserialisasikan atribut readonly nilai default: False

Mengembalikan

Jenis	Deskripsi
dict	Objek yang kompatibel dengan JSON dict