Range

Range Command for Python SDK

The range method is used to retrieve documents in chunks with pagination.

Arguments

Payload · dict · required

Hide child attributes

cursor · string · required

The cursor to the last retrieved document. Should be set to "" in the initial range request.

limit · int · required

The number of maximum documents wanted in the response of range. (page size)

Response

Response · dict · required

Hide child attributes

Documents · List[Document] · required

This field is null if no document with the specified ID is found.

Hide child attributes

id · string | number · required

The ID of the resulting document.

content · Record<string, unknown>

The main content of the document.

metadata · Record<string, unknown>

Additional metadata for the document.

next_cursor · string

The cursor for the next page of documents.

Request

range_documents = index.range(cursor="", limit=1)
print(range_documents.documents)

range_documents = index.range(
    cursor=range_documents.next_cursor,
    limit=3
)
print(range_documents.documents)