dataforseo-client 2.1.2 → 2.1.5

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsGoogleHistoricalSerpsLiveItem } from "./DataforseoLabsGoogleHistoricalSerpsLiveItem";
 export interface IDataforseoLabsGoogleHistoricalSerpsLiveResultInfo {
-    /** search engine type in a POST array */
+    /** *search engine type in a POST array* */
     se_type?: string | undefined;
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array*             **the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)** */
     keyword?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** historical SERPs and related data found in the database */
+    /** *historical SERPs and related data found in the database* */
     items?: DataforseoLabsGoogleHistoricalSerpsLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleHistoricalSerpsLiveResultInfo implements IDataforseoLabsGoogleHistoricalSerpsLiveResultInfo {
-    /** search engine type in a POST array */
+    /** *search engine type in a POST array* */
     se_type?: string | undefined;
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array*             **the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)** */
     keyword?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** historical SERPs and related data found in the database */
+    /** *historical SERPs and related data found in the database* */
     items?: DataforseoLabsGoogleHistoricalSerpsLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleHistoricalSerpsLiveResultInfo);

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

@@ -1,12 +1,12 @@
 import { DataforseoLabsGoogleHistoricalSerpsLiveResultInfo } from "./DataforseoLabsGoogleHistoricalSerpsLiveResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDataforseoLabsGoogleHistoricalSerpsLiveTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results the array includes objects with SERPs for each month within the specified time frame */
+    /** *array of results*             the array includes objects with SERPs for each month within the specified time frame */
     result?: DataforseoLabsGoogleHistoricalSerpsLiveResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleHistoricalSerpsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleHistoricalSerpsLiveTaskInfo {
-    /** array of results the array includes objects with SERPs for each month within the specified time frame */
+    /** *array of results*             the array includes objects with SERPs for each month within the specified time frame */
     result?: DataforseoLabsGoogleHistoricalSerpsLiveResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleHistoricalSerpsLiveTaskInfo);

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

@@ -15,7 +15,7 @@ export interface IDataforseoLabsGoogleKeywordIdeasLiveRequestInfo {
     ignore_synonyms?: boolean | undefined;
     /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to_`true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them)n */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
     /** *the maximum number of keywords in the results array* optional field default value: `700` maximum value: `1000` */
     limit?: number | undefined;
@@ -48,7 +48,7 @@ export declare class DataforseoLabsGoogleKeywordIdeasLiveRequestInfo implements
     ignore_synonyms?: boolean | undefined;
     /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to_`true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them)n */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
     /** *the maximum number of keywords in the results array* optional field default value: `700` maximum value: `1000` */
     limit?: number | undefined;

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

