SearchIndexerClient Klas

Een client om te communiceren met indexeerfuncties van de Azure Search-service.

Overname

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Constructor

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

Parameters

endpoint

str

Vereist

Het URL-eindpunt van een Azure Search-service

credential

AzureKeyCredential of TokenCredential

Vereist

Een referentie voor het autoriseren van zoekclientaanvragen

api_version

str

De search-API-versie die moet worden gebruikt voor aanvragen.

audience

str

stelt de doelgroep in die moet worden gebruikt voor verificatie met Azure Active Directory (AAD). De doelgroep wordt niet meegenomen bij het gebruik van een gedeelde sleutel. Als er geen doelgroep wordt opgegeven, wordt uitgegaan van de doelgroep van de openbare cloud.

Methoden

close	Sluit de SearchIndexerClient sessie.
create_data_source_connection	Hiermee maakt u een nieuwe gegevensbronverbinding.
create_indexer	Hiermee maakt u een nieuwe SearchIndexer.
create_or_update_data_source_connection	Hiermee maakt u een nieuwe gegevensbronverbinding of werkt u een gegevensbronverbinding bij als deze al bestaat. :p aram data_source_connection: de definitie van de gegevensbronverbinding die moet worden gemaakt of bijgewerkt. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: De overeenkomstvoorwaarde die moet worden gebruikt voor de etag :p aramtype match_condition: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Hiermee maakt u een nieuwe indexeerfunctie of werkt u een indexeerfunctie bij als deze al bestaat.
create_or_update_skillset	Maak een nieuwe SearchIndexerSkillset in een Azure-Search-service of werk een bestaande bij.
create_skillset	Een nieuwe SearchIndexerSkillset maken in een Azure-Search-service
delete_data_source_connection	Hiermee verwijdert u een gegevensbronverbinding. Als u toegangsvoorwaarden wilt gebruiken, moet het model SearchIndexerDataSourceConnection worden opgegeven in plaats van de naam. Het is voldoende om de naam van de gegevensbronverbinding op te geven om onvoorwaardelijk te verwijderen
delete_indexer	Hiermee verwijdert u een indexeerfunctie. Als u toegangsvoorwaarden wilt gebruiken, moet het SearchIndexer-model worden opgegeven in plaats van de naam. Het is voldoende om de naam van de indexeerfunctie op te geven die u onvoorwaardelijk wilt verwijderen.
delete_skillset	Verwijder een benoemde SearchIndexerSkillset in een Azure-Search-service. Als u toegangsvoorwaarden wilt gebruiken, moet het Model SearchIndexerSkillset worden opgegeven in plaats van de naam. Het is voldoende om de naam op te geven van de vaardighedenset die onvoorwaardelijk moet worden verwijderd
get_data_source_connection	Hiermee wordt een verbindingsdefinitie voor een gegevensbron opgehaald.
get_data_source_connection_names	Een lijst met alle namen van de gegevensbronverbindingen die beschikbaar zijn voor een zoekservice.
get_data_source_connections	Een lijst met alle gegevensbronverbindingen die beschikbaar zijn voor een zoekservice.
get_indexer	Hiermee haalt u een indexeerfunctiedefinitie op.
get_indexer_names	Een lijst met alle namen van indexeerfuncties die beschikbaar zijn voor een zoekservice.
get_indexer_status	Haal de status van de indexeerfunctie op.
get_indexers	Een lijst met alle indexeerfuncties die beschikbaar zijn voor een zoekservice.
get_skillset	Een benoemde SearchIndexerSkillset ophalen in een Azure-Search-service
get_skillset_names	Vermeld de Namen van SearchIndexerSkillsets in een Azure-Search-service.
get_skillsets	De SearchIndexerSkillsets weergeven in een Azure-Search-service.
reset_indexer	Hiermee wordt de status van het bijhouden van wijzigingen die is gekoppeld aan een indexeerfunctie opnieuw ingesteld.
run_indexer	Voer een indexeerfunctie uit.

close

