SearchIndexerClient Třída

Klient pro interakci s indexery služby Azure Search.

Dědičnost

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Konstruktor

SearchIndexerClient(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

close	Zavřete SearchIndexerClient relaci.
create_data_source_connection	Vytvoří nové připojení ke zdroji dat.
create_indexer	Vytvoří nový SearchIndexer.
create_or_update_data_source_connection	Vytvoří nové připojení ke zdroji dat nebo aktualizuje připojení ke zdroji dat, pokud již existuje. :p aram data_source_connection: Definice připojení ke zdroji dat pro vytvoření nebo aktualizaci. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: Podmínka shody pro :p aramtype match_condition: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Vytvoří nový indexer nebo aktualizuje indexer, pokud už existuje.
create_or_update_skillset	Vytvořte novou sadu SearchIndexerSkillset v azure Search nebo aktualizujte existující sadu.
create_skillset	Vytvoření nové sady SearchIndexerSkillset v Azure Search
delete_data_source_connection	Odstraní připojení ke zdroji dat. Pokud chcete použít podmínky přístupu, musí být místo názvu zadaný model SearchIndexerDataSourceConnection. K bezpodmínečnému odstranění stačí zadat název připojení ke zdroji dat.
delete_indexer	Odstraní indexer. Pokud chcete použít podmínky přístupu, musí se místo názvu zadat model SearchIndexer. Stačí zadat název indexeru k bezpodmínečnému odstranění.
delete_skillset	Odstraňte pojmenovanou SearchIndexerSkillset v Azure Search. Pokud chcete použít podmínky přístupu, musí být místo názvu zadaný model SearchIndexerSkillset. K bezpodmínečnému odstranění stačí zadat název sady dovedností.
get_data_source_connection	Načte definici připojení zdroje dat.
get_data_source_connection_names	Zobrazí seznam všech názvů připojení zdroje dat dostupných pro vyhledávací službu.
get_data_source_connections	Zobrazí seznam všech dostupných připojení ke zdrojům dat pro vyhledávací službu.
get_indexer	Načte definici indexeru.
get_indexer_names	Zobrazí seznam všech názvů indexerů dostupných pro vyhledávací službu.
get_indexer_status	Získejte stav indexeru.
get_indexers	Zobrazí seznam všech indexerů dostupných pro vyhledávací službu.
get_skillset	Načtení pojmenované sady SearchIndexerSkillset v Azure Search
get_skillset_names	Seznam názvů SearchIndexerSkillset v Azure Search.
get_skillsets	Vypište searchIndexerSkillsets v azure Search.
reset_indexer	Obnoví stav sledování změn přidružený k indexeru.
run_indexer	Spusťte indexer.

close

Zavřete SearchIndexerClient relaci.

close() -> None

create_data_source_connection

Vytvoří nové připojení ke zdroji dat.

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

Parametry

data_source_connection

SearchIndexerDataSourceConnection

Vyžadováno

Definice připojení ke zdroji dat, které se má vytvořit.

Návraty

Vytvořený SearchIndexerDataSourceConnection

Návratový typ

SearchIndexerDataSourceConnection

Příklady

Vytvoření zdroje dat

   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

Vytvoří nový SearchIndexer.

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

Parametry

indexer

SearchIndexer

Vyžadováno

Definice indexeru, který se má vytvořit.

Návraty

Vytvořený Indexer služby SearchIndexer

Návratový typ

SearchIndexer

create_or_update_data_source_connection

Vytvoří nové připojení ke zdroji dat nebo aktualizuje připojení ke zdroji dat, pokud již existuje. :p aram data_source_connection: Definice připojení ke zdroji dat pro vytvoření nebo aktualizaci. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: Podmínka shody pro :p aramtype match_condition: ~azure.core.MatchConditions :return: The created 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

Vytvoří nový indexer nebo aktualizuje indexer, pokud už existuje.

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

Parametry

indexer

SearchIndexer

Vyžadováno

Definice indexeru, který se má vytvořit nebo aktualizovat.

match_condition

MatchConditions

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

Návraty

Vytvořený Indexer služby SearchIndexer

Návratový typ

SearchIndexer

create_or_update_skillset

Vytvořte novou sadu SearchIndexerSkillset v azure Search nebo aktualizujte existující sadu.

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

Parametry

skillset

SearchIndexerSkillset

Vyžadováno

Objekt SearchIndexerSkillset pro vytvoření nebo aktualizaci

match_condition

MatchConditions

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

Návraty

Vytvořená nebo aktualizovaná sada SearchIndexerSkillset

Návratový typ

SearchIndexerSkillset

create_skillset

Vytvoření nové sady SearchIndexerSkillset v Azure Search

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

Parametry

skillset

SearchIndexerSkillset

Vyžadováno

Objekt SearchIndexerSkillset, který se má vytvořit

Návraty

Vytvořená sada SearchIndexerSkillset

Návratový typ

SearchIndexerSkillset

delete_data_source_connection

Odstraní připojení ke zdroji dat. Pokud chcete použít podmínky přístupu, musí být místo názvu zadaný model SearchIndexerDataSourceConnection. K bezpodmínečnému odstranění stačí zadat název připojení ke zdroji dat.

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

Parametry

data_source_connection

str nebo SearchIndexerDataSourceConnection

Vyžadováno

Připojení ke zdroji dat, 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

Příklady

Odstranění funkce SearchIndexerDataSourceConnection

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

delete_indexer

Odstraní indexer. Pokud chcete použít podmínky přístupu, musí se místo názvu zadat model SearchIndexer. Stačí zadat název indexeru k bezpodmínečnému odstranění.

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

Parametry

indexer

str nebo SearchIndexer

Vyžadováno

Indexer, 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

delete_skillset

Odstraňte pojmenovanou SearchIndexerSkillset v Azure Search. Pokud chcete použít podmínky přístupu, musí být místo názvu zadaný model SearchIndexerSkillset. K bezpodmínečnému odstranění stačí zadat název sady dovedností.

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

Parametry

skillset

str nebo SearchIndexerSkillset

Vyžadováno

Sada SearchIndexerSkillset, která se má odstranit

match_condition

MatchConditions

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

get_data_source_connection

Načte definici připojení zdroje dat.

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

Parametry

name

str

Vyžadováno

Název připojení ke zdroji dat, které se má načíst.

Návraty

SearchIndexerDataSourceConnection, který je načten.

Návratový typ

SearchIndexerDataSourceConnection

Příklady

Načtení funkce 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

Zobrazí seznam všech názvů připojení zdroje dat dostupných pro vyhledávací službu.

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

Návraty

Seznam všech názvů připojení ke zdroji dat

Návratový typ

list[str]

get_data_source_connections

Zobrazí seznam všech dostupných připojení ke zdrojům dat pro vyhledávací službu.

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

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 všech připojení ke zdrojům dat

Návratový typ

list[SearchIndexerDataSourceConnection]

Příklady

Vypsat všechny funkce 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

Načte definici indexeru.

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

Parametry

name

str

Vyžadováno

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

Návraty

SearchIndexer, který se načte.

Návratový typ

SearchIndexer

get_indexer_names

Zobrazí seznam všech názvů indexerů dostupných pro vyhledávací službu.

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

Návraty

Seznam všech indexerů searchindexerů.

Návratový typ

list[str]

get_indexer_status

Získejte stav indexeru.

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

Parametry

name

str

Vyžadováno

Název indexeru, který má načíst stav.

Návraty

SearchIndexerStatus

Návratový typ

SearchIndexerStatus

get_indexers

Zobrazí seznam všech indexerů dostupných pro vyhledávací službu.

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

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 všech indexerů searchindexerů.

Návratový typ

list[SearchIndexer]

get_skillset

Načtení pojmenované sady SearchIndexerSkillset v Azure Search

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

Parametry

name

str

Vyžadováno

Název sady SearchIndexerSkillset pro získání

Návraty

Načtená sada SearchIndexerSkillset

Návratový typ

SearchIndexerSkillset

Výjimky

ResourceNotFoundError

get_skillset_names

Seznam názvů SearchIndexerSkillset v Azure Search.

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

Návraty

Seznam názvů searchIndexerSkillset

Návratový typ

list[str]

Výjimky

HttpResponseError

get_skillsets

Vypište searchIndexerSkillsets v azure Search.

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

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 sad SearchIndexerSkillsets

Návratový typ

list[SearchIndexerSkillset]

Výjimky

HttpResponseError

reset_indexer

Obnoví stav sledování změn přidružený k indexeru.

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

Parametry

name

str

Vyžadováno

Název indexeru, který se má resetovat.

Návraty

Žádné

Návratový typ

None

run_indexer

Spusťte indexer.

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

Parametry

name

str

Vyžadováno

Název indexeru, který se má spustit.

Návraty

Žádné

Návratový typ

None