SearchIndexClient Třída

Reference

Klient pro interakci s indexem služby Azure Search.

Dědičnost: azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

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

Parametry

endpoint: str

Vyžadováno

Koncový bod adresy URL služby Azure Search

credential: AzureKeyCredential nebo TokenCredential

Vyžadováno

Přihlašovací údaje pro autorizaci žádostí klientů vyhledávání

api_version: str

Verze rozhraní API pro vyhledávání, která se má použít pro požadavky.

audience: str

nastaví cílovou skupinu pro ověřování pomocí Azure Active Directory (AAD). Při použití sdíleného klíče se nezohlední cílová skupina. Pokud cílová skupina není k dispozici, předpokládá se cílová skupina veřejného cloudu.

Metody

analyze_text	Ukazuje, jak analyzátor rozděluje text na tokeny.
close	Zavřete SearchIndexClient relaci.
create_index	Vytvoří nový index vyhledávání.
create_or_update_index	Vytvoří nový index vyhledávání nebo aktualizuje index, pokud již existuje.
create_or_update_synonym_map	Vytvořte novou mapu synonym v azure Search nebo aktualizujte existující mapu.
create_synonym_map	Vytvoření nové mapy synonym v Azure Search
delete_index	Odstraní index vyhledávání a všechny dokumenty, které obsahuje. Aby bylo možné použít podmínky přístupu, musí se místo názvu zadat model.
delete_synonym_map	Odstraňte pojmenovanou mapu synonym v azure Search. Pokud chcete použít podmínky přístupu, musí se místo názvu zadat model SynonymMap. K bezpodmínečnému odstranění stačí zadat název mapy synonym.
get_index
get_index_statistics	Vrátí statistiky pro daný index, včetně počtu dokumentů a využití úložiště.
get_search_client	Vrácení klienta k provádění operací při vyhledávání
get_service_statistics	Získání statistiky na úrovni služby Search
get_synonym_map	Načtení pojmenované mapy synonym v Azure Search
get_synonym_map_names	Vypište názvy map synonym v azure Search.
get_synonym_maps	Výpis map synonym v azure Search.
list_index_names	Výpis názvů indexů v azure Search
list_indexes	Výpis indexů v Azure Search

analyze_text

Ukazuje, jak analyzátor rozděluje text na tokeny.

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

Parametry

index_name: str

Vyžadováno

Název indexu, pro který se má testovat analyzátor.

analyze_request: AnalyzeTextOptions

Vyžadováno

Komponenty textu a analyzátoru nebo analýzy, které se mají testovat.

Návraty

AnalyzeResult

Návratový typ

AnalyzeResult

Výjimky

HttpResponseError

Příklady

Analýza textu


   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

Zavřete SearchIndexClient relaci.

close() -> None

Výjimky

HttpResponseError

create_index

Vytvoří nový index vyhledávání.

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

Parametry

index: SearchIndex

Vyžadováno

Objekt indexu.

Návraty

Vytvořený index

Návratový typ

SearchIndex

Výjimky

HttpResponseError

Příklady

Vytvoření nového indexu.


   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

Vytvoří nový index vyhledávání nebo aktualizuje index, pokud již existuje.

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

Parametry

index: SearchIndex

Vyžadováno

Objekt indexu.

allow_index_downtime: bool

Vyžadováno

Umožňuje přidat do indexu nové analyzátory, tokenizátory, filtry tokenů nebo filtry znaků tak, že index alespoň na několik sekund přejdou do offline režimu. To dočasně způsobí selhání požadavků na indexování a dotazování. Výkon a dostupnost zápisu indexu může být narušena několik minut po aktualizaci indexu nebo déle u velmi velkých indexů.

match_condition: MatchConditions

Podmínka shody, která se má použít u značky etag

Návraty

Vytvořený nebo aktualizovaný index

Návratový typ

SearchIndex

Výjimky

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Příklady

Aktualizace indexu


   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

Vytvořte novou mapu synonym v azure Search nebo aktualizujte existující mapu.

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

Parametry

synonym_map: SynonymMap

Vyžadováno

Objekt Mapování synonym

match_condition: MatchConditions

