@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
55 lines (54 loc) • 2.09 kB
TypeScript
/**
* Pinecone Control 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.
*/
import type { ConfigureIndexRequestEmbed } from './ConfigureIndexRequestEmbed';
import type { ConfigureIndexRequestSpec } from './ConfigureIndexRequestSpec';
import type { DeletionProtection } from './DeletionProtection';
/**
* Configuration used to scale an index.
* @export
* @interface ConfigureIndexRequest
*/
export interface ConfigureIndexRequest {
/**
*
* @type {ConfigureIndexRequestSpec}
* @memberof ConfigureIndexRequest
*/
spec?: ConfigureIndexRequestSpec;
/**
*
* @type {DeletionProtection}
* @memberof ConfigureIndexRequest
*/
deletionProtection?: DeletionProtection;
/**
* Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '_', or '-'. Values must be alphanumeric, ';', '@', '_', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.
* @type {{ [key: string]: string; }}
* @memberof ConfigureIndexRequest
*/
tags?: {
[key: string]: string;
};
/**
*
* @type {ConfigureIndexRequestEmbed}
* @memberof ConfigureIndexRequest
*/
embed?: ConfigureIndexRequestEmbed;
}
/**
* Check if a given object implements the ConfigureIndexRequest interface.
*/
export declare function instanceOfConfigureIndexRequest(value: object): boolean;
export declare function ConfigureIndexRequestFromJSON(json: any): ConfigureIndexRequest;
export declare function ConfigureIndexRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConfigureIndexRequest;
export declare function ConfigureIndexRequestToJSON(value?: ConfigureIndexRequest | null): any;