@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
79 lines (78 loc) • 2.35 kB
TypeScript
/**
* Pinecone Assistant Control Plane API
* Pinecone Assistant Engine is a context engine to store and retrieve relevant knowledge from millions of documents at scale. This API supports creating and managing 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.
*/
/**
* The AssistantModel describes the configuration and status of a Pinecone Assistant.
* @export
* @interface Assistant
*/
export interface Assistant {
/**
* The name of the assistant. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
* @type {string}
* @memberof Assistant
*/
name: string;
/**
* Description or directive for the assistant to apply to all responses.
* @type {string}
* @memberof Assistant
*/
instructions?: string | null;
/**
*
* @type {object}
* @memberof Assistant
*/
metadata?: object | null;
/**
*
* @type {string}
* @memberof Assistant
*/
status: AssistantStatusEnum;
/**
* The host where the assistant is deployed.
* @type {string}
* @memberof Assistant
*/
host?: string;
/**
*
* @type {Date}
* @memberof Assistant
*/
createdAt?: Date;
/**
*
* @type {Date}
* @memberof Assistant
*/
updatedAt?: Date;
}
/**
* @export
*/
export declare const AssistantStatusEnum: {
readonly Initializing: "Initializing";
readonly Failed: "Failed";
readonly Ready: "Ready";
readonly Terminating: "Terminating";
readonly InitializationFailed: "InitializationFailed";
};
export type AssistantStatusEnum = typeof AssistantStatusEnum[keyof typeof AssistantStatusEnum];
/**
* Check if a given object implements the Assistant interface.
*/
export declare function instanceOfAssistant(value: object): boolean;
export declare function AssistantFromJSON(json: any): Assistant;
export declare function AssistantFromJSONTyped(json: any, ignoreDiscriminator: boolean): Assistant;
export declare function AssistantToJSON(value?: Assistant | null): any;