Skip to navigation
Get started

SDKs

Talqora Vector ships official Python and TypeScript SDKs generated from the same OpenAPI contract as the API Reference.

Install

pip install talqora

Authenticate

Both SDKs read TALQORA_API_KEY automatically. You can also pass the API key directly to the client.

import os
from talqora import TalqoraApi
client = TalqoraApi(
    talqora_api_key=os.environ["TALQORA_API_KEY"],
)

Query vectors

SDK methods are grouped by product resource. You do not need to know the HTTP path or generated OpenAPI operation ID.

dense = client.vectors.query(
    INDEX_ID,
    search_type="dense",
    vector=query_vector,
    top_k=5,
)
sparse = client.vectors.query(
    INDEX_ID,
    search_type="sparse",
    sparse_query="hybrid search",
    top_k=5,
)
hybrid = client.vectors.query(
    INDEX_ID,
    search_type="hybrid",
    vector=query_vector,
    sparse_query="enterprise documents",
    top_k=5,
)

The same resource-oriented convention applies throughout the SDK: client.indexes.create(...), client.vectors.upsert(...), client.files.create_upload(...) in Python, and the corresponding camel-cased methods in TypeScript.

What is included

  • Organization onboarding, members, plans, API keys, and usage.
  • Regional indexes with immutable dimensions and distance metrics.
  • Dense vector writes, deletes, metadata filters, and queries.
  • Sparse BM25 and hybrid retrieval through the same API surface.
  • Asynchronous file-processing jobs for extraction, OCR, chunking, and embeddings.
  • Connector sync jobs, branches, assistants, and webhooks where enabled.

Versioning and support

The SDKs are generated from the versioned OpenAPI definition. Pin the package version in production and use the API Reference for endpoint-level request and response details.