Bagikan melalui

SearchIndexer Kelas

  • Referensi

Mewakili pengindeks.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.

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

Konstruktor

SearchIndexer(*, name: str, data_source_name: str, target_index_name: str, description: str | None = None, skillset_name: str | None = None, schedule: _models.IndexingSchedule | None = None, parameters: _models.IndexingParameters | None = None, field_mappings: List[_models.FieldMapping] | None = None, output_field_mappings: List[_models.FieldMapping] | None = None, is_disabled: bool = False, e_tag: str | None = None, encryption_key: _models.SearchResourceEncryptionKey | None = None, **kwargs: Any)

Parameter Kata Kunci-Saja

Nama Deskripsi
name
str

Nama pengindeks. Wajib diisi.
description
str

Deskripsi pengindeks.
data_source_name
str

Nama sumber data tempat pengindeks ini membaca data. Wajib diisi.
skillset_name
str

Nama skillset yang dieksekusi dengan pengindeks ini.
target_index_name
str

Nama indeks tempat pengindeks ini menulis data. Wajib diisi.
schedule
<xref:search_service_client.models.IndexingSchedule>

Jadwal untuk pengindeks ini.
parameters
<xref:search_service_client.models.IndexingParameters>

Parameter untuk eksekusi pengindeks.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Menentukan pemetaan antara bidang di sumber data dan bidang target terkait dalam indeks.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Pemetaan bidang output diterapkan setelah pengayaan dan segera sebelum pengindeksan.
is_disabled
bool

Nilai yang menunjukkan apakah pengindeks dinonaktifkan. Defaultnya adalah false.
e_tag
str

ETag pengindeks.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi-saat-istirahat tambahan untuk definisi pengindeks Anda (serta status eksekusi pengindeks) ketika Anda menginginkan jaminan penuh bahwa tidak ada, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi pengindeks, definisi pengindeks akan selalu tetap dienkripsi. Layanan pencarian akan mengabaikan upaya untuk menyetel properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi; Definisi pengindeks Anda (dan status eksekusi pengindeks) 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.

Variabel

Nama Deskripsi
name
str

Nama pengindeks. Wajib diisi.
description
str

Deskripsi pengindeks.
data_source_name
str

Nama sumber data tempat pengindeks ini membaca data. Wajib diisi.
skillset_name
str

Nama skillset yang dieksekusi dengan pengindeks ini.
target_index_name
str

Nama indeks tempat pengindeks ini menulis data. Wajib diisi.
schedule
<xref:search_service_client.models.IndexingSchedule>

Jadwal untuk pengindeks ini.
parameters
<xref:search_service_client.models.IndexingParameters>

Parameter untuk eksekusi pengindeks.
field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Menentukan pemetaan antara bidang di sumber data dan bidang target terkait dalam indeks.
output_field_mappings
list[<xref:search_service_client.models.FieldMapping>]

Pemetaan bidang output diterapkan setelah pengayaan dan segera sebelum pengindeksan.
is_disabled
bool

Nilai yang menunjukkan apakah pengindeks dinonaktifkan. Defaultnya adalah false.
e_tag
str

ETag pengindeks.
encryption_key
<xref:search_service_client.models.SearchResourceEncryptionKey>

Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi-saat-istirahat tambahan untuk definisi pengindeks Anda (serta status eksekusi pengindeks) ketika Anda menginginkan jaminan penuh bahwa tidak ada, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi pengindeks, definisi pengindeks akan selalu tetap dienkripsi. Layanan pencarian akan mengabaikan upaya untuk menyetel properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi; Definisi pengindeks Anda (dan status eksekusi pengindeks) 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.

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