GetPromptRequest extension type
Used by the client to get a prompt provided by the server.
- on
- Implemented types
Constructors
-
GetPromptRequest({required String name, Map<
String, Object?> ? arguments, Map<String, Result> ? inputResponses, String? requestState, MetaWithProgressToken? meta}) -
factory
-
GetPromptRequest.fromMap(Map<
String, Object?> _value)
Properties
-
arguments
→ Map<
String, Object?> ? -
Arguments to use for templating the prompt.
no setter
-
inputResponses
→ Map<
String, Result> ? -
What the client got for each request in
InputRequiredResult.inputRequests, under the keys the server gave them.
no setterinherited
- meta → MetaWithProgressToken?
-
If specified, the caller is requesting out-of-band progress notifications
for this request (as represented by notifications/progress).
no setterinherited
- name → String
-
The name of the prompt or prompt template.
no setter
- requestState → String?
-
The InputRequiredResult.requestState the server sent, echoed back
unread.
no setterinherited
Methods
-
createMessageResult(
String key) → CreateMessageResult? -
The sampling arm of the schema
InputResponseunion underkey.inherited -
elicitResult(
String key) → ElicitResult? -
The elicitation arm of the schema
InputResponseunion underkey.inherited -
listRootsResult(
String key) → ListRootsResult? -
The roots arm of the schema
InputResponseunion underkey.inherited
Constants
- methodName → const String