Skip to main content

QAnswer: Api Documentation

Project description

QAnswer Python SDK

PyPI version Python Versions License: MIT

Official Python SDK for the QAnswer API, automatically generated from the OpenAPI specification.

This SDK allows Python applications to interact with QAnswer's services programmatically without needing to craft raw HTTP requests.


🚀 Features

  • Full coverage of QAnswer API endpoints
  • Type-safe models via Pydantic
  • Easy configuration of authentication and base URL
  • Auto-generated and versioned with each API release

📦 Installation

You can install from PyPI:

pip install qanswer-sdk

Or add it to your requirements.txt

qanswer-sdk==3.1184.0

🔑 Authentication

Most endpoints require authentication. You can set your API key like this:

from qanswer_sdk import Configuration, ApiClient
from qanswer_sdk.apis import DefaultApi

# Configure API key authorization
config = Configuration(
    host="https://api.qanswer.eu",
    api_key={"Authorization": "Bearer <YOUR_TOKEN>"}
)

# Initialize client
with ApiClient(config) as client:
    api = DefaultApi(client)
    response = api.health_check()
    print(response)

📖 Usage Examples

Call an endpoint

from qanswer_sdk import Configuration, ApiClient
from qanswer_sdk.apis import DefaultApi

config = Configuration(host="https://api.qanswer.eu")

with ApiClient(config) as client:
    api = DefaultApi(client)
    result = api.ask_question(question="What is ISO 27001?")
    print(result)

Handle responses

print(result.answer)      # direct answer
print(result.confidence)  # model confidence

⚙️ Configuration

config = Configuration(
    host="https://api.qanswer.eu",
    api_key={"Authorization": "Bearer <YOUR_TOKEN>"},
    timeout=30
)

📌 Versioning

This SDK follows the version of the QAnswer API. The current version is: 3.1209.0 (branch: main)

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

qanswer_sdk-3.1209.0.tar.gz (199.8 kB view details)

Uploaded Source

Built Distribution

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

qanswer_sdk-3.1209.0-py3-none-any.whl (612.4 kB view details)

Uploaded Python 3

File details

Details for the file qanswer_sdk-3.1209.0.tar.gz.

File metadata

  • Download URL: qanswer_sdk-3.1209.0.tar.gz
  • Upload date:
  • Size: 199.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.0-64-generic

File hashes

Hashes for qanswer_sdk-3.1209.0.tar.gz
Algorithm Hash digest
SHA256 0a92474bb073f8558f16370760fdd019e02b1b464d5e87d504617a88cab881c6
MD5 b7763ab332de7d0010110ea47eeb342e
BLAKE2b-256 20ac69ddc099ce4d17de4973480d7d70b45aa4216e39e52f65193af4592fe0a6

See more details on using hashes here.

File details

Details for the file qanswer_sdk-3.1209.0-py3-none-any.whl.

File metadata

  • Download URL: qanswer_sdk-3.1209.0-py3-none-any.whl
  • Upload date:
  • Size: 612.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.0-64-generic

File hashes

Hashes for qanswer_sdk-3.1209.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30efc6dae257f3b89ef078b1a765e599221e027cd50c0f41ef2b3d40bd614ee2
MD5 37968973590bc06a21f62908223b26fc
BLAKE2b-256 4f36b080d843a131cdc324b7d0286cb134efae931a7e684b09e225947444a42d

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