Skip to main content

Searching Across Vast Documents

Overview

This agent registers microcontroller manuals with a vast number of pages as knowledge, and allows you to quickly check the information necessary for development.

When a user asks a question about a microcontroller in natural language, the agent will provide the following information based on the manual's contents:

  • Key points regarding the question
  • Explanation of the manual's contents
  • Reference to the relevant section of the manual

The goal is to experience the process of efficiently checking necessary technical information by utilizing microcontroller manuals as knowledge and interacting with AI.

What you can do with this sample

  • Find out how to use specific functions from the microcontroller manual
  • Check an overview of register settings and initialization procedures
  • Quickly grasp the specifications of interrupts, communication, timers, DMA, GPIO, etc.
  • Check precautions and constraints
  • Check the references that support the answer

Target Users

This sample is primarily intended for the following types of users:

  • Developers working with the target microcontroller
  • Teams wanting to streamline technical research and specification verification
  • Administrators and project managers wanting to create a technical inquiry agent for their company

Package Contents

This sample includes the following data as an example:
The microcontroller manual is not included; users must prepare one of their own and register it in the knowledge base.

DataFile Name
Agent DefinitionMicrocontroller Manual Information Search.yaml
InputMicrocontroller Manual (inputData\Microcontroller Manual\ALX-312F64_Manual_Sample.pdf)
DocumentationThis README

Using Sample Data

Prerequisites

  • You must have the microcontroller manual to be registered in the knowledge base.

Input/Output

  • Microcontroller Manual

Procedure

  1. (First time only) Register the microcontroller manual as knowledge.

    • On the Agentiqs knowledge base screen, click "Create New" to create the knowledge base.
    • Overview: Enter the required information and click the "Save" button.
    • Data: Click "Add Data" and register the target microcontroller manual file using "Add File" or "Add Folder".
    • Once loading is complete, knowledge creation is finished.
    info

    For detailed instructions, please refer to "Creating Knowledge"

  2. On the Agentiqs agent screen, hover your mouse over "Microcontroller Manual Information Search" and click "Start Chat".

  3. On the Agentiqs chat screen, click "Select Knowledge" in the upper right corner and select the microcontroller manual knowledge you created from the pull-down menu.

  4. Enter your question on the Agentiqs chat screen.

Target Operation

  • Agent: Microcontroller Manual Information Search

Limitations

  • The answer content depends on the content of the microcontroller manual registered as knowledge.
  • The content, granularity, and expression of the answer may change depending on the wording and level of detail of the question.

Reference: Example Questions

Example questions to enter in the chat screen are shown below.

info

The answer will vary depending on the content of the microcontroller manual in question.

Initial Setup and Getting Started

These are questions you should first check when starting up CAN on this microcontroller.

  • Please tell me the initialization procedure when starting to use CAN.
  • Please show a diagram of the CAN initialization flow.
  • Where do I set the CAN transmission ID and data length?
  • What do I need to set to enable receive interrupts in CAN?

Basic Confirmation of Transmission and Reception

These are questions you will often check when implementing transmit and receive processing.

  • How can I determine if CAN transmission is complete?
  • Where can I check if received data has arrived via CAN?
  • Which registers can I check the ID and data length of the received CAN frame?

Interrupts and Status Checks

These questions are helpful for checking operation and debugging.

  • Which register should I use to check for CAN interrupts, and how do I clear them?
  • Are there CAN error interrupts for each channel?
  • Are the receive FIFO interrupt and the transmit/receive FIFO receive completion interrupt different things?

Checking Information Not Found in the Microcontroller Manual

These questions are for confirming answers to questions about information not included in the knowledge base.

  • How do I determine the optimal configuration by comparing interrupt load and DMA load?
  • What percentage of sample points is best for this board trace length?