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

qanswer_sdk/models/publication_office_additional_fields.py

@@ -0,0 +1,111 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PublicationOfficeAdditionalFields(BaseModel):
+    """
+    This is the additional fields for the publication office connector, this is the additional fields that are sent to the connector.
+    """ # noqa: E501
+    file_id: StrictStr
+    collections: List[StrictStr]
+    thumbnail_url: StrictStr
+    modified_at: StrictStr
+    created_at: StrictStr
+    work_date: StrictStr
+    languages: List[StrictStr]
+    titles: List[Dict[str, StrictStr]]
+    descriptions: List[Dict[str, StrictStr]]
+    subjects: List[Dict[str, StrictStr]]
+    formats: List[StrictStr]
+    domains: List[StrictStr]
+    download_url: StrictStr
+    __properties: ClassVar[List[str]] = ["file_id", "collections", "thumbnail_url", "modified_at", "created_at", "work_date", "languages", "titles", "descriptions", "subjects", "formats", "domains", "download_url"]
+
+    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 PublicationOfficeAdditionalFields 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 PublicationOfficeAdditionalFields from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "collections": obj.get("collections"),
+            "thumbnail_url": obj.get("thumbnail_url"),
+            "modified_at": obj.get("modified_at"),
+            "created_at": obj.get("created_at"),
+            "work_date": obj.get("work_date"),
+            "languages": obj.get("languages"),
+            "titles": obj.get("titles"),
+            "descriptions": obj.get("descriptions"),
+            "subjects": obj.get("subjects"),
+            "formats": obj.get("formats"),
+            "domains": obj.get("domains"),
+            "download_url": obj.get("download_url")
+        })
+        return _obj
+
+

qanswer_sdk/models/publication_office_connector_config.py

@@ -0,0 +1,110 @@
+# 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 PublicationOfficeConnectorConfig(BaseModel):
+    """
+    PublicationOfficeConnectorConfig
+    """ # noqa: E501
+    domain: Optional[StrictStr] = None
+    search_path: Optional[StrictStr] = None
+    facets_path: Optional[StrictStr] = None
+    download_path: Optional[StrictStr] = None
+    auth_key: Optional[StrictStr] = None
+    additional_properties: Optional[Dict[str, Any]] = Field(default=None, alias="additionalProperties")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["domain", "search_path", "facets_path", "download_path", "auth_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 PublicationOfficeConnectorConfig 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 PublicationOfficeConnectorConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "domain": obj.get("domain"),
+            "search_path": obj.get("search_path"),
+            "facets_path": obj.get("facets_path"),
+            "download_path": obj.get("download_path"),
+            "auth_key": obj.get("auth_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/publication_search_index_search_response.py

@@ -0,0 +1,113 @@
+# 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.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.publication_file_metadata import PublicationFileMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PublicationSearchIndexSearchResponse(BaseModel):
+    """
+    PublicationSearchIndexSearchResponse
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    total_count: StrictInt
+    aggregations: Optional[List[AggregationsGroup]] = None
+    files: List[PublicationFileMetadata]
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "total_count", "aggregations", "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 PublicationSearchIndexSearchResponse 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 each item in aggregations (list)
+        _items = []
+        if self.aggregations:
+            for _item_aggregations in self.aggregations:
+                if _item_aggregations:
+                    _items.append(_item_aggregations.to_dict())
+            _dict['aggregations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in files (list)
+        _items = []
+        if self.files:
+            for _item_files in self.files:
+                if _item_files:
+                    _items.append(_item_files.to_dict())
+            _dict['files'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PublicationSearchIndexSearchResponse 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"),
+            "total_count": obj.get("total_count"),
+            "aggregations": [AggregationsGroup.from_dict(_item) for _item in obj["aggregations"]] if obj.get("aggregations") is not None else None,
+            "files": [PublicationFileMetadata.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/published_assistant_from_java.py

@@ -0,0 +1,94 @@
+# 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 uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PublishedAssistantFromJava(BaseModel):
+    """
+    PublishedAssistantFromJava
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    dataset: StrictStr
+    assistant_id: Optional[UUID] = None
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "assistant_id"]
+
+    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 PublishedAssistantFromJava 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 PublishedAssistantFromJava from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "assistant_id": obj.get("assistant_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/put_cell_payload.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PutCellPayload(BaseModel):
+    """
+    PutCellPayload
+    """ # noqa: E501
+    value: Optional[StrictStr] = None
+    prompt: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["value", "prompt"]
+
+    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 PutCellPayload 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 PutCellPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "value": obj.get("value"),
+            "prompt": obj.get("prompt")
+        })
+        return _obj
+
+

