qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/website_connector_settings.py

@@ -0,0 +1,160 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebsiteConnectorSettings(BaseModel):
+    """
+    WebsiteConnectorSettings
+    """ # noqa: E501
+    connector_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="Connector ID")
+    username: Annotated[str, Field(min_length=1, strict=True, max_length=2147483647)] = Field(description="Username")
+    dataset: Annotated[str, Field(min_length=1, strict=True, max_length=2147483647)] = Field(description="Dataset")
+    explicit_sleep: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="Explicit Sleep for loading the website")
+    scrolling_strategy: Optional[StrictStr] = Field(default=None, description="How the website should be scrolled for loading the contents")
+    css_include: Optional[StrictStr] = Field(default=None, description="What is the css query that should be used for including the elements")
+    css_exclude: Optional[StrictStr] = Field(default=None, description="What is the css query that should be used for exluding the elements")
+    return_type: Optional[StrictStr] = Field(default=None, description="Return type of the website txt or md")
+    skip_404: Optional[StrictBool] = Field(default=None, description="If the website responds with 404 should this be excluded for scraping ")
+    iframe_strategy: Optional[StrictStr] = Field(default=None, description="Should the iframes be actively searched or automatically processed?")
+    shadow_dom_strategy: Optional[StrictStr] = Field(default=None, description="Should the shadow doem be actively searched or automatically processed?")
+    cookies: Optional[Dict[str, Any]] = Field(default=None, description="What are the cookies that should be used for extracting websites")
+    local_storage: Optional[Dict[str, Any]] = Field(default=None, description="What are the local storage key values that should be used for extracting websties")
+    page_load_timeout: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="What is the page load timeout that is set for the webdriver")
+    script_timeout: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="What is the script timeout used for the webdriver")
+    implicit_timeout: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="What is the implicit timeout used for the webdeiver")
+    custom_script: Optional[StrictStr] = Field(default=None, description="The custom java script to be executed.")
+    __properties: ClassVar[List[str]] = ["connector_id", "username", "dataset", "explicit_sleep", "scrolling_strategy", "css_include", "css_exclude", "return_type", "skip_404", "iframe_strategy", "shadow_dom_strategy", "cookies", "local_storage", "page_load_timeout", "script_timeout", "implicit_timeout", "custom_script"]
+
+    @field_validator('scrolling_strategy')
+    def scrolling_strategy_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['full', 'step']):
+            raise ValueError("must be one of enum values ('full', 'step')")
+        return value
+
+    @field_validator('return_type')
+    def return_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['txt', 'md', 'html']):
+            raise ValueError("must be one of enum values ('txt', 'md', 'html')")
+        return value
+
+    @field_validator('iframe_strategy')
+    def iframe_strategy_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['auto', 'force', 'skip']):
+            raise ValueError("must be one of enum values ('auto', 'force', 'skip')")
+        return value
+
+    @field_validator('shadow_dom_strategy')
+    def shadow_dom_strategy_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['auto', 'force', 'skip']):
+            raise ValueError("must be one of enum values ('auto', 'force', 'skip')")
+        return value
+
+    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 WebsiteConnectorSettings 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 WebsiteConnectorSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connector_id": obj.get("connector_id"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "explicit_sleep": obj.get("explicit_sleep"),
+            "scrolling_strategy": obj.get("scrolling_strategy"),
+            "css_include": obj.get("css_include"),
+            "css_exclude": obj.get("css_exclude"),
+            "return_type": obj.get("return_type"),
+            "skip_404": obj.get("skip_404"),
+            "iframe_strategy": obj.get("iframe_strategy"),
+            "shadow_dom_strategy": obj.get("shadow_dom_strategy"),
+            "cookies": obj.get("cookies"),
+            "local_storage": obj.get("local_storage"),
+            "page_load_timeout": obj.get("page_load_timeout"),
+            "script_timeout": obj.get("script_timeout"),
+            "implicit_timeout": obj.get("implicit_timeout"),
+            "custom_script": obj.get("custom_script")
+        })
+        return _obj
+
+

qanswer_sdk/models/widget_configs.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WidgetConfigs(BaseModel):
+    """
+    WidgetConfigs
+    """ # noqa: E501
+    init_msg: Optional[StrictStr] = None
+    theme: Optional[StrictStr] = None
+    open_default: Optional[StrictBool] = None
+    font: Optional[StrictStr] = None
+    color_primary: Optional[StrictStr] = Field(default=None, alias="colorPrimary")
+    color_secondary: Optional[StrictStr] = Field(default=None, alias="colorSecondary")
+    align: Optional[StrictStr] = None
+    offset_x: Optional[StrictInt] = Field(default=None, alias="offsetX")
+    offset_y: Optional[StrictInt] = Field(default=None, alias="offsetY")
+    show_powered_by: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["init_msg", "theme", "open_default", "font", "colorPrimary", "colorSecondary", "align", "offsetX", "offsetY", "show_powered_by"]
+
+    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 WidgetConfigs 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 WidgetConfigs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "init_msg": obj.get("init_msg"),
+            "theme": obj.get("theme"),
+            "open_default": obj.get("open_default"),
+            "font": obj.get("font"),
+            "colorPrimary": obj.get("colorPrimary"),
+            "colorSecondary": obj.get("colorSecondary"),
+            "align": obj.get("align"),
+            "offsetX": obj.get("offsetX"),
+            "offsetY": obj.get("offsetY"),
+            "show_powered_by": obj.get("show_powered_by")
+        })
+        return _obj
+
+

qanswer_sdk/rest.py

@@ -0,0 +1,257 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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,
+        }
+        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-3.1193.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.1
+Name: qanswer_sdk
+Version: 3.1193.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 set your API key like this:
+```python
+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
+
+```python
+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
+
+```python
+print(result.answer)      # direct answer
+print(result.confidence)  # model confidence
+```
+
+---
+
+## ⚙️ Configuration
+
+```python
+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.1193.0 (branch: main)`