pinecone-sdk 0.1.2

Pinecone Rust SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# Rust API client for openapi

Pinecone is a vector database that makes it easy to search and retrieve billions of high-dimensional vectors.

For more information, please visit [https://support.pinecone.io](https://support.pinecone.io)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 2024-07
- Package version: 0.0.1
- Generator version: 7.6.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:

```
openapi = { path = "./openapi" }
```

## Documentation for API Endpoints

All URIs are relative to *https://api.pinecone.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*InferenceApi* | [**embed**](docs/InferenceApi.md#embed) | **POST** /embed | Embed data
*ManageIndexesApi* | [**configure_index**](docs/ManageIndexesApi.md#configure_index) | **PATCH** /indexes/{index_name} | Configure an index
*ManageIndexesApi* | [**create_collection**](docs/ManageIndexesApi.md#create_collection) | **POST** /collections | Create a collection
*ManageIndexesApi* | [**create_index**](docs/ManageIndexesApi.md#create_index) | **POST** /indexes | Create an index
*ManageIndexesApi* | [**delete_collection**](docs/ManageIndexesApi.md#delete_collection) | **DELETE** /collections/{collection_name} | Delete a collection
*ManageIndexesApi* | [**delete_index**](docs/ManageIndexesApi.md#delete_index) | **DELETE** /indexes/{index_name} | Delete an index
*ManageIndexesApi* | [**describe_collection**](docs/ManageIndexesApi.md#describe_collection) | **GET** /collections/{collection_name} | Describe a collection
*ManageIndexesApi* | [**describe_index**](docs/ManageIndexesApi.md#describe_index) | **GET** /indexes/{index_name} | Describe an index
*ManageIndexesApi* | [**list_collections**](docs/ManageIndexesApi.md#list_collections) | **GET** /collections | List collections
*ManageIndexesApi* | [**list_indexes**](docs/ManageIndexesApi.md#list_indexes) | **GET** /indexes | List indexes


## Documentation For Models

 - [CollectionList](docs/CollectionList.md)
 - [CollectionModel](docs/CollectionModel.md)
 - [ConfigureIndexRequest](docs/ConfigureIndexRequest.md)
 - [ConfigureIndexRequestSpec](docs/ConfigureIndexRequestSpec.md)
 - [ConfigureIndexRequestSpecPod](docs/ConfigureIndexRequestSpecPod.md)
 - [CreateCollectionRequest](docs/CreateCollectionRequest.md)
 - [CreateIndexRequest](docs/CreateIndexRequest.md)
 - [DeletionProtection](docs/DeletionProtection.md)
 - [EmbedRequest](docs/EmbedRequest.md)
 - [EmbedRequestInputsInner](docs/EmbedRequestInputsInner.md)
 - [EmbedRequestParameters](docs/EmbedRequestParameters.md)
 - [Embedding](docs/Embedding.md)
 - [EmbeddingsList](docs/EmbeddingsList.md)
 - [EmbeddingsListUsage](docs/EmbeddingsListUsage.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [ErrorResponseError](docs/ErrorResponseError.md)
 - [IndexList](docs/IndexList.md)
 - [IndexModel](docs/IndexModel.md)
 - [IndexModelSpec](docs/IndexModelSpec.md)
 - [IndexModelStatus](docs/IndexModelStatus.md)
 - [IndexSpec](docs/IndexSpec.md)
 - [PodSpec](docs/PodSpec.md)
 - [PodSpecMetadataConfig](docs/PodSpecMetadataConfig.md)
 - [ServerlessSpec](docs/ServerlessSpec.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

support@pinecone.io