wordlift-client 1.133.0__py3-none-any.whl → 1.134.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,7 +15,7 @@
15
15
  """ # noqa: E501
16
16
 
17
17
 
18
- __version__ = "1.133.0"
18
+ __version__ = "1.134.0"
19
19
 
20
20
  # import apis into sdk package
21
21
  from wordlift_client.api.account_api import AccountApi
@@ -114,7 +114,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
114
114
  from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
115
115
  from wordlift_client.models.analytics_sync import AnalyticsSync
116
116
  from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
117
- from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
117
+ from wordlift_client.models.analyze_content_request import AnalyzeContentRequest
118
118
  from wordlift_client.models.anchor_text import AnchorText
119
119
  from wordlift_client.models.annotation import Annotation
120
120
  from wordlift_client.models.ask_request import AskRequest
@@ -20,7 +20,7 @@ from typing_extensions import Annotated
20
20
  from pydantic import StrictStr
21
21
  from typing import Optional
22
22
  from wordlift_client.models.ai_visibility_analysis_result import AIVisibilityAnalysisResult
23
- from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
23
+ from wordlift_client.models.analyze_content_request import AnalyzeContentRequest
24
24
 
25
25
  from wordlift_client.api_client import ApiClient, RequestSerialized
26
26
  from wordlift_client.api_response import ApiResponse
@@ -43,7 +43,7 @@ class QueryFanOutApi:
43
43
  @validate_call
44
44
  async def create_ai_visibility_audit(
45
45
  self,
46
- analyze_url_request: AnalyzeURLRequest,
46
+ analyze_content_request: AnalyzeContentRequest,
47
47
  authorization: Optional[StrictStr] = None,
48
48
  _request_timeout: Union[
49
49
  None,
@@ -61,8 +61,8 @@ class QueryFanOutApi:
61
61
  """Create AI visibility audits for Query Fan-Out
62
62
 
63
63
 
64
- :param analyze_url_request: (required)
65
- :type analyze_url_request: AnalyzeURLRequest
64
+ :param analyze_content_request: (required)
65
+ :type analyze_content_request: AnalyzeContentRequest
66
66
  :param authorization:
67
67
  :type authorization: str
68
68
  :param _request_timeout: timeout setting for this request. If one
@@ -88,7 +88,7 @@ class QueryFanOutApi:
88
88
  """ # noqa: E501
89
89
 
90
90
  _param = self._create_ai_visibility_audit_serialize(
91
- analyze_url_request=analyze_url_request,
91
+ analyze_content_request=analyze_content_request,
92
92
  authorization=authorization,
93
93
  _request_auth=_request_auth,
94
94
  _content_type=_content_type,
@@ -114,7 +114,7 @@ class QueryFanOutApi:
114
114
  @validate_call
115
115
  async def create_ai_visibility_audit_with_http_info(
116
116
  self,
117
- analyze_url_request: AnalyzeURLRequest,
117
+ analyze_content_request: AnalyzeContentRequest,
118
118
  authorization: Optional[StrictStr] = None,
119
119
  _request_timeout: Union[
120
120
  None,
@@ -132,8 +132,8 @@ class QueryFanOutApi:
132
132
  """Create AI visibility audits for Query Fan-Out
133
133
 
134
134
 
135
- :param analyze_url_request: (required)
136
- :type analyze_url_request: AnalyzeURLRequest
135
+ :param analyze_content_request: (required)
136
+ :type analyze_content_request: AnalyzeContentRequest
137
137
  :param authorization:
138
138
  :type authorization: str
139
139
  :param _request_timeout: timeout setting for this request. If one
@@ -159,7 +159,7 @@ class QueryFanOutApi:
159
159
  """ # noqa: E501
160
160
 
161
161
  _param = self._create_ai_visibility_audit_serialize(
162
- analyze_url_request=analyze_url_request,
162
+ analyze_content_request=analyze_content_request,
163
163
  authorization=authorization,
164
164
  _request_auth=_request_auth,
165
165
  _content_type=_content_type,
@@ -185,7 +185,7 @@ class QueryFanOutApi:
185
185
  @validate_call
186
186
  async def create_ai_visibility_audit_without_preload_content(
187
187
  self,
188
- analyze_url_request: AnalyzeURLRequest,
188
+ analyze_content_request: AnalyzeContentRequest,
189
189
  authorization: Optional[StrictStr] = None,
190
190
  _request_timeout: Union[
191
191
  None,
@@ -203,8 +203,8 @@ class QueryFanOutApi:
203
203
  """Create AI visibility audits for Query Fan-Out
