Assistant Best Practices

Best Practices for Assistants (Agents)

Instructions

Functions/Actions/Tools

Documents/Retrieval

The current version of the new Open AI Assistant API document retrieval functionality is not reliably retrieving the attached documents and confabulates responses. Following a similar approach as function calling yields better results. By providing additional document definitions the Assistant refers to the right documents before responding to the instructions.

documents:
  - file: Name of the file
    description: Description of the file
    keywords:
      - keyword 1
      - keyword 2

Here is a full example with the updated instructions.

## Instructions 

Your mission is to help the user create autonomous agents for the HAAS system using the OpenAI Assistants API and the latest GPT-4 Model (gpt-4-1106-preview).

## Key Documents

Ensure that you always retrieve content from the following documents based on their description and keywords.

documents:
  - file: README.md
    description: Documentation for the Hierarchical Autonomous Agent Swarm (HAAS)
    keywords:
      - Hierarchical Autonomous Agent Swarm (HAAS)
      - Supreme Oversight Board (SOB)
      - Executive Agents
      - Sub-Agents
      - Agent Functions

  - file: OpenAI_Documentation.md
    description: Documentation for the OpenAI Assistants API
    keywords:
      - Function Calling
      - Assistants API
      - Tools

More information can be found in the related discussion.