Toggle Menu
Prev Up Next

# `langchain_community.utilities.arxiv`.ArxivAPIWrapper

class langchain_community.utilities.arxiv.ArxivAPIWrapper

  Bases: `BaseModel`

  Wrapper around ArxivAPI.

  To use, you should have the `arxiv` python package installed. https://lukasschwab.me/arxiv.py/index.html This wrapper will use the Arxiv API to conduct searches and fetch document summaries. By default, it will return the document summaries of the top-k results. If the query is in the form of arxiv identifier (see https://info.arxiv.org/help/find/index.html), it will return the paper corresponding to the arxiv identifier. It limits the Document content by doc_content_chars_max. Set doc_content_chars_max=None if you don’t want to limit the content size.

  top_k_results

    number of the top-scored document used for the arxiv tool

  ARXIV_MAX_QUERY_LENGTH

    the cut limit on the query used for the arxiv tool.

  continue_on_failure

    If True, continue loading other URLs on failure.

    Type

      bool

  load_max_docs

    a limit to the number of loaded documents

  load_all_available_meta

    if True: the metadata of the loaded Documents contains all available meta info (see https://lukasschwab.me/arxiv.py/index.html#Result), if False: the metadata contains only the published date, title, authors and summary.

  doc_content_chars_max

    an optional cut limit for the length of a document’s content

  Example

      from langchain_community.utilities.arxiv import ArxivAPIWrapper
      arxiv = ArxivAPIWrapper(
          top_k_results = 3,
          ARXIV_MAX_QUERY_LENGTH = 300,
          load_max_docs = 3,
          load_all_available_meta = False,
          doc_content_chars_max = 40000
      )
      arxiv.run("tree of thought llm)

  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 ARXIV_MAX_QUERY_LENGTH: int = 300
  param arxiv_exceptions: Any = None
  param continue_on_failure: bool = False
  param doc_content_chars_max: Optional[int] = 4000
  param load_all_available_meta: bool = False
  param load_max_docs: int = 100
  param top_k_results: int = 3
  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

  get_summaries_as_docs(query: str) → List[Document]

    Performs an arxiv search and returns list of documents, with summaries as the content.

    If an error occurs or no documents found, error text is returned instead. Wrapper for https://lukasschwab.me/arxiv.py/index.html#Search

    Parameters

      query (str) – a plaintext search query

    Return type

      List[Document]

  is_arxiv_identifier(query: str) → bool

    Check if a query is an arxiv identifier.

    Parameters

      query (str) –

    Return type

      bool

  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

  lazy_load(query: str) → Iterator[Document]

    Run Arxiv search and get the article texts plus the article meta information. See https://lukasschwab.me/arxiv.py/index.html#Search

    Returns: documents with the document.page_content in text format

    Performs an arxiv search, downloads the top k results as PDFs, loads them as Documents, and returns them.

    Parameters

      query (str) – a plaintext search query

    Return type

      Iterator[Document]

  load(query: str) → List[Document]

    Run Arxiv search and get the article texts plus the article meta information. See https://lukasschwab.me/arxiv.py/index.html#Search

    Returns: a list of documents with the document.page_content in text format

    Performs an arxiv search, downloads the top k results as PDFs, loads them as Documents, and returns them in a List.

    Parameters

      query (str) – a plaintext search query

    Return type

      List[Document]

  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

  run(query: str) → str

    Performs an arxiv search and A single string with the publish date, title, authors, and summary for each article separated by two newlines.

    If an error occurs or no documents found, error text is returned instead. Wrapper for https://lukasschwab.me/arxiv.py/index.html#Search

    Parameters

      query (str) – a plaintext search query

    Return type

      str

  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

# Examples using ArxivAPIWrapper

- arxiv.md