Node Details

  • Name: airtable
  • Type: Document
  • Version: 3.02
  • Category: Document Loaders

Parameters

Credential

  • Label: Connect Credential
  • Name: credential
  • Type: credential
  • Credential Names: airtableApi

Inputs

  1. Text Splitter (optional)

    • Type: TextSplitter
    • Description: A text splitter to process the loaded documents
  2. Base Id (required)

    • Type: string
    • Description: The Airtable base ID
  3. Table Id (required)

    • Type: string
    • Description: The Airtable table ID
  4. View Id (optional)

    • Type: string
    • Description: The Airtable view ID
  5. Include Only Fields (optional)

    • Type: string
    • Description: Comma-separated list of field names or IDs to include
  6. Return All (optional)

    • Type: boolean
    • Default: true
    • Description: Whether to return all results or limit them
  7. Limit (optional)

    • Type: number
    • Default: 100
    • Description: Number of results to return when Return All is disabled
  8. Additional Metadata (optional)

    • Type: json
    • Description: Additional metadata to be added to the extracted documents
  9. Omit Metadata Keys (optional)

    • Type: string
    • Description: Comma-separated list of metadata keys to omit
  10. Filter By Formula (optional)

    • Type: string
    • Description: Airtable formula to filter records

Outputs

  1. Document

    • Description: Array of document objects containing metadata and pageContent
    • Base Classes: Document, json
  2. Text

    • Description: Concatenated string from pageContent of documents
    • Base Classes: string, json

Functionality

The Airtable Document Loader fetches data from the specified Airtable base and table using the provided credentials. It can optionally filter the data, limit the number of records, and include only specific fields. The loader converts each Airtable record into a document object with the record data as the page content and additional metadata.

Key features include:

  • Pagination support for fetching large datasets
  • Optional text splitting of loaded documents
  • Custom metadata addition and omission
  • Filtering records using Airtable formulas
  • Option to return all records or a limited number

Use Cases

  • Loading structured data from Airtable for natural language processing tasks
  • Integrating Airtable data into document-based workflows
  • Preprocessing Airtable records for use in language models or other AI applications

Notes

  • Ensure you have the necessary Airtable API credentials and permissions to access the desired base and table.
  • Be mindful of API rate limits when fetching large amounts of data.
  • Use the text splitter option if you need to process large text fields from Airtable.