Databricks SDK for JavaScript
    Preparing search index...

    Interface ScanIndexRequest

    Request to scan (paginate over) the rows of an AI Search index. Models the legacy num_results / last_primary_key cursor as AIP-158 page_size / page_token.

    interface ScanIndexRequest {
        name?: string;
        pageSize?: number;
        pageToken?: string;
    }
    Index

    Properties

    name? pageSize? pageToken?

    Properties

    name?: string

    Full resource name of the index to scan. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

    pageSize?: number

    Maximum number of rows to return in this page.

    pageToken?: string

    Page token from a previous response; if unset, scanning starts from the beginning.

    Settings

    Member Visibility

    On This Page

    Properties