HumanFirst icon

HumanFirst

Call HumanFirst playbook API

Import Document

AI-generated

Overview

This node operation uploads a document file to a specified Conversation Source within a given namespace in the HumanFirst platform. It supports uploading binary files from the input data and optionally prevents immediate indexing trigger after upload. This operation is useful for importing documents into a conversation dataset for further processing or analysis.

Use Case Examples

  1. Uploading a PDF or text document to a conversation source for indexing and analysis.
  2. Importing a binary file from a previous node into a HumanFirst conversation dataset.

Properties

Name Meaning
Namespace The namespace in the HumanFirst platform where the conversation source exists.
Conversation Source Name or ID The identifier of the conversation source to which the document will be uploaded.
File Name The name of the file being uploaded.
File to Upload (Binary Property) The name of the binary property in the input data that contains the file to upload.
Prevent Trigger If true, the indexing process will not start immediately after upload; it must be triggered later with noTrigger set to false.

Output

JSON

  • json - The JSON response from the HumanFirst API after uploading the document, typically containing metadata or status information about the uploaded file.

Dependencies

  • Requires an API key credential for the HumanFirst API to authenticate requests.

Troubleshooting

  • Error if the Conversation Source is not selected: The node throws an error indicating that a Conversation Source must be selected before importing a document.
  • Error if the specified binary property does not exist in the input data: The node throws an error indicating the missing binary property.
  • Ensure the binary data is properly base64 encoded and accessible in the specified binary property.
  • Check API key validity and permissions if the upload request fails.

Links

Discussion