SearchIndexerClient Klass

En klient för att interagera med Azure Search-tjänstindexerare.

Arv
azure.search.documents._headers_mixin.HeadersMixin
SearchIndexerClient

Konstruktor

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

Parametrar

endpoint
str
Obligatorisk

URL-slutpunkten för en Azure Search-tjänst

credential
AzureKeyCredential eller TokenCredential
Obligatorisk

En autentiseringsuppgift för att auktorisera sökklientbegäranden

api_version
str

Den Search API-version som ska användas för begäranden.

audience
str

anger vilken målgrupp som ska användas för autentisering med Azure Active Directory (AAD). Målgruppen beaktas inte när du använder en delad nyckel. Om målgruppen inte tillhandahålls antas målgruppen för det offentliga molnet.

Metoder

close

SearchIndexerClient Stäng sessionen.

create_data_source_connection

Skapar en ny datakällaanslutning.

create_indexer

Skapar en ny SearchIndexer.

create_or_update_data_source_connection

Skapar en ny anslutning till datakällan eller uppdaterar en anslutning till datakällan om den redan finns. :p aram data_source_connection: Definitionen av datakällans anslutning för att skapa eller uppdatera. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: Matchningsvillkoret som ska användas på etag :p aramtype match_condition: ~azure.core.MatchConditions :return: Den skapade SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_indexer

Skapar en ny indexerare eller uppdaterar en indexerare om den redan finns.

create_or_update_skillset

Skapa en ny SearchIndexerSkillset i en Azure-tjänsten Search eller uppdatera en befintlig.

create_skillset

Skapa en ny SearchIndexerSkillset i en Azure-tjänsten Search

delete_data_source_connection

Tar bort en datakällaanslutning. Om du vill använda åtkomstvillkor måste modellen SearchIndexerDataSourceConnection anges i stället för namnet. Det räcker att ange namnet på datakällans anslutning för att ovillkorligt ta bort

delete_indexer

Tar bort en indexerare. Om du vill använda åtkomstvillkor måste SearchIndexer-modellen anges i stället för namnet. Det räcker att ange namnet på indexeraren för att ovillkorligt ta bort.

delete_skillset

Ta bort en namngiven SearchIndexerSkillset i en Azure-tjänsten Search. Om du vill använda åtkomstvillkor måste modellen SearchIndexerSkillset anges i stället för namnet. Det räcker att ange namnet på kompetensuppsättningen för att ovillkorligt ta bort

get_data_source_connection

Hämtar en anslutningsdefinition för datakällan.

get_data_source_connection_names

Visar en lista över alla anslutningsnamn för datakällor som är tillgängliga för en söktjänst.

get_data_source_connections

Visar en lista över alla datakällans anslutningar som är tillgängliga för en söktjänst.

get_indexer

Hämtar en indexeringsdefinition.

get_indexer_names

Visar en lista över alla indexerare som är tillgängliga för en söktjänst.

get_indexer_status

Hämta indexerarens status.

get_indexers

Visar en lista över alla indexerare som är tillgängliga för en söktjänst.

get_skillset

Hämta en namngiven SearchIndexerSkillset i en Azure-tjänsten Search

get_skillset_names

Visa en lista över SearchIndexerSkillset-namn i en Azure-tjänsten Search.

get_skillsets

Visa en lista över SearchIndexerSkillsets i en Azure-tjänsten Search.

reset_indexer

Återställer ändringsspårningstillståndet som är associerat med en indexerare.

run_indexer

Kör en indexerare.

close

SearchIndexerClient Stäng sessionen.

close() -> None

create_data_source_connection

Skapar en ny datakällaanslutning.

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

Parametrar

data_source_connection
SearchIndexerDataSourceConnection
Obligatorisk

Definitionen av datakällans anslutning som ska skapas.

Returer

Den skapade SearchIndexerDataSourceConnection

Returtyp

Exempel

Skapa en datakälla


   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

Skapar en ny SearchIndexer.

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

Parametrar

indexer
SearchIndexer
Obligatorisk

Definitionen av indexeraren som ska skapas.

Returer

Den skapade SearchIndexer

Returtyp

create_or_update_data_source_connection

Skapar en ny anslutning till datakällan eller uppdaterar en anslutning till datakällan om den redan finns. :p aram data_source_connection: Definitionen av datakällans anslutning för att skapa eller uppdatera. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: Matchningsvillkoret som ska användas på etag :p aramtype match_condition: ~azure.core.MatchConditions :return: Den skapade 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

Skapar en ny indexerare eller uppdaterar en indexerare om den redan finns.

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

Parametrar

indexer
SearchIndexer
Obligatorisk

Definitionen av indexeraren som ska skapas eller uppdateras.

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Den skapade SearchIndexer

Returtyp

create_or_update_skillset

Skapa en ny SearchIndexerSkillset i en Azure-tjänsten Search eller uppdatera en befintlig.

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

Parametrar

skillset
SearchIndexerSkillset
Obligatorisk

SearchIndexerSkillset-objektet som ska skapas eller uppdateras

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Den skapade eller uppdaterade SearchIndexerSkillset