204
204
 
205
205
 
206
- :param analyze_url_request: (required)
207
- :type analyze_url_request: AnalyzeURLRequest
206
+ :param analyze_content_request: (required)
207
+ :type analyze_content_request: AnalyzeContentRequest
208
208
  :param authorization:
209
209
  :type authorization: str
210
210
  :param _request_timeout: timeout setting for this request. If one
@@ -230,7 +230,7 @@ class QueryFanOutApi:
230
230
  """ # noqa: E501
231
231
 
232
232
  _param = self._create_ai_visibility_audit_serialize(
233
- analyze_url_request=analyze_url_request,
233
+ analyze_content_request=analyze_content_request,
234
234
  authorization=authorization,
235
235
  _request_auth=_request_auth,
236
236
  _content_type=_content_type,
@@ -251,7 +251,7 @@ class QueryFanOutApi:
251
251
 
252
252
  def _create_ai_visibility_audit_serialize(
253
253
  self,
254
- analyze_url_request,
254
+ analyze_content_request,
255
255
  authorization,
256
256
  _request_auth,
257
257
  _content_type,
@@ -278,8 +278,8 @@ class QueryFanOutApi:
278
278
  _header_params['authorization'] = authorization
279
279
  # process the form parameters
280
280
  # process the body parameter
281
- if analyze_url_request is not None:
282
- _body_params = analyze_url_request
281
+ if analyze_content_request is not None:
282
+ _body_params = analyze_content_request
283
283
 
284
284
 
285
285
  # set the HTTP header `Accept`
@@ -89,7 +89,7 @@ class ApiClient:
89
89
  self.default_headers[header_name] = header_value
90
90
  self.cookie = cookie
91
91
  # Set default User-Agent.
92
- self.user_agent = 'OpenAPI-Generator/1.133.0/python'
92
+ self.user_agent = 'OpenAPI-Generator/1.134.0/python'
93
93
  self.client_side_validation = configuration.client_side_validation
94
94
 
95
95
  async def __aenter__(self):
@@ -426,7 +426,7 @@ conf = wordlift_client.Configuration(
426
426
  "OS: {env}\n"\
427
427
  "Python Version: {pyversion}\n"\
428
428
  "Version of the API: 1.0\n"\
429
- "SDK Package Version: 1.133.0".\
429
+ "SDK Package Version: 1.134.0".\
430
430
  format(env=sys.platform, pyversion=sys.version)
431
431
 
432
432
  def get_host_settings(self):
@@ -29,7 +29,7 @@ from wordlift_client.models.analyses_response_item import AnalysesResponseItem
29
29
  from wordlift_client.models.analytics_import_request import AnalyticsImportRequest
30
30
  from wordlift_client.models.analytics_sync import AnalyticsSync
31
31
  from wordlift_client.models.analytics_sync_request import AnalyticsSyncRequest
32
- from wordlift_client.models.analyze_url_request import AnalyzeURLRequest
32
+ from wordlift_client.models.analyze_content_request import AnalyzeContentRequest
33
33
  from wordlift_client.models.anchor_text import AnchorText
34
34
  from wordlift_client.models.annotation import Annotation
35
35
  from wordlift_client.models.ask_request import AskRequest
@@ -28,7 +28,6 @@ class AIVisibilityAnalysisResult(BaseModel):
28
28
  """
29
29
  AIVisibilityAnalysisResult
