@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
58 lines (57 loc) • 2.18 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 configuration needed to create an assistant.
* @export
* @interface CreateAssistantRequest
*/
export interface CreateAssistantRequest {
/**
* 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 CreateAssistantRequest
*/
name: string;
/**
* Description or directive for the assistant to apply to all responses.
* @type {string}
* @memberof CreateAssistantRequest
*/
instructions?: string | null;
/**
*
* @type {object}
* @memberof CreateAssistantRequest
*/
metadata?: object;
/**
* The region to deploy the assistant in. Our current options are either us or eu. Defaults to us.
* @type {string}
* @memberof CreateAssistantRequest
*/
region?: CreateAssistantRequestRegionEnum;
}
/**
* @export
*/
export declare const CreateAssistantRequestRegionEnum: {
readonly Us: "us";
readonly Eu: "eu";
};
export type CreateAssistantRequestRegionEnum = typeof CreateAssistantRequestRegionEnum[keyof typeof CreateAssistantRequestRegionEnum];
/**
* Check if a given object implements the CreateAssistantRequest interface.
*/
export declare function instanceOfCreateAssistantRequest(value: object): boolean;
export declare function CreateAssistantRequestFromJSON(json: any): CreateAssistantRequest;
export declare function CreateAssistantRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAssistantRequest;
export declare function CreateAssistantRequestToJSON(value?: CreateAssistantRequest | null): any;