Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface IndexOptions

    Options for targeting an index for data operations.

    You must provide either name or host (or both). If only host is provided, the SDK will perform data operations directly against that host without calling describeIndex() to resolve it.

    interface IndexOptions {
        additionalHeaders?: HTTPHeaders;
        host?: string;
        name?: string;
        namespace?: string;
    }
    Index
    additionalHeaders? host? name? namespace?
    additionalHeaders?: HTTPHeaders

    Optional additional HTTP headers to include with each request to the index.

    host?: string

    The host URL to use for data operations against this index. If not provided, the host URL will be automatically resolved by calling describeIndex() using the name.

    You can find your index host in the Pinecone console or by using describeIndex().

    name?: string

    The name of the index to target. Required unless host is provided.

    namespace?: string

    The namespace to target within the index. If not specified, operations will be performed on the default namespace ''.

    Settings
    Member Visibility

    On This Page
    Properties