Skip to content

Request Form Tool

The Request Form tool allows Agents to guide users to fill in structured forms during conversations and collect specific information.

When to Use

  • Need to collect information in a specific format
  • Ensure users provide required fields
  • Establish standardized requirement collection processes

Use Case Examples

Scenario Form Content
Bug Report Environment information, reproduction steps, error messages
Requirement Collection Feature description, priority, expected timeline
Customer Service Ticket Issue type, contact information, issue description
Appointment Request Date, time slot, number of people, special requirements

Setup Steps

Step 1: Add Form Tool

In the Tools section, click "Add Tool", open the tool selector, and select "Form Tool" from the "Form Tools" group.

Step 2: Design Form Structure

Click the form tool you just added, then click the "Form Editor" button to design the form structure.

The form editor provides the following features:

  • Add/Remove Fields: Can dynamically add or remove fields
  • Adjust Field Order: Can drag to adjust field display order
  • Set Field Properties: Each field can set name, question text, required/optional, default value, etc.
  • Set Data Field Name (Optional): Each field can set an optional English label for use in exported data files for subsequent data analysis (e.g., for a "Name" question, set name as the field name for export or data analysis)

Available Field Types

Type Description Examples
Short Text Single-line text input Name, Email
Long Text Multi-line text input Issue description, Notes
Number Numeric input Quantity, Amount
Dropdown Single selection list Issue type, Priority
Radio Radio buttons Yes/No, Agree/Disagree
Checkbox (Multiple) Multiple checkboxes Applicable features, Preference options
Date Date selection Expected date, Birthday

Step 3: Set Required and Optional

In the form editor, mark which fields are required.

Step 4: Set "When to Use"

Tell the Agent when to use this form.

Examples:

When users want to report an issue or bug, use this form to collect information.
Before displaying the form, briefly explain why this information is needed.
After the form is completed, confirm the information and inform about next steps.

When users express purchase intent or want a quote, use this form to collect requirement specifications.
Guide users to fill in with a friendly tone, explaining the purpose of each field.

Step 5: Confirm Addition

Click confirm, and the tool will appear in the Tools list.

Form Filling Process

The process users see:

  1. Agent determines information needs to be collected
  2. Agent explains the reason and displays the form
  3. User fills in the form
  4. Agent confirms received information
  5. Agent continues conversation based on the information

Tool List Display

Added Request Form tools are displayed in the "Form Tools" group under the "Tools" section, each tool showing:

  • Form title (displays "Untitled Form" if not set)
  • Can be expanded to view detailed settings (including "When to Use" and form editor)
  • Can be removed by clicking the delete button

Click "Form Editor" to modify the form structure at any time.

Form Design Tips

Moderate Number of Fields

  • Too few: Incomplete information
  • Too many: Users abandon filling
  • Recommended: 5-10 fields

Use Correct Field Types

  • Fixed options → Dropdown or Radio
  • Free input → Short/Long text
  • Clear numeric values → Number

Reasonable Field Order

  • Simple questions first
  • Related questions together
  • Required items clearly marked

Best Practices

Use in Conjunction with Agent's "Core Instruction"

Explain form purpose in the Agent's "Core Instruction":

## Information Collection
When needing to collect bug report information:
1. First express thanks for the user's report
2. Explain that some information is needed to help process
3. Display bug report form
4. Confirm receipt and explain processing time

Follow-up Actions After Form

Explain in "When to Use":

After form completion:
- Organize received information
- Generate ticket number (if needed)
- Inform user of expected processing time
- Provide tracking method

Testing the Form

After adding, test the process:

  1. Say something that should trigger the form (e.g., "I want to report an issue")
  2. Confirm form displays correctly
  3. Fill in test data
  4. Confirm Agent correctly receives and responds

Common Questions

Can users skip the form?

Yes. Users can ignore the form and continue the conversation. It's recommended to handle this situation in the Agent's "Core Instruction", for example, by asking questions one by one through conversation instead.

Where is form data stored?

Form data becomes part of the conversation history and can also be viewed in Codeer's Agent backend for form response results.

Can I have multiple forms?

Yes, you can add multiple Request Form tools, each with different form structures and trigger conditions. For example, "Bug Report Form" and "Requirement Submission Form".

Can fields have default values?

Currently default values are not supported, but you can provide examples in the field description.

Next Steps