dataforseo-client 2.1.2 → 2.1.5

package/dist/esm/models/AiOptimizationGeminiLlmScraperTaskPostTaskInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"AiOptimizationGeminiLlmScraperTaskPostTaskInfo.js","sourceRoot":"","sources":["../../../src/models/AiOptimizationGeminiLlmScraperTaskPostTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAWrF,MAAM,OAAO,8CAAgD,SAAQ,oBAAoB;IAOrF,YAAY,IAAsD;QAClE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8CAA8C,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"AiOptimizationGeminiLlmScraperTaskPostTaskInfo.js","sourceRoot":"","sources":["../../../src/models/AiOptimizationGeminiLlmScraperTaskPostTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAYrF,MAAM,OAAO,8CAAgD,SAAQ,oBAAoB;IAUrF,YAAY,IAAsD;QAClE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8CAA8C,EAAE,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

package/dist/esm/models/AiOptimizationLlmMentionsMultiTargetMetricsLiveItem.d.ts

@@ -11,11 +11,11 @@ export interface IAiOptimizationLlmMentionsMultiTargetMetricsLiveItem {
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *data on total mentions and search volume for the target* */
     total?: AggregatedMetricsInfoTotalInfo | undefined;
@@ -32,11 +32,11 @@ export declare class AiOptimizationLlmMentionsMultiTargetMetricsLiveItem impleme
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *data on total mentions and search volume for the target* */
     total?: AggregatedMetricsInfoTotalInfo | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsSearchMentionsLiveItem.d.ts

@@ -17,7 +17,7 @@ export interface IAiOptimizationLlmMentionsSearchMentionsLiveItem {
     answer?: string | undefined;
     /** *array of sources* the sources the model cited or relied on in its final answer learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources?: Sources[] | undefined;
-    /** *array of search results* all web search outputs the model retrieved when looking up information, including duplicates and unused entries */
+    /** *array of search results* all web search outputs the model retrieved when looking up information, including duplicates and unused entries **Note:** available only for `chat_gpt` */
     search_results?: SearchResults[] | undefined;
     /** *current AI search volume rate of a keyword* learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions) */
     ai_search_volume?: number | undefined;
@@ -27,9 +27,9 @@ export interface IAiOptimizationLlmMentionsSearchMentionsLiveItem {
     first_response_at?: string | undefined;
     /** *date and time when the response data was last updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2025-10-21 06:25:30 +00:00` */
     last_response_at?: string | undefined;
-    /** *array of brand entities* contains information on brands mentioned in the response */
+    /** *array of brand entities* contains information on brands mentioned in the response **Note:** available only for `chat_gpt` */
     brand_entities?: BrandEntities[] | undefined;
-    /** *array of fan-out queries* contains related search queries derived from the main query to provide a more comprehensive response */
+    /** *array of fan-out queries* contains related search queries derived from the main query to provide a more comprehensive response **Note:** available only for `chat_gpt` */
     fan_out_queries?: string[] | undefined;
     /** *indicates whether the response was generated using web search results* if `true`, the model retrieved live web search results to produce the response if `false`, the response was generated from the model's internal knowledge */
     is_web_search_based?: boolean | undefined;
@@ -50,7 +50,7 @@ export declare class AiOptimizationLlmMentionsSearchMentionsLiveItem implements
     answer?: string | undefined;
     /** *array of sources* the sources the model cited or relied on in its final answer learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources?: Sources[] | undefined;
-    /** *array of search results* all web search outputs the model retrieved when looking up information, including duplicates and unused entries */
+    /** *array of search results* all web search outputs the model retrieved when looking up information, including duplicates and unused entries **Note:** available only for `chat_gpt` */
     search_results?: SearchResults[] | undefined;
     /** *current AI search volume rate of a keyword* learn more about this metric [here](https://dataforseo.com/help-center/how-the-ai-search-volume-metric-works-in-llm-mentions) */
     ai_search_volume?: number | undefined;
@@ -60,9 +60,9 @@ export declare class AiOptimizationLlmMentionsSearchMentionsLiveItem implements
     first_response_at?: string | undefined;
     /** *date and time when the response data was last updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2025-10-21 06:25:30 +00:00` */
     last_response_at?: string | undefined;
-    /** *array of brand entities* contains information on brands mentioned in the response */
+    /** *array of brand entities* contains information on brands mentioned in the response **Note:** available only for `chat_gpt` */
     brand_entities?: BrandEntities[] | undefined;
-    /** *array of fan-out queries* contains related search queries derived from the main query to provide a more comprehensive response */
+    /** *array of fan-out queries* contains related search queries derived from the main query to provide a more comprehensive response **Note:** available only for `chat_gpt` */
     fan_out_queries?: string[] | undefined;
     /** *indicates whether the response was generated using web search results* if `true`, the model retrieved live web search results to produce the response if `false`, the response was generated from the model's internal knowledge */
     is_web_search_based?: boolean | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveRequestInfo.d.ts

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiveRe
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiteLiv
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveRequestInfo.d.ts

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveReques
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandCategoriesLiveReq
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo.d.ts

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>', 1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestI
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>', 1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo.d.ts

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo {
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequestInfo.d.ts

@@ -12,7 +12,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequestInf
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; **Note:** if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -47,7 +47,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedDomainsLiteLiveRequest
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; **Note:** if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedDomainsLiveItem.d.ts

@@ -11,11 +11,11 @@ export interface IAiOptimizationLlmMentionsTopMentionedDomainsLiveItem {
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all dimensions */
     total?: AggregatedMetricsInfoTotalInfo | undefined;
@@ -32,11 +32,11 @@ export declare class AiOptimizationLlmMentionsTopMentionedDomainsLiveItem implem
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all dimensions */
     total?: AggregatedMetricsInfoTotalInfo | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo.d.ts

@@ -12,7 +12,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo {
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` **Note:**if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -47,7 +47,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedDomainsLiveRequestInfo
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` **Note:**if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestInfo.d.ts

@@ -12,7 +12,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestInfo
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; ; **Note:** if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -47,7 +47,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedPagesLiteLiveRequestIn
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; ; **Note:** if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedPagesLiveItem.d.ts

@@ -11,11 +11,11 @@ export interface IAiOptimizationLlmMentionsTopMentionedPagesLiveItem {
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all dimensions */
     total?: AggregatedMetricsInfoTotalInfo | undefined;
@@ -32,11 +32,11 @@ export declare class AiOptimizationLlmMentionsTopMentionedPagesLiveItem implemen
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all dimensions */
     total?: AggregatedMetricsInfoTotalInfo | undefined;

package/dist/esm/models/AiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo.d.ts

@@ -12,7 +12,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo {
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; **Note:**if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -47,7 +47,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedPagesLiveRequestInfo i
     language_code?: string | undefined;
     /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
-    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources` */
+    /** *links source scope* optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: `sources`, `search_results` default value: `sources`; **Note:**if you specify `search_results`, the data will be available for `chat_gpt` only */
     links_scope?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

package/dist/esm/models/AiOverviewElement.d.ts

@@ -3,26 +3,26 @@ import { AiModeAiOverviewReferenceInfo } from "./AiModeAiOverviewReferenceInfo";
 export interface IAiOverviewElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** content within the item */
+    /** *content within the item* */
     text?: string | undefined;
-    /** images of the element */
+    /** *images of the element* */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
 }
 export declare class AiOverviewElement implements IAiOverviewElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** content within the item */
+    /** *content within the item* */
     text?: string | undefined;
-    /** images of the element */
+    /** *images of the element* */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IAiOverviewElement);

package/dist/esm/models/AiOverviewExpandedComponent.d.ts

@@ -4,34 +4,34 @@ import { AiModeAiOverviewReferenceInfo } from "./AiModeAiOverviewReferenceInfo";
 export interface IAiOverviewExpandedComponent {
     /** type of element */
     type?: string | undefined;
-    /** reference page title */
+    /** *reference page title* */
     title?: string | undefined;
-    /** reference text text snippet from the page that was used to generate the ai_overview_element */
+    /** *reference text* text snippet from the page that was used to generate the `ai_overview_element` */
     text?: string | undefined;
-    /** content of the element in markdown format */
+    /** *content of the element in markdown format* */
     markdown?: string | undefined;
-    /** images of the element if there is none, equals null */
+    /** *images of the element* if there is none, equals `null` */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** sitelinks the links shown below some of Google’s search results if there are none, equals null */
+    /** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
     links?: LinkElement[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
 }
 export declare class AiOverviewExpandedComponent implements IAiOverviewExpandedComponent {
     /** type of element */
     type?: string | undefined;
-    /** reference page title */
+    /** *reference page title* */
     title?: string | undefined;
-    /** reference text text snippet from the page that was used to generate the ai_overview_element */
+    /** *reference text* text snippet from the page that was used to generate the `ai_overview_element` */
     text?: string | undefined;
-    /** content of the element in markdown format */
+    /** *content of the element in markdown format* */
     markdown?: string | undefined;
-    /** images of the element if there is none, equals null */
+    /** *images of the element* if there is none, equals `null` */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** sitelinks the links shown below some of Google’s search results if there are none, equals null */
+    /** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
     links?: LinkElement[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IAiOverviewExpandedComponent);

package/dist/esm/models/AmazonInfo.d.ts

@@ -1,85 +1,85 @@
 import { RatingInfo } from "./RatingInfo";
 import { AmazonDeliveryInfo } from "./AmazonDeliveryInfo";
 export interface IAmazonInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *position within a group of elements with identical `type` values* positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in Amazon SERP absolute position among all the elements in SERP */
+    /** *absolute rank in Amazon SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Amazon SERP can take the following values: left, right */
+    /** *the alignment of the element in Amazon SERP* can take the following values: `left`, `right` */
     position?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** Amazon domain */
+    /** *Amazon domain* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** URL of the product page */
+    /** *URL of the product page* */
     url?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** URL of the product image featured in the results */
+    /** *URL of the product image featured in the results* */
     image_url?: string | undefined;
-    /** the regular price of a product example: 49.98 */
+    /** *the regular price of a product* example: `49.98` */
     price_from?: number | undefined;
-    /** the upper limit of the product price range example: 384.99 */
+    /** *the upper limit of the product price range* example: `384.99` */
     price_to?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** special offer details contains special offer details, including coupon and Subscribe & Save discounts */
+    /** *special offer details* contains special offer details, including coupon and Subscribe & Save discounts */
     special_offers?: string[] | undefined;
-    /** “Best Seller” label if the value is true, the product is marked with the “Best Seller” label */
+    /** *'Best Seller' label* if the value is `true`, the product is marked with the 'Best Seller' label */
     is_best_seller?: boolean | undefined;
-    /** “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label */
+    /** *'Amazon's choice' label* if the value is `true`, the product is marked with the 'Amazon's choice' label */
     is_amazon_choice?: boolean | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** delivery information delivery information including free and fast delivery date ranges */
+    /** *delivery information* delivery information including free and fast delivery date ranges */
     delivery_info?: AmazonDeliveryInfo | undefined;
     bought_past_month?: number | undefined;
     [key: string]: any;
 }
 export declare class AmazonInfo implements IAmazonInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *position within a group of elements with identical `type` values* positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in Amazon SERP absolute position among all the elements in SERP */
+    /** *absolute rank in Amazon SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Amazon SERP can take the following values: left, right */
+    /** *the alignment of the element in Amazon SERP* can take the following values: `left`, `right` */
     position?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** Amazon domain */
+    /** *Amazon domain* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** URL of the product page */
+    /** *URL of the product page* */
     url?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** URL of the product image featured in the results */
+    /** *URL of the product image featured in the results* */
     image_url?: string | undefined;
-    /** the regular price of a product example: 49.98 */
+    /** *the regular price of a product* example: `49.98` */
     price_from?: number | undefined;
-    /** the upper limit of the product price range example: 384.99 */
+    /** *the upper limit of the product price range* example: `384.99` */
     price_to?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** special offer details contains special offer details, including coupon and Subscribe & Save discounts */
+    /** *special offer details* contains special offer details, including coupon and Subscribe & Save discounts */
     special_offers?: string[] | undefined;
-    /** “Best Seller” label if the value is true, the product is marked with the “Best Seller” label */
+    /** *'Best Seller' label* if the value is `true`, the product is marked with the 'Best Seller' label */
     is_best_seller?: boolean | undefined;
-    /** “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label */
+    /** *'Amazon's choice' label* if the value is `true`, the product is marked with the 'Amazon's choice' label */
     is_amazon_choice?: boolean | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** delivery information delivery information including free and fast delivery date ranges */
+    /** *delivery information* delivery information including free and fast delivery date ranges */
     delivery_info?: AmazonDeliveryInfo | undefined;
     bought_past_month?: number | undefined;
     [key: string]: any;