Aryn

Tools (9)

• Create DocSet

  Tool to create a new DocSet. Use when you need to allocate a storage container before adding documents.

  Inputs: name, schema, prompts, properties

• Delete DocSet

  Tool to delete a DocSet and all its documents. Use after confirming the DocSet ID, when you need to permanently remove a DocSet and its contents.

  Inputs: docset_id

• Generate plan

  Tool to generate a query plan without executing it. Use when you need to review the logical plan before running your query (e.g., "Generate a plan for revenue breakdown by region").

  Inputs: query, rag_mode, docset_id

• Get DocSet Metadata

  Tool to retrieve metadata for a specific DocSet by its ID. Use when you need to check DocSet details like name, creation time, properties, or prompts.

  Inputs: docsetId

• Get Document by ID

  Retrieve a document by ID from Aryn DocParse storage. Returns the document's parsed elements (text, tables, sections with embeddings), custom properties, and optionally the original binary content. Use this after obtaining a docset_id and doc_id from other Aryn actions (e.g., list_docs or add_doc).

  Inputs: doc_id, docset_id, include_binary, include_elements

• Download Document Binary

  Download the original binary content (e.g., PDF, image) of a document from an Aryn DocSet. This action retrieves the raw binary file that was originally uploaded to the DocSet. Use this when you need to access the original document file rather than the parsed elements or extracted text.

  Inputs: docsetId, documentId

• List Async Tasks

  Tool to list all outstanding asynchronous tasks for the account. Use when you need to check pending or running tasks.

• Partition Document

  Partition a document using Aryn DocParse to extract and structure its content elements including text, tables, and images. Supports file upload or URL input with extensive processing options for chunking, OCR, table extraction, image extraction, and multiple output formats. Use when you need to extract structured content from PDFs or other document formats.

  Inputs: file, options, file_url

• Submit Document for Async Add Doc

  Tool to submit a document for asynchronous addition to a DocSet. Returns a task ID to track the operation. Use when you need to add documents to an existing DocSet and want to track the processing status.

  Inputs: file, options, file_url, docset_id