SearchIndexClient Sınıf

Azure arama hizmeti diziniyle etkileşime geçmek için bir istemci.

Devralma

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Oluşturucu

SearchIndexClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parametreler

endpoint

str

Gerekli

Azure arama hizmetinin URL uç noktası

credential

AzureKeyCredential veya TokenCredential

Gerekli

Arama istemcisi isteklerini yetkilendirmek için bir kimlik bilgisi

api_version

str

İstekler için kullanılacak Arama API'sinin sürümü.

audience

str

, Azure Active Directory (AAD) ile kimlik doğrulaması için kullanılacak hedef kitleyi ayarlar. Paylaşılan anahtar kullanılırken hedef kitle dikkate alınmaz. Hedef kitle sağlanmazsa genel bulut hedef kitlesi varsayılır.

Yöntemler

analyze_text	Çözümleyicinin metni belirteçlere nasıl böler olduğunu gösterir.
close	SearchIndexClient Oturumu kapatın.
create_index	Yeni bir arama dizini oluşturur.
create_or_update_index	Yeni bir arama dizini oluşturur veya zaten varsa dizini güncelleştirir.
create_or_update_synonym_map	Azure Arama hizmeti yeni bir Eş Anlamlı Eşlemesi oluşturun veya mevcut eşlemleri güncelleştirin.
create_synonym_map	Azure Arama hizmeti yeni bir Eş anlamlı eşlem oluşturma
delete_index	Arama dizinini ve içerdiği tüm belgeleri siler. Erişim koşullarını kullanmak için model adı yerine sağlanmalıdır.
delete_synonym_map	Azure Arama hizmeti adlandırılmış eş anlamlı eşlemlerini silin. Erişim koşullarını kullanmak için ad yerine SynonymMap modelinin sağlanması gerekir. Eş anlamlı eşlemesinin adını koşulsuz olarak silmek için sağlamak yeterlidir.
get_index
get_index_statistics	Belge sayısı ve depolama kullanımı dahil olmak üzere verilen dizine ilişkin istatistikleri döndürür.
get_search_client	Arama'da işlem gerçekleştirmek için istemci döndürme
get_service_statistics	Arama hizmeti için hizmet düzeyi istatistiklerini alın.
get_synonym_map	Azure Arama hizmeti adlandırılmış eş anlamlı eşlem alma
get_synonym_map_names	Azure Arama hizmeti eş anlamlı eşlem adlarını listeleyin.
get_synonym_maps	Bir Azure Arama hizmeti Eş Anlamlı Eşlemeleri'ni listeleyin.
list_index_names	Azure Arama hizmeti dizin adlarını listeleme.
list_indexes	Azure Arama hizmeti dizinlerini listeleme.

analyze_text

Çözümleyicinin metni belirteçlere nasıl böler olduğunu gösterir.

analyze_text(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) -> AnalyzeResult

Parametreler

index_name

str

Gerekli

Çözümleyicinin testine yönelik dizinin adı.

analyze_request

AnalyzeTextOptions

Gerekli

Test etmek için kullanılan metin ve çözümleyici veya analiz bileşenleri.

Döndürülenler

AnalyzeResult

Dönüş türü

AnalyzeResult

Özel durumlar

HttpResponseError

Örnekler

Metni analiz etme

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexClient
   from azure.search.documents.indexes.models import AnalyzeTextOptions

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))

   analyze_request = AnalyzeTextOptions(text="One's <two/>", analyzer_name="standard.lucene")

   result = client.analyze_text(index_name, analyze_request)
   print(result.as_dict())

close

SearchIndexClient Oturumu kapatın.

close() -> None

Özel durumlar

HttpResponseError

create_index

Yeni bir arama dizini oluşturur.

create_index(index: SearchIndex, **kwargs: Any) -> SearchIndex

Parametreler

index

SearchIndex

Gerekli

Dizin nesnesi.

Döndürülenler

Oluşturulan dizin

Dönüş türü

SearchIndex

Özel durumlar

HttpResponseError

Örnekler

Yeni dizin oluşturma.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profiles: List[ScoringProfile] = []
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_index(index)

create_or_update_index

