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.1205.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.1205.0.tar.gz (199.7 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.1205.0-py3-none-any.whl (612.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qanswer_sdk-3.1205.0.tar.gz
  • Upload date:
  • Size: 199.7 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.1205.0.tar.gz
Algorithm Hash digest
SHA256 baefd6bf4c7af798529fdf48382baa30844edd85971d32f494e506f8710c2211
MD5 7f8737fb9c17783f172102b040d2842a
BLAKE2b-256 34b39098167003707fd5dcf657767a7c3a4449d237d294024fc69a68822fe8a7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qanswer_sdk-3.1205.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.1205.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e28321eb73a0f01b920140b57ccce8482eeec8401ac252f3a1a1fd4ed5dd6a86
MD5 863e79521d8a74babf2beb0600c3dee9
BLAKE2b-256 41b9fbda28969a2b1add50f1c9b40f29e7c7de81bbc2282b831383a2b8e01037

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