wordlift-client 1.133.0__tar.gz → 1.134.0__tar.gz

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/PKG-INFO

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

{wordlift_client-1.133.0 → wordlift_client-1.134.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.133.0
+- Package version: 1.134.0
 - Generator version: 7.6.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://wordlift.io](https://wordlift.io)
@@ -254,7 +254,7 @@ Class | Method | HTTP request | Description
  - [AnalyticsImportRequest](docs/AnalyticsImportRequest.md)
  - [AnalyticsSync](docs/AnalyticsSync.md)
  - [AnalyticsSyncRequest](docs/AnalyticsSyncRequest.md)
- - [AnalyzeURLRequest](docs/AnalyzeURLRequest.md)
+ - [AnalyzeContentRequest](docs/AnalyzeContentRequest.md)
  - [AnchorText](docs/AnchorText.md)
  - [Annotation](docs/Annotation.md)
  - [AskRequest](docs/AskRequest.md)

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/pyproject.toml

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

{wordlift_client-1.133.0 → wordlift_client-1.134.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.133.0"
+VERSION = "1.134.0"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

wordlift_client-1.134.0/test/test_analyze_content_request.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.analyze_content_request import AnalyzeContentRequest
+
+class TestAnalyzeContentRequest(unittest.TestCase):
+    """AnalyzeContentRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> AnalyzeContentRequest:
+        """Test AnalyzeContentRequest
+            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 `AnalyzeContentRequest`
+        """
+        model = AnalyzeContentRequest()
+        if include_optional:
+            return AnalyzeContentRequest(
+                url = '0',
+                text = '',
+                num_queries = 1,
+                coverage_threshold = 0
+            )
+        else:
+            return AnalyzeContentRequest(
+        )
+        """
+
+    def testAnalyzeContentRequest(self):
+        """Test AnalyzeContentRequest"""
+        # 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.133.0 → wordlift_client-1.134.0}/wordlift_client/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.133.0"
+__version__ = "1.134.0"
 
 # import apis into sdk package
 from wordlift_client.api.account_api import AccountApi
@@ -114,7 +114,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
 from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
 from wordlift_client.models.analytics_sync import AnalyticsSync
 from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
-from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
+from wordlift_client.models.analyze_content_request import AnalyzeContentRequest
 from wordlift_client.models.anchor_text import AnchorText
 from wordlift_client.models.annotation import Annotation
 from wordlift_client.models.ask_request import AskRequest

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/wordlift_client/api/query_fan_out_api.py

@@ -20,7 +20,7 @@ from typing_extensions import Annotated
 from pydantic import StrictStr
 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.models.analyze_content_request import AnalyzeContentRequest
 
 from wordlift_client.api_client import ApiClient, RequestSerialized
 from wordlift_client.api_response import ApiResponse
@@ -43,7 +43,7 @@ class QueryFanOutApi:
     @validate_call
     async def create_ai_visibility_audit(
         self,
-        analyze_url_request: AnalyzeURLRequest,
+        analyze_content_request: AnalyzeContentRequest,
         authorization: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
@@ -61,8 +61,8 @@ class QueryFanOutApi:
         """Create AI visibility audits for Query Fan-Out
 
 
-        :param analyze_url_request: (required)
-        :type analyze_url_request: AnalyzeURLRequest
+        :param analyze_content_request: (required)
+        :type analyze_content_request: AnalyzeContentRequest
         :param authorization:
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -88,7 +88,7 @@ class QueryFanOutApi:
         """ # noqa: E501
 
         _param = self._create_ai_visibility_audit_serialize(
-            analyze_url_request=analyze_url_request,
+            analyze_content_request=analyze_content_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -114,7 +114,7 @@ class QueryFanOutApi:
     @validate_call
     async def create_ai_visibility_audit_with_http_info(
         self,
-        analyze_url_request: AnalyzeURLRequest,
+        analyze_content_request: AnalyzeContentRequest,
         authorization: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
@@ -132,8 +132,8 @@ class QueryFanOutApi:
         """Create AI visibility audits for Query Fan-Out
 
 
-        :param analyze_url_request: (required)
-        :type analyze_url_request: AnalyzeURLRequest
+        :param analyze_content_request: (required)
+        :type analyze_content_request: AnalyzeContentRequest
         :param authorization:
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -159,7 +159,7 @@ class QueryFanOutApi:
         """ # noqa: E501
 
         _param = self._create_ai_visibility_audit_serialize(
-            analyze_url_request=analyze_url_request,
+            analyze_content_request=analyze_content_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -185,7 +185,7 @@ class QueryFanOutApi:
     @validate_call
     async def create_ai_visibility_audit_without_preload_content(
         self,
-        analyze_url_request: AnalyzeURLRequest,
+        analyze_content_request: AnalyzeContentRequest,
         authorization: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
@@ -203,8 +203,8 @@ class QueryFanOutApi:
         """Create AI visibility audits for Query Fan-Out
 
 
-        :param analyze_url_request: (required)
-        :type analyze_url_request: AnalyzeURLRequest
+        :param analyze_content_request: (required)
+        :type analyze_content_request: AnalyzeContentRequest
         :param authorization:
         :type authorization: str
         :param _request_timeout: timeout setting for this request. If one
@@ -230,7 +230,7 @@ class QueryFanOutApi:
         """ # noqa: E501
 
         _param = self._create_ai_visibility_audit_serialize(
-            analyze_url_request=analyze_url_request,
+            analyze_content_request=analyze_content_request,
             authorization=authorization,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -251,7 +251,7 @@ class QueryFanOutApi:
 
     def _create_ai_visibility_audit_serialize(
         self,
-        analyze_url_request,
+        analyze_content_request,
         authorization,
         _request_auth,
         _content_type,
@@ -278,8 +278,8 @@ class QueryFanOutApi:
             _header_params['authorization'] = authorization
         # process the form parameters
         # process the body parameter
-        if analyze_url_request is not None:
-            _body_params = analyze_url_request
+        if analyze_content_request is not None:
+            _body_params = analyze_content_request
 
 
         # set the HTTP header `Accept`

{wordlift_client-1.133.0 → wordlift_client-1.134.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.133.0/python'
+        self.user_agent = 'OpenAPI-Generator/1.134.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

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

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/wordlift_client/models/__init__.py

@@ -29,7 +29,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
 from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
 from wordlift_client.models.analytics_sync import AnalyticsSync
 from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
-from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
+from wordlift_client.models.analyze_content_request import AnalyzeContentRequest
 from wordlift_client.models.anchor_text import AnchorText
 from wordlift_client.models.annotation import Annotation
 from wordlift_client.models.ask_request import AskRequest

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/wordlift_client/models/ai_visibility_analysis_result.py

@@ -28,7 +28,6 @@ class AIVisibilityAnalysisResult(BaseModel):
     """
     AIVisibilityAnalysisResult
     """ # noqa: E501
-    url: StrictStr
     num_queries_requested: StrictInt
     coverage_threshold: Union[StrictFloat, StrictInt]
     entity_name: StrictStr
@@ -38,7 +37,7 @@ class AIVisibilityAnalysisResult(BaseModel):
     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"]
+    __properties: ClassVar[List[str]] = ["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,
@@ -100,7 +99,6 @@ class AIVisibilityAnalysisResult(BaseModel):
             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"),

wordlift_client-1.134.0/wordlift_client/models/analyze_content_request.py

@@ -0,0 +1,105 @@
+# 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, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyzeContentRequest(BaseModel):
+    """
+    AnalyzeContentRequest
+    """ # noqa: E501
+    url: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=2083)]] = None
+    text: Optional[StrictStr] = None
+    num_queries: Optional[Annotated[int, Field(le=20, strict=True, ge=1)]] = Field(default=10, description="Number of synthetic queries to generate")
+    coverage_threshold: Optional[Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]]] = Field(default=0.65, description="The threshold for answering synthetic queries")
+    __properties: ClassVar[List[str]] = ["url", "text", "num_queries", "coverage_threshold"]
+
+    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 AnalyzeContentRequest 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,
+        )
+        # set to None if url (nullable) is None
+        # and model_fields_set contains the field
+        if self.url is None and "url" in self.model_fields_set:
+            _dict['url'] = None
+
+        # set to None if text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalyzeContentRequest 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"),
+            "text": obj.get("text"),
+            "num_queries": obj.get("num_queries") if obj.get("num_queries") is not None else 10,
+            "coverage_threshold": obj.get("coverage_threshold") if obj.get("coverage_threshold") is not None else 0.65
+        })
+        return _obj
+
+

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/wordlift_client.egg-info/PKG-INFO

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

{wordlift_client-1.133.0 → wordlift_client-1.134.0}/wordlift_client.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ test/test_analytics_imports_api.py
 test/test_analytics_sync.py
 test/test_analytics_sync_request.py
 test/test_analytics_syncs_api.py
+test/test_analyze_content_request.py
 test/test_analyze_url_request.py
 test/test_anchor_text.py
 test/test_annotation.py
@@ -382,6 +383,7 @@ wordlift_client/models/analyses_response_item.py
 wordlift_client/models/analytics_import_request.py
 wordlift_client/models/analytics_sync.py
 wordlift_client/models/analytics_sync_request.py
+wordlift_client/models/analyze_content_request.py
 wordlift_client/models/analyze_url_request.py
 wordlift_client/models/anchor_text.py
 wordlift_client/models/annotation.py