Type Alias TavilySearchResponseWithSimpleImages

TavilySearchResponseWithSimpleImages: {
    answer?: undefined | string;
    auto_parameters?: undefined | Partial<TavilySearchParams>;
    images?: undefined | string[];
    query: string;
    response_time: number;
    results: TavilySearchResult[];
}

The shape of the response from the Tavily Search API when TavilySearchParams.includeImageDescriptions is false or unspecified.

Type declaration

  • Optionalanswer?: undefined | string

    A short answer to the user's query, generated by an LLM. Included in the response only if TavilySearchParams.includeAnswer is requested (i.e., set to true, "basic", or "advanced").

  • Optionalauto_parameters?: undefined | Partial<TavilySearchParams>

    The results from the search.

  • Optionalimages?: undefined | string[]

    List of query-related images. If 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.

  • query: string

    The search query that was executed.

  • response_time: number

    The response time of the search.

  • results: TavilySearchResult[]

Settings

Member Visibility