wordlift-client 1.126.0__tar.gz → 1.128.0__tar.gz

{wordlift_client-1.126.0 → wordlift_client-1.128.0}/PKG-INFO

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

{wordlift_client-1.126.0 → wordlift_client-1.128.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.126.0
+- Package version: 1.128.0
 - Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://wordlift.io](https://wordlift.io)
@@ -241,6 +241,7 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [AIVisibilityAnalysisResult](docs/AIVisibilityAnalysisResult.md)
  - [Account](docs/Account.md)
  - [AccountConfig](docs/AccountConfig.md)
  - [AccountInfo](docs/AccountInfo.md)
@@ -373,6 +374,7 @@ Class | Method | HTTP request | Description
  - [ProjectType](docs/ProjectType.md)
  - [Properties](docs/Properties.md)
  - [Properties1](docs/Properties1.md)
+ - [QueryCoverageOutput](docs/QueryCoverageOutput.md)
  - [QuestionAndAnswer](docs/QuestionAndAnswer.md)
  - [QuestionAndAnswerRequest](docs/QuestionAndAnswerRequest.md)
  - [QuickWin](docs/QuickWin.md)

{wordlift_client-1.126.0 → wordlift_client-1.128.0}/pyproject.toml

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

{wordlift_client-1.126.0 → wordlift_client-1.128.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.126.0"
+VERSION = "1.128.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wordlift_client-1.128.0/test/test_ai_visibility_analysis_result.py

@@ -0,0 +1,83 @@
+# 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.ai_visibility_analysis_result import AIVisibilityAnalysisResult
+
+class TestAIVisibilityAnalysisResult(unittest.TestCase):
+    """AIVisibilityAnalysisResult unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AIVisibilityAnalysisResult:
+        """Test AIVisibilityAnalysisResult
+            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 `AIVisibilityAnalysisResult`
+        """
+        model = AIVisibilityAnalysisResult()
+        if include_optional:
+            return AIVisibilityAnalysisResult(
+                url = '',
+                num_queries_requested = 56,
+                coverage_threshold = 1.337,
+                entity_name = '',
+                query_reasoning = '',
+                covered_count = 56,
+                total_queries = 56,
+                query_details = [
+                    wordlift_client.models.query_coverage.QueryCoverage(
+                        query = '', 
+                        is_covered = True, 
+                        similarity = 1.337, 
+                        best_chunk_preview = '', )
+                    ],
+                content_chunks_count = 56,
+                coverage_score = 1.337
+            )
+        else:
+            return AIVisibilityAnalysisResult(
+                url = '',
+                num_queries_requested = 56,
+                coverage_threshold = 1.337,
+                entity_name = '',
+                query_reasoning = '',
+                covered_count = 56,
+                total_queries = 56,
+                query_details = [
+                    wordlift_client.models.query_coverage.QueryCoverage(
+                        query = '', 
+                        is_covered = True, 
+                        similarity = 1.337, 
+                        best_chunk_preview = '', )
+                    ],
+                content_chunks_count = 56,
+                coverage_score = 1.337,
+        )
+        """
+
+    def testAIVisibilityAnalysisResult(self):
+        """Test AIVisibilityAnalysisResult"""
+        # 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.128.0/test/test_query_coverage.py

@@ -0,0 +1,59 @@
+# 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.query_coverage import QueryCoverage
+
+class TestQueryCoverage(unittest.TestCase):
+    """QueryCoverage unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> QueryCoverage:
+        """Test QueryCoverage
+            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 `QueryCoverage`
+        """
+        model = QueryCoverage()
+        if include_optional:
+            return QueryCoverage(
+                query = '',
+                is_covered = True,
+                similarity = 1.337,
+                best_chunk_preview = ''
+            )
+        else:
+            return QueryCoverage(
+                query = '',
+                is_covered = True,
+                similarity = 1.337,
+                best_chunk_preview = '',
+        )
+        """
+
+    def testQueryCoverage(self):
+        """Test QueryCoverage"""
+        # 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.128.0/test/test_query_coverage_output.py

@@ -0,0 +1,57 @@
+# 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.query_coverage_output import QueryCoverageOutput
+
+class TestQueryCoverageOutput(unittest.TestCase):
+    """QueryCoverageOutput unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> QueryCoverageOutput:
+        """Test QueryCoverageOutput
+            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 `QueryCoverageOutput`
+        """
+        model = QueryCoverageOutput()
+        if include_optional:
+            return QueryCoverageOutput(
+                query = '',
+                is_covered = True,
+                similarity = 1.337
+            )
+        else:
+            return QueryCoverageOutput(
+                query = '',
+                is_covered = True,
+                similarity = 1.337,
+        )
+        """
+
+    def testQueryCoverageOutput(self):
+        """Test QueryCoverageOutput"""
+        # 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.126.0 → wordlift_client-1.128.0}/wordlift_client/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.126.0"
+__version__ = "1.128.0"
 
 # import apis into sdk package
 from wordlift_client.api.account_api import AccountApi
@@ -101,6 +101,7 @@ from wordlift_client.exceptions import ApiAttributeError
 from wordlift_client.exceptions import ApiException
 
 # import models into sdk package
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
 from wordlift_client.models.account import Account
 from wordlift_client.models.account_config import AccountConfig
 from wordlift_client.models.account_info import AccountInfo
@@ -233,6 +234,7 @@ from wordlift_client.models.problem_detail import ProblemDetail
 from wordlift_client.models.project_type import ProjectType
 from wordlift_client.models.properties import Properties
 from wordlift_client.models.properties1 import Properties1
+from wordlift_client.models.query_coverage_output import QueryCoverageOutput
 from wordlift_client.models.question_and_answer import QuestionAndAnswer
 from wordlift_client.models.question_and_answer_request import QuestionAndAnswerRequest
 from wordlift_client.models.quick_win import QuickWin

{wordlift_client-1.126.0 → wordlift_client-1.128.0}/wordlift_client/api/ai_visibility_api.py

@@ -18,7 +18,8 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import StrictStr
-from typing import Any, Optional
+from typing import Optional
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
 from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
 
 from wordlift_client.api_client import ApiClient, RequestSerialized
@@ -56,7 +57,7 @@ class AiVisibilityApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> AIVisibilityAnalysisResult:
         """Create AI visibility audits for Query Fan-Out
 
 
@@ -96,7 +97,7 @@ class AiVisibilityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': "AIVisibilityAnalysisResult",
             '422': "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -127,7 +128,7 @@ class AiVisibilityApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[AIVisibilityAnalysisResult]:
         """Create AI visibility audits for Query Fan-Out
 
 
@@ -167,7 +168,7 @@ class AiVisibilityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': "AIVisibilityAnalysisResult",
             '422': "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -238,7 +239,7 @@ class AiVisibilityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': "AIVisibilityAnalysisResult",
             '422': "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(

{wordlift_client-1.126.0 → wordlift_client-1.128.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.126.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.128.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{wordlift_client-1.126.0 → wordlift_client-1.128.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.126.0".\
+               "SDK Package Version: 1.128.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{wordlift_client-1.126.0 → wordlift_client-1.128.0}/wordlift_client/models/__init__.py

@@ -15,6 +15,7 @@
 
 
 # import models into model package
+from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
 from wordlift_client.models.account import Account
 from wordlift_client.models.account_config import AccountConfig
 from wordlift_client.models.account_info import AccountInfo
@@ -147,6 +148,7 @@ from wordlift_client.models.problem_detail import ProblemDetail
 from wordlift_client.models.project_type import ProjectType
 from wordlift_client.models.properties import Properties
 from wordlift_client.models.properties1 import Properties1
+from wordlift_client.models.query_coverage_output import QueryCoverageOutput
 from wordlift_client.models.question_and_answer import QuestionAndAnswer
 from wordlift_client.models.question_and_answer_request import QuestionAndAnswerRequest
 from wordlift_client.models.quick_win import QuickWin

wordlift_client-1.128.0/wordlift_client/models/ai_visibility_analysis_result.py

@@ -0,0 +1,116 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from wordlift_client.models.query_coverage_output import QueryCoverageOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AIVisibilityAnalysisResult(BaseModel):
+    """
+    AIVisibilityAnalysisResult
+    """ # noqa: E501
+    url: StrictStr
+    num_queries_requested: StrictInt
+    coverage_threshold: Union[StrictFloat, StrictInt]
+    entity_name: StrictStr
+    query_reasoning: StrictStr
+    covered_count: StrictInt
+    total_queries: StrictInt
+    query_details: List[QueryCoverageOutput]
+    content_chunks_count: StrictInt
+    coverage_score: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["url", "num_queries_requested", "coverage_threshold", "entity_name", "query_reasoning", "covered_count", "total_queries", "query_details", "content_chunks_count", "coverage_score"]
+
+    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 AIVisibilityAnalysisResult 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "coverage_score",
+        ])
+
+        _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 query_details (list)
+        _items = []
+        if self.query_details:
+            for _item in self.query_details:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['query_details'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AIVisibilityAnalysisResult 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"),
+            "num_queries_requested": obj.get("num_queries_requested"),
+            "coverage_threshold": obj.get("coverage_threshold"),
+            "entity_name": obj.get("entity_name"),
+            "query_reasoning": obj.get("query_reasoning"),
+            "covered_count": obj.get("covered_count"),
+            "total_queries": obj.get("total_queries"),
+            "query_details": [QueryCoverageOutput.from_dict(_item) for _item in obj["query_details"]] if obj.get("query_details") is not None else None,
+            "content_chunks_count": obj.get("content_chunks_count"),
+            "coverage_score": obj.get("coverage_score")
+        })
+        return _obj
+
+

wordlift_client-1.128.0/wordlift_client/models/query_coverage.py

@@ -0,0 +1,94 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryCoverage(BaseModel):
+    """
+    QueryCoverage
+    """ # noqa: E501
+    query: StrictStr
+    is_covered: StrictBool
+    similarity: Union[StrictFloat, StrictInt]
+    best_chunk_preview: StrictStr
+    __properties: ClassVar[List[str]] = ["query", "is_covered", "similarity", "best_chunk_preview"]
+
+    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 QueryCoverage 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 QueryCoverage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": obj.get("query"),
+            "is_covered": obj.get("is_covered"),
+            "similarity": obj.get("similarity"),
+            "best_chunk_preview": obj.get("best_chunk_preview")
+        })
+        return _obj
+
+

wordlift_client-1.128.0/wordlift_client/models/query_coverage_output.py

@@ -0,0 +1,92 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QueryCoverageOutput(BaseModel):
+    """
+    QueryCoverageOutput
+    """ # noqa: E501
+    query: StrictStr
+    is_covered: StrictBool
+    similarity: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["query", "is_covered", "similarity"]
+
+    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 QueryCoverageOutput 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 QueryCoverageOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": obj.get("query"),
+            "is_covered": obj.get("is_covered"),
+            "similarity": obj.get("similarity")
+        })
+        return _obj
+
+

{wordlift_client-1.126.0 → wordlift_client-1.128.0}/wordlift_client.egg-info/PKG-INFO

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