DataStream: DataStream Class

In openaistream: Streaming Capabilities for 'OpenAI API' Interactions

DataStream Class

Description

DataStream Class

DataStream Class

Details

A R6 class to manage data streams.

Active bindings

next_value

The next data value from the DataStream or an error message.

Methods

Public methods

• DataStream$new()

• DataStream$close()

• DataStream$get_state()

• DataStream$clone()

---

Method new()

Initialize the DataStream object

Usage

DataStream$new(requery, num = 2)

Arguments

requery

The requery object, usually of class 'curl'

num

Numeric. Defines the number of lines to read from the data source.

---

Method close()

Close the DataStream

This method tries to destroy the object, and closes the requery if opened.

Usage

DataStream$close()

Returns

A character message indicating the status of the close operation.

---

Method get_state()

Get the status of the DataStream

Usage

DataStream$get_state()

Returns

A character string indicating the current status of the DataStream.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DataStream$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

openaistream documentation built on June 22, 2024, 9:55 a.m.