qanswer-sdk 0.1.0.dev0__py3-none-any.whl

qanswer_sdk/models/x_wiki_add_request.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.x_wiki_download_by_ids import XWikiDownloadByIds
+from typing import Optional, Set
+from typing_extensions import Self
+
+class XWikiAddRequest(BaseModel):
+    """
+    XWikiAddRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    ids: Optional[XWikiDownloadByIds] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "ids"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of XWikiAddRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of ids
+        if self.ids:
+            _dict['ids'] = self.ids.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of XWikiAddRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "connector_id": obj.get("connector_id"),
+            "ids": XWikiDownloadByIds.from_dict(obj["ids"]) if obj.get("ids") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/x_wiki_download_by_ids.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class XWikiDownloadByIds(BaseModel):
+    """
+    XWikiDownloadByIds
+    """ # noqa: E501
+    spaces: Optional[List[StrictStr]] = Field(default=None, description="XWiki space ids selected as whole-space picks. Each id implies the space and every descendant space's pages.")
+    files: Optional[List[StrictStr]] = Field(default=None, description="XWiki page ids selected individually (not via a parent space).")
+    __properties: ClassVar[List[str]] = ["spaces", "files"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of XWikiDownloadByIds from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of XWikiDownloadByIds from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "spaces": obj.get("spaces"),
+            "files": obj.get("files")
+        })
+        return _obj
+
+

qanswer_sdk/rest.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from qanswer_sdk.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

qanswer_sdk-0.1.0.dev0.dist-info/METADATA

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: qanswer_sdk
+Version: 0.1.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.1.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