Skip to content

Interface: AgentElicitationQuestion ​

Defined in: packages/sdk/src/agents-service.ts:1384

Beta

One question in an AgentElicitationRequest.

Properties ​

id ​

ts
readonly id: string;

Defined in: packages/sdk/src/agents-service.ts:1387

Beta

Identifies the question when answering — the key in the map passed to AgentElicitationRequest.respond.


kind ​

ts
readonly kind: AgentElicitationQuestionKind;

Defined in: packages/sdk/src/agents-service.ts:1389

Beta

Which control to render.


prompt ​

ts
readonly prompt: string;

Defined in: packages/sdk/src/agents-service.ts:1392

Beta

The question to show. Never empty; for a single-question form this is the request's own AgentElicitationRequest.message.


title? ​

ts
readonly optional title?: string;

Defined in: packages/sdk/src/agents-service.ts:1394

Beta

A short header to show above prompt, when the agent gave one.


options? ​

ts
readonly optional options?: readonly AgentElicitationOption[];

Defined in: packages/sdk/src/agents-service.ts:1397

Beta

The choices, for "select" / "multi-select". Never empty when present — a question with no usable options arrives as "text".


custom? ​

ts
readonly optional custom?: AgentElicitationCustomAnswer;

Defined in: packages/sdk/src/agents-service.ts:1399

Beta

The question's own free-text box, when it has one.