Yeni bir arama dizini oluşturur veya zaten varsa dizini güncelleştirir.

create_or_update_index(index: SearchIndex, allow_index_downtime: bool | None = None, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndex

Parametreler

index

SearchIndex

Gerekli

Dizin nesnesi.

allow_index_downtime

bool

Gerekli

Dizini en az birkaç saniye çevrimdışına alarak yeni çözümleyicilerin, belirteçlerin, belirteç filtrelerinin veya karakter filtrelerinin dizine eklenmesine izin verir. Bu, dizin oluşturma ve sorgu isteklerinin geçici olarak başarısız olmasına neden olur. Dizinin performansı ve yazma kullanılabilirliği, dizin güncelleştirildikten sonra birkaç dakika veya çok büyük dizinler için daha uzun süre bozulabilir.

match_condition

MatchConditions

Etag üzerinde kullanılacak eşleştirme koşulu

Döndürülenler

Oluşturulan veya güncelleştirilen dizin

Dönüş türü

SearchIndex

Özel durumlar

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Örnekler

Dizini güncelleştirme.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   fields = [
       SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
       SimpleField(name="baseRate", type=SearchFieldDataType.Double),
       SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
       SearchableField(name="hotelName", type=SearchFieldDataType.String),
       ComplexField(
           name="address",
           fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
               SimpleField(name="state", type=SearchFieldDataType.String),
           ],
           collection=True,
       ),
   ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profile = ScoringProfile(name="MyProfile")
   scoring_profiles = []
   scoring_profiles.append(scoring_profile)
   index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)

   result = client.create_or_update_index(index=index)

create_or_update_synonym_map

Azure Arama hizmeti yeni bir Eş Anlamlı Eşlemesi oluşturun veya mevcut eşlemleri güncelleştirin.

create_or_update_synonym_map(synonym_map: SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SynonymMap

Parametreler

synonym_map

SynonymMap

Gerekli

Eş Anlamlı Eşleme nesnesi

match_condition

MatchConditions

Etag üzerinde kullanılacak eşleştirme koşulu

Döndürülenler

Oluşturulan veya güncelleştirilen Eş Anlamlı Eşlem

Dönüş türü

SynonymMap

Özel durumlar

HttpResponseError

create_synonym_map

Azure Arama hizmeti yeni bir Eş anlamlı eşlem oluşturma

create_synonym_map(synonym_map: SynonymMap, **kwargs: Any) -> SynonymMap

Parametreler

synonym_map

SynonymMap

Gerekli

Eş Anlamlı Eşleme nesnesi

Döndürülenler

Oluşturulan Eş Anlamlı Eşlem

Dönüş türü

SynonymMap

Özel durumlar

HttpResponseError

Örnekler

Eş Anlamlı Eşlem Oluşturma

   synonyms = [
       "USA, United States, United States of America",
       "Washington, Wash. => WA",
   ]
   synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms)
   result = client.create_synonym_map(synonym_map)
   print("Create new Synonym Map 'test-syn-map succeeded")

delete_index

Arama dizinini ve içerdiği tüm belgeleri siler. Erişim koşullarını kullanmak için model adı yerine sağlanmalıdır.

