SearchIndexerClient Klasse
Ein Client für die Interaktion mit Indexern des Azure-Suchdiensts.
- Vererbung
-
azure.search.documents._headers_mixin.HeadersMixinSearchIndexerClient
Konstruktor
SearchIndexerClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)
Parameter
- credential
- AzureKeyCredential oder TokenCredential
Anmeldeinformationen zum Autorisieren von Suchclientanforderungen
- api_version
- str
Die Such-API-Version, die für Anforderungen verwendet werden soll.
- audience
- str
legt die Zielgruppe fest, die für die Authentifizierung mit Azure Active Directory (AAD) verwendet werden soll. Die Zielgruppe wird bei verwendung eines gemeinsam verwendeten Schlüssels nicht berücksichtigt. Wenn keine Zielgruppe bereitgestellt wird, wird die Öffentliche Cloud-Zielgruppe angenommen.
Methoden
close |
Schließen Sie die SearchIndexerClient Sitzung. |
create_data_source_connection |
Erstellt eine neue Datenquellenverbindung. |
create_indexer |
Erstellt einen neuen SearchIndexer. |
create_or_update_data_source_connection |
Erstellt eine neue Datenquellenverbindung oder aktualisiert eine Datenquellenverbindung, sofern diese bereits vorhanden ist. :p aram data_source_connection: Die Definition der zu erstellenden oder zu aktualisierenden Datenquellenverbindung. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :Schlüsselwort (keyword) match_condition: Die Übereinstimmungsbedingung, die für das etag :p aramtype match_condition: ~azure.core.MatchConditions :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection |
create_or_update_indexer |
Erstellt einen neuen Indexer oder aktualisiert einen Indexer, sofern er bereits vorhanden ist. |
create_or_update_skillset |
Erstellen Sie ein neues SearchIndexerSkillset in einer Azure Suchdienst, oder aktualisieren Sie ein vorhandenes. |
create_skillset |
Erstellen eines neuen SearchIndexerSkillsets in einer Azure-Suchdienst |
delete_data_source_connection |
Löscht eine Datenquellenverbindung. Um Zugriffsbedingungen zu verwenden, muss anstelle des Namens das SearchIndexerDataSourceConnection-Modell angegeben werden. Es reicht aus, den Namen der Datenquellenverbindung anzugeben, um bedingungslos zu löschen. |
delete_indexer |
Löscht einen Indexer. Um Zugriffsbedingungen verwenden zu können, muss anstelle des Namens das SearchIndexer-Modell bereitgestellt werden. Es reicht aus, den Namen des Indexers anzugeben, der bedingungslos gelöscht werden soll. |
delete_skillset |
Löschen Sie ein benanntes SearchIndexerSkillset in einer Azure-Suchdienst. Um Zugriffsbedingungen verwenden zu können, muss anstelle des Namens das SearchIndexerSkillset-Modell angegeben werden. Es genügt, den Namen des Skillsets anzugeben, um bedingungslos zu löschen. |
get_data_source_connection |
Ruft eine Datenquellenverbindungsdefinition ab. |
get_data_source_connection_names |
Listet alle Datenquellenverbindungsnamen auf, die für einen Suchdienst verfügbar sind. |
get_data_source_connections |
Listet alle Datenquellenverbindungen auf, die für einen Suchdienst verfügbar sind. |
get_indexer |
Ruft eine Indexerdefinition ab. |
get_indexer_names |
Listet alle Indexernamen auf, die für einen Suchdienst verfügbar sind. |
get_indexer_status |
Rufen Sie die status des Indexers ab. |
get_indexers |
Listet alle Indexer auf, die für einen Suchdienst verfügbar sind. |
get_skillset |
Abrufen eines benannten SearchIndexerSkillsets in einer Azure-Suchdienst |
get_skillset_names |
Listen Sie die SearchIndexerSkillset-Namen in einer Azure-Suchdienst auf. |
get_skillsets |
Listen Sie die SearchIndexerSkillsets in einer Azure-Suchdienst auf. |
reset_indexer |
Setzt den Einem Indexer zugeordneten Änderungsnachverfolgungsstatus zurück. |
run_indexer |
Führen Sie einen Indexer aus. |
close
Schließen Sie die SearchIndexerClient Sitzung.
close() -> None
create_data_source_connection
Erstellt eine neue Datenquellenverbindung.
create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection
Parameter
- data_source_connection
- SearchIndexerDataSourceConnection
Die Definition der zu erstellenden Datenquellenverbindung.
Gibt zurück
Die erstellte SearchIndexerDataSourceConnection
Rückgabetyp
Beispiele
Erstellen einer Datenquelle
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
Erstellt einen neuen SearchIndexer.
create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer
Parameter
Gibt zurück
Der erstellte SearchIndexer
Rückgabetyp
create_or_update_data_source_connection
Erstellt eine neue Datenquellenverbindung oder aktualisiert eine Datenquellenverbindung, sofern diese bereits vorhanden ist. :p aram data_source_connection: Die Definition der zu erstellenden oder zu aktualisierenden Datenquellenverbindung. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :Schlüsselwort (keyword) match_condition: Die Übereinstimmungsbedingung, die für das 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
Erstellt einen neuen Indexer oder aktualisiert einen Indexer, sofern er bereits vorhanden ist.
create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer
Parameter
- indexer
- SearchIndexer
Die Definition des zu erstellenden oder aktualisierenden Indexers.
- match_condition
- MatchConditions
Die Übereinstimmungsbedingung, die für das etag verwendet werden soll
Gibt zurück
Der erstellte SearchIndexer
Rückgabetyp
create_or_update_skillset
Erstellen Sie ein neues SearchIndexerSkillset in einer Azure Suchdienst, oder aktualisieren Sie ein vorhandenes.
create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset
Parameter
- skillset
- SearchIndexerSkillset
Das zu erstellende oder zu aktualisierende SearchIndexerSkillset-Objekt
- match_condition
- MatchConditions
Die Übereinstimmungsbedingung, die für das etag verwendet werden soll
Gibt zurück
Das erstellte oder aktualisierte SearchIndexerSkillset
Rückgabetyp
create_skillset
Erstellen eines neuen SearchIndexerSkillsets in einer Azure-Suchdienst
create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset
Parameter
Gibt zurück
Das erstellte SearchIndexerSkillset
Rückgabetyp
delete_data_source_connection
Löscht eine Datenquellenverbindung. Um Zugriffsbedingungen zu verwenden, muss anstelle des Namens das SearchIndexerDataSourceConnection-Modell angegeben werden. Es reicht aus, den Namen der Datenquellenverbindung anzugeben, um bedingungslos zu löschen.
delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
Parameter
- data_source_connection
- str oder SearchIndexerDataSourceConnection
Die zu löschende Datenquellenverbindung.
- match_condition
- MatchConditions
Die Übereinstimmungsbedingung, die für das etag verwendet werden soll
Gibt zurück
Keine
Rückgabetyp
Beispiele
Löschen eines SearchIndexerDataSourceConnection-Steuerelements
client.delete_data_source_connection("sample-data-source-connection")
print("Data Source Connection 'sample-data-source-connection' successfully deleted")
delete_indexer
Löscht einen Indexer. Um Zugriffsbedingungen verwenden zu können, muss anstelle des Namens das SearchIndexer-Modell bereitgestellt werden. Es reicht aus, den Namen des Indexers anzugeben, der bedingungslos gelöscht werden soll.
delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
Parameter
- match_condition
- MatchConditions
Die Übereinstimmungsbedingung, die für das etag verwendet werden soll
Gibt zurück
Keine
Rückgabetyp
delete_skillset
Löschen Sie ein benanntes SearchIndexerSkillset in einer Azure-Suchdienst. Um Zugriffsbedingungen verwenden zu können, muss anstelle des Namens das SearchIndexerSkillset-Modell angegeben werden. Es genügt, den Namen des Skillsets anzugeben, um bedingungslos zu löschen.
delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
Parameter
- match_condition
- MatchConditions
Die Übereinstimmungsbedingung, die für das etag verwendet werden soll
get_data_source_connection
Ruft eine Datenquellenverbindungsdefinition ab.
get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection
Parameter
Gibt zurück
Die SearchIndexerDataSourceConnection, die abgerufen wird.
Rückgabetyp
Beispiele
Abrufen eines SearchIndexerDataSourceConnection-Steuerelements
result = client.get_data_source_connection("sample-data-source-connection")
print("Retrived Data Source Connection 'sample-data-source-connection'")
get_data_source_connection_names
Listet alle Datenquellenverbindungsnamen auf, die für einen Suchdienst verfügbar sind.
get_data_source_connection_names(**kwargs: Any) -> Sequence[str]
Gibt zurück
Liste aller Datenquellenverbindungsnamen.
Rückgabetyp
get_data_source_connections
Listet alle Datenquellenverbindungen auf, die für einen Suchdienst verfügbar sind.
get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]
Parameter
Wählt aus, welche Eigenschaften der obersten Ebene der Skillsets abgerufen werden sollen. Wird als Liste von JSON-Eigenschaftennamen oder "*" für alle Eigenschaften angegeben. Der Standardwert sind alle Eigenschaften.
Gibt zurück
Liste aller Datenquellenverbindungen.
Rückgabetyp
Beispiele
Auflisten aller 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
Ruft eine Indexerdefinition ab.
get_indexer(name: str, **kwargs: Any) -> SearchIndexer
Parameter
Gibt zurück
Der SearchIndexer, der abgerufen wird.
Rückgabetyp
get_indexer_names
Listet alle Indexernamen auf, die für einen Suchdienst verfügbar sind.
get_indexer_names(**kwargs: Any) -> Sequence[str]
Gibt zurück
Liste aller SearchIndexers.
Rückgabetyp
get_indexer_status
Rufen Sie die status des Indexers ab.
get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus
Parameter
Gibt zurück
SearchIndexerStatus
Rückgabetyp
get_indexers
Listet alle Indexer auf, die für einen Suchdienst verfügbar sind.
get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]
Parameter
Wählt aus, welche Eigenschaften der obersten Ebene der Skillsets abgerufen werden sollen. Wird als Liste von JSON-Eigenschaftennamen oder "*" für alle Eigenschaften angegeben. Der Standardwert sind alle Eigenschaften.
Gibt zurück
Liste aller SearchIndexers.
Rückgabetyp
get_skillset
Abrufen eines benannten SearchIndexerSkillsets in einer Azure-Suchdienst
get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset
Parameter
Gibt zurück
Das abgerufene SearchIndexerSkillset
Rückgabetyp
Ausnahmen
get_skillset_names
Listen Sie die SearchIndexerSkillset-Namen in einer Azure-Suchdienst auf.
get_skillset_names(**kwargs: Any) -> List[str]
Gibt zurück
Liste der SearchIndexerSkillset-Namen
Rückgabetyp
Ausnahmen
get_skillsets
Listen Sie die SearchIndexerSkillsets in einer Azure-Suchdienst auf.
get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]
Parameter
Wählt aus, welche Eigenschaften der obersten Ebene der Skillsets abgerufen werden sollen. Wird als Liste von JSON-Eigenschaftennamen oder "*" für alle Eigenschaften angegeben. Der Standardwert sind alle Eigenschaften.
Gibt zurück
Liste der SearchIndexerSkillsets
Rückgabetyp
Ausnahmen
reset_indexer
Setzt den Einem Indexer zugeordneten Änderungsnachverfolgungsstatus zurück.
reset_indexer(name: str, **kwargs: Any) -> None
Parameter
Gibt zurück
Keine
Rückgabetyp
run_indexer
Azure SDK for Python