Skip to content

[FEATURE] Clarify distinction between Searches and Tools in documentation #24

@virginia-delos

Description

@virginia-delos

Problem Statement

The documentation does not clearly distinguish between Searches and Tools, even though they represent different concepts:

  • Searches are used to retrieve information from documents.
  • Tools are general-purpose Python scripts that extend the assistant’s capabilities.

Currently, there is only a documentation section for Tools, and that section contains an example that actually corresponds to a Search.

Proposed Solution

Update the documentation to clearly separate and define:

Searches

  • Explain that they are used specifically for document retrieval.
  • Provide a dedicated section with a proper example.

Tools

  • Explain that they represent general Python-based capabilities.
  • Provide an example that reflects a true tool (not a retrieval/search example).

Additionally, clarify how Searches and Tools relate to each other within the agent configuration.

Use Case

A new user reading the documentation may assume that Searches and Tools are the same concept because they are not clearly differentiated.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions