TTMSMCPElicitRequest Class
Request with which a server asks the connected client application, and through it the person using that application, for additional input while an operation is running.
API unit family: TMS.MCP.Elicitation
Inherits from: TPersistent
Syntax
TTMSMCPElicitRequest = class(TPersistent)
Remarks
The client answers with a TTMSMCPElicitResult. No language model is involved: a server that needs a model completion instead sends a sampling request, which runs in the opposite direction. Two modes are supported. Form mode, the default, sends a schema that the client renders as a set of inputs; URL mode sends a link that the client opens so the input can be collected outside the session.
Properties
| Name | Description |
|---|---|
| ElicitationId | Identifier that lets the server match the incoming answer to this request. |
| Message | Text shown to the user explaining why the input is being asked for. |
| Mode | Selects how the input is collected: 'form', the default, sends TTMSMCPElicitRequest.Schema for the client to render, while 'url' sends TTMSMCPElicitRequest.URL for the client to open. |
| RelatedTaskId | Identifier of the long-running task this request belongs to. |
| Schema | Fields the client is asked to fill in when the request is in form mode. |
| URL | Address the client opens to collect the input when the request is in URL mode. |
Methods
| Name | Description |
|---|---|
| ToJSON | Builds the payload of the elicitation request. |