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

qanswer_sdk/models/websearch_connector_config.py

@@ -0,0 +1,102 @@
+# 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 WebsearchConnectorConfig(BaseModel):
+    """
+    WebsearchConnectorConfig
+    """ # noqa: E501
+    api_key: Optional[StrictStr] = None
+    additional_properties: Optional[Dict[str, Any]] = Field(default=None, alias="additionalProperties")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["api_key", "additionalProperties"]
+
+    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 WebsearchConnectorConfig 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebsearchConnectorConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "api_key": obj.get("api_key"),
+            "additionalProperties": obj.get("additionalProperties")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

qanswer_sdk/models/websearch_scraping_site.py

@@ -0,0 +1,91 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebsearchScrapingSite(BaseModel):
+    """
+    WebsearchScrapingSite
+    """ # noqa: E501
+    url: StrictStr
+    title: Optional[StrictStr] = None
+    favicon: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["url", "title", "favicon"]
+
+    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 WebsearchScrapingSite 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 WebsearchScrapingSite from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "title": obj.get("title"),
+            "favicon": obj.get("favicon")
+        })
+        return _obj
+
+

qanswer_sdk/models/website_add_payload.py

@@ -0,0 +1,102 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WebsiteAddPayload(BaseModel):
+    """
+    WebsiteAddPayload
+    """ # noqa: E501
+    username: Annotated[str, Field(min_length=1, strict=True)] = Field(description="username")
+    dataset: Annotated[str, Field(min_length=1, strict=True)] = Field(description="dataset")
+    connector_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="connector id")
+    links: Optional[List[StrictStr]] = Field(default=None, description="links to be indexed")
+    link_weights: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = Field(default=None, description="Weight of the links will be considered when searching")
+    quota: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=0, description="quota of the dataset")
+    external_sources_quota: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="quota of the external sources")
+    additional_fields: Optional[Dict[str, StrictStr]] = Field(default=None, description="Additional fields for the connector")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "links", "link_weights", "quota", "external_sources_quota", "additional_fields"]
+
+    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 WebsiteAddPayload 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 WebsiteAddPayload 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"),
+            "links": obj.get("links"),
+            "link_weights": obj.get("link_weights"),
+            "quota": obj.get("quota") if obj.get("quota") is not None else 0,
+            "external_sources_quota": obj.get("external_sources_quota") if obj.get("external_sources_quota") is not None else -1,
+            "additional_fields": obj.get("additional_fields")
+        })
+        return _obj
+
+

qanswer_sdk/models/website_connector_config.py

@@ -0,0 +1,102 @@
+# 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 WebsiteConnectorConfig(BaseModel):
+    """
+    WebsiteConnectorConfig
+    """ # noqa: E501
+    selenium_path: Optional[StrictStr] = None
+    additional_properties: Optional[Dict[str, Any]] = Field(default=None, alias="additionalProperties")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["selenium_path", "additionalProperties"]
+
+    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 WebsiteConnectorConfig 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WebsiteConnectorConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "selenium_path": obj.get("selenium_path"),
+            "additionalProperties": obj.get("additionalProperties")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

qanswer_sdk/models/website_connector_settings.py

@@ -0,0 +1,123 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from qanswer_sdk.models.iframe_strategy import IframeStrategy
+from qanswer_sdk.models.return_type import ReturnType
+from qanswer_sdk.models.scrolling_strategy import ScrollingStrategy
+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)] = Field(description="Username")
+    dataset: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Dataset")
+    explicit_sleep: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, description="Explicit Sleep for loading the website")
+    scrolling_strategy: Optional[ScrollingStrategy] = 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[ReturnType] = Field(default=None, description="Return type of the website txt or md")
+    skip_404: Optional[StrictBool] = Field(default=True, description="If the website responds with 404 should this be excluded for scraping ")
+    iframe_strategy: Optional[IframeStrategy] = Field(default=None, description="Should the iframes be actively searched or automatically processed?")
+    shadow_dom_strategy: Optional[IframeStrategy] = Field(default=None, description="Should the shadow doem be actively searched or automatically processed?")
+    cookies: Optional[Dict[str, StrictStr]] = Field(default=None, description="What are the cookies that should be used for extracting websites")
+    local_storage: Optional[Dict[str, StrictStr]] = 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=30000, 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=30000, description="What is the script timeout used for the webdriver")
+    implicit_timeout: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=0, 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"]
+
+    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") if obj.get("explicit_sleep") is not None else 0,
+            "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") if obj.get("skip_404") is not None else True,
+            "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") if obj.get("page_load_timeout") is not None else 30000,
+            "script_timeout": obj.get("script_timeout") if obj.get("script_timeout") is not None else 30000,
+            "implicit_timeout": obj.get("implicit_timeout") if obj.get("implicit_timeout") is not None else 0,
+            "custom_script": obj.get("custom_script")
+        })
+        return _obj
+
+

qanswer_sdk/models/widget_configs.py

@@ -0,0 +1,109 @@
+# 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, 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
+    title: 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
+    show_export_conversation: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["init_msg", "title", "theme", "open_default", "font", "colorPrimary", "colorSecondary", "align", "offsetX", "offsetY", "show_powered_by", "show_export_conversation"]
+
+    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"),
+            "title": obj.get("title"),
+            "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"),
+            "show_export_conversation": obj.get("show_export_conversation")
+        })
+        return _obj
+
+