search_by_document_id

Function

Searches for a document chunk based on a specific document ID.

Prototype

def search_by_document_id(document_id: int)

Parameters

Parameter

Data Type

Required/Optional

Description

document_id

Integer

Required

Document index. The value must be greater than or equal to 0.

Return Value

Data Type

Description

List[MxDocument]

If a result is found, a list of MxDocument class instances is returned. If no result is found, an empty list is returned. For details about MxDocument, see MxDocument.