@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
82 lines (81 loc) • 5.17 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.
*/
import * as runtime from '../runtime';
import type { Assistant, CreateAssistantRequest, ListAssistants200Response, UpdateAssistant200Response, UpdateAssistantRequest } from '../models/index';
export interface CreateAssistantOperationRequest {
createAssistantRequest: CreateAssistantRequest;
}
export interface DeleteAssistantRequest {
assistantName: string;
}
export interface GetAssistantRequest {
assistantName: string;
}
export interface UpdateAssistantOperationRequest {
assistantName: string;
updateAssistantRequest: UpdateAssistantRequest;
}
/**
*
*/
export declare class ManageAssistantsApi extends runtime.BaseAPI {
/**
* Create an assistant. This is where you specify the underlying training model, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an assistant](https://docs.pinecone.io/guides/assistant/create-assistant)
* Create an assistant
*/
createAssistantRaw(requestParameters: CreateAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assistant>>;
/**
* Create an assistant. This is where you specify the underlying training model, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an assistant](https://docs.pinecone.io/guides/assistant/create-assistant)
* Create an assistant
*/
createAssistant(requestParameters: CreateAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assistant>;
/**
* Delete an existing assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#delete-an-assistant)
* Delete an assistant
*/
deleteAssistantRaw(requestParameters: DeleteAssistantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Delete an existing assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#delete-an-assistant)
* Delete an assistant
*/
deleteAssistant(requestParameters: DeleteAssistantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Get the status of an assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#get-the-status-of-an-assistant)
* Check assistant status
*/
getAssistantRaw(requestParameters: GetAssistantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assistant>>;
/**
* Get the status of an assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#get-the-status-of-an-assistant)
* Check assistant status
*/
getAssistant(requestParameters: GetAssistantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assistant>;
/**
* List of all assistants in a project. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#list-assistants-for-a-project).
* List assistants
*/
listAssistantsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAssistants200Response>>;
/**
* List of all assistants in a project. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#list-assistants-for-a-project).
* List assistants
*/
listAssistants(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAssistants200Response>;
/**
* Update an existing assistant. You can modify the assistant\'s instructions. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#add-instructions-to-an-assistant).
* Update an assistant
*/
updateAssistantRaw(requestParameters: UpdateAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateAssistant200Response>>;
/**
* Update an existing assistant. You can modify the assistant\'s instructions. For guidance and examples, see [Manage assistants](https://docs.pinecone.io/guides/assistant/manage-assistants#add-instructions-to-an-assistant).
* Update an assistant
*/
updateAssistant(requestParameters: UpdateAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateAssistant200Response>;
}