@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
75 lines (74 loc) • 2.12 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 { CitationModel } from './CitationModel';
import type { MessageModel } from './MessageModel';
import type { UsageModel } from './UsageModel';
/**
* The ChatModel describes the response format of a chat request from the citation api.
* @export
* @interface ChatModel
*/
export interface ChatModel {
/**
*
* @type {string}
* @memberof ChatModel
*/
id?: string;
/**
*
* @type {string}
* @memberof ChatModel
*/
finishReason?: ChatModelFinishReasonEnum;
/**
*
* @type {MessageModel}
* @memberof ChatModel
*/
message?: MessageModel;
/**
*
* @type {string}
* @memberof ChatModel
*/
model?: string;
/**
*
* @type {Array<CitationModel>}
* @memberof ChatModel
*/
citations?: Array<CitationModel>;
/**
*
* @type {UsageModel}
* @memberof ChatModel
*/
usage?: UsageModel;
}
/**
* @export
*/
export declare const ChatModelFinishReasonEnum: {
readonly Stop: "stop";
readonly Length: "length";
readonly ContentFilter: "content_filter";
readonly FunctionCall: "function_call";
};
export type ChatModelFinishReasonEnum = typeof ChatModelFinishReasonEnum[keyof typeof ChatModelFinishReasonEnum];
/**
* Check if a given object implements the ChatModel interface.
*/
export declare function instanceOfChatModel(value: object): boolean;
export declare function ChatModelFromJSON(json: any): ChatModel;
export declare function ChatModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatModel;
export declare function ChatModelToJSON(value?: ChatModel | null): any;