@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
54 lines (53 loc) • 2.51 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.
*/
/**
* Configure the integrated inference embedding settings for this index.
*
* You can convert an existing index to an integrated index by specifying the embedding model and field_map. The index vector type and dimension must match the model vector type and dimension, and the index similarity metric must be supported by the model. Refer to the [model guide](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models) for available models and model details.
*
* You can later change the embedding configuration to update the field map, read parameters, or write parameters. Once set, the model cannot be changed.
* @export
* @interface ConfigureIndexRequestEmbed
*/
export interface ConfigureIndexRequestEmbed {
/**
* The name of the embedding model to use with the index. The index dimension and model dimension must match, and the index similarity metric must be supported by the model. The index embedding model cannot be changed once set.
* @type {string}
* @memberof ConfigureIndexRequestEmbed
*/
model?: string;
/**
* Identifies the name of the text field from your document model that will be embedded.
* @type {object}
* @memberof ConfigureIndexRequestEmbed
*/
fieldMap?: object;
/**
* The read parameters for the embedding model.
* @type {object}
* @memberof ConfigureIndexRequestEmbed
*/
readParameters?: object;
/**
* The write parameters for the embedding model.
* @type {object}
* @memberof ConfigureIndexRequestEmbed
*/
writeParameters?: object;
}
/**
* Check if a given object implements the ConfigureIndexRequestEmbed interface.
*/
export declare function instanceOfConfigureIndexRequestEmbed(value: object): boolean;
export declare function ConfigureIndexRequestEmbedFromJSON(json: any): ConfigureIndexRequestEmbed;
export declare function ConfigureIndexRequestEmbedFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConfigureIndexRequestEmbed;
export declare function ConfigureIndexRequestEmbedToJSON(value?: ConfigureIndexRequestEmbed | null): any;