Skip to content
Nappai Documentation

Pimberly Document Loader

The Pimberly Document Loader is a component within the Nappai system that allows users to load data from the Pimberly API. It helps users filter and structure the data according to their specified criteria, making data management more efficient and tailored to their needs.

Relationship with Pimberly API

This component interacts directly with the Pimberly API to retrieve data. It uses the API to fetch documents and applies user-defined filters and structures to the data, ensuring that only relevant information is loaded and displayed.

Inputs

  • Since Date: Specify the date from which updated products should be filtered.
  • Max Results: Set the maximum number of results to return.
  • Text fields separated by comma: List metadata fields to include in the text, separated by commas.
  • Metadata Fields to include: List metadata fields to include in the output, separated by commas.
  • Metadata Fields to exclude: List metadata fields to exclude from the output, separated by commas.
  • Document Fields to include: List document fields to include in the output, separated by commas.
  • Source Field Template: Template for the attribute to use as a source.
  • Split by page: Choose whether to split the output into pages.
  • Credential: Provide the credential to access the Pimberly API.

Outputs

The component produces a list of data objects, each representing a document loaded from Pimberly. These objects are structured with the content and metadata specified by the user, making them ready for further processing or analysis in the workflow.

Usage Example

Imagine you want to load product data updated since January 1, 2023, and only need specific metadata fields. You can set the “Since Date” to “2023-01-01” and specify the desired metadata fields in “Metadata Fields to include.” The component will then fetch and structure the data accordingly.

Templates

Currently, there are no specific templates where this component is pre-configured. However, it can be customized and integrated into various workflows within the Nappai system.

  • libSQLRetrieverTool: Tool for interacting with libSQL Retriever.
  • Embedding Similarity: Compute similarity between two embedding vectors.
  • SQLite: Interact with SQLite databases.
  • Tool Calling Agent: Agent that uses tools.
  • OpenAI Tools Agent: Agent using OpenAI tools.
  • Basic Agent: Basic Agent for simple tasks.
  • Supabase: Supabase Vector Store with search capabilities.
  • Google Drive: Google File Loader.

Tips and Best Practices

  • Always ensure your credentials are up-to-date to avoid access issues.
  • Use the “Max Results” input to limit data volume and improve performance.
  • Regularly update the “Since Date” to keep your data current.

Security Considerations

Ensure that your credentials for accessing the Pimberly API are stored securely and are not shared with unauthorized users. Regularly update your credentials to maintain security.