SearchIndexClient Klasa

Klient do interakcji z indeksem usługi Azure Search.

Dziedziczenie

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

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

Parametry

endpoint

str

Wymagane

Punkt końcowy adresu URL usługi Azure Search

credential

AzureKeyCredential lub TokenCredential

Wymagane

Poświadczenie autoryzacji żądań klientów wyszukiwania

api_version

str

Wersja interfejsu API wyszukiwania do użycia dla żądań.

audience

str

ustawia odbiorców do użycia do uwierzytelniania w usłudze Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę podczas korzystania z klucza współużytkowanego. Jeśli odbiorcy nie zostaną podani, zakłada się, że odbiorcy chmury publicznej.

Metody

analyze_text	Pokazuje, jak analizator dzieli tekst na tokeny.
close	Zamknij sesję SearchIndexClient .
create_index	Tworzy nowy indeks wyszukiwania.
create_or_update_index	Tworzy nowy indeks wyszukiwania lub aktualizuje indeks, jeśli już istnieje.
create_or_update_synonym_map	Utwórz nową mapę synonimów w usłudze Azure usługa wyszukiwania lub zaktualizuj istniejącą.
create_synonym_map	Tworzenie nowej mapy synonimów w usłudze Azure usługa wyszukiwania
delete_index	Usuwa indeks wyszukiwania i wszystkie zawarte w nim dokumenty. Model musi być podany zamiast nazwy, aby korzystać z warunków dostępu.
delete_synonym_map	Usuń nazwę mapowania synonimów w usłudze Azure usługa wyszukiwania. Aby można było korzystać z warunków dostępu, należy podać model SynonymMap zamiast nazwy. Wystarczy podać nazwę mapy synonimów, aby usunąć bezwarunkowo.
get_index
get_index_statistics	Zwraca statystyki dla danego indeksu, w tym liczbę dokumentów i użycie magazynu.
get_search_client	Zwracanie klienta do wykonywania operacji w usłudze Search
get_service_statistics	Pobieranie statystyk poziomu usług dla usługi wyszukiwania.
get_synonym_map	Pobieranie nazwanej mapy synonimów w usłudze Azure usługa wyszukiwania
get_synonym_map_names	Wyświetl listę nazw map synonimów w usłudze Azure usługa wyszukiwania.
get_synonym_maps	Wyświetl listę map synonimów w usłudze Azure usługa wyszukiwania.
list_index_names	Wyświetl listę nazw indeksów w usłudze Azure usługa wyszukiwania.
list_indexes	Wyświetl listę indeksów w usługa wyszukiwania platformy Azure.

analyze_text

Pokazuje, jak analizator dzieli tekst na tokeny.

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

Parametry

index_name

str

Wymagane

Nazwa indeksu, dla którego należy przetestować analizator.

analyze_request

AnalyzeTextOptions

Wymagane

Składniki tekstowe i analizatora lub analizy do przetestowania.

Zwraca

AnalyzeResult

Typ zwracany

AnalyzeResult

Wyjątki

HttpResponseError

Przykłady

Analizowanie tekstu

   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

Zamknij sesję SearchIndexClient .

close() -> None

Wyjątki

HttpResponseError

create_index

Tworzy nowy indeks wyszukiwania.

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

Parametry

index

SearchIndex

Wymagane

Obiekt indeksu.

Zwraca

Utworzony indeks

Typ zwracany

SearchIndex

Wyjątki

HttpResponseError

Przykłady

Tworzenie nowego indeksu.

   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

Tworzy nowy indeks wyszukiwania lub aktualizuje indeks, jeśli już istnieje.

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

Parametry

index

SearchIndex

Wymagane

Obiekt indeksu.

allow_index_downtime

bool

Wymagane

Umożliwia dodawanie nowych analizatorów, tokenizatorów, filtrów tokenów lub filtrów char do indeksu przez co najmniej kilka sekund przełączenie indeksu do trybu offline. Powoduje to tymczasowe niepowodzenie indeksowania i wysyłania zapytań do żądań. Wydajność i dostępność zapisu indeksu może być obniżona przez kilka minut po zaktualizowaniu indeksu lub dłużej dla bardzo dużych indeksów.

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu

Zwraca

Indeks został utworzony lub zaktualizowany

Typ zwracany

SearchIndex

Wyjątki

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Przykłady

Aktualizowanie indeksu.

   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

Utwórz nową mapę synonimów w usłudze Azure usługa wyszukiwania lub zaktualizuj istniejącą.

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