Sluit de SearchIndexerClient sessie.

close() -> None

create_data_source_connection

Hiermee maakt u een nieuwe gegevensbronverbinding.

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

Parameters

data_source_connection

SearchIndexerDataSourceConnection

Vereist

De definitie van de gegevensbronverbinding die moet worden gemaakt.

Retouren

De gemaakte SearchIndexerDataSourceConnection

Retourtype

SearchIndexerDataSourceConnection

Voorbeelden

Een gegevensbron maken

   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

Hiermee maakt u een nieuwe SearchIndexer.

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

Parameters

indexer

SearchIndexer

Vereist

De definitie van de indexeerfunctie die moet worden gemaakt.

Retouren

De gemaakte SearchIndexer

Retourtype

SearchIndexer

create_or_update_data_source_connection

Hiermee maakt u een nieuwe gegevensbronverbinding of werkt u een gegevensbronverbinding bij als deze al bestaat. :p aram data_source_connection: de definitie van de gegevensbronverbinding die moet worden gemaakt of bijgewerkt. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: De overeenkomstvoorwaarde die moet worden gebruikt voor de etag :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

Hiermee maakt u een nieuwe indexeerfunctie of werkt u een indexeerfunctie bij als deze al bestaat.

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

Parameters

indexer

SearchIndexer

Vereist

De definitie van de indexeerfunctie die moet worden gemaakt of bijgewerkt.

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

De gemaakte SearchIndexer

Retourtype

SearchIndexer

create_or_update_skillset

Maak een nieuwe SearchIndexerSkillset in een Azure-Search-service of werk een bestaande bij.

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

Parameters

skillset

SearchIndexerSkillset

Vereist

Het Object SearchIndexerSkillset dat moet worden gemaakt of bijgewerkt

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

De gemaakte of bijgewerkte SearchIndexerSkillset

Retourtype

SearchIndexerSkillset

create_skillset

Een nieuwe SearchIndexerSkillset maken in een Azure-Search-service

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

Parameters

skillset

SearchIndexerSkillset

Vereist

Het Object SearchIndexerSkillset dat moet worden gemaakt

Retouren

De gemaakte SearchIndexerSkillset

Retourtype

SearchIndexerSkillset

delete_data_source_connection

Hiermee verwijdert u een gegevensbronverbinding. Als u toegangsvoorwaarden wilt gebruiken, moet het model SearchIndexerDataSourceConnection worden opgegeven in plaats van de naam. Het is voldoende om de naam van de gegevensbronverbinding op te geven om onvoorwaardelijk te verwijderen

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

Parameters

data_source_connection

str of SearchIndexerDataSourceConnection

Vereist

De gegevensbronverbinding die moet worden verwijderd.

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

Geen

Retourtype

None

Voorbeelden

Een SearchIndexerDataSourceConnection verwijderen

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

delete_indexer

Hiermee verwijdert u een indexeerfunctie. Als u toegangsvoorwaarden wilt gebruiken, moet het SearchIndexer-model worden opgegeven in plaats van de naam. Het is voldoende om de naam van de indexeerfunctie op te geven die u onvoorwaardelijk wilt verwijderen.

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

Parameters

indexer

str of SearchIndexer

Vereist

De indexeerfunctie die moet worden verwijderd.

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

Geen

Retourtype

None

delete_skillset

Verwijder een benoemde SearchIndexerSkillset in een Azure-Search-service. Als u toegangsvoorwaarden wilt gebruiken, moet het Model SearchIndexerSkillset worden opgegeven in plaats van de naam. Het is voldoende om de naam op te geven van de vaardighedenset die onvoorwaardelijk moet worden verwijderd

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

Parameters

skillset

str of SearchIndexerSkillset

Vereist

De SearchIndexerSkillset die moet worden verwijderd

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

get_data_source_connection

Hiermee wordt een verbindingsdefinitie voor een gegevensbron opgehaald.

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

Parameters

name

str

Vereist

De naam van de gegevensbronverbinding die moet worden opgehaald.