qanswer_sdk/models/qa_context.py

@@ -0,0 +1,129 @@
+# 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 qanswer_sdk.models.coordinates import Coordinates
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QaContext(BaseModel):
+    """
+    QaContext
+    """ # noqa: E501
+    kb: Optional[StrictStr] = None
+    uri: Optional[StrictStr] = None
+    user: Optional[StrictStr] = None
+    literal: Optional[StrictStr] = None
+    literal_datatype: Optional[StrictStr] = Field(default=None, alias="literalDatatype")
+    label: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    disambiguation: Optional[StrictStr] = None
+    links: Optional[Dict[str, StrictStr]] = None
+    time: Optional[StrictStr] = None
+    time_series: Optional[StrictStr] = Field(default=None, alias="timeSeries")
+    images: Optional[List[StrictStr]] = None
+    audio: Optional[List[StrictStr]] = None
+    video: Optional[List[StrictStr]] = None
+    geo: Optional[List[Coordinates]] = None
+    geo_json: Optional[StrictStr] = Field(default=None, alias="geoJson")
+    optional: Optional[Dict[str, List[StrictStr]]] = None
+    page_rank: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="pageRank")
+    __properties: ClassVar[List[str]] = ["kb", "uri", "user", "literal", "literalDatatype", "label", "description", "disambiguation", "links", "time", "timeSeries", "images", "audio", "video", "geo", "geoJson", "optional", "pageRank"]
+
+    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 QaContext 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 each item in geo (list)
+        _items = []
+        if self.geo:
+            for _item_geo in self.geo:
+                if _item_geo:
+                    _items.append(_item_geo.to_dict())
+            _dict['geo'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QaContext from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "kb": obj.get("kb"),
+            "uri": obj.get("uri"),
+            "user": obj.get("user"),
+            "literal": obj.get("literal"),
+            "literalDatatype": obj.get("literalDatatype"),
+            "label": obj.get("label"),
+            "description": obj.get("description"),
+            "disambiguation": obj.get("disambiguation"),
+            "links": obj.get("links"),
+            "time": obj.get("time"),
+            "timeSeries": obj.get("timeSeries"),
+            "images": obj.get("images"),
+            "audio": obj.get("audio"),
+            "video": obj.get("video"),
+            "geo": [Coordinates.from_dict(_item) for _item in obj["geo"]] if obj.get("geo") is not None else None,
+            "geoJson": obj.get("geoJson"),
+            "optional": obj.get("optional"),
+            "pageRank": obj.get("pageRank")
+        })
+        return _obj
+
+

qanswer_sdk/models/qa_context_display_type.py

@@ -0,0 +1,44 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class QaContextDisplayType(str, Enum):
+    """
+    QaContextDisplayType
+    """
+
+    """
+    allowed enum values
+    """
+    SIMPLE = 'SIMPLE'
+    LIST = 'LIST'
+    FACET = 'FACET'
+    IMAGES = 'IMAGES'
+    TABLE = 'TABLE'
+    MAP = 'MAP'
+    TIME_SERIES = 'TIME_SERIES'
+    TIME = 'TIME'
+    TIMEOUT = 'TIMEOUT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of QaContextDisplayType from a JSON string"""
+        return cls(json.loads(json_str))
+
+