qanswer_sdk 3.1208.0__tar.gz → 3.1210.0__tar.gz

qanswer_sdk-3.1210.0/PKG-INFO

@@ -0,0 +1,266 @@
+Metadata-Version: 2.1
+Name: qanswer_sdk
+Version: 3.1210.0
+Summary: QAnswer: Api Documentation
+Home-page: https://github.com/GIT_USER_ID/GIT_REPO_ID
+License: NoLicense
+Keywords: OpenAPI,OpenAPI-Generator,QAnswer: Api Documentation
+Author: OpenAPI Generator Community
+Author-email: team@openapitools.org
+Requires-Python: >=3.8,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pydantic (>=2)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: typing-extensions (>=4.7.1)
+Requires-Dist: urllib3 (>=1.25.3,<3.0.0)
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Description-Content-Type: text/markdown
+
+# 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://api.qanswer.eu",
+    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://api.qanswer.eu",
+    access_token="your-jwt-token-here"
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+### Basic Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure Basic authorization
+config = Configuration(
+    host="https://api.qanswer.eu",
+    username="your-username",
+    password="your-password"
+)
+
+# 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://api.qanswer.eu",
+    api_key={"QAnswer-Api-Key": "your-api-key"}
+)
+
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    
+    # Create chat payload
+    payload = ChatbotChatPayload(
+        message="What is artificial intelligence?",
+        # Add other required fields based on your model
+    )
+    
+    # Send chat message
+    response = api.free_text_chatbot_chat(payload)
+    print(response.answer)  # 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://api.qanswer.eu",  # 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: `3.1210.0 (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-3.1210.0/README.md

@@ -0,0 +1,242 @@
+# 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://api.qanswer.eu",
+    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://api.qanswer.eu",
+    access_token="your-jwt-token-here"
+)
+
+# Initialize client
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    # Use the API...
+```
+
+### Basic Authentication
+
+```python
+from qanswer_sdk import Configuration, ApiClient
+from qanswer_sdk.api.chatbot_api import ChatbotApi
+
+# Configure Basic authorization
+config = Configuration(
+    host="https://api.qanswer.eu",
+    username="your-username",
+    password="your-password"
+)
+
+# 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://api.qanswer.eu",
+    api_key={"QAnswer-Api-Key": "your-api-key"}
+)
+
+with ApiClient(config) as client:
+    api = ChatbotApi(client)
+    
+    # Create chat payload
+    payload = ChatbotChatPayload(
+        message="What is artificial intelligence?",
+        # Add other required fields based on your model
+    )
+    
+    # Send chat message
+    response = api.free_text_chatbot_chat(payload)
+    print(response.answer)  # 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://api.qanswer.eu",  # 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: `3.1210.0 (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-3.1208.0 → qanswer_sdk-3.1210.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qanswer_sdk"
-version = "3.1208.0"
+version = "3.1210.0"
 description = "QAnswer: Api Documentation"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.1208.0"
+__version__ = "3.1210.0"
 
 # import apis into sdk package
 from qanswer_sdk.api.admin_api import AdminApi

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/3.1208.0/python'
+        self.user_agent = 'OpenAPI-Generator/3.1210.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/configuration.py

@@ -421,7 +421,7 @@ conf = qanswer_sdk.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0\n"\
-               "SDK Package Version: 3.1208.0".\
+               "SDK Package Version: 3.1210.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/models/document_metadata.py

@@ -37,7 +37,8 @@ class DocumentMetadata(BaseModel):
     title: Optional[StrictStr] = None
     additional_fields: Optional[Dict[str, StrictStr]] = Field(default=None, alias="additionalFields")
     do_ocr: Optional[StrictBool] = Field(default=None, alias="doOCR")
-    __properties: ClassVar[List[str]] = ["fileName", "originalFileName", "fileExtension", "fileId", "connectorType", "connectorId", "source", "displayName", "title", "additionalFields", "doOCR"]
+    do_llm: Optional[StrictBool] = Field(default=None, alias="doLLM")
+    __properties: ClassVar[List[str]] = ["fileName", "originalFileName", "fileExtension", "fileId", "connectorType", "connectorId", "source", "displayName", "title", "additionalFields", "doOCR", "doLLM"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -100,7 +101,8 @@ class DocumentMetadata(BaseModel):
             "displayName": obj.get("displayName"),
             "title": obj.get("title"),
             "additionalFields": obj.get("additionalFields"),
-            "doOCR": obj.get("doOCR")
+            "doOCR": obj.get("doOCR"),
+            "doLLM": obj.get("doLLM")
         })
         return _obj
 

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/models/page_organization.py

@@ -29,18 +29,18 @@ class PageOrganization(BaseModel):
     """
     PageOrganization
     """ # noqa: E501
-    total_elements: Optional[StrictInt] = Field(default=None, alias="totalElements")
     total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages")
-    pageable: Optional[PageableObject] = None
+    total_elements: Optional[StrictInt] = Field(default=None, alias="totalElements")
     sort: Optional[SortObject] = None
