UNPKG

@pinecone-database/pinecone

Version:

This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.

51 lines (50 loc) 2.01 kB
import { BasePineconeError } from './base'; /** * This exception indicates there is a problem with the configuration values * you have provided to the client. The error message should contain additional * context about what you are missing. * * @see {@link Pinecone} for information about initializing the client. */ export declare class PineconeConfigurationError extends BasePineconeError { constructor(message: string); } /** * This exception indicates an API call that returned a response that was * unable to be parsed or that did not include expected fields. It's not * expected to ever occur. * * If you encounter this error, please [file an issue](https://github.com/pinecone-io/pinecone-ts-client/issues) so we can investigate. */ export declare class PineconeUnexpectedResponseError extends BasePineconeError { constructor(url: string, status: number, body: string, message?: string); } /** * This error occurs when the client tries to read environment variables in * an environment that does not have access to the Node.js global `process.env`. * * If you are seeing this error, you will need to configure the client by passing * configuration values to the `Pinecone` constructor. * * ```typescript * import { Pinecone } from '@pinecone-database/pinecone'; * * const pinecone = new Pinecone({ * apiKey: 'YOUR_API_KEY', * }) * ``` * * @see Instructions for configuring { @link Pinecone } */ export declare class PineconeEnvironmentVarsNotSupportedError extends BasePineconeError { constructor(message: string); } /** * This error occurs when the client is unable to resolve the database host for a given * index. This is unexpected to occur unless there is a problem with the Pinecone service. * * If you encounter this error, please [file an issue](https://github.com/pinecone-io/pinecone-ts-client/issues) so we can investigate. */ export declare class PineconeUnableToResolveHostError extends BasePineconeError { constructor(message: string); }