centaur-client 0.0.10

Centaur Client Python Sdk Library

Centaur Client Python Library

Centaur provides fully-managed, serverless, scalable vector-database service for building various machine learning applications. The Centaur client SDK is your gateway to access the Centaur service.

Installation

To install the Centaur client Python SDK, simply run:

pip install centaur-client

QuickStart

You can use Client api to communicate with Centaur service.

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")

Sample Code

Create a Collection

Client host various Collection APIs for interacting with Centaur service.

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
client.create("YOUR-COLLECTION-NAME", dimension=4)

List Collections

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
rsp = client.list()
if rsp:
    collection_list = rsp.output
    print("collection_list:", collection_list)

Describe Collection

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
rsp = client.describe("YOUR-COLLECTION-NAME")
if rsp:
    collection_meta = rsp.output
    print("collection_meta:", collection_meta)

Delete Collection

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
client.delete("YOUR-COLLECTION-NAME")

Get a Collection Instance

Collection provides APIs for accessing Doc and Partition

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
if collection:
    print("collection:", collection)

Describe Collection Statistics

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
rsp = collection.stats()
if rsp:
    collection_stats = rsp.output
    print("collection_stats:", collection_stats)

Insert/Update/Upsert Docs

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
collection.upsert(("YOUR-DOC-ID", [0.1, 0.2], {'price': 100, 'type': "dress"}))

Query a Collection

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
rsp = collection.query([0.1, 0.2], 
                       topk=100, 
                       output_fields=["price"], 
                       include_vector=True)
if rsp:
    doc_list = rsp.output
    print("doc_list:", doc_list)

Delete Docs

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
collection.delete("YOUR-DOC-ID")

Fetch Docs

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
rsp = collection.fetch("YOUR-DOC-ID")
if rsp:
    doc_dict = rsp.output
    print("doc_dict:", doc_dict)

Create a Collection Partition

import centaur

client = centaur.Client(api_key="YOUR-CENTAUR-API-KEY")
collection = client.get("YOUR-COLLECTION-NAME")
collection.create_partition("YOUR-PARTITION-NAME")

Centaur Response

from centaur import CentaurCode

@dataclasses
class CentaurResponse(object):
    code: CentaurCode
    message: str
    request_id: str
    output: Any

License

This project is licensed under the Apache License (Version 2.0).