langchain_community.utilities.tavily_search.TavilySearchAPIWrapperΒΆ

class langchain_community.utilities.tavily_search.TavilySearchAPIWrapper[source]ΒΆ

Bases: BaseModel

Wrapper for Tavily Search API.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param tavily_api_key: SecretStr [Required]ΒΆ
Constraints
  • type = string

  • writeOnly = True

  • format = password

clean_results(results: List[Dict]) List[Dict][source]ΒΆ

Clean results from Tavily Search API.

Parameters

results (List[Dict]) –

Return type

List[Dict]

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) ModelΒΆ

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = β€˜allow’ was set since it adds all passed values

Parameters
  • _fields_set (Optional[SetStr]) –

  • values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) ModelΒΆ

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters
  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

  • update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep (bool) – set to True to make a deep copy of the model

  • self (Model) –

Returns

new model instance

Return type

Model

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAnyΒΆ

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters
  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

Return type

DictStrAny

classmethod from_orm(obj: Any) ModelΒΆ
Parameters

obj (Any) –

Return type

Model

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicodeΒΆ

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters
  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

  • encoder (Optional[Callable[[Any], Any]]) –

  • models_as_dict (bool) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) ModelΒΆ
Parameters
  • path (Union[str, Path]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) ModelΒΆ
Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) ModelΒΆ
Parameters
  • b (Union[str, bytes]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

raw_results(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) Dict[source]ΒΆ
Parameters
  • query (str) –

  • max_results (Optional[int]) –

  • search_depth (Optional[str]) –

  • include_domains (Optional[List[str]]) –

  • exclude_domains (Optional[List[str]]) –

  • include_answer (Optional[bool]) –

  • include_raw_content (Optional[bool]) –

  • include_images (Optional[bool]) –

Return type

Dict

async raw_results_async(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) Dict[source]ΒΆ

Get results from the Tavily Search API asynchronously.

Parameters
  • query (str) –

  • max_results (Optional[int]) –

  • search_depth (Optional[str]) –

  • include_domains (Optional[List[str]]) –

  • exclude_domains (Optional[List[str]]) –

  • include_answer (Optional[bool]) –

  • include_raw_content (Optional[bool]) –

  • include_images (Optional[bool]) –

Return type

Dict

results(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) List[Dict][source]ΒΆ

Run query through Tavily Search and return metadata.

Parameters
  • query (str) – The query to search for.

  • max_results (Optional[int]) – The maximum number of results to return.

  • search_depth (Optional[str]) – The depth of the search. Can be β€œbasic” or β€œadvanced”.

  • include_domains (Optional[List[str]]) – A list of domains to include in the search.

  • exclude_domains (Optional[List[str]]) – A list of domains to exclude from the search.

  • include_answer (Optional[bool]) – Whether to include the answer in the results.

  • include_raw_content (Optional[bool]) – Whether to include the raw content in the results.

  • include_images (Optional[bool]) – Whether to include images in the results.

Returns

The query that was searched for. follow_up_questions: A list of follow up questions. response_time: The response time of the query. answer: The answer to the query. images: A list of images. results: A list of dictionaries containing the results:

title: The title of the result. url: The url of the result. content: The content of the result. score: The score of the result. raw_content: The raw content of the result.

Return type

query

async results_async(query: str, max_results: Optional[int] = 5, search_depth: Optional[str] = 'advanced', include_domains: Optional[List[str]] = [], exclude_domains: Optional[List[str]] = [], include_answer: Optional[bool] = False, include_raw_content: Optional[bool] = False, include_images: Optional[bool] = False) List[Dict][source]ΒΆ
Parameters
  • query (str) –

  • max_results (Optional[int]) –

  • search_depth (Optional[str]) –

  • include_domains (Optional[List[str]]) –

  • exclude_domains (Optional[List[str]]) –

  • include_answer (Optional[bool]) –

  • include_raw_content (Optional[bool]) –

  • include_images (Optional[bool]) –

Return type

List[Dict]

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAnyΒΆ
Parameters
  • by_alias (bool) –

  • ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicodeΒΆ
Parameters
  • by_alias (bool) –

  • ref_template (unicode) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) NoneΒΆ

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) ModelΒΆ
Parameters

value (Any) –

Return type

Model