Expand description
All the different models and data types sent and recieved to pinecone as well as their alternative respesentations / rust specific representations are stored within this file.
As the API updates these values will update. If changes do occur please create an issue if you notice a breaking change.
Structs§
- Client
Info - Returned data type under the /actions/whoami GET request detailing the Client’s information used for future requests as well as Client validation.
- Collection
Description - Description / Information about a collection.
- Configure
Index Request - Request sent to change the settings / details of an index.
- Describe
Index Config - Describes an Indexes Configuration
- Fetch
Request - Detailing parameters for an operation that looks up and returns vector by ID.
- Fetch
Response - Pinecones data sent during the succesfull Fetch Request.
- Index
Create Request - Request sent to pinecone for the creation of an Index.
- Index
Database Description - Details the configuration of the index.
- Index
Description - Returns information about the index in great depth.
- Index
Metadata Config - 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. - Index
Stats - The stats / information about an index, this is different information compared to
IndexDescription. - Index
Status Description - Describes the Status of an Index
- Match
- Match is a specific match under a Query Request.
- Namespace
- Details information about an individual namespace, found in
IndexStats. - Pinecone
Error Response - Details the generic pinecone error response sent during index operations.
- Query
Request - Data type detailing the search of a namespace using a query vector.
- Query
Response - Response Returned during a query operation.
- Sparse
Values - Vector sparse data. Represented as a list of indeices and a list of corresponded values, which must be the same length.
- Update
Request - Updates a vector in a namespace.
- Upsert
Response - Response from an upsert request sending data to the Index.
- Vector
- Represents a vector that can be sent and retrieved from pinecone.
Enums§
- Describe
Status State - Current Status of an Index. Whenever you create a new index, for a minute or see you will recieve an Initializing index status and connot run any index operations on it.
- Metric
- The distance metric used for similarity search.
- PodType
- The pod type for the index.
Type Aliases§
- Mapped
Value - A value representing a map from a string to a currently unknown value, as the value of these is better understood their implementations might be transfered to a more type strict version.