Documentation searcher

The tool searches for IBM product documentation and user-uploaded documents to quickly find relevant information based on your query.

The Documentation Searcher tool retrieves detailed information from IBM product documentation and user-uploaded files. It displays structured results in markdown format. You can upload files in PDF, Markdown, Microsoft Word, or HTML format.

Key highlights
  • Searches IBM Documentations or user-uploaded documentations based on prompt.
  • Displays results in markdown format.

How it works

Enter a search prompt, the tool displays the following results:

  1. Searches uploaded documents.
  2. Searches API Connect documents.
  3. Displays detailed results, including API metadata in table format.
The following operations are supported in the documentation searcher tool:
Note: The API Agent has few limitations with documentation searcher tool. For more information, see limitations.

Search IBM documentation

Search IBM documents based on your query. The tool displays detailed results in markdown format.
Table 1. Parameters
Parameter Required Description
Text Yes

Search query for documentation search.
Example prompts

  • Show me the official IBM documentation on creating APIs in API Connect
  • What does IBM's documentation say about API creation in API Connect?
  • According to IBM docs, how do I publish an API to a catalog in API Connect?
  • What does the official IBM documentation state about publishing an API to a catalog in API Connect?
  • How can I track API usage and gain insights into API performance according to IBM documentation?
  • Find the IBM official guide for tracking API usage and gaining insights into API performance
  • Search the IBM docs on what security options are available to protect APIs in API Connect?
  • What security options are available to protect APIs in API Connect as per IBM docs?
  • How do I test an API in API Connect before making it available to consumers? Answer as per the ibm documentation.
  • Going by IBM docs, how do I test an API in API Connect before making it available to consumers?

Search user documentation

Search user-uploaded documents based on your query. The tool displays detailed results in markdown format.

Table 2. Parameters
Parameter Required Description
Text Yes

Search query for documentation search.
Example prompts

  • Based on uploaded documents, what are the Queue operations available?
  • In user documentation, what Queue operations are described?
  • What does user documentation say about object oriented programming concepts?
  • According to user documents uploaded, what are the OOP concepts?
  • Tell me the merge sort time complexity from user uploaded files
  • What is the merge time complexity given in user documentation?

Search all available documentation

Search both IBM Documentation and user-uploaded documents based on your query.

Table 3. Parameters
Parameter Required Description
Text Yes

Search query for documentation search.
Example prompts

  • How do I manage an API lifecycle using API Connect?
  • What should I do to learn API Connect / Get started
  • What is a gateway? How does it relate to my API? Answer based on documentation
  • According to user documents uploaded, what are the OOP concepts?
  • Can API Connect work with my non-REST (SOAP/GraphQL) services according to all the documentation available?
  • According to both user and IBM docs, how do I add custom JavaScript logic to my API flow?
  • What are rate limits based on all the available documentation?