fixing types

Author: Michael G

libs/langchain-tavily/src/utils.ts

@@ -26,7 +26,7 @@ export type TavilySearchParamsBase = {
   /**
    * The number of {@link TavilySearchResult.content} chunks to retrieve from each source.
    * Each chunk's length is maximum 500 characters. Available only when
-   * {@link TavilySearchParams.search_depth} is advanced.
+   * {@link TavilySearchParams.searchDepth} is advanced.
    *
    * @default 3
    */
@@ -108,21 +108,21 @@ export type TavilySearchParamsWithSimpleImages = TavilySearchParamsBase & {
    */
   includeImages?: boolean;
   /**
-   * When {@link TavilySearchParams.include_images} is true, also add a descriptive text for each
+   * When {@link TavilySearchParams.includeImages} is true, also add a descriptive text for each
    * image.
    *
    * @default false
    */
-  includeImageDescriptions?: false;
+  includeImageDescriptions?: boolean;
 };
 
 export type TavilySearchParamsWithImageDescriptions = TavilySearchParamsBase & {
   /**
    * Also perform an image search and include the results in the response.
    */
-  includeImages?: true;
+  includeImages?: boolean;
   /**
-   * When {@link TavilySearchParams.include_images} is true, also add a descriptive text for each
+   * When {@link TavilySearchParams.includeImages} is true, also add a descriptive text for each
    * image.
    */
   includeImageDescriptions?: true;
@@ -396,7 +396,7 @@ export type TavilyBaseSearchResponse = {
   query: string;
   /**
    * A short answer to the user's query, generated by an LLM. Included in the response only if
-   * {@link TavilySearchParams.include_answer} is requested (i.e., set to `true`, `"basic"`, or
+   * {@link TavilySearchParams.includeAnswer} is requested (i.e., set to `true`, `"basic"`, or
    * `"advanced"`).
    */
   answer?: string;
@@ -413,12 +413,12 @@ export type TavilyBaseSearchResponse = {
 
 /**
  * The shape of the response from the Tavily Search API when
- * {@link TavilySearchParams.include_image_descriptions} is true.
+ * {@link TavilySearchParams.includeImageDescriptions} is true.
  */
 export type TavilySearchResponseWithImageDescriptions =
   TavilyBaseSearchResponse & {
     /**
-     * List of query-related images. If {@link TavilySearchParams.include_image_descriptions} is
+     * List of query-related images. If {@link TavilySearchParams.includeImageDescriptions} is
      * `true`, each item will be an object with `url` and `description` properties. Otherwise, each
      * item will be a string containing the URL of the image.
      */
@@ -436,11 +436,11 @@ export type TavilySearchResponseWithImageDescriptions =
 
 /**
  * The shape of the response from the Tavily Search API when
- * {@link TavilySearchParams.include_image_descriptions} is `false` or unspecified.
+ * {@link TavilySearchParams.includeImageDescriptions} is `false` or unspecified.
  */
 export type TavilySearchResponseWithSimpleImages = TavilyBaseSearchResponse & {
   /**
-   * List of query-related images. If {@link TavilySearchParams.include_image_descriptions} is
+   * List of query-related images. If {@link TavilySearchParams.includeImageDescriptions} is
    * `true`, each item will be an object with `url` and `description` properties. Otherwise, each
    * item will be a string containing the URL of the image.
    */