SearchIndexer Sınıf
Dizin oluşturucuları temsil eder.
Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.
- Devralma
-
azure.search.documents.indexes._generated._serialization.ModelSearchIndexer
Oluşturucu
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)
Yalnızca Anahtar Sözcük Parametreleri
Name | Description |
---|---|
name
|
Dizin oluşturucunun adı. Gereklidir. |
description
|
Dizin oluşturucunun açıklaması. |
data_source_name
|
Bu dizin oluşturucunun verileri okuduğu veri kaynağının adı. Gereklidir. |
skillset_name
|
Bu dizin oluşturucuyla yürütülen beceri kümesinin adı. |
target_index_name
|
Bu dizin oluşturucunun veri yazdığı dizinin adı. Gereklidir. |
schedule
|
<xref:search_service_client.models.IndexingSchedule>
Bu dizin oluşturucu için zamanlama. |
parameters
|
<xref:search_service_client.models.IndexingParameters>
Dizin oluşturucu yürütme parametreleri. |
field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Veri kaynağındaki alanlarla dizindeki karşılık gelen hedef alanlar arasındaki eşlemeleri tanımlar. |
output_field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Çıkış alanı eşlemeleri zenginleştirmeden sonra ve dizin oluşturmadan hemen önce uygulanır. |
is_disabled
|
Dizin oluşturucunun devre dışı bırakılıp bırakılmadığını gösteren değer. Varsayılan değer false’tur. |
e_tag
|
Dizin oluşturucunun ETag'i. |
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
Azure Key Vault'de oluşturduğunuz şifreleme anahtarının açıklaması. Bu anahtar, Microsoft'un bile değil, hiç kimsenin şifresini çözemediğini tam olarak güvenceye almak istediğinizde dizin oluşturucu tanımınız (dizin oluşturucu yürütme durumu) için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Dizin oluşturucu tanımınızı şifreledikten sonra her zaman şifrelenmiş olarak kalır. Arama hizmeti bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Dizin oluşturucu tanımınız (ve dizin oluşturucu yürütme durumunuz) etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
Değişkenler
Name | Description |
---|---|
name
|
Dizin oluşturucunun adı. Gereklidir. |
description
|
Dizin oluşturucunun açıklaması. |
data_source_name
|
Bu dizin oluşturucunun verileri okuduğu veri kaynağının adı. Gereklidir. |
skillset_name
|
Bu dizin oluşturucuyla yürütülen beceri kümesinin adı. |
target_index_name
|
Bu dizin oluşturucunun veri yazdığı dizinin adı. Gereklidir. |
schedule
|
<xref:search_service_client.models.IndexingSchedule>
Bu dizin oluşturucu için zamanlama. |
parameters
|
<xref:search_service_client.models.IndexingParameters>
Dizin oluşturucu yürütme parametreleri. |
field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Veri kaynağındaki alanlarla dizindeki karşılık gelen hedef alanlar arasındaki eşlemeleri tanımlar. |
output_field_mappings
|
list[<xref:search_service_client.models.FieldMapping>]
Çıkış alanı eşlemeleri zenginleştirmeden sonra ve dizin oluşturmadan hemen önce uygulanır. |
is_disabled
|
Dizin oluşturucunun devre dışı bırakılıp bırakılmadığını gösteren değer. Varsayılan değer false’tur. |
e_tag
|
Dizin oluşturucunun ETag'i. |
encryption_key
|
<xref:search_service_client.models.SearchResourceEncryptionKey>
Azure Key Vault'de oluşturduğunuz şifreleme anahtarının açıklaması. Bu anahtar, Microsoft'un bile değil, hiç kimsenin şifresini çözemediğini tam olarak güvenceye almak istediğinizde dizin oluşturucu tanımınız (dizin oluşturucu yürütme durumu) için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Dizin oluşturucu tanımınızı şifreledikten sonra her zaman şifrelenmiş olarak kalır. Arama hizmeti bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Dizin oluşturucu tanımınız (ve dizin oluşturucu yürütme durumunuz) etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
Yöntemler
as_dict |
json.dump kullanılarak seri hale getirilebilen bir dikte döndürür. Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir: Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir. Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir. Bu dosyadaki üç örne bakın:
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz. |
deserialize |
RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün. |
enable_additional_properties_sending | |
from_dict |
Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür. Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun |
is_xml_model | |
serialize |
Bu modelden sunucuya gönderilecek JSON'ı döndür. Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır. XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz. |
as_dict
json.dump kullanılarak seri hale getirilebilen bir dikte döndürür.
Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir:
Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir.
Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir.
Bu dosyadaki üç örne bakın:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
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]
Parametreler
Name | Description |
---|---|
key_transformer
|
<xref:function>
Anahtar transformatörü işlevi. |
keep_readonly
|
varsayılan değer: True
|
Döndürülenler
Tür | Description |
---|---|
JSON uyumlu bir dikte nesnesi |
deserialize
RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Parametreler
Name | Description |
---|---|
data
Gerekli
|
RestAPI yapısını kullanan bir str. Varsayılan olarak JSON. |
content_type
|
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın. varsayılan değer: None
|
Döndürülenler
Tür | Description |
---|---|
Bu modelin bir örneği |
Özel durumlar
Tür | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür.
Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun
from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType
Parametreler
Name | Description |
---|---|
data
Gerekli
|
RestAPI yapısını kullanan bir dikte |
content_type
|
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın. varsayılan değer: None
|
key_extractors
|
varsayılan değer: None
|
Döndürülenler
Tür | Description |
---|---|
Bu modelin bir örneği |
Özel durumlar
Tür | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Bu modelden sunucuya gönderilecek JSON'ı döndür.
Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Parametreler
Name | Description |
---|---|
keep_readonly
|
Salt okunur öznitelikleri seri hale getirmek istiyorsanız varsayılan değer: False
|
Döndürülenler
Tür | Description |
---|---|
JSON uyumlu bir dikte nesnesi |
Azure SDK for Python
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin