File size: 4,536 Bytes
d04f74a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | /**
* Session feedback: the `feedback/record` event, its command-independent
* producer, the `sessionFeedback` Host Remote a product surface records
* through, and the human-facing `/feedback` command. Recording appends one
* authoritative log-only event and does not start model work. The append is
* eager but unflushed, so acknowledgement reports that the entry is logged,
* not that it reached disk.
* @module @deepseek-ai/dsh-command-feedback
*/
import type { Context } from '@deepseek-ai/cordis'
import { CommandDefinitionId } from '@deepseek-ai/dsh-commands/brand'
import type { CommandInvocation, CommandResult } from '@deepseek-ai/dsh-commands'
import type { Session } from '@deepseek-ai/dsh-session'
import { getOrCreateAnonymousUserId } from '@deepseek-ai/dsh-anonymous-user-id'
import { TypertRemoteService, Remote } from '@deepseek-ai/dsh-typert-protocol'
import type {
FeedbackCategory,
FeedbackRecord,
SessionFeedbackRecordRequest,
SessionFeedbackRecordResult,
} from './types.ts'
export type * from './types.ts'
/**
* Every feedback category in the order product surfaces present them; each
* surface owns its localized labels.
*/
export const FEEDBACK_CATEGORIES = [
'task-result',
'instruction-following',
'product-interaction',
'service-stability',
'resource-cost',
'security-privacy-permission',
'other',
] as const satisfies readonly FeedbackCategory[]
export const name = 'command-feedback'
export const inject = ['commands']
const USAGE = 'Usage: /feedback <text>'
declare module '@deepseek-ai/cordis' {
interface Context {
sessionFeedback: SessionFeedbackService
}
}
/**
* Record feedback independently of any UI trigger. Surrounding whitespace is
* discarded and a blank text is recorded as absent; an entry with neither
* text nor category is still recorded.
* @param session - session the feedback describes.
* @param entry - human-authored remark and its category.
*/
export function recordFeedback(session: Session, entry: FeedbackRecord): void {
const text = entry.text?.trim() ?? ''
session.append('feedback/record', {
...(text.length === 0 ? {} : { text }),
...(entry.category === undefined ? {} : { category: entry.category }),
})
}
/**
* Validate, record, and acknowledge one feedback entry. Returning an error
* leaves no `feedback/record` event.
* @param invocation - receiving agent, raw command input, and UI cancellation.
* @returns an acknowledgement containing the receiving session and anonymous
* user ids, or a usage error when no feedback text was supplied.
*/
function executeFeedbackCommand(invocation: CommandInvocation): CommandResult {
if (invocation.rawInput.trim().length === 0) {
return { kind: 'error', text: `Feedback text is required. ${USAGE}` }
}
recordFeedback(invocation.agent.session, { text: invocation.rawInput })
return {
kind: 'success',
text: `Feedback recorded for session ${invocation.agent.session.id}\nAnonymous user: ${getOrCreateAnonymousUserId()}.`,
}
}
/** Host Remote through which a product surface records a Session-level remark. */
export class SessionFeedbackService extends TypertRemoteService {
static inject = ['sessions']
/**
* @param ctx - Host context carrying the live Session store.
*/
constructor(ctx: Context) {
super(ctx, 'sessionFeedback')
}
/**
* Record one remark on a live Session.
* @param request - target Session plus the optional text and category.
* @returns the recorded postcondition, or `session-not-found` when no live
* Session carries the id.
*/
@Remote('record')
record(request: SessionFeedbackRecordRequest): Promise<SessionFeedbackRecordResult> {
const session = this.ctx.sessions.get(request.sessionId)
if (session === undefined) {
return Promise.resolve({ ok: false, error: { code: 'session-not-found', sessionId: request.sessionId } })
}
recordFeedback(session, request)
return Promise.resolve({ ok: true, value: { recorded: true } })
}
}
/**
* Register the global `/feedback` command for every composed command adapter
* and mount the `sessionFeedback` Remote.
* @param ctx - Host context.
*/
export function apply(ctx: Context): void {
ctx.plugin(SessionFeedbackService)
ctx.commands.register({
definitionId: CommandDefinitionId('@deepseek-ai/dsh-command-feedback'),
name: 'feedback',
description: 'Record feedback about this session',
input: { hint: '<text>' },
recordInput: false,
handler: executeFeedbackCommand,
})
}
|