@pinecone-database/pinecone/dist/data/vectors/query.d.ts

This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.

import { OperationUsage, RecordValues, RecordSparseValues } from './types';
import type { PineconeRecord, RecordMetadata } from './types';
import { VectorOperationsProvider } from './vectorOperationsProvider';
/**
 * @see [Query data](https://docs.pinecone.io/docs/query-data)
 */
export type QueryShared = {
    /** The number of query results you would like returned. */
    topK: number;
    /**
     * This boolean value specifies whether embedding values are returned with query results.
     *
     * By default, values are not returned to reduce the size of the request payload.
     */
    includeValues?: boolean;
    /**
     * This boolean value specifies whether metadata values are returned with query results.
     *
     * By default, metadata values are not returned to reduce the size of the request payload.
     */
    includeMetadata?: boolean;
    /**
     * This parameter allows you to modify your query with a metadata filter.
     *
     * @see [Metadata filtering](https://docs.pinecone.io/docs/metadata-filtering)
     */
    filter?: object;
};
/**
 * Include an `id` in your query configuration along with properties defined in
 * { @link QueryShared } if you want to use vector values from a record in the
 * index as your query.
 *
 * @see [Querying data](https://docs.pinecone.io/docs/query-data)
 */
export type QueryByRecordId = QueryShared & {
    /**
     * Specifies the {@link RecordId} of a record whose `values` you'd
     * like to query with.
     */
    id: string;
};
/**
 * Include vector values in your query configuration along with properties defined
 * in { @link QueryShared }.
 *
 * @see [Querying data](https://docs.pinecone.io/docs/query-data)
 */
export type QueryByVectorValues = QueryShared & {
    /**
     * Vector values output from an embedding model.
     */
    vector: RecordValues;
    /**
     * The sparse values of the query vector, if applicable.
     */
    sparseVector?: RecordSparseValues;
};
/**
 * The options that may be passed to {@link Index.query }
 */
export type QueryOptions = QueryByRecordId | QueryByVectorValues;
/**
 * A {@link PineconeRecord} with a similarity score.
 */
export interface ScoredPineconeRecord<T extends RecordMetadata = RecordMetadata> extends PineconeRecord<T> {
    /**
     * The similarity score of the record. The interpretation of this score will be different
     * depending on the distance metric configured on the index.
     *
     * For indexes using the `euclidean` distance metric, a lower similarity score is more
     * similar, while for indexes using the `dotproduct` metric, higher scores are more similar.
     */
    score?: number;
}
/**
 * Response from { @link Index.query }
 *
 * @see [Query data](https://docs.pinecone.io/docs/query-data)
 */
export type QueryResponse<T extends RecordMetadata = RecordMetadata> = {
    /** The query results sorted by similarity */
    matches: Array<ScoredPineconeRecord<T>>;
    /** The namespace where the query was executed. */
    namespace: string;
    /** The usage information for the query operation. */
    usage?: OperationUsage;
};
export declare class QueryCommand<T extends RecordMetadata = RecordMetadata> {
    apiProvider: VectorOperationsProvider;
    namespace: string;
    constructor(apiProvider: any, namespace: any);
    validator: (options: QueryOptions) => void;
    run(query: QueryOptions): Promise<QueryResponse<T>>;
}