wordlift-client 1.114.0__tar.gz → 1.115.0__tar.gz

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wordlift-client
-Version: 1.114.0
+Version: 1.115.0
 Summary: WordLift API
 Home-page: 
 Author: WordLift

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/README.md

@@ -4,7 +4,7 @@ WordLift API
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.114.0
+- Package version: 1.115.0
 - Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://wordlift.io](https://wordlift.io)
@@ -317,6 +317,7 @@ Class | Method | HTTP request | Description
  - [InternalLinkSource](docs/InternalLinkSource.md)
  - [Item](docs/Item.md)
  - [KgEmbeddingRequest](docs/KgEmbeddingRequest.md)
+ - [KgEmbeddingResponse](docs/KgEmbeddingResponse.md)
  - [LevelEnum](docs/LevelEnum.md)
  - [LocationInner](docs/LocationInner.md)
  - [LongtailResponse](docs/LongtailResponse.md)

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wordlift_client"
-version = "1.114.0"
+version = "1.115.0"
 description = "WordLift API"
 authors = ["WordLift <hello@wordlift.io>"]
 license = "(c) copyright 2022-present WordLift"

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/setup.py

@@ -22,7 +22,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "wordlift-client"
-VERSION = "1.114.0"
+VERSION = "1.115.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wordlift_client-1.115.0/test/test_kg_embedding_response.py

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from wordlift_client.models.kg_embedding_response import KgEmbeddingResponse
+
+class TestKgEmbeddingResponse(unittest.TestCase):
+    """KgEmbeddingResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> KgEmbeddingResponse:
+        """Test KgEmbeddingResponse
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `KgEmbeddingResponse`
+        """
+        model = KgEmbeddingResponse()
+        if include_optional:
+            return KgEmbeddingResponse(
+                id = '',
+                model = ''
+            )
+        else:
+            return KgEmbeddingResponse(
+                id = '',
+                model = '',
+        )
+        """
+
+    def testKgEmbeddingResponse(self):
+        """Test KgEmbeddingResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.114.0"
+__version__ = "1.115.0"
 
 # import apis into sdk package
 from wordlift_client.api.account_api import AccountApi
@@ -179,6 +179,7 @@ from wordlift_client.models.internal_link_request import InternalLinkRequest
 from wordlift_client.models.internal_link_source import InternalLinkSource
 from wordlift_client.models.item import Item
 from wordlift_client.models.kg_embedding_request import KgEmbeddingRequest
+from wordlift_client.models.kg_embedding_response import KgEmbeddingResponse
 from wordlift_client.models.level_enum import LevelEnum
 from wordlift_client.models.location_inner import LocationInner
 from wordlift_client.models.longtail_response import LongtailResponse

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/api/embedding_api.py

@@ -17,9 +17,9 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import StrictStr
-from typing import Dict, List
+from typing import List
 from wordlift_client.models.kg_embedding_request import KgEmbeddingRequest
+from wordlift_client.models.kg_embedding_response import KgEmbeddingResponse
 
 from wordlift_client.api_client import ApiClient, RequestSerialized
 from wordlift_client.api_response import ApiResponse
@@ -55,7 +55,7 @@ class EmbeddingApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Dict[str, str]]:
+    ) -> List[KgEmbeddingResponse]:
         """Create
 
         Create the embedding for the IRIs for the provided query.
