SearchIndexingBufferedSender Klasse
Ein gepufferter Absender für Dokumentindizierungsaktionen.
- Vererbung
-
azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBaseSearchIndexingBufferedSenderazure.search.documents._headers_mixin.HeadersMixinSearchIndexingBufferedSender
Konstruktor
SearchIndexingBufferedSender(endpoint: str, index_name: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)Parameter
- credential
- AzureKeyCredential oder TokenCredential
Anmeldeinformationen zum Autorisieren von Suchclientanforderungen
- auto_flush_interval
- int
wie viele maximale Sekunden, wenn zwischen 2 Leerungen. Dies wird nur wirksam, wenn auto_flush aktiviert ist. Der Standardwert ist 60 Sekunden.
- initial_batch_action_count
- int
Die anfängliche Anzahl von Aktionen, die beim Optimieren des Verhaltens des Absenders in einem Batch gruppiert werden sollen. Der Standardwert ist 512.
- max_retries_per_action
- int
Die Häufigkeit, mit der ein fehlerhaftes Dokument wiederholt werden soll. Der Standardwert ist 3.
- on_new
- callable
Wenn sie festgelegt ist, ruft der Client entsprechende Methoden auf, wenn eine neue IndexAction hinzugefügt wird. Dies kann von Standard Thread oder einem Workerthread aufgerufen werden.
- on_progress
- callable
Wenn sie festgelegt ist, ruft der Client die entsprechenden Methoden auf, wenn eine IndexAction erfolgreich ist. Dies kann von Standard Thread oder einem Workerthread aufgerufen werden.
- on_error
- callable
Wenn sie festgelegt ist, ruft der Client die entsprechenden Methoden auf, wenn ein IndexAction-Fehler auftritt. Dies kann von Standard Thread oder einem Workerthread aufgerufen werden.
- on_remove
- callable
Wenn sie festgelegt ist, ruft der Client die entsprechenden Methoden auf, wenn eine IndexAction aus der Warteschlange entfernt wurde (erfolgreich oder schlägt fehl). Dies kann von Standard Thread oder einem Workerthread aufgerufen werden.
- 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 freigegebenen Schlüssels nicht berücksichtigt. Wenn keine Zielgruppe bereitgestellt wird, wird die Öffentliche Cloud-Zielgruppe angenommen.
Methoden
| close |
Schließen Sie die SearchClient Sitzung. |
| delete_documents |
Aktionen zum Löschen von Dokumenten in warteschlangen |
| flush |
Leeren Sie den Batch. |
| index_documents |
Geben Sie einen Dokumentvorgang an, der als Batch ausgeführt werden soll. |
| merge_documents |
Aktionen zum Zusammenführen von Warteschlangendokumenten |
| merge_or_upload_documents |
Warteschlangenzusammenführung oder Hochladen von Dokumentenaktionen |
| upload_documents |
Aktionen zum Warteschlangenupload von Dokumenten. |
close
Schließen Sie die SearchClient Sitzung.
close(**kwargs) -> Nonedelete_documents
Aktionen zum Löschen von Dokumenten in warteschlangen
delete_documents(documents: List[Dict], **kwargs) -> NoneParameter
flush
Leeren Sie den Batch.
flush(timeout: int = 86400, **kwargs: Any) -> boolParameter
Gibt zurück
True, wenn Fehler vorhanden sind. Else False
Rückgabetyp
Ausnahmen
index_documents
Geben Sie einen Dokumentvorgang an, der als Batch ausgeführt werden soll.
:Löst RequestEntityTooLargeError
index_documents(batch: IndexDocumentsBatch, **kwargs) -> List[IndexingResult]Parameter
Gibt zurück
Indizierungsergebnis jeder Aktion im Batch.
Rückgabetyp
merge_documents
Aktionen zum Zusammenführen von Warteschlangendokumenten
merge_documents(documents: List[Dict], **kwargs) -> NoneParameter
merge_or_upload_documents
Warteschlangenzusammenführung oder Hochladen von Dokumentenaktionen
merge_or_upload_documents(documents: List[Dict], **kwargs) -> NoneParameter
upload_documents
Aktionen zum Warteschlangenupload von Dokumenten.
upload_documents(documents: List[Dict], **kwargs) -> NoneParameter
Attribute
actions
Die Liste der derzeit indizierenden Aktionen in der Warteschlange zum Indizieren.
Rückgabetyp
Azure SDK for Python