Add --valuable-results to search feedback #164
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,10 @@ import { | |
| parseFeedbackListArg, | ||
| parsePageNumbersArg, | ||
| } from '../../commands/feedback'; | ||
| import { | ||
| parseValuableResultsArg, | ||
| type ValuableResultInput, | ||
| } from '../../commands/search-feedback'; | ||
| import { parseAlexandriaFeedbackArray } from '../../commands/alexandria-feedback'; | ||
| import { getClient } from '../../utils/client'; | ||
| import { initializeConfig } from '../../utils/config'; | ||
|
|
@@ -153,6 +157,45 @@ describe('executeEndpointFeedback', () => { | |
| }); | ||
| }); | ||
|
|
||
| it('rejects --valuable-results on non-search endpoints', async () => { | ||
| const result = await executeEndpointFeedback({ | ||
| endpoint: 'scrape', | ||
| jobId: '0193f6c5-1234-7890-abcd-1234567890ab', | ||
| rating: 'good', | ||
| valuableResults: [{ source: 'web', position: 1 }], | ||
| }); | ||
|
|
||
| expect(result.success).toBe(false); | ||
| expect(result.error).toBe( | ||
| '--valuable-results is only supported for search feedback.' | ||
| ); | ||
| expect(mockFetch).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('forwards valuableResults for search feedback', async () => { | ||
| mockFetch.mockResolvedValue({ | ||
| ok: true, | ||
| status: 200, | ||
| statusText: 'OK', | ||
| json: async () => ({ success: true, creditsRefunded: 1 }), | ||
| }); | ||
|
|
||
| const valuableResults: ValuableResultInput[] = [ | ||
| { source: 'web', position: 1 }, | ||
| { source: 'news', position: 2 }, | ||
| ]; | ||
| const result = await executeEndpointFeedback({ | ||
| endpoint: 'search', | ||
| jobId: '0193f6c5-1234-7890-abcd-1234567890ab', | ||
| rating: 'good', | ||
| valuableResults, | ||
| }); | ||
|
|
||
| expect(result.success).toBe(true); | ||
| const [, request] = mockFetch.mock.calls[0]; | ||
| expect(JSON.parse(request.body).valuableResults).toEqual(valuableResults); | ||
| }); | ||
|
|
||
| it('treats team opt-out as a disabled success', async () => { | ||
| mockFetch.mockResolvedValue({ | ||
| ok: false, | ||
|
|
@@ -255,6 +298,55 @@ describe('feedback parsing', () => { | |
| expect(parsePageNumbersArg('1, 2, bad, -1, 3')).toEqual([1, 2, 3]); | ||
| expect(parsePageNumbersArg('[4,5]')).toEqual([4, 5]); | ||
| }); | ||
|
|
||
| it('parses valuable results as source:position pairs', () => { | ||
| expect(parseValuableResultsArg('web:1, news:2')).toEqual([ | ||
| { source: 'web', position: 1 }, | ||
| { source: 'news', position: 2 }, | ||
| ]); | ||
| expect(parseValuableResultsArg('images:3')).toEqual([ | ||
| { source: 'images', position: 3 }, | ||
| ]); | ||
| }); | ||
|
|
||
| it('parses valuable results from JSON, keeping reasons', () => { | ||
| expect( | ||
| parseValuableResultsArg( | ||
| '[{"source":"web","position":1,"reason":"Answered it"},{"source":"news","position":2}]' | ||
| ) | ||
| ).toEqual([ | ||
| { source: 'web', position: 1, reason: 'Answered it' }, | ||
| { source: 'news', position: 2 }, | ||
| ]); | ||
| }); | ||
|
|
||
| // Each group is numbered from 1 independently, so a bare position does not | ||
| // identify a result. | ||
| it('rejects valuable results without a source', () => { | ||
| expect(() => parseValuableResultsArg('1,3')).toThrow( | ||
| 'must be "source:position"' | ||
| ); | ||
| expect(() => parseValuableResultsArg('[{"position":1}]')).toThrow( | ||
| 'source must be one of' | ||
| ); | ||
| }); | ||
|
|
||
| it('rejects unknown sources and non-positive positions', () => { | ||
| expect(() => parseValuableResultsArg('video:1')).toThrow( | ||
| 'source must be one of' | ||
| ); | ||
| expect(() => parseValuableResultsArg('web:0')).toThrow( | ||
| 'positions must be integers of 1 or greater' | ||
| ); | ||
| expect(() => parseValuableResultsArg('web:abc')).toThrow( | ||
| 'positions must be integers of 1 or greater' | ||
| ); | ||
| }); | ||
|
|
||
| it('returns undefined for empty input', () => { | ||
| expect(parseValuableResultsArg(undefined)).toBeUndefined(); | ||
| expect(parseValuableResultsArg(' ')).toBeUndefined(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('parseAlexandriaFeedbackArray capability issues', () => { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,9 +4,11 @@ import { getConfig, isCustomApiUrl, validateConfig } from '../utils/config'; | |
| import { getClient } from '../utils/client'; | ||
| import { | ||
| parseMissingContentArg, | ||
| parseValuableResultsArg, | ||
| parseValuableSourcesArg, | ||
| type MissingContentInput, | ||
| type SearchFeedbackRating, | ||
| type ValuableResultInput, | ||
| type ValuableSourceInput, | ||
| } from './search-feedback'; | ||
|
|
||
|
|
@@ -24,6 +26,7 @@ export interface EndpointFeedbackOptions { | |
| tags?: string[]; | ||
| note?: string; | ||
| valuableSources?: ValuableSourceInput[]; | ||
| valuableResults?: ValuableResultInput[]; | ||
| missingContent?: MissingContentInput[]; | ||
| querySuggestions?: string; | ||
| url?: string; | ||
|
|
@@ -211,6 +214,7 @@ export function parseEndpointFeedbackCliOptions(options: { | |
| metadata?: string; | ||
| metadataFile?: string; | ||
| valuableSources?: string; | ||
| valuableResults?: string; | ||
| missingContent?: string | string[]; | ||
| rating?: string; | ||
| }) { | ||
|
|
@@ -221,6 +225,7 @@ export function parseEndpointFeedbackCliOptions(options: { | |
| pageNumbers: parsePageNumbersArg(options.pageNumbers), | ||
| metadata: parseMetadataArg(options.metadata, options.metadataFile), | ||
| valuableSources: parseValuableSourcesArg(options.valuableSources), | ||
| valuableResults: parseValuableResultsArg(options.valuableResults), | ||
| missingContent: parseMissingContentArg(options.missingContent), | ||
| }; | ||
| } | ||
|
|
@@ -263,6 +268,15 @@ export async function executeEndpointFeedback( | |
| if (options.endpoint !== 'alexandria' && !options.jobId) { | ||
| throw new Error('Job feedback requires a job ID.'); | ||
| } | ||
| // Positions in `valuableResults` are 1-indexed within a search result | ||
| // group (web/images/news), so they are meaningless anywhere else. Reject | ||
| // rather than drop: silently ignoring the flag would let a caller believe | ||
| // the results were recorded. | ||
| if (options.endpoint !== 'search' && options.valuableResults?.length) { | ||
| throw new Error( | ||
| '--valuable-results is only supported for search feedback.' | ||
| ); | ||
| } | ||
| const entries: Array<[string, unknown]> = | ||
| options.endpoint === 'alexandria' | ||
| ? [ | ||
|
|
@@ -276,6 +290,7 @@ export async function executeEndpointFeedback( | |
| ['tags', normalizeList(options.tags)], | ||
| ['note', options.note], | ||
| ['valuableSources', options.valuableSources], | ||
| ['valuableResults', options.valuableResults], | ||
| ['missingContent', options.missingContent], | ||
| ['querySuggestions', options.querySuggestions], | ||
| ['url', options.url], | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,10 +13,28 @@ export interface MissingContentInput { | |
| description?: string; | ||
| } | ||
|
|
||
| export type SearchResultSource = 'web' | 'images' | 'news'; | ||
|
|
||
| export const SEARCH_RESULT_SOURCES: readonly SearchResultSource[] = [ | ||
| 'web', | ||
| 'images', | ||
| 'news', | ||
| ]; | ||
|
|
||
| // Search results come back grouped — data.web, data.images, data.news — and | ||
| // each group is numbered from 1 independently, so a position is only | ||
| // meaningful alongside the group it indexes into. | ||
| export interface ValuableResultInput { | ||
| source: SearchResultSource; | ||
| position: number; | ||
| reason?: string; | ||
| } | ||
|
|
||
| export interface SearchFeedbackOptions { | ||
| searchId: string; | ||
| rating: SearchFeedbackRating; | ||
| valuableSources?: ValuableSourceInput[]; | ||
| valuableResults?: ValuableResultInput[]; | ||
| missingContent?: MissingContentInput[]; | ||
| querySuggestions?: string; | ||
| apiKey?: string; | ||
|
|
@@ -118,6 +136,9 @@ export async function executeSearchFeedback( | |
| ...(s.reason ? { reason: s.reason } : {}), | ||
| })); | ||
| } | ||
| if (options.valuableResults && options.valuableResults.length > 0) { | ||
| body.valuableResults = options.valuableResults; | ||
| } | ||
| if (options.missingContent && options.missingContent.length > 0) { | ||
| body.missingContent = options.missingContent | ||
| .filter((m) => !!m.topic) | ||
|
|
@@ -350,6 +371,95 @@ export function parseValuableSourcesArg( | |
| .map((url) => ({ url })); | ||
| } | ||
|
|
||
| function isSearchResultSource(value: unknown): value is SearchResultSource { | ||
| return ( | ||
| typeof value === 'string' && | ||
| (SEARCH_RESULT_SOURCES as readonly string[]).includes(value) | ||
| ); | ||
| } | ||
|
|
||
| function parsePositionValue(raw: unknown, flag: string): number { | ||
| const position = typeof raw === 'string' ? Number(raw.trim()) : raw; | ||
| if ( | ||
| typeof position !== 'number' || | ||
| !Number.isInteger(position) || | ||
| position < 1 | ||
| ) { | ||
| throw new Error(`${flag} positions must be integers of 1 or greater.`); | ||
| } | ||
| return position; | ||
| } | ||
|
|
||
| // Accepts a compact "source:position" list (e.g. "web:1,news:2") or a JSON | ||
| // array of {source, position, reason} entries. The source is always required: | ||
| // results are grouped and each group is numbered from 1, so a bare position | ||
| // does not identify a result. | ||
| export function parseValuableResultsArg( | ||
| raw: string | undefined, | ||
| flag = '--valuable-results' | ||
| ): ValuableResultInput[] | undefined { | ||
| if (!raw) return undefined; | ||
| const trimmed = raw.trim(); | ||
| if (!trimmed) return undefined; | ||
|
|
||
| const sourceList = SEARCH_RESULT_SOURCES.join(' | '); | ||
|
|
||
| if (trimmed.startsWith('[') || trimmed.startsWith('{')) { | ||
| let parsed: unknown; | ||
| try { | ||
| parsed = JSON.parse(trimmed); | ||
| } catch { | ||
| throw new Error( | ||
| `${flag} must be valid JSON or a comma-separated "source:position" list.` | ||
| ); | ||
| } | ||
|
|
||
| const entries = Array.isArray(parsed) ? parsed : [parsed]; | ||
| const cleaned = entries.map((entry: any) => { | ||
| if (!entry || typeof entry !== 'object') { | ||
| throw new Error( | ||
| `${flag} JSON entries must be objects with a source and a position.` | ||
| ); | ||
| } | ||
| if (!isSearchResultSource(entry.source)) { | ||
| throw new Error(`${flag} source must be one of: ${sourceList}.`); | ||
| } | ||
| return { | ||
| source: entry.source, | ||
| position: parsePositionValue(entry.position, flag), | ||
| ...(typeof entry.reason === 'string' && entry.reason.trim() | ||
| ? { reason: entry.reason } | ||
| : {}), | ||
| }; | ||
| }); | ||
| return cleaned.length > 0 ? cleaned : undefined; | ||
| } | ||
|
|
||
| const cleaned = trimmed | ||
| .split(',') | ||
| .map((entry) => entry.trim()) | ||
| .filter((entry) => entry.length > 0) | ||
| .map((entry) => { | ||
| const separator = entry.lastIndexOf(':'); | ||
| if (separator === -1) { | ||
| throw new Error( | ||
| `${flag} entries must be "source:position" (e.g. web:1) — ` + | ||
| `results are grouped, so a bare position is ambiguous.` | ||
| ); | ||
| } | ||
| const source = entry.slice(0, separator).trim(); | ||
| if (!isSearchResultSource(source)) { | ||
| throw new Error(`${flag} source must be one of: ${sourceList}.`); | ||
| } | ||
| return { | ||
| source, | ||
| position: parsePositionValue(entry.slice(separator + 1), flag), | ||
| }; | ||
| }); | ||
|
|
||
| return cleaned.length > 0 ? cleaned : undefined; | ||
| } | ||
|
|
||
| // Accepts JSON arrays/objects, "topic: description" strings, comma- | ||
| // separated topic lists, or repeated values. Caps at 20 entries. | ||
| export function parseMissingContentArg( | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P3: The README documents only the compact syntax, leaving users of the advertised
positionsOrJsonform without its required JSON shape. Document the supported{source, position, reason}array here too.Prompt for AI agents