Knowledge Service¶
Toby AI TruePilot can organize the analysis results from the current session into platform notes or Runbooks, and can also search official product documentation to answer usage questions. Notes are suitable for preserving conclusions that have been formed, while Runbooks are suitable for solidifying repeatable operational procedures. Product documentation Q&A is used to obtain usage instructions consistent with official documentation.
Creating Notes and Runbooks¶
After completing troubleshooting, log analysis, query explanation, or solution discussion, you can organize content with long-term value from the current session into notes or Runbooks, avoiding the need to manually copy and reorganize again.
| Content Type | Applicable Content | Example |
|---|---|---|
| Regular Note | Reference content such as conclusions, background information, query explanations, analysis records, etc. | Root cause analysis and impact scope of a failure |
| Runbook | Reusable handling procedures, usually including preconditions, operational steps, verification methods, and necessary rollback or escalation paths | Standard troubleshooting and recovery process for checkout-api timeout |
Trigger Methods¶
You can enter the creation process through the following methods:
- Active Generation: Enter "Organize the above analysis into a note" or "Save the last trace analysis as a note" in the conversation, or explicitly request "Organize this
checkout-apitimeout troubleshooting into a Runbook"; - Toby AI TruePilot Suggestion: When the conversation has formed a relatively complete analysis result or operational procedure, Toby AI TruePilot may prompt whether to organize it into a note or Runbook.
When you need to limit the scope, please clearly specify the object, content, and type to be organized. For example, "Generate a note from the last analysis" only organizes the most recent substantive results, while "Organize the current session into a note" can cover multiple items that can be solidified in the current session. When creating a Runbook, it is recommended to also specify the applicable objects, trigger conditions, and verification steps you wish to retain.
Creation Process¶
- Toby AI TruePilot checks whether the current account has permission to create notes;
- Organizes a draft based on the specified scope and content type, and displays information such as title, content scope, sections, and tags in the confirmation card;
- Check the confirmation card, confirm that it is correct, and agree to create;
- After successful creation, Toby AI TruePilot returns a result card. Click the name to open the corresponding note or Runbook without closing the current conversation.
The draft can reference existing queries and chart summaries in the conversation, but it will not directly write complete raw logs, large query results, or irrelevant historical content into the note or Runbook.
Finding and Maintaining¶
You can ask Toby AI TruePilot to search for existing notes and Runbooks by name or content, and continue to read, update, or delete them. For example:
Search results will first display basic information such as title, type, and tags. When viewing or modifying is needed, Toby AI TruePilot will then read the full Markdown content.
The content type cannot be changed after creation. Regular notes cannot be directly converted to Runbooks, and Runbooks cannot be changed to regular notes. If you need to adjust the type, please recreate the content with the target type.
Runbooks are not executed automatically
Runbooks are knowledge content used to solidify and reuse operational steps, not an automated execution engine. When following a Runbook to handle problems later, the actual data queries, configuration modifications, or handling actions are still subject to current account permissions, tool permissions, and operational confirmation rules.
Note
- Creating notes requires the current account to have creation permissions for the notes module. If you do not have permission, please contact the administrator to enable it;
- Only a draft will be generated before user confirmation; no actual notes or Runbooks will be created;
- If the current conversation content is insufficient, Toby AI TruePilot will indicate what information needs to be supplemented or only organize existing conclusions;
- After creation, please verify key conclusions, operational steps, query references, and object scope before sharing or using them later.
Product Documentation Q&A¶
The product documentation Q&A capability retrieves the platform's official help documentation to answer questions about feature descriptions, entry locations, configuration rules, operational steps, and common troubleshooting issues, and provides corresponding documentation links when necessary.
It can be used to handle the following product issues:
- You are unsure about the function or entry point of a certain feature;
- You need installation, integration, creation, or configuration steps;
- You want to confirm fields, default values, version requirements, or usage limits;
- After configuration, there is no data or it is not effective, and you need to troubleshoot step by step;
- You want to obtain the corresponding official help documentation.
Submitting Product Questions¶
Directly describe the task you wish to complete, and specify the related product, module, and issue stage. For example:
For complex issues, you can also describe the final goal and current progress. Toby AI TruePilot will organize the answer based on preconditions, operational steps, and verification methods. If you only need a documentation link, you can also clearly input "Where is the related documentation."
Answers and Documentation References¶
Toby AI TruePilot will organize answers based on the retrieved documentation and provide accessible site links when necessary. For configuration and troubleshooting issues, the answer will prioritize explaining the execution order, constraints, and verification methods.
Product documentation Q&A only provides explanations and will not create, modify, delete, install, or deploy resources on behalf of the user. When the retrieval results are insufficient to confirm a certain rule, Toby AI TruePilot will clearly state that the evidence is insufficient, rather than supplementing the missing conclusions in the documentation with general knowledge.