SearchIndex Sınıf

Bir dizinin alanlarını ve arama davranışını açıklayan bir arama dizini tanımını temsil eder.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.

Devralma

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

SearchIndex

Oluşturucu

SearchIndex(**kwargs)

Değişkenler

Name	Description
name	str Gereklidir. Dizinin adı.
fields	list[SearchField] Gereklidir. Dizinin alanları.
scoring_profiles	list[ScoringProfile] Dizin için puanlama profilleri.
default_scoring_profile	str Sorguda belirtilmemişse kullanılacak puanlama profilinin adı. Bu özellik ayarlanmazsa ve sorguda puanlama profili belirtilmezse, varsayılan puanlama (tf-idf) kullanılır.
cors_options	CorsOptions Dizin için Çıkış Noktaları Arası Kaynak Paylaşımı'nı (CORS) denetleme seçenekleri.
suggesters	list[SearchSuggester] Dizin için öneride bulunanlar.
analyzers	list[LexicalAnalyzer] Dizin için çözümleyiciler.
tokenizers	list[LexicalTokenizer] Dizin için belirteç oluşturucular.
token_filters	list[TokenFilter] Dizin için belirteç filtreleri.
char_filters	list[CharFilter] Dizin için karakter filtreleri.
encryption_key	SearchResourceEncryptionKey Azure Key Vault'de oluşturduğunuz şifreleme anahtarının açıklaması. Bu anahtar, Azure Bilişsel Arama'da microsoft bile olmayan hiç kimsenin verilerinizin şifresini çözemediğini tam olarak güvenceye almak istediğinizde verileriniz için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Verilerinizi şifreledikten sonra her zaman şifrelenmiş olarak kalır. Azure Bilişsel Arama 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; Verileriniz 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.
similarity	SimilarityAlgorithm Arama sorgusuyla eşleşen belgeleri puanlama ve derecelendirme sırasında kullanılacak benzerlik algoritmasının türü. Benzerlik algoritması yalnızca dizin oluşturma zamanında tanımlanabilir ve mevcut dizinlerde değiştirilemez. Null ise ClassicSimilarity algoritması kullanılır.
semantic_search	SemanticSearch Anlamsal özellikleri etkileyen bir arama dizininin parametrelerini tanımlar.
vector_search	VectorSearch Vektör alanında puanlama işlemini etkileyen arama dizini parametrelerini tanımlar.
e_tag	str Dizinin ETag'i.

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: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 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
dict	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	str RestAPI yapısını kullanan bir str. Varsayılan olarak JSON.
content_type	str 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	dict RestAPI yapısını kullanan bir dikte
content_type	str 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	bool Salt okunur öznitelikleri seri hale getirmek istiyorsanız varsayılan değer: False

Döndürülenler

Tür	Description
dict	JSON uyumlu bir dikte nesnesi