@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
57 lines (56 loc) • 2.08 kB
TypeScript
/**
* Pinecone Assistant Data Plane API
* Pinecone Assistant Engine is a context engine to store and retrieve relevant knowledge from millions of documents at scale. This API supports interactions with assistants.
*
* The version of the OpenAPI document: 2025-04
* Contact: support@pinecone.io
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { MessageModel } from './MessageModel';
/**
* Parameters to retrieve context from an assistant.
* @export
* @interface ContextRequest
*/
export interface ContextRequest {
/**
* The query that is used to generate the context. Exactly one of query or messages should be provided.
* @type {string}
* @memberof ContextRequest
*/
query?: string;
/**
* Optionally filter which documents can be retrieved using the following metadata fields.
* @type {object}
* @memberof ContextRequest
*/
filter?: object;
/**
* The list of messages to use for generating the context. Exactly one of query or messages should be provided.
* @type {Array<MessageModel>}
* @memberof ContextRequest
*/
messages?: Array<MessageModel>;
/**
* The maximum number of context snippets to return. Default is 16. Maximum is 64.
* @type {number}
* @memberof ContextRequest
*/
topK?: number;
/**
* The maximum context snippet size. Default is 2048 tokens. Minimum is 512 tokens. Maximum is 8192 tokens.
* @type {number}
* @memberof ContextRequest
*/
snippetSize?: number;
}
/**
* Check if a given object implements the ContextRequest interface.
*/
export declare function instanceOfContextRequest(value: object): boolean;
export declare function ContextRequestFromJSON(json: any): ContextRequest;
export declare function ContextRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContextRequest;
export declare function ContextRequestToJSON(value?: ContextRequest | null): any;