SearchIndexerClient Klasa

Klient do interakcji z indeksatorami usługi Azure Search.

Dziedziczenie

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Konstruktor

SearchIndexerClient(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 do autoryzowania żą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ólnego. Jeśli odbiorcy nie zostaną podani, zakłada się, że odbiorcy chmury publicznej.

Metody

close	Zamknij sesję SearchIndexerClient .
create_data_source_connection	Tworzy nowe połączenie ze źródłem danych.
create_indexer	Tworzy nowy indeksator wyszukiwania.
create_or_update_data_source_connection	Tworzy nowe połączenie ze źródłem danych lub aktualizuje połączenie ze źródłem danych, jeśli już istnieje. :p aram data_source_connection: definicja połączenia ze źródłem danych w celu utworzenia lub zaktualizowania. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: warunek dopasowania do użycia w match_condition etag :p aramtype: ~azure.core.MatchConditions :return: Utworzony element SearchIndexerDataSourceConnection:rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Tworzy nowy indeksator lub aktualizuje indeksator, jeśli już istnieje.
create_or_update_skillset	Utwórz nowy zestaw SearchIndexerSkillset w usłudze Azure usługa wyszukiwania lub zaktualizuj istniejący.
create_skillset	Tworzenie nowego zestawu SearchIndexerSkillset w usłudze Azure usługa wyszukiwania
delete_data_source_connection	Usuwa połączenie ze źródłem danych. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexerDataSourceConnection zamiast nazwy. Wystarczy podać nazwę połączenia ze źródłem danych, aby usunąć bezwarunkowo
delete_indexer	Usuwa indeksator. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexer zamiast nazwy. Wystarczy podać nazwę indeksatora, aby usunąć bezwarunkowo.
delete_skillset	Usuń nazwany element SearchIndexerSkillset w usłudze Azure usługa wyszukiwania. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexerSkillset zamiast nazwy. Wystarczy podać nazwę zestawu umiejętności, aby usunąć bezwarunkowo
get_data_source_connection	Pobiera definicję połączenia ze źródłem danych.
get_data_source_connection_names	Wyświetla listę wszystkich nazw połączeń ze źródłem danych dostępnych dla usługi wyszukiwania.
get_data_source_connections	Wyświetla listę wszystkich połączeń ze źródłem danych dostępnych dla usługi wyszukiwania.
get_indexer	Pobiera definicję indeksatora.
get_indexer_names	Wyświetla listę wszystkich nazw indeksatora dostępnych dla usługi wyszukiwania.
get_indexer_status	Pobierz stan indeksatora.
get_indexers	Wyświetla listę wszystkich indeksatorów dostępnych dla usługi wyszukiwania.
get_skillset	Pobieranie nazwanego elementu SearchIndexerSkillset w usłudze Azure usługa wyszukiwania
get_skillset_names	Wyświetl listę nazw SearchIndexerSkillset w usługa wyszukiwania Azure.
get_skillsets	Wyświetl listę elementów SearchIndexerSkillsets w usługa wyszukiwania Azure.
reset_indexer	Resetuje stan śledzenia zmian skojarzony z indeksatorem.
run_indexer	Uruchom indeksator.

close

Zamknij sesję SearchIndexerClient .

close() -> None

create_data_source_connection

Tworzy nowe połączenie ze źródłem danych.

create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parametry

data_source_connection

SearchIndexerDataSourceConnection

Wymagane

Definicja połączenia ze źródłem danych do utworzenia.

Zwraca

Utworzony element SearchIndexerDataSourceConnection

Typ zwracany

SearchIndexerDataSourceConnection

Przykłady

Tworzenie źródła danych

   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source_connection = SearchIndexerDataSourceConnection(
       name="sample-data-source-connection", type="azureblob", connection_string=connection_string, container=container
   )
   result = client.create_data_source_connection(data_source_connection)
   print(result)
   print("Create new Data Source Connection - sample-data-source-connection")

create_indexer

Tworzy nowy indeksator wyszukiwania.

create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

Parametry

indexer

SearchIndexer

Wymagane

Definicja indeksatora do utworzenia.

Zwraca

Utworzony indeksator wyszukiwania

Typ zwracany

SearchIndexer

create_or_update_data_source_connection

Tworzy nowe połączenie ze źródłem danych lub aktualizuje połączenie ze źródłem danych, jeśli już istnieje. :p aram data_source_connection: definicja połączenia ze źródłem danych w celu utworzenia lub zaktualizowania. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: warunek dopasowania do użycia w match_condition etag :p aramtype: ~azure.core.MatchConditions :return: Utworzony element SearchIndexerDataSourceConnection:rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

create_or_update_indexer

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

create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

Parametry

indexer

SearchIndexer

Wymagane

Definicja indeksatora do utworzenia lub zaktualizowania.

match_condition

MatchConditions

Warunek dopasowania do użycia na etag

Zwraca

Utworzony indeksator wyszukiwania

Typ zwracany

SearchIndexer

create_or_update_skillset

Utwórz nowy zestaw SearchIndexerSkillset w usłudze Azure usługa wyszukiwania lub zaktualizuj istniejący.

create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

Parametry

skillset

SearchIndexerSkillset

Wymagane

Obiekt SearchIndexerSkillset do utworzenia lub zaktualizowania

match_condition

MatchConditions

Warunek dopasowania do użycia na etag

Zwraca

Utworzony lub zaktualizowany element SearchIndexerSkillset

Typ zwracany

SearchIndexerSkillset

create_skillset

Tworzenie nowego zestawu SearchIndexerSkillset w usłudze Azure usługa wyszukiwania

create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

Parametry

skillset

SearchIndexerSkillset

Wymagane

Obiekt SearchIndexerSkillset do utworzenia

Zwraca

Utworzony element SearchIndexerSkillset

Typ zwracany

SearchIndexerSkillset

delete_data_source_connection

Usuwa połączenie ze źródłem danych. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexerDataSourceConnection zamiast nazwy. Wystarczy podać nazwę połączenia ze źródłem danych, aby usunąć bezwarunkowo

delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parametry

data_source_connection

str lub SearchIndexerDataSourceConnection

Wymagane

Połączenie ze źródłem danych do usunięcia.

match_condition

MatchConditions

Warunek dopasowania do użycia na etag

Zwraca

Brak

Typ zwracany

None

Przykłady

Usuwanie elementu SearchIndexerDataSourceConnection

   client.delete_data_source_connection("sample-data-source-connection")
   print("Data Source Connection 'sample-data-source-connection' successfully deleted")

delete_indexer

Usuwa indeksator. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexer zamiast nazwy. Wystarczy podać nazwę indeksatora, aby usunąć bezwarunkowo.

delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parametry

indexer

str lub SearchIndexer

Wymagane

Indeksator do usunięcia.

match_condition

MatchConditions

Warunek dopasowania do użycia na etag

Zwraca

Brak

Typ zwracany

None

delete_skillset

Usuń nazwany element SearchIndexerSkillset w usłudze Azure usługa wyszukiwania. Aby można było korzystać z warunków dostępu, należy podać model SearchIndexerSkillset zamiast nazwy. Wystarczy podać nazwę zestawu umiejętności, aby usunąć bezwarunkowo

delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parametry

skillset

str lub SearchIndexerSkillset

Wymagane

Element SearchIndexerSkillset do usunięcia

match_condition

MatchConditions

Warunek dopasowania do użycia na etag

get_data_source_connection

Pobiera definicję połączenia ze źródłem danych.

get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parametry

name

str

Wymagane

Nazwa połączenia ze źródłem danych do pobrania.

Zwraca

Pobrany element SearchIndexerDataSourceConnection.

Typ zwracany

SearchIndexerDataSourceConnection

Przykłady

Pobieranie elementu SearchIndexerDataSourceConnection

   result = client.get_data_source_connection("sample-data-source-connection")
   print("Retrived Data Source Connection 'sample-data-source-connection'")

get_data_source_connection_names

Wyświetla listę wszystkich nazw połączeń ze źródłem danych dostępnych dla usługi wyszukiwania.

get_data_source_connection_names(**kwargs: Any) -> Sequence[str]

Zwraca

Lista wszystkich nazw połączeń ze źródłem danych.

Typ zwracany

list[str]

get_data_source_connections

Wyświetla listę wszystkich połączeń ze źródłem danych dostępnych dla usługi wyszukiwania.

get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

Parametry

select

list[str]

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

Zwraca

Lista wszystkich połączeń ze źródłem danych.

Typ zwracany

list[SearchIndexerDataSourceConnection]

Przykłady

Wyświetl listę wszystkich elementów SearchIndexerDataSourceConnections

   result = client.get_data_source_connections()
   names = [ds.name for ds in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

get_indexer

Pobiera definicję indeksatora.

get_indexer(name: str, **kwargs: Any) -> SearchIndexer

Parametry

name

str

Wymagane

Nazwa indeksatora do pobrania.

Zwraca

Pobierany indeksator wyszukiwania.

Typ zwracany

SearchIndexer

get_indexer_names

Wyświetla listę wszystkich nazw indeksatora dostępnych dla usługi wyszukiwania.

get_indexer_names(**kwargs: Any) -> Sequence[str]

Zwraca

Lista wszystkich indeksatorów wyszukiwania.

Typ zwracany

list[str]

get_indexer_status

Pobierz stan indeksatora.

get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

Parametry

name

str

Wymagane

Nazwa indeksatora do pobrania stanu.

Zwraca

SearchIndexerStatus

Typ zwracany

SearchIndexerStatus

get_indexers

Wyświetla listę wszystkich indeksatorów dostępnych dla usługi wyszukiwania.

get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]

Parametry

select

list[str]

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

Zwraca

Lista wszystkich indeksatorów wyszukiwania.

Typ zwracany

list[SearchIndexer]

get_skillset

Pobieranie nazwanego elementu SearchIndexerSkillset w usłudze Azure usługa wyszukiwania

get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset

Parametry

name

str

Wymagane

Nazwa elementu SearchIndexerSkillset do pobrania

Zwraca

Pobrany element SearchIndexerSkillset

Typ zwracany

SearchIndexerSkillset

Wyjątki

ResourceNotFoundError

get_skillset_names

Wyświetl listę nazw SearchIndexerSkillset w usługa wyszukiwania Azure.

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

Zwraca

Lista nazw searchIndexerSkillset

Typ zwracany

list[str]

Wyjątki

HttpResponseError

get_skillsets

Wyświetl listę elementów SearchIndexerSkillsets w usługa wyszukiwania Azure.

get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]

Parametry

select

list[str]

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

Zwraca

Lista elementów SearchIndexerSkillsets

Typ zwracany

list[SearchIndexerSkillset]

Wyjątki

HttpResponseError

reset_indexer

Resetuje stan śledzenia zmian skojarzony z indeksatorem.

reset_indexer(name: str, **kwargs: Any) -> None

Parametry

name

str

Wymagane

Nazwa indeksatora do zresetowania.

Zwraca

Brak

Typ zwracany

None

run_indexer

Uruchom indeksator.

run_indexer(name: str, **kwargs: Any) -> None

Parametry

name

str

Wymagane

Nazwa indeksatora do uruchomienia.

Zwraca

Brak

Typ zwracany

None