@@ -93,7 +93,7 @@ class EmbeddingApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '201': "List[Dict[str, str]]",
+            '201': "List[KgEmbeddingResponse]",
             '401': None,
         }
         response_data = await self.api_client.call_api(
@@ -123,7 +123,7 @@ class EmbeddingApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Dict[str, str]]]:
+    ) -> ApiResponse[List[KgEmbeddingResponse]]:
         """Create
 
         Create the embedding for the IRIs for the provided query.
@@ -161,7 +161,7 @@ class EmbeddingApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '201': "List[Dict[str, str]]",
+            '201': "List[KgEmbeddingResponse]",
             '401': None,
         }
         response_data = await self.api_client.call_api(
@@ -229,7 +229,7 @@ class EmbeddingApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '201': "List[Dict[str, str]]",
+            '201': "List[KgEmbeddingResponse]",
             '401': None,
         }
         response_data = await self.api_client.call_api(

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/api_client.py

@@ -89,7 +89,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.114.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.115.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/configuration.py

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

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/models/__init__.py

@@ -95,6 +95,7 @@ from wordlift_client.models.internal_link_request import InternalLinkRequest
 from wordlift_client.models.internal_link_source import InternalLinkSource
 from wordlift_client.models.item import Item
 from wordlift_client.models.kg_embedding_request import KgEmbeddingRequest
+from wordlift_client.models.kg_embedding_response import KgEmbeddingResponse
 from wordlift_client.models.level_enum import LevelEnum
 from wordlift_client.models.location_inner import LocationInner
 from wordlift_client.models.longtail_response import LongtailResponse

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client/models/kg_embedding_request.py

@@ -18,8 +18,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from wordlift_client.models.embedding_request import EmbeddingRequest
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,9 +28,9 @@ class KgEmbeddingRequest(BaseModel):
     """
     KgEmbeddingRequest
     """ # noqa: E501
-    graphql_query: Optional[StrictStr] = None
-    properties: Optional[List[StrictStr]] = None
-    __properties: ClassVar[List[str]] = ["graphql_query", "properties"]
+    embedding: EmbeddingRequest
+    graphql_query: StrictStr = Field(description="The GraphQL query used to select entities to create embedding vectors for.")
+    __properties: ClassVar[List[str]] = ["embedding", "graphql_query"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -70,6 +71,9 @@ class KgEmbeddingRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of embedding
+        if self.embedding:
+            _dict['embedding'] = self.embedding.to_dict()
         return _dict
 
     @classmethod
@@ -82,8 +86,8 @@ class KgEmbeddingRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "graphql_query": obj.get("graphql_query"),
-            "properties": obj.get("properties")
+            "embedding": EmbeddingRequest.from_dict(obj["embedding"]) if obj.get("embedding") is not None else None,
+            "graphql_query": obj.get("graphql_query")
         })
         return _obj
 

wordlift_client-1.115.0/wordlift_client/models/kg_embedding_response.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    WordLift API
+
+    WordLift API
+
+    The version of the OpenAPI document: 1.0
+    Contact: hello@wordlift.io
+    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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KgEmbeddingResponse(BaseModel):
+    """
+    Graph Embedding Response
+    """ # noqa: E501
+    id: StrictStr = Field(description="The id/iri of the web page in the Graph.")
+    model: StrictStr
+    __properties: ClassVar[List[str]] = ["id", "model"]
+
+    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 KgEmbeddingResponse 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 KgEmbeddingResponse 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"),
+            "model": obj.get("model")
+        })
+        return _obj
+
+

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wordlift-client
-Version: 1.114.0
+Version: 1.115.0
 Summary: WordLift API
 Home-page: 
 Author: WordLift

{wordlift_client-1.114.0 → wordlift_client-1.115.0}/wordlift_client.egg-info/SOURCES.txt

@@ -131,6 +131,7 @@ test/test_internal_link_source.py
 test/test_internal_links_api.py
 test/test_item.py
 test/test_kg_embedding_request.py
+test/test_kg_embedding_response.py
 test/test_level_enum.py
 test/test_location_inner.py
 test/test_long_tails_api.py
@@ -419,6 +420,7 @@ wordlift_client/models/internal_link_request.py
 wordlift_client/models/internal_link_source.py
 wordlift_client/models/item.py
 wordlift_client/models/kg_embedding_request.py
+wordlift_client/models/kg_embedding_response.py
 wordlift_client/models/level_enum.py
 wordlift_client/models/location_inner.py
 wordlift_client/models/longtail_response.py