+    pageable: Optional[PageableObject] = None
+    number_of_elements: Optional[StrictInt] = Field(default=None, alias="numberOfElements")
     first: Optional[StrictBool] = None
     last: Optional[StrictBool] = None
     size: Optional[StrictInt] = None
     content: Optional[List[Organization]] = None
     number: Optional[StrictInt] = None
-    number_of_elements: Optional[StrictInt] = Field(default=None, alias="numberOfElements")
     empty: Optional[StrictBool] = None
-    __properties: ClassVar[List[str]] = ["totalElements", "totalPages", "pageable", "sort", "first", "last", "size", "content", "number", "numberOfElements", "empty"]
+    __properties: ClassVar[List[str]] = ["totalPages", "totalElements", "sort", "pageable", "numberOfElements", "first", "last", "size", "content", "number", "empty"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,12 +81,12 @@ class PageOrganization(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of pageable
-        if self.pageable:
-            _dict['pageable'] = self.pageable.to_dict()
         # override the default output from pydantic by calling `to_dict()` of sort
         if self.sort:
             _dict['sort'] = self.sort.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pageable
+        if self.pageable:
+            _dict['pageable'] = self.pageable.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in content (list)
         _items = []
         if self.content:
@@ -106,16 +106,16 @@ class PageOrganization(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "totalElements": obj.get("totalElements"),
             "totalPages": obj.get("totalPages"),
-            "pageable": PageableObject.from_dict(obj["pageable"]) if obj.get("pageable") is not None else None,
+            "totalElements": obj.get("totalElements"),
             "sort": SortObject.from_dict(obj["sort"]) if obj.get("sort") is not None else None,
+            "pageable": PageableObject.from_dict(obj["pageable"]) if obj.get("pageable") is not None else None,
+            "numberOfElements": obj.get("numberOfElements"),
             "first": obj.get("first"),
             "last": obj.get("last"),
             "size": obj.get("size"),
             "content": [Organization.from_dict(_item) for _item in obj["content"]] if obj.get("content") is not None else None,
             "number": obj.get("number"),
-            "numberOfElements": obj.get("numberOfElements"),
             "empty": obj.get("empty")
         })
         return _obj

{qanswer_sdk-3.1208.0 → qanswer_sdk-3.1210.0}/qanswer_sdk/models/page_team_with_count.py

@@ -29,18 +29,18 @@ class PageTeamWithCount(BaseModel):
     """
     PageTeamWithCount
     """ # noqa: E501
-    total_elements: Optional[StrictInt] = Field(default=None, alias="totalElements")
     total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages")
-    pageable: Optional[PageableObject] = None
+    total_elements: Optional[StrictInt] = Field(default=None, alias="totalElements")
     sort: Optional[SortObject] = None
+    pageable: Optional[PageableObject] = None
+    number_of_elements: Optional[StrictInt] = Field(default=None, alias="numberOfElements")
     first: Optional[StrictBool] = None
     last: Optional[StrictBool] = None
     size: Optional[StrictInt] = None
     content: Optional[List[TeamWithCount]] = None
     number: Optional[StrictInt] = None
-    number_of_elements: Optional[StrictInt] = Field(default=None, alias="numberOfElements")
     empty: Optional[StrictBool] = None
-    __properties: ClassVar[List[str]] = ["totalElements", "totalPages", "pageable", "sort", "first", "last", "size", "content", "number", "numberOfElements", "empty"]
+    __properties: ClassVar[List[str]] = ["totalPages", "totalElements", "sort", "pageable", "numberOfElements", "first", "last", "size", "content", "number", "empty"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,12 +81,12 @@ class PageTeamWithCount(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of pageable
-        if self.pageable:
-            _dict['pageable'] = self.pageable.to_dict()
         # override the default output from pydantic by calling `to_dict()` of sort
         if self.sort:
             _dict['sort'] = self.sort.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pageable
+        if self.pageable:
+            _dict['pageable'] = self.pageable.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in content (list)
         _items = []
         if self.content:
@@ -106,16 +106,16 @@ class PageTeamWithCount(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "totalElements": obj.get("totalElements"),
             "totalPages": obj.get("totalPages"),
-            "pageable": PageableObject.from_dict(obj["pageable"]) if obj.get("pageable") is not None else None,
+            "totalElements": obj.get("totalElements"),
             "sort": SortObject.from_dict(obj["sort"]) if obj.get("sort") is not None else None,
+            "pageable": PageableObject.from_dict(obj["pageable"]) if obj.get("pageable") is not None else None,
+            "numberOfElements": obj.get("numberOfElements"),
             "first": obj.get("first"),
             "last": obj.get("last"),
             "size": obj.get("size"),
             "content": [TeamWithCount.from_dict(_item) for _item in obj["content"]] if obj.get("content") is not None else None,
             "number": obj.get("number"),
-            "numberOfElements": obj.get("numberOfElements"),
             "empty": obj.get("empty")
         })
         return _obj