Retouren

De SearchIndexerDataSourceConnection die wordt opgehaald.

Retourtype

SearchIndexerDataSourceConnection

Voorbeelden

Een SearchIndexerDataSourceConnection ophalen

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

get_data_source_connection_names

Een lijst met alle namen van de gegevensbronverbindingen die beschikbaar zijn voor een zoekservice.

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

Retouren

Lijst met alle verbindingsnamen van de gegevensbron.

Retourtype

list[str]

get_data_source_connections

Een lijst met alle gegevensbronverbindingen die beschikbaar zijn voor een zoekservice.

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

Parameters

select

list[str]

Selecteert welke eigenschappen op het hoogste niveau van de vaardighedensets moeten worden opgehaald. Opgegeven als een lijst met JSON-eigenschapsnamen, of '*' voor alle eigenschappen. De standaardwaarde is alle eigenschappen.

Retouren

Lijst met alle gegevensbronverbindingen.

Retourtype

list[SearchIndexerDataSourceConnection]

Voorbeelden

Alle SearchIndexerDataSourceConnections weergeven

   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

Hiermee haalt u een indexeerfunctiedefinitie op.

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

Parameters

name

str

Vereist

De naam van de indexeerfunctie die moet worden opgehaald.

Retouren

De SearchIndexer die wordt opgehaald.

Retourtype

SearchIndexer

get_indexer_names

Een lijst met alle namen van indexeerfuncties die beschikbaar zijn voor een zoekservice.

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

Retouren

Lijst met alle SearchIndexers.

Retourtype

list[str]

get_indexer_status

Haal de status van de indexeerfunctie op.

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

Parameters

name

str

Vereist

De naam van de indexeerfunctie om de status op te halen.

Retouren

SearchIndexerStatus

Retourtype

SearchIndexerStatus

get_indexers

Een lijst met alle indexeerfuncties die beschikbaar zijn voor een zoekservice.

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

Parameters

select

list[str]

Selecteert welke eigenschappen op het hoogste niveau van de vaardighedensets moeten worden opgehaald. Opgegeven als een lijst met JSON-eigenschapsnamen, of '*' voor alle eigenschappen. De standaardwaarde is alle eigenschappen.

Retouren

Lijst met alle SearchIndexers.

Retourtype

list[SearchIndexer]

get_skillset

Een benoemde SearchIndexerSkillset ophalen in een Azure-Search-service

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

Parameters

name

str

Vereist

De naam van de SearchIndexerSkillset die u wilt ophalen

Retouren

De opgehaalde SearchIndexerSkillset

Retourtype

SearchIndexerSkillset

Uitzonderingen

ResourceNotFoundError

get_skillset_names

Vermeld de Namen van SearchIndexerSkillsets in een Azure-Search-service.

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

Retouren

Lijst met SearchIndexerSkillset-namen

Retourtype

list[str]

Uitzonderingen

HttpResponseError

get_skillsets

De SearchIndexerSkillsets weergeven in een Azure-Search-service.

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

Parameters

select

list[str]

Selecteert welke eigenschappen op het hoogste niveau van de vaardighedensets moeten worden opgehaald. Opgegeven als een lijst met JSON-eigenschapsnamen, of '*' voor alle eigenschappen. De standaardwaarde is alle eigenschappen.

Retouren

Lijst met SearchIndexerSkillsets

Retourtype

list[SearchIndexerSkillset]

Uitzonderingen

HttpResponseError

reset_indexer

Hiermee wordt de status van het bijhouden van wijzigingen die is gekoppeld aan een indexeerfunctie opnieuw ingesteld.

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

Parameters

name

str

Vereist

De naam van de indexeerfunctie die u opnieuw wilt instellen.

Retouren

Geen

Retourtype

None

run_indexer

Voer een indexeerfunctie uit.

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

Parameters

name

str

Vereist

De naam van de indexeerfunctie die moet worden uitgevoerd.

Retouren

Geen

Retourtype

None