1. class
  2. Hypervel
  3. \
  4. Ai
  5. \
  6. Streaming
  7. \
  8. Events
  9. \
  10. Citation

Citation

class Citation 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.

from  StreamEvent
void
broadcastNow(Channel|array $channels)

Broadcast the stream event immediately.

from  StreamEvent
string
type()

Get the event's type.

from  StreamEvent
StreamEvent
withInvocationId(string $id)

Set the invocation ID associated with the event.

from  StreamEvent
string
__toString()

Get the string representation of the event.

from  StreamEvent
__construct(string $id, string $messageId, Citation $citation, int $timestamp)

Create a citation event.

static Collection
combine(Collection|array $events)

Combine citation events into the sources the run cited, in the order it cited them.

Details

at line 45
array toArray()

Get the event as an array.

Return Value

array

Exceptions

UnhandledMatchError

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 17
__construct(string $id, string $messageId, Citation $citation, int $timestamp)

Create a citation event.

Parameters

string $id
string $messageId
Citation $citation
int $timestamp

at line 30
static Collection combine(Collection|array $events)

Combine citation events into the sources the run cited, in the order it cited them.

Parameters

Collection|array $events

Return Value

Collection