release version 2.1.1

Author: dfs-lvics

dataforseo_client/api/serp_api.py

@@ -17,6 +17,7 @@
     from dataforseo_client.models.serp_google_locations_country_response_info import SerpGoogleLocationsCountryResponseInfo
     from dataforseo_client.models.serp_google_languages_response_info import SerpGoogleLanguagesResponseInfo
     from dataforseo_client.models.serp_google_organic_task_post_request_info import SerpGoogleOrganicTaskPostRequestInfo
+    from dataforseo_client.models.serp_api_stop_crawl_on_match_info import SerpApiStopCrawlOnMatchInfo
     from dataforseo_client.models.serp_google_organic_task_post_response_info import SerpGoogleOrganicTaskPostResponseInfo
     from dataforseo_client.models.serp_google_organic_tasks_ready_response_info import SerpGoogleOrganicTasksReadyResponseInfo
     from dataforseo_client.models.serp_tasks_ready_response_info import SerpTasksReadyResponseInfo
@@ -131,7 +132,6 @@
     from dataforseo_client.models.serp_bing_locations_country_response_info import SerpBingLocationsCountryResponseInfo
     from dataforseo_client.models.serp_bing_languages_response_info import SerpBingLanguagesResponseInfo
     from dataforseo_client.models.serp_bing_organic_task_post_request_info import SerpBingOrganicTaskPostRequestInfo
-    from dataforseo_client.models.serp_api_stop_crawl_on_match_info import SerpApiStopCrawlOnMatchInfo
     from dataforseo_client.models.serp_bing_organic_task_post_response_info import SerpBingOrganicTaskPostResponseInfo
     from dataforseo_client.models.serp_bing_organic_tasks_ready_response_info import SerpBingOrganicTasksReadyResponseInfo
     from dataforseo_client.models.serp_bing_organic_tasks_fixed_response_info import SerpBingOrganicTasksFixedResponseInfo

dataforseo_client/api_client.py

@@ -62,7 +62,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'python-client/2.1.0'
+        self.user_agent = 'python-client/2.1.1'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

dataforseo_client/models/aggregated_metrics_info_total_info.py

@@ -15,8 +15,8 @@ class AggregatedMetricsInfoTotalInfo(BaseModel):
     """
     AggregatedMetricsInfoTotalInfo
     """ # noqa: E501
