Expand description
Models for the Pinecone SDK.
Structs§
- Collection
List - CollectionList : The list of collections that exist in the project.
- Collection
Model - CollectionModel : The CollectionModel describes the configuration and status of a Pinecone collection.
- Configure
Index Request - ConfigureIndexRequest : Configuration used to scale an index.
- Configure
Index Request Spec - Configure
Index Request Spec Pod - Create
Collection Request - CreateCollectionRequest : The configuration needed to create a Pinecone collection.
- Describe
Index Stats Response - The response for the
describe_index_statsoperation. - Embed
Request Parameters - EmbedRequestParameters : Model-specific parameters.
- Embedding
- Embedding
- Embeddings
List - EmbeddingsList : Embeddings generated for the input
- Embeddings
List Usage - EmbeddingsListUsage : Usage statistics for model inference including any instruction prefixes
- Fetch
Response - The response for the
fetchoperation. - Index
List - IndexList : The list of indexes that exist in the project.
- Index
Model - IndexModel : The IndexModel describes the configuration and status of a Pinecone index.
- Index
Model Spec - Index
Model Status - Index
Spec - IndexSpec : The spec object defines how the index should be deployed. For serverless indexes, you define only the cloud and region where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.
- List
Response - The response for the
Listoperation. - Metadata
Structrepresents a structured data value, consisting of fields which map to dynamically typed values. In some languages,Structmight be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.- Namespace
- The namespace of an index
- PodSpec
- PodSpec : Configuration needed to deploy a pod-based index.
- PodSpec
Metadata Config - PodSpecMetadataConfig : Configuration for the behavior of Pinecone’s internal metadata index. By default, all metadata is indexed; when
metadata_configis present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes. - Query
Response - The response for the
queryoperation. These are the matches found for a particular query vector. The matches are ordered from most similar to least similar. - Serverless
Spec - ServerlessSpec : Configuration needed to deploy a serverless index.
- Sparse
Values - Update
Response - The response for the
updateoperation. - Upsert
Response - The response for the
upsertoperation. - Value
Valuerepresents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.- Vector
Enums§
- Cloud
- The public cloud where you would like your index hosted.
- Deletion
Protection - DeletionProtection : Whether deletion protection is enabled/disabled for the index. Whether deletion protection is enabled/disabled for the index.
- Kind
- The kind of value.
- Metric
- The distance metric to be used for similarity search. You can use ‘euclidean’, ‘cosine’, or ‘dotproduct’.
- State
- Wait
Policy - Defines the wait policy for index creation.