SearchIndexingBufferedSender Clase

Remitente almacenado en búfer para acciones de indexación de documentos.

Herencia

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Constructor

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

Parámetros

endpoint

str

Requerido

Punto de conexión de dirección URL de un servicio de Azure Search

index_name

str

Requerido

Nombre del índice al que se va a conectar.

credential

AzureKeyCredential o TokenCredential

Requerido

Una credencial para autorizar solicitudes de cliente de búsqueda

auto_flush_interval

int

cuántos segundos máximos si hay entre 2 vaciados. Esto solo surte efecto cuando auto_flush está activado. El valor predeterminado es 60 segundos.

initial_batch_action_count

int

Número inicial de acciones que se van a agrupar en un lote al optimizar el comportamiento del remitente. El valor predeterminado es 512.

max_retries_per_action

int

Número de veces que se reintenta un documento con errores. El valor predeterminado es 3.

on_new

callable

Si se establece, el cliente llamará a los métodos correspondientes cuando se agregue una nueva IndexAction. Se puede llamar desde el subproceso principal o un subproceso de trabajo.

on_progress

callable

Si se establece, el cliente llamará a los métodos correspondientes cuando indexAction se realice correctamente. Se puede llamar desde el subproceso principal o un subproceso de trabajo.

on_error

callable

Si se establece, el cliente llamará a los métodos correspondientes cuando se produzca un error en IndexAction. Se puede llamar desde el subproceso principal o un subproceso de trabajo.

on_remove

callable

Si se establece, el cliente llamará a los métodos correspondientes cuando se quite indexAction de la cola (se realiza correctamente o se produce un error). Se puede llamar desde el subproceso principal o un subproceso de trabajo.

api_version

str

La versión de Search API que se va a usar para las solicitudes.

audience

str

establece la audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. Si no se proporciona audiencia, se supone que la audiencia de la nube pública.

Métodos

close	Cierre la SearchClient sesión.
delete_documents	Acciones de eliminación de documentos en cola
flush	Vacíe el lote.
index_documents	Especifique una operación de documento que se va a realizar como un lote. :Plantea RequestEntityTooLargeError
merge_documents	Acciones de documentos de combinación de colas
merge_or_upload_documents	Acciones de carga o documentos de combinación de colas
upload_documents	Acciones de carga de documentos en cola.

close

Cierre la SearchClient sesión.

close(**kwargs) -> None

delete_documents

Acciones de eliminación de documentos en cola

delete_documents(documents: List[Dict], **kwargs) -> None

Parámetros

documents

list[dict]

Requerido

Lista de documentos que se van a eliminar.

flush

Vacíe el lote.

flush(timeout: int = 86400, **kwargs: Any) -> bool

Parámetros

timeout

int

Requerido

configuración de tiempo de espera. El valor predeterminado es 86400s (un día)

Devoluciones

True si hay errores. Else False

Tipo de valor devuelto

bool

Excepciones

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Especifique una operación de documento que se va a realizar como un lote.

:Plantea RequestEntityTooLargeError

index_documents(batch: IndexDocumentsBatch, **kwargs) -> List[IndexingResult]

Parámetros

batch

IndexDocumentsBatch

Requerido

Un lote de operaciones de documento que se van a realizar.

Devoluciones

Resultado de la indexación de cada acción del lote.

Tipo de valor devuelto

list[IndexingResult]

merge_documents

Acciones de documentos de combinación de colas

merge_documents(documents: List[Dict], **kwargs) -> None

Parámetros

documents

list[dict]

Requerido

Lista de documentos que se van a combinar.

merge_or_upload_documents

Acciones de carga o documentos de combinación de colas

merge_or_upload_documents(documents: List[Dict], **kwargs) -> None

Parámetros

documents

list[dict]

Requerido

Lista de documentos que se van a combinar o cargar.

upload_documents

Acciones de carga de documentos en cola.

upload_documents(documents: List[Dict], **kwargs) -> None

Parámetros

documents

list[dict]

Requerido

Lista de documentos que se van a cargar.

Atributos

actions

Lista de acciones de índice actualmente en cola que se van a indexar.

Tipo de valor devuelto

list[IndexAction]