Skip to content

chore(core): improve element description prompt with language-specific examples #2067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
quanru merged 1 commit into from
Mar 4, 2026
Merged

chore(core): improve element description prompt with language-specific examples #2067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions packages/core/src/ai-model/prompt/describe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,34 @@
import { getPreferredLanguage } from '@midscene/shared/env';

const examplesMap: Record<string, string[]> = {
Chinese: [
'"登录表单中的"登录"按钮"',
'"搜索输入框，placeholder 为"请输入关键词""',
'"顶部导航栏中文字为"首页"的链接"',
'"联系表单中的提交按钮"',
'"aria-label 为"打开菜单"的菜单图标"',
],
English: [
'"Login button with text \'Sign In\'"',
'"Search input with placeholder \'Enter keywords\'"',
'"Navigation link with text \'Home\' in header"',
'"Submit button in contact form"',
'"Menu icon with aria-label \'Open menu\'"',
],
};

const getExamples = (language: string) => {
const examples = examplesMap[language] || examplesMap.English;
return examples.map((e) => `- ${e}`).join('\n');
};

export const elementDescriberInstruction = () => {
const preferredLanguage = getPreferredLanguage();

return `
Describe the element in the red rectangle for precise identification. Use ${getPreferredLanguage()}.
Describe the element in the red rectangle for precise identification.

IMPORTANT: You MUST write the description in ${preferredLanguage}.

CRITICAL REQUIREMENTS:
1. UNIQUENESS: The description must uniquely identify this element on the current page
Expand All @@ -28,13 +54,10 @@ GUIDELINES:
- Avoid page-specific or temporary content
- Don't mention the red rectangle or selection box
- Focus on stable, reusable characteristics
- **Write the description in ${preferredLanguage}**

EXAMPLES:
- "Login button with text 'Sign In'"
- "Search input with placeholder 'Enter keywords'"
- "Navigation link with text 'Home' in header"
- "Submit button in contact form"
- "Menu icon with aria-label 'Open menu'"
${getExamples(preferredLanguage)}

Return JSON:
{
Expand Down
5 changes: 4 additions & 1 deletion packages/core/tests/unit-test/prompt/__snapshots__/describe.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

exports[`elementDescriberInstruction > should return the correct instruction 1`] = `
"
Describe the element in the red rectangle for precise identification. Use English.
Describe the element in the red rectangle for precise identification.

IMPORTANT: You MUST write the description in English.

CRITICAL REQUIREMENTS:
1. UNIQUENESS: The description must uniquely identify this element on the current page
Expand All @@ -28,6 +30,7 @@ GUIDELINES:
- Avoid page-specific or temporary content
- Don't mention the red rectangle or selection box
- Focus on stable, reusable characteristics
- **Write the description in English**

EXAMPLES:
- "Login button with text 'Sign In'"
Expand Down