CompletionCompleteRequest extends Request
FinalYes
A request from the client to the server, to ask for completion options.
Tags
Table of Contents
Properties
- $argument : array<string|int, mixed>
- $ref : PromptReference|ResourceReference
- $id : string|int
- $meta : array<string, mixed>|null
Methods
- __construct() : mixed
- fromArray() : static
- getId() : string|int
- getMeta() : array<string, mixed>|null
- getMethod() : string
- jsonSerialize() : RequestData
- withId() : static
- withMeta() : static
- fromParams() : static
- getParams() : ResourceReference, argument: array{name: string, value: string}}
Properties
$argument read-only
public
array<string|int, mixed>
$argument
$ref read-only
public
PromptReference|ResourceReference
$ref
$id
protected
string|int
$id
$meta
protected
array<string, mixed>|null
$meta
= null
Methods
__construct()
public
__construct(PromptReference|ResourceReference $ref, array{name: string, value: string} $argument) : mixed
Parameters
- $ref : PromptReference|ResourceReference
-
the prompt or resource to complete
- $argument : array{name: string, value: string}
-
the argument to complete
fromArray()
public
static fromArray(RequestData $data) : static
Parameters
- $data : RequestData
Return values
staticgetId()
public
getId() : string|int
Return values
string|intgetMeta()
public
getMeta() : array<string, mixed>|null
Return values
array<string, mixed>|nullgetMethod()
public
static getMethod() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : RequestData
Return values
RequestDatawithId()
public
withId(string|int $id) : static
Parameters
- $id : string|int
Return values
staticwithMeta()
public
withMeta(array<string, mixed>|null $meta) : static
Parameters
- $meta : array<string, mixed>|null
Return values
staticfromParams()
protected
static fromParams(array<string|int, mixed>|null $params) : static
Parameters
- $params : array<string|int, mixed>|null
Return values
staticgetParams()
protected
getParams() : ResourceReference, argument: array{name: string, value: string}}