SearchIndexClient Osztály

Egy ügyfél, amely az Azure search szolgáltatás indexével kommunikál.

Öröklődés

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

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

Paraméterek

endpoint

str

Kötelező

Egy Azure Search-szolgáltatás URL-végpontja

credential

AzureKeyCredential vagy TokenCredential

Kötelező

Hitelesítő adat a keresési ügyfélkérések engedélyezéséhez

api_version

str

A kérésekhez használandó Search API-verzió.

audience

str

az Azure Active Directoryval (AAD) való hitelesítéshez használni kívánt célközönséget állítja be. A célközönség nem számít megosztott kulcs használatakor. Ha a célközönség nincs megadva, a nyilvános felhő célközönségét feltételezzük.

Metódusok

analyze_text	Azt mutatja be, hogy egy elemző hogyan bontja a szöveget jogkivonatokká.
close	Zárja be a munkamenetet SearchIndexClient .
create_index	Új keresési indexet hoz létre.
create_or_update_index	Létrehoz egy új keresési indexet, vagy frissíti az indexet, ha már létezik.
create_or_update_synonym_map	Hozzon létre egy új szinonimatérképet egy Azure-Search szolgáltatás, vagy frissítsen egy meglévőt.
create_synonym_map	Új szinonimatérkép létrehozása egy Azure-Search szolgáltatás
delete_index	Törli a keresési indexet és a benne lévő összes dokumentumot. A hozzáférési feltételek használatához a modellt a név helyett kell megadni.
delete_synonym_map	Névvel ellátott szinonimatérkép törlése egy Azure-Search szolgáltatás. A hozzáférési feltételek használatához a név helyett a Szinonimakép modellt kell megadni. Elég megadni a szinonimatérkép nevét a feltétel nélküli törléshez.
get_index
get_index_statistics	Az adott index statisztikáit adja vissza, beleértve a dokumentumok számát és a tárterület használatát.
get_search_client	Ügyfél visszaadása a keresési műveletek végrehajtásához
get_service_statistics	Keresési szolgáltatás szolgáltatásiszint-statisztikáinak lekérése.
get_synonym_map	Névvel ellátott szinonimatérkép lekérése egy Azure-Search szolgáltatás
get_synonym_map_names	Az Azure-Search szolgáltatás szinonimatérkép-neveinek listázása.
get_synonym_maps	Az Azure-Search szolgáltatás szinonimatérképeinek listázása.
list_index_names	Az Indexnevek listázása egy Azure-Search szolgáltatás.
list_indexes	Az Azure-Search szolgáltatás indexeinek listázása.

analyze_text

Azt mutatja be, hogy egy elemző hogyan bontja a szöveget jogkivonatokká.

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

Paraméterek

index_name

str

Kötelező

Annak az indexnek a neve, amelynek az elemzőt tesztelnie kell.

analyze_request

AnalyzeTextOptions

Kötelező

A tesztelni kívánt szöveg- és elemző- vagy elemzési összetevők.

Válaszok

AnalyzeResult

Visszatérési típus

AnalyzeResult

Kivételek

HttpResponseError

Példák

Szöveg elemzése

   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

Zárja be a munkamenetet SearchIndexClient .

close() -> None

Kivételek

HttpResponseError

create_index

Új keresési indexet hoz létre.

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

Paraméterek

index

SearchIndex

Kötelező

Az indexobjektum.

Válaszok

Az index létrehozva

Visszatérési típus

SearchIndex

Kivételek

HttpResponseError

Példák

Új index létrehozása.

   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

Létrehoz egy új keresési indexet, vagy frissíti az indexet, ha már létezik.

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

Paraméterek

index

SearchIndex

Kötelező

Az indexobjektum.

allow_index_downtime

bool

Kötelező

Lehetővé teszi az új elemzők, jogkivonat-elemzők, jogkivonatszűrők vagy karakterszűrők hozzáadását egy indexhez úgy, hogy legalább néhány másodpercre offline állapotba viszi az indexet. Ez ideiglenesen az indexelés és a lekérdezési kérések sikertelenségéhez vezet. Az index teljesítménye és írási rendelkezésre állása az index frissítése után néhány percig, illetve a nagyon nagy indexek esetében hosszabb ideig is romlhat.

match_condition

MatchConditions

Az etagen használandó egyezési feltétel

Válaszok

Az index létrehozva vagy frissítve

Visszatérési típus

SearchIndex

Kivételek

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Példák

Index frissítése.

   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

Hozzon létre egy új szinonimatérképet egy Azure-Search szolgáltatás, vagy frissítsen egy meglévőt.

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

Paraméterek

synonym_map

SynonymMap

Kötelező

