Documentation files

Upload documentation files to enhance the API Agent knowledge base and enable queries based on custom content.

About this task

Use the Documents tab in API Agent to upload documentation files that can be queried through the chat interface. Uploaded files allow the API Agent to provide responses based on your uploaded content.

Procedure

  1. In API Manager, click Settings > API Agent > Sources.
  2. Prepare your file to upload. Ensure that the file meets the following requirements:
    1. The format of the file can be either PDF, Word, Markdown, or HTML.
    2. The maximum file size must not exceed more than 2 MB.
  3. Use the following methods to upload your document:
    1. On the Documents tab, drag the file into the Upload files box.
    2. Click the Upload files box, select the file in the file browser, and then click Open.
  4. Monitor the upload progress and wait for processing to complete.
  5. Verify the upload status. A success notification appears when the file is processed. The file is listed with a status indicator.
  6. If an error occurs, review the message and upload the corrected file.
  7. Open the API Agent chat interface and ask a question that is related to the uploaded document to confirm it is accessible.
    Note: You can view the status of each document, delete documents that are no longer needed, and replace invalid files with corrected versions.