delete_index(index: str | SearchIndex, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parametreler

index

str veya SearchIndex

Gerekli

Silinecek dizin adı veya nesnesi.

match_condition

MatchConditions

Etag üzerinde kullanılacak eşleştirme koşulu

Özel durumlar

HttpResponseError

Örnekler

Dizini silme.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   client.delete_index(name)

delete_synonym_map

Azure Arama hizmeti adlandırılmış eş anlamlı eşlemlerini silin. Erişim koşullarını kullanmak için ad yerine SynonymMap modelinin sağlanması gerekir. Eş anlamlı eşlemesinin adını koşulsuz olarak silmek için sağlamak yeterlidir.

delete_synonym_map(synonym_map: str | SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parametreler

name

str veya SynonymMap

Gerekli

Silinecek eş anlamlı eşlem adı veya nesnesi

match_condition

MatchConditions

Etag üzerinde kullanılacak eşleştirme koşulu

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

Örnekler

Eş Anlamlı Eşlem Silme

   client.delete_synonym_map("test-syn-map")
   print("Synonym Map 'test-syn-map' deleted")

get_index

get_index(name: str, **kwargs: Any) -> SearchIndex

Parametreler

name

str

Gerekli

Alınacak dizinin adı.

Döndürülenler

SearchIndex nesnesi

Dönüş türü

SearchIndex

Özel durumlar

HttpResponseError

Örnekler

Dizin alın.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   result = client.get_index(name)

get_index_statistics

Belge sayısı ve depolama kullanımı dahil olmak üzere verilen dizine ilişkin istatistikleri döndürür.

get_index_statistics(index_name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parametreler

index_name

str

Gerekli

Alınacak dizinin adı.

Döndürülenler

Belge sayısı ve depolama kullanımı dahil olmak üzere verilen dizine ilişkin istatistikler.

Dönüş türü

Dict

Özel durumlar

HttpResponseError

get_search_client

Arama'da işlem gerçekleştirmek için istemci döndürme

get_search_client(index_name: str, **kwargs: Any) -> SearchClient

Parametreler

index_name

str

Gerekli

Arama Dizininin adı

Döndürülenler

SearchClient nesnesi

Dönüş türü

SearchClient

Özel durumlar

HttpResponseError

get_service_statistics

Arama hizmeti için hizmet düzeyi istatistiklerini alın.

get_service_statistics(**kwargs: Any) -> MutableMapping[str, Any]

Döndürülenler

Hizmet istatistikleri sonucu.

Dönüş türü

dict

Özel durumlar

HttpResponseError

get_synonym_map

Azure Arama hizmeti adlandırılmış eş anlamlı eşlem alma

get_synonym_map(name: str, **kwargs: Any) -> SynonymMap

Parametreler

name

str

Gerekli

Alınacak Eş Anlamlı Eşlem'in adı

Döndürülenler

Alınan Eş Anlamlı Eşlem

Dönüş türü

SynonymMap

Özel durumlar

ResourceNotFoundError

Örnekler

Eş AnlamlıLar Haritası Alma

   result = client.get_synonym_map("test-syn-map")
   print("Retrived Synonym Map 'test-syn-map' with synonyms")
   for syn in result.synonyms:
       print("    {}".format(syn))

get_synonym_map_names

Azure Arama hizmeti eş anlamlı eşlem adlarını listeleyin.

get_synonym_map_names(**kwargs: Any) -> List[str]

Döndürülenler

Eş anlamlı haritalar listesi

Dönüş türü

list[str]

Özel durumlar

HttpResponseError

get_synonym_maps

Bir Azure Arama hizmeti Eş Anlamlı Eşlemeleri'ni listeleyin.

get_synonym_maps(*, select: List[str] | None = None, **kwargs) -> List[SynonymMap]

Parametreler

select

list[str]

Beceri kümelerinin hangi üst düzey özelliklerinin alınacaklarını seçer. JSON özellik adlarının listesi olarak veya tüm özellikler için '*' olarak belirtilir. Varsayılan değer tüm özelliklerdir.

Döndürülenler

Eş anlamlı haritalar listesi

Dönüş türü

list[SynonymMap]

Özel durumlar

HttpResponseError

Örnekler

Eş Anlamlı Haritaları Listeleme

   result = client.get_synonym_maps()
   names = [x.name for x in result]
   print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))

list_index_names

Azure Arama hizmeti dizin adlarını listeleme.

list_index_names(**kwargs: Any) -> ItemPaged[str]

Döndürülenler

Dizin adları listesi

Dönüş türü

ItemPaged[str]

Özel durumlar

HttpResponseError

list_indexes

Azure Arama hizmeti dizinlerini listeleme.

list_indexes(*, select: List[str] | None = None, **kwargs: Any) -> ItemPaged[SearchIndex]

Parametreler

select

list[str]

Beceri kümelerinin hangi üst düzey özelliklerinin alınacaklarını seçer. JSON özellik adlarının listesi olarak veya tüm özellikler için '*' olarak belirtilir. Varsayılan değer tüm özelliklerdir.

Döndürülenler

Dizin listesi

Dönüş türü

ItemPaged[SearchIndex]

Özel durumlar

HttpResponseError