# Functions
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewConfigureIndexRequest calls the generic ConfigureIndex builder with application/json body.
NewConfigureIndexRequestWithBody generates requests for ConfigureIndex with any type of body.
NewCreateCollectionRequest calls the generic CreateCollection builder with application/json body.
NewCreateCollectionRequestWithBody generates requests for CreateCollection with any type of body.
NewCreateIndexRequest calls the generic CreateIndex builder with application/json body.
NewCreateIndexRequestWithBody generates requests for CreateIndex with any type of body.
NewDeleteCollectionRequest generates requests for DeleteCollection.
NewDeleteIndexRequest generates requests for DeleteIndex.
NewDescribeCollectionRequest generates requests for DescribeCollection.
NewDescribeIndexRequest generates requests for DescribeIndex.
NewListCollectionsRequest generates requests for ListCollections.
NewListIndexesRequest generates requests for ListIndexes.
ParseConfigureIndexResponse parses an HTTP response from a ConfigureIndexWithResponse call.
ParseCreateCollectionResponse parses an HTTP response from a CreateCollectionWithResponse call.
ParseCreateIndexResponse parses an HTTP response from a CreateIndexWithResponse call.
ParseDeleteCollectionResponse parses an HTTP response from a DeleteCollectionWithResponse call.
ParseDeleteIndexResponse parses an HTTP response from a DeleteIndexWithResponse call.
ParseDescribeCollectionResponse parses an HTTP response from a DescribeCollectionWithResponse call.
ParseDescribeIndexResponse parses an HTTP response from a DescribeIndexWithResponse call.
ParseListCollectionsResponse parses an HTTP response from a ListCollectionsWithResponse call.
ParseListIndexesResponse parses an HTTP response from a ListIndexesWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.
# Constants
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
No description provided by the author
Defines values for ServerlessSpecCloud.
Defines values for ServerlessSpecCloud.
Defines values for CollectionModelStatus.
Defines values for CollectionModelStatus.
Defines values for CollectionModelStatus.
Defines values for IndexMetric.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for IndexMetric.
Defines values for IndexMetric.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ServerlessSpecCloud.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for IndexModelStatusState.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
Defines values for ErrorResponseErrorCode.
# Structs
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CollectionList The list of collections that exist in the project.
CollectionModel The CollectionModel describes the configuration and status of a Pinecone collection.
ConfigureIndexRequest Configuration used to scale an index.
No description provided by the author
CreateCollectionRequest The configuration needed to create a Pinecone collection.
No description provided by the author
CreateIndexRequest The configuration needed to create a Pinecone index.
CreateIndexRequest_Spec The spec object defines how the index should be deployed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrorResponse The response shape used for all error responses.
IndexList The list of indexes that exist in the project.
IndexModel The IndexModel describes the configuration and status of a Pinecone index.
No description provided by the author
No description provided by the author
PodSpec Configuration needed to deploy a pod-based index.
ServerlessSpec Configuration needed to deploy a serverless index.
# Interfaces
The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
CreateIndexRequestSpec0 defines model for .
CreateIndexRequestSpec1 defines model for .
Doer performs HTTP requests.
# Type aliases
ClientOption allows setting custom parameters during construction.
CollectionModelStatus The status of the collection.
ConfigureIndexJSONRequestBody defines body for ConfigureIndex for application/json ContentType.
CreateCollectionJSONRequestBody defines body for CreateCollection for application/json ContentType.
CreateIndexJSONRequestBody defines body for CreateIndex for application/json ContentType.
ErrorResponseErrorCode defines model for ErrorResponse.Error.Code.
IndexDimension The dimensions of the vectors to be inserted in the index.
IndexHost The URL address where the index is hosted.
IndexMetric The distance metric to be used for similarity search.
IndexModelStatusState defines model for IndexModel.Status.State.
IndexName The name of the index.
N400BadRequest The response shape used for all error responses.
N401Unauthorized The response shape used for all error responses.
N403CollectionsQuotaExceeded The response shape used for all error responses.
N403PodQuotaExceeded The response shape used for all error responses.
N404CollectionNotFound The response shape used for all error responses.
N404IndexNotFound The response shape used for all error responses.
N404ServerlessSpecNotFound The response shape used for all error responses.
N412PendingCollection The response shape used for all error responses.
N422UnprocessableEntity The response shape used for all error responses.
N500InternalServerError The response shape used for all error responses.
PodSpecPodType The type of pod to use.
PodSpecReplicas The number of replicas.
PodSpecShards The number of shards.
RequestEditorFn is the function signature for the RequestEditor callback function.
ServerlessSpecCloud The public cloud where you would like your index hosted.