qanswer-sdk 0.53.0.dev0__tar.gz → 0.224.0.dev0__tar.gz

qanswer_sdk-0.224.0.dev0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: qanswer_sdk
+Version: 0.224.0.dev0
+Summary: Official Python SDK for the QAnswer API
+Home-page: 
+Author: The QA Company
+Author-email: team@openapitools.org
+License: MIT
+Project-URL: Homepage, https://qanswer.eu
+Project-URL: Repository, https://gitlab.the-qa-company.com/qanswer-app/qanswer-freetext.git
+Project-URL: Issues, https://gitlab.the-qa-company.com/qanswer-app/qanswer-freetext/-/issues
+Keywords: OpenAPI,OpenAPI-Generator,free-text-client
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author-email
+
+# QAnswer Python SDK
+
+[![PyPI version](https://badge.fury.io/py/qanswer-sdk.svg)](https://pypi.org/project/qanswer-sdk/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/qanswer-sdk.svg)](https://pypi.org/project/qanswer-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Official **Python SDK** for the [QAnswer API](https://qanswer.eu), 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](https://docs.pydantic.dev)  
+- Easy configuration of authentication and base URL  
+- Auto-generated and versioned with each API release  
+
+---
+
+## 📦 Installation
+
+You can install from [PyPI](https://pypi.org/project/qanswer-sdk/):
+
+```bash
+pip install qanswer-sdk
+```
+
+
+Or add it to your `requirements.txt`
+
+```txt
+qanswer-sdk==3.1184.0
+```
+
+---
+
+## 🔑 Authentication
+
+Most endpoints require authentication. You can configure authentication in several ways:
+
+### API Key Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure API key authorization
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    api_key={"QAnswer-Api-Key": "your-api-key-here"}
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+### Bearer Token Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure Bearer token authorization
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    access_token="your-jwt-token-here"
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+---
+
+## 📖 Usage Examples
+
+### Chatbot API
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+from qanswer_sdk.models.chatbot_chat_payload import ChatbotChatPayload
+
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    api_key={"QAnswer-Api-Key": "your-api-key"}
+)
+
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    
+    # Create chat payload
+    payload = ChatbotChatPayload(
+        question="What is artificial intelligence?",
+        username="admin",
+        conversation_id="df150332-97c2-4b6a-9d83-cd35e14cf89c",
+        llm_choice="openai-large"
+        # Add other required fields based on your model
+    )
+    
+    # Send chat message
+    response = api.free_text_chatbot_chat(payload)
+    print(response.ai_response)  # Access response data
+```
+
+### Chat Completion API
+
+```python
+from qanswer_sdk.api.chat_completion_api import ChatCompletionApi
+
+with ApiClient(config) as client:
+    api = ChatCompletionApi(client)
+    # Use chat completion endpoints...
+```
+
+### Handle Different Response Types
+
+```python
+# Get just the data
+response_data = api.free_text_chatbot_chat(payload)
+
+# Get full HTTP response info
+full_response = api.free_text_chatbot_chat_with_http_info(payload)
+print(full_response.status_code)
+print(full_response.headers)
+print(full_response.data)
+
+# Get raw HTTP response for streaming
+raw_response = api.free_text_chatbot_chat_without_preload_content(payload)
+```
+
+---
+
+## ⚙️ Configuration Options
+
+```python
+from qanswer_sdk import Configuration
+
+config = Configuration(
+    host="https://app.qanswer.ai/backend",  # API base URL
+    api_key={"QAnswer-Api-Key": "your-key"},  # API key auth
+    access_token="jwt-token",  # Bearer token auth
+    username="user",  # Basic auth username
+    password="pass",  # Basic auth password
+    verify_ssl=True,  # SSL verification
+    ssl_ca_cert="/path/to/ca.pem",  # Custom CA certificate
+    connection_pool_maxsize=10,  # Connection pool size
+    retries=3,  # Number of retries
+    debug=False,  # Enable debug logging
+    proxy="http://proxy:8080"  # Proxy URL
+)
+```
+---
+
+## 🛠 Error Handling
+
+```python
+from qanswer_sdk.exceptions import (
+    ApiException, 
+    BadRequestException,
+    UnauthorizedException,
+    NotFoundException
+)
+
+try:
+    response = api.free_text_chatbot_chat(payload)
+except UnauthorizedException:
+    print("Invalid authentication credentials")
+except BadRequestException as e:
+    print(f"Bad request: {e}")
+except ApiException as e:
+    print(f"API error: {e.status} - {e.reason}")
+```
+---
+
+## 📝 Models and Type Safety
+
+All request and response objects are Pydantic models with full type safety:
+
+```python
+from qanswer_sdk.models.chatbot_chat_payload import ChatbotChatPayload
+from qanswer_sdk.models.chatbot_response import ChatbotResponse
+
+# Create typed request payload
+payload = ChatbotChatPayload(
+    message="Hello",
+    # IDE will provide autocomplete for available fields
+)
+
+# Response is fully typed
+response: ChatbotResponse = api.free_text_chatbot_chat(payload)
+# Access typed response fields with autocomplete
+print(response.answer)
+```
+
+---
+
+## 📌 Versioning
+
+This SDK follows the version of the QAnswer API.
+The current version is: `0.224.0.dev0 (branch: main)`
+
+---
+
+## 🤝 Support
+
+For issues related to:
+
+- **SDK usage:** Open an issue in this repository
+- **API functionality:** Contact QAnswer support
+- **Authentication:** Check your API key and permissions
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+---
+
+## Made with ❤️ by The QA Company

qanswer_sdk-0.224.0.dev0/README.md

@@ -0,0 +1,227 @@
+# QAnswer Python SDK
+
+[![PyPI version](https://badge.fury.io/py/qanswer-sdk.svg)](https://pypi.org/project/qanswer-sdk/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/qanswer-sdk.svg)](https://pypi.org/project/qanswer-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Official **Python SDK** for the [QAnswer API](https://qanswer.eu), 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](https://docs.pydantic.dev)  
+- Easy configuration of authentication and base URL  
+- Auto-generated and versioned with each API release  
+
+---
+
+## 📦 Installation
+
+You can install from [PyPI](https://pypi.org/project/qanswer-sdk/):
+
+```bash
+pip install qanswer-sdk
+```
+
+
+Or add it to your `requirements.txt`
+
+```txt
+qanswer-sdk==3.1184.0
+```
+
+---
+
+## 🔑 Authentication
+
+Most endpoints require authentication. You can configure authentication in several ways:
+
+### API Key Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure API key authorization
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    api_key={"QAnswer-Api-Key": "your-api-key-here"}
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+### Bearer Token Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure Bearer token authorization
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    access_token="your-jwt-token-here"
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+---
+
+## 📖 Usage Examples
+
+### Chatbot API
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+from qanswer_sdk.models.chatbot_chat_payload import ChatbotChatPayload
+
+config = Configuration(
+    host="https://app.qanswer.ai/backend",
+    api_key={"QAnswer-Api-Key": "your-api-key"}
+)
+
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    
+    # Create chat payload
+    payload = ChatbotChatPayload(
+        question="What is artificial intelligence?",
+        username="admin",
+        conversation_id="df150332-97c2-4b6a-9d83-cd35e14cf89c",
+        llm_choice="openai-large"
+        # Add other required fields based on your model
+    )
+    
+    # Send chat message
+    response = api.free_text_chatbot_chat(payload)
+    print(response.ai_response)  # Access response data
+```
+
+### Chat Completion API
+
+```python
+from qanswer_sdk.api.chat_completion_api import ChatCompletionApi
+
+with ApiClient(config) as client:
+    api = ChatCompletionApi(client)
+    # Use chat completion endpoints...
+```
+
+### Handle Different Response Types
+
+```python
+# Get just the data
+response_data = api.free_text_chatbot_chat(payload)
+
+# Get full HTTP response info
+full_response = api.free_text_chatbot_chat_with_http_info(payload)
+print(full_response.status_code)
+print(full_response.headers)
+print(full_response.data)
+
+# Get raw HTTP response for streaming
+raw_response = api.free_text_chatbot_chat_without_preload_content(payload)
+```
+
+---
+
+## ⚙️ Configuration Options
+
+```python
+from qanswer_sdk import Configuration
+
+config = Configuration(
+    host="https://app.qanswer.ai/backend",  # API base URL
+    api_key={"QAnswer-Api-Key": "your-key"},  # API key auth
+    access_token="jwt-token",  # Bearer token auth
+    username="user",  # Basic auth username
+    password="pass",  # Basic auth password
+    verify_ssl=True,  # SSL verification
+    ssl_ca_cert="/path/to/ca.pem",  # Custom CA certificate
+    connection_pool_maxsize=10,  # Connection pool size
+    retries=3,  # Number of retries
+    debug=False,  # Enable debug logging
+    proxy="http://proxy:8080"  # Proxy URL
+)
+```
+---
+
+## 🛠 Error Handling
+
+```python
+from qanswer_sdk.exceptions import (
+    ApiException, 
+    BadRequestException,
+    UnauthorizedException,
+    NotFoundException
+)
+
+try:
+    response = api.free_text_chatbot_chat(payload)
+except UnauthorizedException:
+    print("Invalid authentication credentials")
+except BadRequestException as e:
+    print(f"Bad request: {e}")
+except ApiException as e:
+    print(f"API error: {e.status} - {e.reason}")
+```
+---
+
+## 📝 Models and Type Safety
+
+All request and response objects are Pydantic models with full type safety:
+
+```python
+from qanswer_sdk.models.chatbot_chat_payload import ChatbotChatPayload
+from qanswer_sdk.models.chatbot_response import ChatbotResponse
+
+# Create typed request payload
+payload = ChatbotChatPayload(
+    message="Hello",
+    # IDE will provide autocomplete for available fields
+)
+
+# Response is fully typed
+response: ChatbotResponse = api.free_text_chatbot_chat(payload)
+# Access typed response fields with autocomplete
+print(response.answer)
+```
+
+---
+
+## 📌 Versioning
+
+This SDK follows the version of the QAnswer API.
+The current version is: `0.224.0.dev0 (branch: main)`
+
+---
+
+## 🤝 Support
+
+For issues related to:
+
+- **SDK usage:** Open an issue in this repository
+- **API functionality:** Contact QAnswer support
+- **Authentication:** Check your API key and permissions
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+---
+
+## Made with ❤️ by The QA Company

qanswer_sdk-0.224.0.dev0/pyproject.toml

@@ -0,0 +1,103 @@
+[project]
+license = {text = "MIT"}
+name = "qanswer_sdk"
+version = "0.224.0.dev0"
+description = "Official Python SDK for the QAnswer API"
+authors = [{name = "The QA Company"}]
+readme = "README.md"
+keywords = ["OpenAPI", "OpenAPI-Generator", "free-text-client"]
+requires-python = ">=3.9"
+
+dependencies = [
+  "urllib3 (>=2.1.0,<3.0.0)",
+  "python-dateutil (>=2.8.2)",
+  "pydantic (>=2)",
+  "typing-extensions (>=4.7.1)",
+]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+]
+
+[project.urls]
+Homepage = "https://qanswer.eu"
+Repository = "https://gitlab.the-qa-company.com/qanswer-app/qanswer-freetext.git"
+Issues = "https://gitlab.the-qa-company.com/qanswer-app/qanswer-freetext/-/issues"
+
+[tool.poetry]
+requires-poetry = ">=2.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "qanswer_sdk",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "qanswer_sdk.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true