Skip to main content

Official Python SDK for building integrations with Krira Augment RAG pipelines

Project description

Krira Augment SDK

Official Python SDK for building integrations with Krira Augment RAG pipelines.

Installation

pip install krira-augment-sdk

Quick Start

from krira_augment import KriraAugment

# Initialize the client with your API key and pipeline name
client = KriraAugment(api_key="sk-live-your-key", pipeline_name="employees")

# Ask a question to your RAG pipeline
response = client.ask("What can you help me with?")
print(response.answer)

# With conversation context
response = client.ask(
    "Tell me more about that",
    conversation_id="my-session-123"
)
print(response.answer)

API Reference

KriraAugment

The main client class for interacting with Krira Augment pipelines.

Constructor

KriraAugment(
    *,
    api_key: str,           # Your Krira Augment API key
    pipeline_name: str,     # Name or ID of your RAG pipeline
    base_url: str = None,   # Optional custom API base URL
    timeout: float = 15.0,  # Request timeout in seconds
)

Methods

ask(question, *, conversation_id=None, metadata=None, timeout=None)

Send a question to your RAG pipeline and receive an answer.

Parameters:

  • question (str): The question to ask
  • conversation_id (str, optional): Session ID for conversation context
  • metadata (dict, optional): Additional metadata to pass
  • timeout (float, optional): Override the default timeout

Returns: ChatResponse object with:

  • answer (str): The model's response
  • pipeline_name (str): The pipeline used
  • conversation_id (str, optional): The conversation ID
  • raw (dict): Raw API response
close()

Close the underlying HTTP session.

Error Handling

from krira_augment import KriraAugment
from krira_augment.exceptions import (
    AuthenticationError,
    PermissionDeniedError,
    RateLimitError,
    ServerError,
)

client = KriraAugment(api_key="sk-live-your-key", pipeline_name="employees")

try:
    response = client.ask("What is the status of my order?")
    print(response.answer)
except AuthenticationError:
    print("Invalid API key")
except PermissionDeniedError:
    print("API key doesn't have access to this pipeline")
except RateLimitError:
    print("Too many requests, slow down")
except ServerError:
    print("Krira Augment service is temporarily unavailable")

Aliases

For convenience, additional class aliases are available:

from krira_augment import KriraPipeline, KriraAugmentClient

# These are equivalent to KriraAugment
client = KriraPipeline(api_key="...", pipeline_name="...")
client = KriraAugmentClient(api_key="...", pipeline_name="...")

Requirements

  • Python 3.9+
  • requests >= 2.31.0

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

krira_augment_sdk-1.0.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

krira_augment_sdk-1.0.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file krira_augment_sdk-1.0.1.tar.gz.

File metadata

  • Download URL: krira_augment_sdk-1.0.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for krira_augment_sdk-1.0.1.tar.gz
Algorithm Hash digest
SHA256 095c43a8252128c751ee2110e3555a5142b2708d5622b015d85cfa61faa0e7fd
MD5 ddc6cac10f0de0d0068111a835efa2cb
BLAKE2b-256 721cf966c8d029306ef393b388adbadbe86613e456736b1e6366475b96b719aa

See more details on using hashes here.

File details

Details for the file krira_augment_sdk-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for krira_augment_sdk-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f938753fad0e71ba1ee602956328da3f72f85c5fb0d78f39370dfd9374c16f7
MD5 aaa8b81506fabc52162a678be595422b
BLAKE2b-256 ab68946a11848fd55b5b2aad3cc651decb5227b8b015578a0d335f671e7f53ba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page