Skip to main content

Ziqara Python SDK - Enterprise AI with company knowledge

Project description

Ziqara Python SDK

Enterprise AI with company knowledge. Query your uploaded documents via a simple Python SDK.

Installation

pip install ziqara

Quick Start

  1. Get an API key at ziqara.com/dashboard/api
  2. Install and use:
from ziqara import Ziqara

client = Ziqara(api_key="sk-ziq-xxx")

response = client.chat.completions.create(
    model="ziqx",
    messages=[{"role": "user", "content": "Summarize the Airtel agreement"}]
)

print(response.choices[0].message.content)
# Or use the convenience property:
print(response.content)

API Reference

Ziqara(api_key, base_url?)

  • api_key (required): Your Ziqara API key. Starts with sk-ziq-.
  • base_url (optional): API base URL. Default: https://ziqara.com. For local dev: http://localhost:8000

client.chat.completions.create(model?, messages, stream?)

  • model (optional): Model name. Default: ziqx (Ziqara's RAG-powered model)
  • messages (required): List of {"role": "user"|"assistant"|"system", "content": "..."}
  • stream (optional): Not yet supported. Default: false

Returns an OpenAI-compatible response with:

  • response.choices[0].message.content - the assistant's reply
  • response.content - shortcut for the above

Requirements

  • Python 3.8+
  • requests

Publishing to PyPI

pip install build twine
python -m build
twine upload dist/*

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

ziqara-0.1.1.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

ziqara-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file ziqara-0.1.1.tar.gz.

File metadata

  • Download URL: ziqara-0.1.1.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ziqara-0.1.1.tar.gz
Algorithm Hash digest
SHA256 77c45482dad28a3a21646220ae7a24249723e93cb43249d3d2005be440e8ccb1
MD5 d2eaa6179d23f3d927225ca6d5dafe15
BLAKE2b-256 34f6bcf9aac68d23ae3bc84246b89bf24ed38ab6e053b778850450401805c4d4

See more details on using hashes here.

File details

Details for the file ziqara-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ziqara-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ziqara-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2fbad85dcc96cf1e0ef121867434ab2aabce42adf8f37438f27eaf56509d0a90
MD5 5e1aba6e8950ef772620749adc478f38
BLAKE2b-256 43576e737033462b8cac75d9b865e19efc290f15ca0125a61301fe1c19b1df18

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