30
30
  """ # noqa: E501
31
- url: StrictStr
32
31
  num_queries_requested: StrictInt
33
32
  coverage_threshold: Union[StrictFloat, StrictInt]
34
33
  entity_name: StrictStr
@@ -38,7 +37,7 @@ class AIVisibilityAnalysisResult(BaseModel):
38
37
  query_details: List[QueryCoverageOutput]
39
38
  content_chunks_count: StrictInt
40
39
  coverage_score: Union[StrictFloat, StrictInt]
41
- __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"]
40
+ __properties: ClassVar[List[str]] = ["num_queries_requested", "coverage_threshold", "entity_name", "query_reasoning", "covered_count", "total_queries", "query_details", "content_chunks_count", "coverage_score"]
42
41
 
43
42
  model_config = ConfigDict(
44
43
  populate_by_name=True,
@@ -100,7 +99,6 @@ class AIVisibilityAnalysisResult(BaseModel):
100
99
  return cls.model_validate(obj)
101
100
 
102
101
  _obj = cls.model_validate({
103
- "url": obj.get("url"),
104
102
  "num_queries_requested": obj.get("num_queries_requested"),
105
103
  "coverage_threshold": obj.get("coverage_threshold"),
106
104
  "entity_name": obj.get("entity_name"),
@@ -0,0 +1,105 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ WordLift API
5
+
6
+ WordLift API
7
+
8
+ The version of the OpenAPI document: 1.0
9
+ Contact: hello@wordlift.io
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
+ from typing_extensions import Annotated
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class AnalyzeContentRequest(BaseModel):
28
+ """
29
+ AnalyzeContentRequest
30
+ """ # noqa: E501
31
+ url: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=2083)]] = None
32
+ text: Optional[StrictStr] = None
33
+ num_queries: Optional[Annotated[int, Field(le=20, strict=True, ge=1)]] = Field(default=10, description="Number of synthetic queries to generate")
34
+ 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")
35
+ __properties: ClassVar[List[str]] = ["url", "text", "num_queries", "coverage_threshold"]
36
+
37
+ model_config = ConfigDict(
38
+ populate_by_name=True,
39
+ validate_assignment=True,
40
+ protected_namespaces=(),
41
+ )
42
+
43
+
44
+ def to_str(self) -> str:
45
+ """Returns the string representation of the model using alias"""
46
+ return pprint.pformat(self.model_dump(by_alias=True))
47
+
48
+ def to_json(self) -> str:
49
+ """Returns the JSON representation of the model using alias"""
50
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
51
+ return json.dumps(self.to_dict())
52
+
53
+ @classmethod
54
+ def from_json(cls, json_str: str) -> Optional[Self]:
55
+ """Create an instance of AnalyzeContentRequest from a JSON string"""
56
+ return cls.from_dict(json.loads(json_str))
57
+
58
+ def to_dict(self) -> Dict[str, Any]:
59
+ """Return the dictionary representation of the model using alias.
60
+
61
+ This has the following differences from calling pydantic's
62
+ `self.model_dump(by_alias=True)`:
63
+
64
+ * `None` is only added to the output dict for nullable fields that
65
+ were set at model initialization. Other fields with value `None`
66
+ are ignored.
67
+ """
68
+ excluded_fields: Set[str] = set([
69
+ ])
70
+
71
+ _dict = self.model_dump(
72
+ by_alias=True,
73
+ exclude=excluded_fields,
74
+ exclude_none=True,
75
+ )
76
+ # set to None if url (nullable) is None
77
+ # and model_fields_set contains the field
78
+ if self.url is None and "url" in self.model_fields_set:
79
+ _dict['url'] = None
80
+
81
+ # set to None if text (nullable) is None
82
+ # and model_fields_set contains the field
83
+ if self.text is None and "text" in self.model_fields_set:
84
+ _dict['text'] = None
85
+
86
+ return _dict
87
+
88
+ @classmethod
89
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
90
+ """Create an instance of AnalyzeContentRequest from a dict"""
91
+ if obj is None:
92
+ return None
93
+
94
+ if not isinstance(obj, dict):
95
+ return cls.model_validate(obj)
96
+
97
+ _obj = cls.model_validate({
98
+ "url": obj.get("url"),
99
+ "text": obj.get("text"),
100
+ "num_queries": obj.get("num_queries") if obj.get("num_queries") is not None else 10,
101
+ "coverage_threshold": obj.get("coverage_threshold") if obj.get("coverage_threshold") is not None else 0.65
102
+ })
103
+ return _obj
104
+
105
+
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: wordlift-client
3
- Version: 1.133.0
3
+ Version: 1.134.0
4
4
  Summary: WordLift API
5
5
  Home-page:
6
6
  Author: WordLift
@@ -1,7 +1,7 @@
1
- wordlift_client/__init__.py,sha256=65u6T2EHxwoWhfKkvzW85ey2tGhWxHHbi6Mdt3Zuzlg,20012
2
- wordlift_client/api_client.py,sha256=bwUN2T54TeI6gvZlfhVmqzY6We3aZossHCCRJ4OCX2M,26397
1
+ wordlift_client/__init__.py,sha256=UqBZbkM_4e43MRrfvtpi9dGBZ65-mGFhyFInIoTW3x4,20020
2
+ wordlift_client/api_client.py,sha256=RnxC8dvm6dVdAYynCWz5bQVsO_ixFwI3i9Ncb-ai7-A,26397
3
3
  wordlift_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
4
- wordlift_client/configuration.py,sha256=BL0vNLw18i8D3WwYJkNGSFSRukKzrHcMo2R_t6isN_o,15932
4
+ wordlift_client/configuration.py,sha256=Naufk8oJOnGeknpblUb6mrI4UdiXkmW77MT2YAQgU_o,15932
5
5
  wordlift_client/exceptions.py,sha256=KvTu-E964XhAzMXOSfVycfOL1Eeraob5bgD4CfElD7M,5912
6
6
  wordlift_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  wordlift_client/rest.py,sha256=3D4hicZkeSFLxmhmgnlH63K7P39ToGyPk_3aQlHGznI,6817
@@ -64,7 +64,7 @@ wordlift_client/api/platform_consumptions_api.py,sha256=o6HVj9-BvLB2lEOunCSNTHYe
64
64
  wordlift_client/api/platform_limits_api.py,sha256=TpcTfw04rEYGctHe5rMNzdV0HRDN1JeNkh78WyjqEOI,55869
65
65
  wordlift_client/api/plugin_diagnostics_api.py,sha256=qB3JbZSYIKPIcwVOYWD8EsBflldHkaTGkXw9q72A59g,12536
66
66
  wordlift_client/api/plugin_events_api.py,sha256=knq7Bab7ukTANLRZF-UCNm8Nftoueoc0oWZkEF8GqPo,25860
67
- wordlift_client/api/query_fan_out_api.py,sha256=-hEIpbEtbRFJdTCddAphukFzx-ERQtofcuPvXynS2hY,12392
67
+ wordlift_client/api/query_fan_out_api.py,sha256=__MjTylEaW-vD0qLoMzUx2_w88eCHQfS2ntp7U_8ggk,12496
68
68
  wordlift_client/api/questions_and_answers_api.py,sha256=OME5ucn7_fwj5vHBJgbXC64US58uE-kNDK46pzz5Y8A,75218
69
69
  wordlift_client/api/redeem_codes_api.py,sha256=GG7LIFHqCL--KH6hEtXO-Gn1NQKa5w4qYJIhjlZVuZU,11462
70
70
  wordlift_client/api/rules_api.py,sha256=6ESuYM5gHzdzIs1LO69CcnODUXRqnloiHLB6TaGio-M,68256
@@ -82,7 +82,7 @@ wordlift_client/api/web_asyncs_metadata_api.py,sha256=cpDQmIGc6uHu5rFXwZAy1cVgcW
82
82
  wordlift_client/api/web_asyncs_responses_api.py,sha256=h91xI3iIgGoMUcZ7Oft5xiLy0rHh_2qzZDrFTRz3P8w,10889
83
83
  wordlift_client/api/web_pages_api.py,sha256=VKPLIaQRxxDn3daP0zvXRiHj2eegsZIjxUmHKzxZXoc,10839
84
84
  wordlift_client/api/web_pages_imports_api.py,sha256=yPhNLZ1jV2dEDnYuHb7OpiFH3K2ROrRYHG4ZrAf4VMU,11719
85
- wordlift_client/models/__init__.py,sha256=kBhWQsN98AIW7yKVF4JkL9ENyIiPDaIK2l32ZkIA9gg,14474
85
+ wordlift_client/models/__init__.py,sha256=qQDFZf0-IqmYOlYo0qkzrKz3_xhJ6ASchiL3rFWE3-E,14482
86
86
  wordlift_client/models/account.py,sha256=trGNzy3ZBGE1VsSke4aoXBQem-3jK60xVz0OWOOMWso,5523
87
87
  wordlift_client/models/account_config.py,sha256=_4YZ8IGS4h16wa9aSaL9rpeoZYR8faiwEAtovP4eBVI,2592
88
88
  wordlift_client/models/account_info.py,sha256=tCqVHqfeK5u1cQkLOBgJRUTs-e8vmGCjqZ4wgfmNIuw,7750
@@ -90,13 +90,14 @@ wordlift_client/models/account_stats.py,sha256=hMtiIDYGGMp4ytKgvgBIx40U5EyWr6-IJ
90
90
  wordlift_client/models/account_subscription.py,sha256=hJNuMXCDt9EqLvp3vfgv2xMc1Uk7UQ7gzTM320MsPbk,2858
91
91
  wordlift_client/models/active_account.py,sha256=rFDPX3X2hwMQfMnURcLEPgb9W5NGE1xmDIQhPZRMXQA,5707
92
92
  wordlift_client/models/add_on_configuration.py,sha256=8sEIAr91rjmj-A3B1vGUVlZkc_hVxOSmO_Irt4irhz4,3731
93
- wordlift_client/models/ai_visibility_analysis_result.py,sha256=mAAQA8cJxKooYYGNNnK7agxtvjnEsFtvCKCoBD8j8tg,4120
93
+ wordlift_client/models/ai_visibility_analysis_result.py,sha256=tTwPp9TiflBXUedHILl02Tc4eO3X843ZY0dwkMbtdXY,4059
94
94
  wordlift_client/models/analyses_request.py,sha256=_D_X2nN1Dkq835XUs8rinSSNOgQf5nXrFUV_YFbUI6E,4553
95
95
  wordlift_client/models/analyses_response.py,sha256=Nd7Tm2Cll3zqLCAx6KpgaY-dqQgmYLwKxnICOBBdmhU,2924
96
96
  wordlift_client/models/analyses_response_item.py,sha256=A-Xu3xm-XsOLfcxQa4ULb6p_T3CUXcrz7jVmzg3cBvM,3906
97
97
  wordlift_client/models/analytics_import_request.py,sha256=yfc37Vz_NnDWJrH8GpRke9-paSFbe__v9IJknIaKWHc,2538
98
98
  wordlift_client/models/analytics_sync.py,sha256=0H_ac6_00mNBBdfninOli6Bq_Rr9RdjZKZf-qLGSWt4,5415
99
99
  wordlift_client/models/analytics_sync_request.py,sha256=TWvOIfsF2V1_zJSC8NhUwB7WXiD2fEguqAQ4KmY-Z-s,2487
100
+ wordlift_client/models/analyze_content_request.py,sha256=AV3LXmeln5AvxfvqmBnVp4dLDbQoLCtC9dXrLVW4LpU,3674
100
101
  wordlift_client/models/analyze_url_request.py,sha256=-NCLEKVLL2SzpdcGDzqy1gJLRywWvPfAeKzNTg0hagg,3196
101
102
  wordlift_client/models/anchor_text.py,sha256=O0vQxxJfMhzWZ66-39bilO_cc1v89iyMaypoeK3YrFQ,4364
102
103
  wordlift_client/models/annotation.py,sha256=HRjN8hQ-Xz-rUOdLYTgUhucJ-vDATKhFSj1wRFqBMtw,3795
@@ -282,8 +283,8 @@ wordlift_client/models/with_limits.py,sha256=rSzDb_If8APxR2Rw2U6cfFRFubnnai3Vj3-
282
283
  wordlift_client/models/word.py,sha256=FPCGb6ohwdfydE5_qG4PT-UrnMzaTktAWqEEnezwaso,3922
283
284
  wordlift_client/models/word_repetition_data.py,sha256=CQnxCnhakt12czl6a_AQIPgHlJtvR9YGBIjGV22rq14,2659
284
285
  wordlift_client/models/word_request.py,sha256=ZD13xNRYCZmF14jxEDrRRyEMAd-quDT-HsqkbUP_xWU,2627
285
- wordlift_client-1.133.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
286
- wordlift_client-1.133.0.dist-info/METADATA,sha256=1QN9WYq2Pl6vcfjnbD-p1Js9gY-5UAuHhVSJdSujDY0,530
287
- wordlift_client-1.133.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
288
- wordlift_client-1.133.0.dist-info/top_level.txt,sha256=p7KFYU869ksxkpP7ADvg8baPgWkTYCzcOpDl1qrJdHk,16
289
- wordlift_client-1.133.0.dist-info/RECORD,,
286
+ wordlift_client-1.134.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
287
+ wordlift_client-1.134.0.dist-info/METADATA,sha256=VQTsYbtG_0jQTtc3RPRUUzfqW16A655iMtpMswx6VaM,530
288
+ wordlift_client-1.134.0.dist-info/WHEEL,sha256=WnJ8fYhv8N4SYVK2lLYNI6N0kVATA7b0piVUNvqIIJE,91
289
+ wordlift_client-1.134.0.dist-info/top_level.txt,sha256=p7KFYU869ksxkpP7ADvg8baPgWkTYCzcOpDl1qrJdHk,16
290
+ wordlift_client-1.134.0.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (75.3.2)
2
+ Generator: setuptools (75.3.3)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5