-    mentions: Optional[StrictInt] = Field(default=None, description=r"total LLM mentions count. the number of times the target keyword or domain were mentioned in relation to this specific grouping key")
-    ai_search_volume: Optional[StrictInt] = Field(default=None, description=r"aggregated AI search volume for mentions within this grouping. learn more about this metric here")
+    mentions: Optional[StrictInt] = Field(default=None, description=r"*total LLM mentions count*. the number of times the target keyword or domain were mentioned in relation to this specific grouping key")
+    ai_search_volume: Optional[StrictInt] = Field(default=None, description=r"*aggregated AI search volume for mentions within this grouping*. learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions)")
     __properties: ClassVar[List[str]] = [
         "mentions", 
         "ai_search_volume", 

dataforseo_client/models/aggregated_metrics_item_info.py

@@ -15,9 +15,9 @@ class AggregatedMetricsItemInfo(BaseModel):
     """
     AggregatedMetricsItemInfo
     """ # noqa: E501
-    key: Optional[StrictStr] = Field(default=None, description=r"grouping identifier. the specific identifier for the grouping dimension")
-    mentions: Optional[StrictInt] = Field(default=None, description=r"total LLM mentions count. the number of times the target keyword or domain were mentioned in relation to this specific grouping key")
-    ai_search_volume: Optional[StrictInt] = Field(default=None, description=r"aggregated AI search volume for mentions within this grouping. learn more about this metric here")
+    key: Optional[StrictStr] = Field(default=None, description=r"*grouping identifier*. the specific identifier for the grouping dimension")
+    mentions: Optional[StrictInt] = Field(default=None, description=r"*total LLM mentions count*. the number of times the target keyword or domain were mentioned in relation to this specific grouping key")
+    ai_search_volume: Optional[StrictInt] = Field(default=None, description=r"*aggregated AI search volume for mentions within this grouping*. learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions)")
     __properties: ClassVar[List[str]] = [
         "key", 
         "mentions", 

dataforseo_client/models/ai_mode_ai_overview_expanded_component_info.py

@@ -19,12 +19,12 @@ class AiModeAiOverviewExpandedComponentInfo(BaseModel):
     AiModeAiOverviewExpandedComponentInfo
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    title: Optional[StrictStr] = Field(default=None, description=r"reference page title")
-    text: Optional[StrictStr] = Field(default=None, description=r"additional text of the element in SERP")
-    markdown: Optional[StrictStr] = Field(default=None, description=r"content of the element in markdown format")
-    images: Optional[List[Optional[AiModeImagesElementInfo]]] = Field(default=None, description=r"images of the componentif there are none, equals null")
-    links: Optional[List[Optional[AiModeLinkElementInfo]]] = Field(default=None, description=r"sitelinksthe links shown below some of Google's search resultsif there are none, equals null")
-    references: Optional[List[Optional[AiModeAiOverviewReferenceInfo]]] = Field(default=None, description=r"references relevant to the elementincludes references to webpages that were used to generate the ai_overview_element")
+    title: Optional[StrictStr] = Field(default=None, description=r"*reference page title*")
+    text: Optional[StrictStr] = Field(default=None, description=r"*additional text of the element in SERP*")
+    markdown: Optional[StrictStr] = Field(default=None, description=r"*content of the element in markdown format*")
+    images: Optional[List[Optional[AiModeImagesElementInfo]]] = Field(default=None, description=r"*images of the component*. if there are none, equals `null`")
+    links: Optional[List[Optional[AiModeLinkElementInfo]]] = Field(default=None, description=r"*sitelinks*. the links shown below some of Google's search results. if there are none, equals `null`")
+    references: Optional[List[Optional[AiModeAiOverviewReferenceInfo]]] = Field(default=None, description=r"*references relevant to the element*. includes references to webpages that were used to generate the `ai_overview_element`")
     __properties: ClassVar[List[str]] = [
         "type", 
         "title", 

dataforseo_client/models/ai_mode_ai_overview_info.py

@@ -19,15 +19,15 @@ class AiModeAiOverviewInfo(BaseModel):
     AiModeAiOverviewInfo
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    rank_group: Optional[StrictInt] = Field(default=None, description=r"group rank in SERPposition within a group of elements with identical type valuespositions of elements with different type values are omitted from rank_group")
-    rank_absolute: Optional[StrictInt] = Field(default=None, description=r"absolute rank in SERPabsolute position among all the elements in SERP")
-    page: Optional[StrictInt] = Field(default=None, description=r"SERP pageSERP page on which the element ranks")
-    position: Optional[StrictStr] = Field(default=None, description=r"the alignment of the element in SERPcan take the following values:left, right")
-    xpath: Optional[StrictStr] = Field(default=None, description=r"the XPath of the element")
-    markdown: Optional[StrictStr] = Field(default=None, description=r"content of the element in markdown formatthe text of the ai_overview formatted in the markdown markup language")
-    items: Optional[List[Optional[BaseSerpApiAiModeAiOverviewElementItem]]] = Field(default=None, description=r"elements of search results found in SERP")
-    references: Optional[List[Optional[AiModeAiOverviewReferenceInfo]]] = Field(default=None, description=r"additional references relevant to the itemincludes references to webpages that may have been used to generate the ai_overview")
-    rectangle: Optional[AiModeRectangleInfo] = Field(default=None, description=r"rectangle parameterscontains cartesian coordinates and pixel dimensions of the result's snippet in SERPequals null if calculate_rectangles in the POST request is not set to true")
+    rank_group: Optional[StrictInt] = Field(default=None, description=r"*group rank in SERP*. position within a group of elements with identical `type` values. positions of elements with different `type` values are omitted from `rank_group`")
+    rank_absolute: Optional[StrictInt] = Field(default=None, description=r"*absolute rank in SERP*. absolute position among all the elements in SERP")
+    page: Optional[StrictInt] = Field(default=None, description=r"*SERP page*. SERP page on which the element ranks")
+    position: Optional[StrictStr] = Field(default=None, description=r"*the alignment of the element in SERP*. can take the following values:. `left`, `right`")
+    xpath: Optional[StrictStr] = Field(default=None, description=r"*the [XPath](https://en.wikipedia.org/wiki/XPath) of the element*")
+    markdown: Optional[StrictStr] = Field(default=None, description=r"*content of the element in markdown format*. the text of the `ai_overview` formatted in the [markdown markup language](https://en.wikipedia.org/wiki/Markdown)")
+    items: Optional[List[Optional[BaseSerpApiAiModeAiOverviewElementItem]]] = Field(default=None, description=r"*items present in the element*")
+    references: Optional[List[Optional[AiModeAiOverviewReferenceInfo]]] = Field(default=None, description=r"*additional references relevant to the item*. includes references to webpages that may have been used to generate the `ai_overview`")
+    rectangle: Optional[AiModeRectangleInfo] = Field(default=None, description=r"*rectangle parameters*. contains cartesian coordinates and pixel dimensions of the result's snippet in SERP. equals `null` if `calculate_rectangles` in the POST request is not set to `true`")
     __properties: ClassVar[List[str]] = [
         "type", 
         "rank_group", 

dataforseo_client/models/ai_mode_ai_overview_paid_element_info.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set, Any, Dict, List
+from typing_extensions import Self
+
+from dataforseo_client.models.ai_mode_images_element_info import AiModeImagesElementInfo
+
+
+
+class AiModeAiOverviewPaidElementInfo(BaseModel):
+    """
+    AiModeAiOverviewPaidElementInfo
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description=r"type of element")
+    title: Optional[StrictStr] = Field(default=None, description=r"*title of the element in SERP*")
+    url: Optional[StrictStr] = Field(default=None, description=r"*reference page URL*")
+    domain: Optional[StrictStr] = Field(default=None, description=r"*domain name of the reference*")
+    ad_aclk: Optional[StrictStr] = Field(default=None, description=r"*unique ad click referral parameter*. using this parameter you can get a URL of the advertisement in [Google Shopping Sellers Ad URL](https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/)")
+    website_name: Optional[StrictStr] = Field(default=None, description=r"*displayed name of the advertiser's website*")
+    breadcrumb: Optional[StrictStr] = Field(default=None, description=r"*breadcrumb path displayed in the ad*")
+    snippet: Optional[StrictStr] = Field(default=None, description=r"*description text of the ad*")
+    images: Optional[List[Optional[AiModeImagesElementInfo]]] = Field(default=None, description=r"*images present in the ad*. if there are none, equals `null`")
+    __properties: ClassVar[List[str]] = [
+        "type", 
+        "title", 
+        "url", 
+        "domain", 
+        "ad_aclk", 
+        "website_name", 
+        "breadcrumb", 
+        "snippet", 
+        "images", 
+        ]
+
+    additional_properties: Dict[str, Any] = Field(default_factory=dict)
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = {}
+
+        _dict['type'] = self.type
+        _dict['title'] = self.title
+        _dict['url'] = self.url
+        _dict['domain'] = self.domain
+        _dict['ad_aclk'] = self.ad_aclk
+        _dict['website_name'] = self.website_name
+        _dict['breadcrumb'] = self.breadcrumb
+        _dict['snippet'] = self.snippet
+        images_items = []
+        if self.images:
+            for _item in self.images:
+                if _item:
+                    images_items.append(_item.to_dict())
+            _dict['images'] = images_items
+        return _dict
+
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "title": obj.get("title"),
+            "url": obj.get("url"),
+            "domain": obj.get("domain"),
+            "ad_aclk": obj.get("ad_aclk"),
+            "website_name": obj.get("website_name"),
+            "breadcrumb": obj.get("breadcrumb"),
+            "snippet": obj.get("snippet"),
+            "images": [AiModeImagesElementInfo.from_dict(_item) for _item in obj["images"]] if obj.get("images") is not None else None,
+        })
+
+        additional_properties = {k: v for k, v in obj.items() if k not in cls.__properties}
+        _obj.additional_properties = additional_properties
+        return _obj

dataforseo_client/models/ai_mode_ai_overview_shopping_element_info.py

@@ -18,19 +18,19 @@ class AiModeAiOverviewShoppingElementInfo(BaseModel):
     AiModeAiOverviewShoppingElementInfo
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    product_id: Optional[StrictStr] = Field(default=None, description=r"unique product identifier on Google Shoppinglearn more about the parameter in this help center guide")
-    data_docid: Optional[StrictStr] = Field(default=None, description=r"unique identifier of the SERP data element")
-    gid: Optional[StrictStr] = Field(default=None, description=r"global product identifier on Google Shoppinglearn more about the parameter in this help center guide")
-    title: Optional[StrictStr] = Field(default=None, description=r"reference page title")
-    url: Optional[StrictStr] = Field(default=None, description=r"URL in link")
-    domain: Optional[StrictStr] = Field(default=None, description=r"domain in link")
-    rating: Optional[RatingInfo] = Field(default=None, description=r"product rating the popularity rate based on reviews if there is none, the value will be null")
-    price: Optional[PriceInfo] = Field(default=None, description=r"product priceproduct price details on the seller's website; if there is none, the value will be null")
-    seller: Optional[StrictStr] = Field(default=None, description=r"product sellername of the product's seller as displayed in search results")
-    snippet: Optional[StrictStr] = Field(default=None, description=r"additional information about the result")
-    marketplace: Optional[StrictStr] = Field(default=None, description=r"merchant account providere-commerce site that hosts products or websites of individual sellers under the same merchant accountexample:by Google")
-    marketplace_url: Optional[StrictStr] = Field(default=None, description=r"URL to the merchant account providere-commerce site that hosts products or websites of individual sellers under the same merchant account")
-    image_url: Optional[StrictStr] = Field(default=None, description=r"URL of the imagethe URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)")
+    product_id: Optional[StrictStr] = Field(default=None, description=r"*unique product identifier on Google Shopping*. learn more about the parameter in [this help center guide](https://dataforseo.com/help-center/product-id-google-shopping)")
+    data_docid: Optional[StrictStr] = Field(default=None, description=r"*unique identifier of the SERP data element*")
+    gid: Optional[StrictStr] = Field(default=None, description=r"*global product identifier on Google Shopping*. learn more about the parameter in [this help center guide](https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api)")
+    title: Optional[StrictStr] = Field(default=None, description=r"*reference page title*")
+    url: Optional[StrictStr] = Field(default=None, description=r"*URL in link*")
+    domain: Optional[StrictStr] = Field(default=None, description=r"*domain in link*")
+    rating: Optional[RatingInfo] = Field(default=None, description=r"*product rating*. the popularity rate based on reviews.  if there is none, the value will be `null`")
+    price: Optional[PriceInfo] = Field(default=None, description=r"*product price*. product price details on the seller's website;.  if there is none, the value will be `null`")
+    seller: Optional[StrictStr] = Field(default=None, description=r"*product seller*. name of the product's seller as displayed in search results")
+    snippet: Optional[StrictStr] = Field(default=None, description=r"*additional information about the result*")
+    marketplace: Optional[StrictStr] = Field(default=None, description=r"*merchant account provider*. e-commerce site that hosts products or websites of individual sellers under the same merchant account. example:. `by Google`")
+    marketplace_url: Optional[StrictStr] = Field(default=None, description=r"*URL to the merchant account provider*. e-commerce site that hosts products or websites of individual sellers under the same merchant account")
+    image_url: Optional[StrictStr] = Field(default=None, description=r"*URL of the image*. the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)")
     __properties: ClassVar[List[str]] = [
         "type", 
         "product_id", 

dataforseo_client/models/ai_mode_link_element_info.py

@@ -16,10 +16,10 @@ class AiModeLinkElementInfo(BaseModel):
     AiModeLinkElementInfo
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default=None, description=r"type of element")
-    title: Optional[StrictStr] = Field(default=None, description=r"title of the element")
-    description: Optional[StrictStr] = Field(default=None, description=r"link description")
-    url: Optional[StrictStr] = Field(default=None, description=r"search URL with refinement parameters")
-    domain: Optional[StrictStr] = Field(default=None, description=r"domain in SERP")
+    title: Optional[StrictStr] = Field(default=None, description=r"*title of the element*")
+    description: Optional[StrictStr] = Field(default=None, description=r"*link description*")
+    url: Optional[StrictStr] = Field(default=None, description=r"*search URL with refinement parameters*")
+    domain: Optional[StrictStr] = Field(default=None, description=r"*domain in SERP*")
     __properties: ClassVar[List[str]] = [
         "type", 
         "title",