@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
169 lines • 9.09 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* Pinecone Data Plane API
* Pinecone is a vector database that makes it easy to search and retrieve billions of high-dimensional vectors.
*
* 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.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.BulkOperationsApi = void 0;
const runtime = __importStar(require("../runtime"));
const index_1 = require("../models/index");
/**
*
*/
class BulkOperationsApi extends runtime.BaseAPI {
/**
* Cancel an import operation if it is not yet finished. It has no effect if the operation is already finished. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Cancel an import
*/
async cancelBulkImportRaw(requestParameters, initOverrides) {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling cancelBulkImport.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Api-Key"] = this.configuration.apiKey("Api-Key"); // ApiKeyAuth authentication
}
const response = await this.request({
path: `/bulk/imports/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response);
}
/**
* Cancel an import operation if it is not yet finished. It has no effect if the operation is already finished. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Cancel an import
*/
async cancelBulkImport(requestParameters, initOverrides) {
const response = await this.cancelBulkImportRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Describe an import
*/
async describeBulkImportRaw(requestParameters, initOverrides) {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling describeBulkImport.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Api-Key"] = this.configuration.apiKey("Api-Key"); // ApiKeyAuth authentication
}
const response = await this.request({
path: `/bulk/imports/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ImportModelFromJSON)(jsonValue));
}
/**
* Return details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Describe an import
*/
async describeBulkImport(requestParameters, initOverrides) {
const response = await this.describeBulkImportRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* List all recent and ongoing import operations. By default, `list_imports` returns up to 100 imports per page. If the `limit` parameter is set, `list` returns up to that number of imports instead. Whenever there are additional IDs to return, the response also includes a `pagination_token` that you can use to get the next batch of imports. When the response does not include a `pagination_token`, there are no more imports to return. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* List imports
*/
async listBulkImportsRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit;
}
if (requestParameters.paginationToken !== undefined) {
queryParameters['paginationToken'] = requestParameters.paginationToken;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Api-Key"] = this.configuration.apiKey("Api-Key"); // ApiKeyAuth authentication
}
const response = await this.request({
path: `/bulk/imports`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListImportsResponseFromJSON)(jsonValue));
}
/**
* List all recent and ongoing import operations. By default, `list_imports` returns up to 100 imports per page. If the `limit` parameter is set, `list` returns up to that number of imports instead. Whenever there are additional IDs to return, the response also includes a `pagination_token` that you can use to get the next batch of imports. When the response does not include a `pagination_token`, there are no more imports to return. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* List imports
*/
async listBulkImports(requestParameters = {}, initOverrides) {
const response = await this.listBulkImportsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Start an asynchronous import of vectors from object storage into an index. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Start import
*/
async startBulkImportRaw(requestParameters, initOverrides) {
if (requestParameters.startImportRequest === null || requestParameters.startImportRequest === undefined) {
throw new runtime.RequiredError('startImportRequest', 'Required parameter requestParameters.startImportRequest was null or undefined when calling startBulkImport.');
}
const queryParameters = {};
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Api-Key"] = this.configuration.apiKey("Api-Key"); // ApiKeyAuth authentication
}
const response = await this.request({
path: `/bulk/imports`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, index_1.StartImportRequestToJSON)(requestParameters.startImportRequest),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StartImportResponseFromJSON)(jsonValue));
}
/**
* Start an asynchronous import of vectors from object storage into an index. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/index-data/import-data).
* Start import
*/
async startBulkImport(requestParameters, initOverrides) {
const response = await this.startBulkImportRaw(requestParameters, initOverrides);
return await response.value();
}
}
exports.BulkOperationsApi = BulkOperationsApi;
//# sourceMappingURL=BulkOperationsApi.js.map