{"note":"OpenAPI conversion -- returning structured metadata","name":"pinecone-io","description":"Pinecone API","version":"20230406.1","base_url":"https://controller.us-east1-gcp.pinecone.io","endpoints":15,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Pinecone API\n@base https://controller.us-east1-gcp.pinecone.io\n@version 20230406.1\n@auth ApiKey Api-Key in header\n@endpoints 15\n@toc collections(4), databases(5), describe_index_stats(1), query(1), vectors(4)\n\n@group collections\n@endpoint GET /collections\n@desc List collections\n@returns(200) This operation returns a list of all the collections in your current project.\n\n@endpoint POST /collections\n@desc Create collection\n@required {name: str(CollectionName) # The unique name of a collection., source: str(IndexName) # The unique name of an index.}\n@returns(201) The collection has been successfully created.\n@errors {400: Quota exceeded, or invalid parameters., 409: A collection with the name provided already exists., 500: Internal error. Can be caused by invalid parameters.}\n\n@endpoint GET /collections/{collectionName}\n@desc Describe collection\n@returns(200) {name: str(CollectionName), size: int(int64), status: str(CollectionState)} # This operation returns a list of all the collections in your current project.\n@errors {404: Collection not found., 500: Internal error. Can be caused by invalid parameters.}\n\n@endpoint DELETE /collections/{collectionName}\n@desc Delete Collection\n@returns(202) The collection has been successfully deleted.\n@errors {404: Collection not found., 500: Internal error. Can be caused by invalid parameters.}\n\n@endgroup\n\n@group databases\n@endpoint GET /databases\n@desc List indexes\n@returns(200) This operation returns a list of all the indexes that you have previously created, and which are associated with the given API key\n\n@endpoint POST /databases\n@desc Create index\n@required {name: str(IndexName) # The unique name of an index., dimension: int(int32) # The number of dimensions in the vector representation}\n@optional {metric: str(euclidean/cosine/dotproduct) # The vector similarity metric of the index, pods: int(int32)=1 # The number of pods for the index to use,including replicas., replicas: int(int32)=1 # The number of replicas. Replicas duplicate your index. They provide higher availability and throughput., pod_type: str(s1.x1/s1.x2/s1.x4/s1.x8/p1.x1/p1.x2/p1.x4/p1.x8/p2.x1/p2.x2/p2.x4/p2.x8) # The pod type, metadata_config: map{indexed: [str]} # Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed., source_collection: str(CollectionName) # The unique name of a collection.}\n@returns(201) The collection has been successfully created.\n@errors {400: Quota exceeded, or invalid parameters., 409: Index of given name already exists., 500: Internal error. Can be caused by invalid parameters.}\n\n@endpoint GET /databases/{indexName}\n@desc Describe index\n@returns(200) {database: map{name: str(IndexName), metric: str, dimension: int(int32), replicas: int(int32), shards: int(int32), pods: int(int32), pod_type: str}, status: map{host: str(Hostname), port: int(int32), state: str(IndexState), ready: bool}} # This operation returns a list of all the collections in your current project.\n@errors {404: Index not found., 500: Internal error. Can be caused by invalid parameters.}\n\n@endpoint DELETE /databases/{indexName}\n@desc Delete Index\n@returns(202) The index has been successfully deleted.\n@errors {404: Index not found., 500: Internal error. Can be caused by invalid parameters.}\n\n@endpoint PATCH /databases/{indexName}\n@desc Configure index\n@optional {replicas: int(int32)=1 # The desired number of replicas for the index., pod_type: str(s1.x1/s1.x2/s1.x4/s1.x8/p1.x1/p1.x2/p1.x4/p1.x8/p2.x1/p2.x2/p2.x4/p2.x8) # The pod type}\n@returns(201) The index has been successfully updated.\n@errors {400: Quota exceeded, or invalid parameters., 404: Index not found., 500: Internal error. Can be caused by invalid parameters.}\n\n@endgroup\n\n@group describe_index_stats\n@endpoint POST /describe_index_stats\n@desc Describe Index Stats\n@optional {filter: map # If this parameter is present, the operation only affects vectors that satisfy the filter. See https://www.pinecone.io/docs/metadata-filtering/.}\n@returns(200) {namespaces: map, dimension: int(int32), indexFullness: num(float), totalVectorCount: int(int64)} # A successful response\n\n@endgroup\n\n@group query\n@endpoint POST /query\n@desc Query\n@required {topK: int(int64)=100 # The number of results to return for each query.}\n@optional {namespace: str(NamespaceName) # An index namespace name, filter: map # If this parameter is present, the operation only affects vectors that satisfy the filter. See https://www.pinecone.io/docs/metadata-filtering/., includeValues: bool=false, includeMetadata: bool=false, vector: [num(float)] # Vector dense data. This should be the same length as the dimension of the index being queried., sparseVector: map{indices!: [int(int64)], values!: [num(float)]} # Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be the same length., id: str(VectorId) # The unique ID of a vector}\n@returns(200) {matches: [map], namespace: str(NamespaceName)} # A successful response\n\n@endgroup\n\n@group vectors\n@endpoint POST /vectors/delete\n@desc Delete\n@optional {ids: [str(VectorId)], deleteAll: bool=false, namespace: str(NamespaceName) # An index namespace name, filter: map # If this parameter is present, the operation only affects vectors that satisfy the filter. See https://www.pinecone.io/docs/metadata-filtering/.}\n@returns(200) A successful response\n\n@endpoint POST /vectors/fetch\n@desc Fetch\n@required {ids: [str(VectorId)]}\n@optional {namespace: str(NamespaceName) # An index namespace name}\n@returns(200) {vectors: map, namespace: str(NamespaceName)} # A successful response\n\n@endpoint POST /vectors/update\n@desc Fetch\n@required {id: str(VectorId) # The vector's unique ID}\n@optional {values: [num(float)] # Vector dense data. This should be the same length as the dimension of the index being queried., sparseValues: map{indices!: [int(int64)], values!: [num(float)]} # Vector sparse data. Represented as a list of indices and a list of corresponded values, which must be the same length., setMetadata: map, namespace: str(NamespaceName) # An index namespace name}\n@returns(200) A successful response\n\n@endpoint POST /vectors/upsert\n@desc Upsert\n@required {vectors: [map{id: str(VectorId), values: [num(float)], sparseValues: map, metadata: map}]}\n@optional {namespace: str(NamespaceName) # An index namespace name}\n@returns(200) {upsertedCount: int(int64)} # A successful response\n\n@endgroup\n\n@end\n"}