class TextDelta extends StreamEvent

Properties

string|null $invocationId from  StreamEvent

Methods

array
toArray()

Get the event as an array.

void
broadcast(Channel|array $channels, bool $now = true)

Broadcast the stream event immediately or using the queue.

void
broadcastNow(Channel|array $channels)

Broadcast the stream event immediately.

string
type()

Get the event's type.

withInvocationId(string $id)

Set the invocation ID associated with the event.

string
__toString()

Get the string representation of the event.

__construct(string $id, string $messageId, string $delta, int $timestamp)

Create a text delta event.

static string
combine(Collection|array $events)

Combine the text deltas, starting a new paragraph only after a step that ran tools.

static string
join(Collection|array $texts)

Join the text of each step, separating the steps with a blank line.

Details

at line 52
array toArray()

Get the event as an array.

Return Value

array

in StreamEvent at line 26
void broadcast(Channel|array $channels, bool $now = true)

Broadcast the stream event immediately or using the queue.

Parameters

Channel|array $channels
bool $now

Return Value

void

in StreamEvent at line 41
void broadcastNow(Channel|array $channels)

Broadcast the stream event immediately.

Parameters

Channel|array $channels

Return Value

void

in StreamEvent at line 49
string type()

Get the event's type.

Return Value

string

in StreamEvent at line 57
StreamEvent withInvocationId(string $id)

Set the invocation ID associated with the event.

Parameters

string $id

Return Value

StreamEvent

in StreamEvent at line 67
string __toString()

Get the string representation of the event.

Return Value

string

at line 14
__construct(string $id, string $messageId, string $delta, int $timestamp)

Create a text delta event.

Parameters

string $id
string $messageId
string $delta
int $timestamp

at line 25
static string combine(Collection|array $events)

Combine the text deltas, starting a new paragraph only after a step that ran tools.

Parameters

Collection|array $events

Return Value

string

at line 40
static string join(Collection|array $texts)

Join the text of each step, separating the steps with a blank line.

Parameters

Collection|array $texts

Return Value

string