Returtyp

create_skillset

Skapa en ny SearchIndexerSkillset i en Azure-tjänsten Search

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

Parametrar

skillset
SearchIndexerSkillset
Obligatorisk

SearchIndexerSkillset-objektet som ska skapas

Returer

Den skapade SearchIndexerSkillset

Returtyp

delete_data_source_connection

Tar bort en datakällaanslutning. Om du vill använda åtkomstvillkor måste modellen SearchIndexerDataSourceConnection anges i stället för namnet. Det räcker att ange namnet på datakällans anslutning för att ovillkorligt ta bort

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

Parametrar

data_source_connection
str eller SearchIndexerDataSourceConnection
Obligatorisk

Anslutningen till datakällan som ska tas bort.

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Ingen

Returtyp

Exempel

Ta bort en SearchIndexerDataSourceConnection


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

delete_indexer

Tar bort en indexerare. Om du vill använda åtkomstvillkor måste SearchIndexer-modellen anges i stället för namnet. Det räcker att ange namnet på indexeraren för att ovillkorligt ta bort.

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

Parametrar

indexer
str eller SearchIndexer
Obligatorisk

Indexeraren som ska tas bort.

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Ingen

Returtyp

delete_skillset

Ta bort en namngiven SearchIndexerSkillset i en Azure-tjänsten Search. Om du vill använda åtkomstvillkor måste modellen SearchIndexerSkillset anges i stället för namnet. Det räcker att ange namnet på kompetensuppsättningen för att ovillkorligt ta bort

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

Parametrar

skillset
str eller SearchIndexerSkillset
Obligatorisk

SearchIndexerSkillset som ska tas bort

match_condition
MatchConditions

Matchningsvillkoret som ska användas på etag

get_data_source_connection

Hämtar en anslutningsdefinition för datakällan.

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

Parametrar

name
str
Obligatorisk

Namnet på datakällans anslutning som ska hämtas.

Returer

SearchIndexerDataSourceConnection som hämtas.

Returtyp

Exempel

Hämta en 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

Visar en lista över alla anslutningsnamn för datakällor som är tillgängliga för en söktjänst.

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

Returer

Lista över alla anslutningsnamn för datakällan.

Returtyp

get_data_source_connections

Visar en lista över alla datakällans anslutningar som är tillgängliga för en söktjänst.

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

Parametrar

select
list[str]

Väljer vilka egenskaper på den översta nivån för de kompetensuppsättningar som ska hämtas. Anges som en lista över JSON-egenskapsnamn eller *för alla egenskaper. Standardvärdet är alla egenskaper.

Returer

Lista över alla datakällans anslutningar.

Returtyp

Exempel

Visa en lista över alla 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

Hämtar en indexeringsdefinition.

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

Parametrar

name
str
Obligatorisk

Namnet på indexeraren som ska hämtas.

Returer

SearchIndexer som hämtas.

Returtyp

get_indexer_names

Visar en lista över alla indexerare som är tillgängliga för en söktjänst.

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

Returer

Lista över alla SearchIndexers.

Returtyp

get_indexer_status

Hämta indexerarens status.

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

Parametrar

name
str
Obligatorisk

Namnet på indexeraren för att hämta statusen.

Returer

SearchIndexerStatus

Returtyp

get_indexers

Visar en lista över alla indexerare som är tillgängliga för en söktjänst.

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

Parametrar

select
list[str]

Väljer vilka egenskaper på den översta nivån för de kompetensuppsättningar som ska hämtas. Anges som en lista över JSON-egenskapsnamn eller *för alla egenskaper. Standardvärdet är alla egenskaper.

Returer

Lista över alla SearchIndexers.

Returtyp

get_skillset

Hämta en namngiven SearchIndexerSkillset i en Azure-tjänsten Search

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

Parametrar

name
str
Obligatorisk

Namnet på SearchIndexerSkillset som ska hämtas

Returer

Den hämtade SearchIndexerSkillset

Returtyp

Undantag

get_skillset_names

Visa en lista över SearchIndexerSkillset-namn i en Azure-tjänsten Search.

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

Returer

Lista över SearchIndexerSkillset-namn

Returtyp

Undantag

get_skillsets

Visa en lista över SearchIndexerSkillsets i en Azure-tjänsten Search.

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

Parametrar

select
list[str]

Väljer vilka egenskaper på den översta nivån för de kompetensuppsättningar som ska hämtas. Anges som en lista över JSON-egenskapsnamn eller *för alla egenskaper. Standardvärdet är alla egenskaper.

Returer

Lista över SearchIndexerSkillsets

Returtyp

Undantag

reset_indexer

Återställer ändringsspårningstillståndet som är associerat med en indexerare.

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

Parametrar

name
str
Obligatorisk

Namnet på indexeraren som ska återställas.

Returer

Ingen

Returtyp

run_indexer

Kör en indexerare.

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

Parametrar

name
str
Obligatorisk

Namnet på indexeraren som ska köras.

Returer

Ingen

Returtyp