Skip to content
Nappai Documentation

Pimberly Document Loader

The Pimberly Document Loader pulls information from your Pimberly account into Nappai.
It lets you choose which parts of the data you want, how many items to bring in, and whether to split the results into separate pages.

How it Works

When you run the component, it talks to the Pimberly API using the API key you set up in Nappai’s credentials.
You can filter the data by a start date, limit the number of items, and decide which fields appear in the text, metadata, or as separate document fields.
If you tick “Split by page”, each page of a document becomes its own output item.
The component then packages each piece of data into a Nappai Data object that can be used by other components in your workflow.

Inputs

Credential
This component requires a Pimberly API credential.

  1. Configure the Pimberly API credential in the Credentials section of Nappai.
  2. Select that credential in the Credential field of this component.
  • Since Date: The date to filter products updated since (e.g., 2023-01-01).
  • Max Results: The maximum number of results to return.
  • Text fields separated by comma: Comma‑separated list of metadata fields to include in the text. Leave empty to include all fields.
  • Metadata Fields to include: Comma‑separated list of metadata fields to include in the output. Leave empty to include all fields.
  • Metadata Fields to exclude: Comma‑separated list of metadata fields to exclude from the output. Leave empty to include all fields.
  • Document Fields to include: Comma‑separated list of document fields to include in the output. Leave empty to include all fields.
  • Source Field Template: Attribute template to use as the source.
  • Split by page: Whether to split the output into pages.

Outputs

  • Data (method: load_documents): A list of Data objects, each containing the text of a document page (if split) and any selected metadata fields.

Usage Example

  1. Set up the credential: In the Credentials tab, add a new Pimberly API credential and paste your API key.
  2. Add the component to your workflow.
  3. Configure the inputs:
    • Since Date: 2024-01-01
    • Max Results: 20
    • Text fields separated by comma: title,description
    • Metadata Fields to include: category,price
    • Split by page: True
  4. Connect the output to a downstream component, such as a text summarizer or a database writer, to process or store the retrieved data.
  • Text Summarizer – Condense the loaded text into concise summaries.
  • Database Writer – Store the retrieved data into your preferred database.
  • Filter Data – Narrow down the loaded data further based on custom conditions.

Tips and Best Practices

  • Use * in the Text fields separated by comma or Metadata Fields to include inputs to pull all available fields quickly.
  • If you only need a few fields, list them explicitly to reduce data transfer and processing time.
  • Enable Split by page only when you need page‑level granularity; otherwise, keep it off for faster loading.
  • Keep the Max Results value reasonable to avoid long loading times, especially when working with large datasets.

Security Considerations

  • The API key is stored securely in Nappai’s credential store and never exposed in the workflow.
  • Ensure that only trusted users have access to the credential and the component to prevent unauthorized data access.
  • When sharing a workflow, the credential reference is included, but the actual key remains hidden.