Parametry

synonym_map

SynonymMap

Wymagane

Obiekt Mapowania synonimów

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu

Zwraca

Utworzona lub zaktualizowana mapa synonimów

Typ zwracany

SynonymMap

Wyjątki

HttpResponseError

create_synonym_map

Tworzenie nowej mapy synonimów w usłudze Azure usługa wyszukiwania

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

Parametry

synonym_map

SynonymMap

Wymagane

Obiekt Mapowania synonimów

Zwraca

Utworzona mapa synonimów

Typ zwracany

SynonymMap

Wyjątki

HttpResponseError

Przykłady

Tworzenie mapy synonimów

   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

Usuwa indeks wyszukiwania i wszystkie zawarte w nim dokumenty. Model musi być podany zamiast nazwy, aby korzystać z warunków dostępu.

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

Parametry

index

str lub SearchIndex

Wymagane

Nazwa indeksu lub obiekt do usunięcia.

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu

Wyjątki

HttpResponseError

Przykłady

Usuń indeks.

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

delete_synonym_map

Usuń nazwę mapowania synonimów w usłudze Azure usługa wyszukiwania. Aby można było korzystać z warunków dostępu, należy podać model SynonymMap zamiast nazwy. Wystarczy podać nazwę mapy synonimów, aby usunąć bezwarunkowo.

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

Parametry

name

str lub SynonymMap

Wymagane

Nazwa mapy lub obiekt synonimu do usunięcia

match_condition

MatchConditions

Warunek dopasowania do użycia na etagu

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

Przykłady

Usuwanie mapy synonimów

   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

Wymagane

Nazwa indeksu do pobrania.

Zwraca

Obiekt SearchIndex

Typ zwracany

SearchIndex

Wyjątki

HttpResponseError

Przykłady

Pobierz indeks.

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

get_index_statistics

Zwraca statystyki dla danego indeksu, w tym liczbę dokumentów i użycie magazynu.

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

Parametry

index_name

str

Wymagane

Nazwa indeksu do pobrania.

Zwraca

Statystyki dla danego indeksu, w tym liczba dokumentów i użycie magazynu.

Typ zwracany

Dict

Wyjątki

HttpResponseError

get_search_client

Zwracanie klienta do wykonywania operacji w usłudze Search

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

Parametry

index_name

str

Wymagane

Nazwa indeksu wyszukiwania

Zwraca

Obiekt SearchClient

Typ zwracany

SearchClient

Wyjątki

HttpResponseError

get_service_statistics

Pobieranie statystyk poziomu usług dla usługi wyszukiwania.

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

Zwraca

Wynik statystyk usługi.

Typ zwracany

dict

Wyjątki

HttpResponseError

get_synonym_map

Pobieranie nazwanej mapy synonimów w usłudze Azure usługa wyszukiwania

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

Parametry

name

str

Wymagane

Nazwa mapy synonimów do pobrania

Zwraca

Pobrana mapa synonimów

Typ zwracany

SynonymMap

Wyjątki

ResourceNotFoundError

Przykłady

Pobieranie mapy synonimów

   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

Wyświetl listę nazw map synonimów w usłudze Azure usługa wyszukiwania.

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

Zwraca

Lista map synonimów

Typ zwracany

list[str]

Wyjątki

HttpResponseError

get_synonym_maps

Wyświetl listę map synonimów w usłudze Azure usługa wyszukiwania.

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

Parametry

select

list[str]

Wybiera właściwości najwyższego poziomu zestawów umiejętności do pobrania. Określona jako lista nazw właściwości JSON lub "*" dla wszystkich właściwości. Wartość domyślna to wszystkie właściwości.

Zwraca

Lista map synonimów

Typ zwracany

list[SynonymMap]

Wyjątki

HttpResponseError

Przykłady

Mapy synonimów listy

   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

Wyświetl listę nazw indeksów w usłudze Azure usługa wyszukiwania.

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

Zwraca

Lista nazw indeksów

Typ zwracany

ItemPaged[str]

Wyjątki

HttpResponseError

list_indexes

Wyświetl listę indeksów w usługa wyszukiwania platformy Azure.

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

Parametry

select

list[str]

Wybiera właściwości najwyższego poziomu zestawów umiejętności do pobrania. Określona jako lista nazw właściwości JSON lub "*" dla wszystkich właściwości. Wartość domyślna to wszystkie właściwości.

Zwraca

Lista indeksów

Typ zwracany

ItemPaged[SearchIndex]

Wyjątki

HttpResponseError