Interface FindAndRerankPage<T>

Overview 🚨

Represents a page of results returned by the Data API when using pagination in findAndRerank operations.

🚨Important: findAndRerank operations are not currently paginated, and as such, this construct mainly exists for consistency with FindPage.

Regardless, the page state mechanism is still full functional on the client side, in case it is available in the future.

See FindPage for more information on the page state.

See

  • FindAndRerankCursor.initialPageState
  • FindAndRerankCursor.fetchNextPage
interface FindAndRerankPage<T> {
    nextPageState: null | string;
    result: T[];
    sortVector?: DataAPIVector;
}

Type Parameters

  • T

Properties

nextPageState result sortVector?

Properties

nextPageState

nextPageState: null | string

The state for the next page of results, which may be stored on the client side to drive pagination.

If this is null, there are no more results to fetch, and the client should stop paginating.

result

result: T[]

The records present in the findAndRerank page, with any mappings applied.

Optional sortVector

sortVector?: DataAPIVector

The sort vector used to perform the vector search, if applicable.

This is only applicable when using vector search and FindAndRerankCursor.includeSortVector is set to true, and will not be present otherwise.

Settings

Member Visibility

Theme

On This Page

nextPageStateresultsortVector