vantage-sdk 0.7.0

Vantage Python SDK.

Vantage Discovery Python SDK

The Vantage Discovery Python SDK provides an easy-to-use interface to interact with the Vantage vector database, enabling developers to seamlessly integrate vector search and collection management capabilities into their Python applications.

Installation

To install the Vantage Python SDK, run the following command:

pip install vantage-sdk

Quickstart

To get started with the Vantage Python SDK, you'll need to set up your Vantage account and obtain your account ID and Vantage API key. Once you have your ID and key, you can initialize the VantageClient which you can then use to manage your account, collections and keys and perform searches.

from vantage_sdk import VantageClient

# Initialize the VantageClient with your Vantage API key and Account ID
vantage_client = VantageClient.using_vantage_api_key(
    vantage_api_key='YOUR_VANTAGE_API_KEY',
    account_id='YOUR_ACCOUNT_ID'
)

# Now you can use the client to manage collections, documents, and perform searches

Overview

The Vantage Discovery Python SDK is divided into several modules, allowing you to manage account, collections, and API keys, as well as perform various types of searches.

Key Features

• Collection Management: Easily create, update, list, and delete collections.
• Documents Upload: Upload your data easily to your collections.
• Search: Perform semantic, embedding and "more like this/these" searches within your collections.
• LLM Keys Management: Keep your LLM provider secrets safe and up-to-date.

Examples

Creating a Collection

collection = vantage_client.create_collection(
    collection_id="my_collection",
    collection_name="My Test Collection",
    embeddings_dimension=1536,
    llm="text-embedding-ada-002",
    external_key_id="YOUR_EXTERNAL_KEY_ID" # Get from Vantage Console UI or using the SDK
)
print(f"Created collection: {collection.name}")

Uploading Documents

documents_jsonl = '{"id": "1", "text": "Example text"}\\n{"id": "2", "text": "Another example"}'
vantage_client.upload_documents_from_jsonl(
    collection_id="my_collection",
    documents=documents_jsonl
)

Performing a Search

search_result = vantage_client.semantic_search(
    text="Find documents similar to this text",
    collection_id="my_collection"
)
for result in search_result.results:
    print(result.id, result.score)

Documentation

For detailed documentation on all methods and their parameters, please refer to the Vantage Discovery official documentation.