Podmínka shody, která se má použít u značky etag

Návraty

Vytvořená nebo aktualizovaná mapa synonym

Návratový typ

SynonymMap

Výjimky

HttpResponseError

create_synonym_map

Vytvoření nové mapy synonym v Azure Search

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

Parametry

synonym_map: SynonymMap

Vyžadováno

Objekt Mapování synonym

Návraty

Vytvořená mapa synonym

Návratový typ

SynonymMap

Výjimky

HttpResponseError

Příklady

Vytvoření mapy synonym


   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

Odstraní index vyhledávání a všechny dokumenty, které obsahuje. Aby bylo možné použít podmínky přístupu, musí se místo názvu zadat model.

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

Parametry

index: str nebo SearchIndex

Vyžadováno

Název indexu nebo objekt, který chcete odstranit.

match_condition: MatchConditions

Podmínka shody, která se má použít u značky etag

Výjimky

HttpResponseError

Příklady

Odstranění indexu


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

delete_synonym_map

Odstraňte pojmenovanou mapu synonym v azure Search. Pokud chcete použít podmínky přístupu, musí se místo názvu zadat model SynonymMap. K bezpodmínečnému odstranění stačí zadat název mapy synonym.

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

Parametry

name: str nebo SynonymMap

Vyžadováno

Název mapování synonym nebo objekt, který chcete odstranit

match_condition: MatchConditions

Podmínka shody, která se má použít u značky etag

Návraty

Žádné

Návratový typ

None

Výjimky

HttpResponseError

Příklady

Odstranění mapy synonym


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

get_index

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

Parametry

name: str

Vyžadováno

Název indexu, který se má načíst.

Návraty

Objekt SearchIndex

Návratový typ

SearchIndex

Výjimky

HttpResponseError

Příklady

Získání indexu


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

get_index_statistics

Vrátí statistiky pro daný index, včetně počtu dokumentů a využití úložiště.

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

Parametry

index_name: str

Vyžadováno

Název indexu, který se má načíst.

Návraty

Statistika daného indexu, včetně počtu dokumentů a využití úložiště.

Návratový typ

Dict

Výjimky

HttpResponseError

get_search_client

Vrácení klienta k provádění operací při vyhledávání

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

Parametry

index_name: str

Vyžadováno

Název indexu vyhledávání

Návraty

Objekt SearchClient

Návratový typ

SearchClient

Výjimky

HttpResponseError

get_service_statistics

Získání statistiky na úrovni služby Search

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

Návraty

Výsledek statistiky služby.

Návratový typ

dict

Výjimky

HttpResponseError

get_synonym_map

Načtení pojmenované mapy synonym v Azure Search

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

Parametry

name: str

Vyžadováno

Název mapy synonym, který chcete získat

Návraty

Načtená mapa synonym

Návratový typ

SynonymMap

Výjimky

ResourceNotFoundError

Příklady

Získání mapy synonym


   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

Vypište názvy map synonym v azure Search.

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

Návraty

Seznam map synonym

Návratový typ

list[str]

Výjimky

HttpResponseError

get_synonym_maps

Výpis map synonym v azure Search.

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

Parametry

select: list[str]

Vybere vlastnosti nejvyšší úrovně sad dovedností, které se mají načíst. Zadaný jako seznam názvů vlastností JSON nebo *pro všechny vlastnosti. Výchozí hodnota je všechny vlastnosti.

Návraty

Seznam map synonym

Návratový typ

list[SynonymMap]

Výjimky

HttpResponseError

Příklady

Seznam map synonym


   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

Výpis názvů indexů v azure Search

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

Návraty

Seznam názvů indexů

Návratový typ

ItemPaged[str]

Výjimky

HttpResponseError

list_indexes

Výpis indexů v Azure Search

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

Parametry

select: list[str]

Vybere vlastnosti nejvyšší úrovně sad dovedností, které se mají načíst. Zadaný jako seznam názvů vlastností JSON nebo *pro všechny vlastnosti. Výchozí hodnota je všechny vlastnosti.

Návraty

Seznam indexů

Návratový typ

ItemPaged[SearchIndex]

Výjimky

HttpResponseError