@@ -1,70 +1,70 @@
 export interface IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo {
-    /** keywordrequired fieldUTF-8 encodingthe keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:United Kingdom */
+    /** *full name of the location* optional field if you use this field, you don't need to specify `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:2840 */
+    /** *location code* optional field if you use this field, you don't need to specify `location_name` you can receive the list of available locations with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `2840` */
     location_code?: number | undefined;
-    /** full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *full name of the language* optional field if you use this field, you don't need to specify `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_name?: string | undefined;
-    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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 with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** include data for the seed keywordoptional fieldif set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the responsedefault value: false */
+    /** *include data for the seed keyword* optional field if set to `true`, data for the seed keyword specified in the `keyword` field will be provided in the `seed_keyword_data` array of the response default value: `false` */
     include_seed_keyword?: boolean | undefined;
-    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** search for the exact phraseoptional fieldif set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrasedefault value: false */
+    /** *search for the exact phrase* optional field if set to `true`, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: `false` */
     exact_match?: boolean | undefined;
-    /** ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded; default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
+    /** *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: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters example: `['keyword_info.search_volume','>',0]` `[['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']]``[['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending ordera comma is used as a separatorexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order a comma is used as a separator example: `['keyword_info.competition,desc']` default rule: `['keyword_info.search_volume,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_info.search_volume,desc','keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo implements IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo {
-    /** keywordrequired fieldUTF-8 encodingthe keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:United Kingdom */
+    /** *full name of the location* optional field if you use this field, you don't need to specify `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `United Kingdom` */
     location_name?: string | undefined;
-    /** location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:2840 */
+    /** *location code* optional field if you use this field, you don't need to specify `location_name` you can receive the list of available locations with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` ignore this field to get the results for all available locations example: `2840` */
     location_code?: number | undefined;
-    /** full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *full name of the language* optional field if you use this field, you don't need to specify `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_name?: string | undefined;
-    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** *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 with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` **Note:** if omitted, results default to the language with the most keyword records in the specified location; refer to the `available_languages.keywords` field of the [Locations and Languages endpoint](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** include data for the seed keywordoptional fieldif set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the responsedefault value: false */
+    /** *include data for the seed keyword* optional field if set to `true`, data for the seed keyword specified in the `keyword` field will be provided in the `seed_keyword_data` array of the response default value: `false` */
     include_seed_keyword?: boolean | undefined;
-    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** search for the exact phraseoptional fieldif set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrasedefault value: false */
+    /** *search for the exact phrase* optional field if set to `true`, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: `false` */
     exact_match?: boolean | undefined;
-    /** ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded; default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
+    /** *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: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`, as well as `ilike` and `not_ilike` to match any string of zero or more characters example: `['keyword_info.search_volume','>',0]` `[['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']]``[['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending ordera comma is used as a separatorexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order a comma is used as a separator example: `['keyword_info.competition,desc']` default rule: `['keyword_info.search_volume,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_info.search_volume,desc','keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo);

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

@@ -1,12 +1,12 @@
 import { DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo } from "./DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IDataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordSuggestionsLiveResponseInfo);

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

@@ -1,47 +1,47 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 export interface IDataforseoLabsGoogleKeywordSuggestionsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword in a POST array */
+    /** *keyword in a POST array* */
     seed_keyword?: string | undefined;
-    /** keyword data for the seed keywordfields in this object are identical to those of the items array */
+    /** *keyword data for the seed keyword* fields in this object are identical to those of the `items` array */
     seed_keyword_data?: KeywordDataInfo | undefined;
-    /** location code in a POST arrayif there is no data, then the value is_nulln */
+    /** *location code in a POST array* if there is no data, then the value is_`null`n */
     location_code?: number | undefined;
-    /** language code in a POST arrayif there is no data, then the value is_nulln */
+    /** *language code in a POST array* if there is no data, then the value is_`null`n */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keywords and related data */
+    /** *contains keywords and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo implements IDataforseoLabsGoogleKeywordSuggestionsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword in a POST array */
+    /** *keyword in a POST array* */
     seed_keyword?: string | undefined;
-    /** keyword data for the seed keywordfields in this object are identical to those of the items array */
+    /** *keyword data for the seed keyword* fields in this object are identical to those of the `items` array */
     seed_keyword_data?: KeywordDataInfo | undefined;
-    /** location code in a POST arrayif there is no data, then the value is_nulln */
+    /** *location code in a POST array* if there is no data, then the value is_`null`n */
     location_code?: number | undefined;
-    /** language code in a POST arrayif there is no data, then the value is_nulln */
+    /** *language code in a POST array* if there is no data, then the value is_`null`n */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keywords and related data */
+    /** *contains keywords and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordSuggestionsLiveResultInfo);

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

@@ -1,12 +1,12 @@
 import { DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo } from "./DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IDataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordSuggestionsLiveTaskInfo);

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

@@ -1,66 +1,66 @@
 export interface IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
-    /** product and service categoriesrequired fieldThe maximum number of categories you can specify: 20you can download the full list of possible categories */
+    /** *product and service categories* **required field** The maximum number of categories you can specify: 20 you can download [the full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     category_codes?: string[] | undefined;
-    /** full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:United Kingdom */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     location_name?: string | undefined;
-    /** unique location identifierrequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840 */
+    /** *unique location identifier* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `2840` */
     location_code?: number | undefined;
-    /** full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** unique language identifierrequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:en */
+    /** *unique language identifier* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** category intersectionsoptional fieldif set to true, you will get keywords featured in all specified categories;if set to false, you will keywords that are specified in any of the specified categories;default value: true */
+    /** *category intersections* optional field if set to `true`, you will get keywords featured in all specified categories; if set to `false`, you will keywords that are specified in any of the specified categories; default value: `true` */
     category_intersection?: boolean | undefined;
-    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded; default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
+    /** *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: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`,as well as `ilike`, `not_ilike` to match any string of zero or more characters example: `['keyword_info.search_volume','>',0]` `[['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']]` `[['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.competition,asc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['keyword_info.competition,desc']` default rule: `['keyword_info.search_volume,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_info.search_volume,desc','keyword_info.competition,asc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo {
-    /** product and service categoriesrequired fieldThe maximum number of categories you can specify: 20you can download the full list of possible categories */
+    /** *product and service categories* **required field** The maximum number of categories you can specify: 20 you can download [the full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     category_codes?: string[] | undefined;
-    /** full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:United Kingdom */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     location_name?: string | undefined;
-    /** unique location identifierrequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:2840 */
+    /** *unique location identifier* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `2840` */
     location_code?: number | undefined;
-    /** full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** unique language identifierrequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:en */
+    /** *unique language identifier* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** category intersectionsoptional fieldif set to true, you will get keywords featured in all specified categories;if set to false, you will keywords that are specified in any of the specified categories;default value: true */
+    /** *category intersections* optional field if set to `true`, you will get keywords featured in all specified categories; if set to `false`, you will keywords that are specified in any of the specified categories; default value: `true` */
     category_intersection?: boolean | undefined;
-    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | undefined;
-    /** ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded;default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded; default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** the maximum number of keywords in the results arrayoptional fielddefault value: 100maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords **Note:** we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the `offset_token` instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
+    /** *offset token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique `offset_token` value from the response array, you will get the subsequent results of the initial task; `offset_token` values are unique for each subsequent task **Note:** if the `offset_token` is specified in the request, all other parameters except `limit` will not be taken into account when processing a task. learn more about this parameter on our [Help Center](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: string | undefined;
-    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
+    /** *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: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `match`, `not_match`, `ilike`, `not_ilike`, `like`, `not_like` you can use the `%` operator with `like` and `not_like`,as well as `ilike`, `not_ilike` to match any string of zero or more characters example: `['keyword_info.search_volume','>',0]` `[['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']]` `[['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.competition,asc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['keyword_info.competition,desc']` default rule: `['keyword_info.search_volume,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_info.search_volume,desc','keyword_info.competition,asc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForCategoriesLiveRequestInfo);

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

@@ -1,12 +1,12 @@
 import { DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo } from "./DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IDataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: DataforseoLabsGoogleKeywordsForCategoriesLiveTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForCategoriesLiveResponseInfo);

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

@@ -1,43 +1,43 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 export interface IDataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** categories in a POST array */
+    /** *categories in a POST array* */
     seed_categories?: number[] | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo implements IDataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** categories in a POST array */
+    /** *categories in a POST array* */
     seed_categories?: number[] | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *current offset value* */
     offset?: number | undefined;
-    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
+    /** *offset token for subsequent requests* you can use the string provided in this field to get the subsequent results of the initial task; **note:** `offset_token` values are unique for each subsequent task */
     offset_token?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordsForCategoriesLiveResultInfo);