Skip to main content

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

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.3.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.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: krira_augment_sdk-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 7fbb08864c7e6fcf620d782b09d44ec93a6a9d84d3b94c2e77fd9ab8e78a2ea3
MD5 3bfc366fbfa1410d10df10c21926aa36
BLAKE2b-256 1af9117158fae83c7abd9cd053209bf3d99f99a398e809635d66feea93a00e83

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for krira_augment_sdk-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2b78bd88c543d858d741642db47b328f58fc32f253add807d8be4b8ca18ea216
MD5 ac604ef0e1876f27c621dce1ca5ef7fc
BLAKE2b-256 38fde31273af238a295d728b4a96887cfea1687a74ce6238f6cf09a8a15d07a7

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Supported by

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