A Szinonimatérkép objektum

match_condition

MatchConditions

Az etagen használandó egyezési feltétel

Válaszok

A létrehozott vagy frissített szinonimatérkép

Visszatérési típus

SynonymMap

Kivételek

HttpResponseError

create_synonym_map

Új szinonimatérkép létrehozása egy Azure-Search szolgáltatás

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

Paraméterek

synonym_map

SynonymMap

Kötelező

A Szinonimatérkép objektum

Válaszok

A létrehozott szinonimatérkép

Visszatérési típus

SynonymMap

Kivételek

HttpResponseError

Példák

Szinonimatérkép létrehozása

   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

Törli a keresési indexet és a benne lévő összes dokumentumot. A hozzáférési feltételek használatához a modellt a név helyett kell megadni.

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

Paraméterek

index

str vagy SearchIndex

Kötelező

A törölni kívánt indexnév vagy objektum.

match_condition

MatchConditions

Az etagen használandó egyezési feltétel

Kivételek

HttpResponseError

Példák

Index törlése.

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

delete_synonym_map

Névvel ellátott szinonimatérkép törlése egy Azure-Search szolgáltatás. A hozzáférési feltételek használatához a név helyett a Szinonimakép modellt kell megadni. Elég megadni a szinonimatérkép nevét a feltétel nélküli törléshez.

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

Paraméterek

name

str vagy SynonymMap

Kötelező

A törölni kívánt szinonimatérkép neve vagy objektuma

match_condition

MatchConditions

Az etagen használandó egyezési feltétel

Válaszok

None

Visszatérési típus

None

Kivételek

HttpResponseError

Példák

Szinonimatérkép törlése

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

get_index

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

Paraméterek

name

str

Kötelező

A lekérni kívánt index neve.

Válaszok

SearchIndex objektum

Visszatérési típus

SearchIndex

Kivételek

HttpResponseError

Példák

Index lekérése.

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

get_index_statistics

Az adott index statisztikáit adja vissza, beleértve a dokumentumok számát és a tárterület használatát.

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

Paraméterek

index_name

str

Kötelező

A lekérni kívánt index neve.

Válaszok

Az adott index statisztikái, beleértve a dokumentumok számát és a tárterület használatát.

Visszatérési típus

Dict

Kivételek

HttpResponseError

get_search_client

Ügyfél visszaadása a keresési műveletek végrehajtásához

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

Paraméterek

index_name

str

Kötelező

A keresési index neve

Válaszok

SearchClient objektum

Visszatérési típus

SearchClient

Kivételek

HttpResponseError

get_service_statistics

Keresési szolgáltatás szolgáltatásiszint-statisztikáinak lekérése.

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

Válaszok

Szolgáltatásstatisztika eredménye.

Visszatérési típus

dict

Kivételek

HttpResponseError

get_synonym_map

Névvel ellátott szinonimatérkép lekérése egy Azure-Search szolgáltatás

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

Paraméterek

name

str

Kötelező

A lekérendő szinonimatérkép neve

Válaszok

A lekért szinonimatérkép

Visszatérési típus

SynonymMap

Kivételek

ResourceNotFoundError

Példák

Szinonimatérkép lekérése

   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

Az Azure-Search szolgáltatás szinonimatérkép-neveinek listázása.

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

Válaszok

Szinonimák térképeinek listája

Visszatérési típus

list[str]

Kivételek

HttpResponseError

get_synonym_maps

Az Azure-Search szolgáltatás szinonimatérképeinek listázása.

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

Paraméterek

select

list[str]

Kiválasztja a lekérni kívánt képességcsoportok legfelső szintű tulajdonságait. JSON-tulajdonságnevek listájaként van megadva, vagy "*" az összes tulajdonsághoz. Az alapértelmezett érték az összes tulajdonság.

Válaszok

Szinonimák térképeinek listája

Visszatérési típus

list[SynonymMap]

Kivételek

HttpResponseError

Példák

Szinonimatérképek listázása

   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

Az Indexnevek listázása egy Azure-Search szolgáltatás.

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

Válaszok

Indexnevek listája

Visszatérési típus

ItemPaged[str]

Kivételek

HttpResponseError

list_indexes

Az Azure-Search szolgáltatás indexeinek listázása.

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

Paraméterek

select

list[str]

Kiválasztja a lekérni kívánt képességcsoportok legfelső szintű tulajdonságait. JSON-tulajdonságnevek listájaként van megadva, vagy "*" az összes tulajdonsághoz. Az alapértelmezett érték az összes tulajdonság.

Válaszok

Indexek listája

Visszatérési típus

ItemPaged[SearchIndex]

Kivételek

HttpResponseError