StreamSession

<p>Stream Session R6 Class</p>
<p>Stream Session R6 Class</p>

Seamless integration between R and 'Goose' AI capabilities
including memory management, visualization enhancements, and workflow
automation. Save R objects to 'Goose' memory, apply Block branding to
visualizations, and manage data science project workflows.
For more information about 'Goose' AI, see <https://github.com/block/goose>.

Brandon Theriault

gooseR

R Integration for 'Goose' AI

StreamSession function

<p><div class="r6-fields"></div></p><dl>
<dt><code>session_id</code></dt>
<dd><p>Unique session identifier</p></dd><p></p><p>
<dt><code>history</code></dt>
<dd><p>Query/response history</p></dd></p><p>
<dt><code>active</code></dt>
<dd><p>Whether session is active
Initialize session</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/StreamSession%24new()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::StreamSession$new()"><code>StreamSession$new()</code></a></p></li>
<li><p><a href="/link/StreamSession%24query()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::StreamSession$query()"><code>StreamSession$query()</code></a></p></li>
<li><p><a href="/link/StreamSession%24get_history()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::StreamSession$get_history()"><code>StreamSession$get_history()</code></a></p></li>
<li><p><a href="/link/StreamSession%24close()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::StreamSession$close()"><code>StreamSession$close()</code></a></p></li>
<li><p><a href="/link/StreamSession%24clone()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::StreamSession$clone()"><code>StreamSession$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-StreamSession-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamSession$new(session_id)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>session_id</code></dt>
<dd><p>Session identifier
Send query in session</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-StreamSession-query"></a></p><div class="section" id="method-query-">
<h3>Method <code>query()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamSession$query(query, show_output = TRUE)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>query</code></dt>
<dd><p>Query to execute</p></dd></dl></div></p><p>
<dt><code>show_output</code></dt>
<dd><p>Show streaming output</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>Response text
Get session history</p>
</div><p></p><p></p><p><hr>
<a id="method-StreamSession-get_history"></a></p><div class="section" id="method-get-history-">
<h3>Method <code>get_history()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamSession$get_history()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Data frame of queries and responses
Close session</p>
</div></p><p></p><p><hr>
<a id="method-StreamSession-close"></a></p><div class="section" id="method-close-">
<h3>Method <code><a href="/link/close()?package=gooseR&version=0.1.2" data-mini-rdoc="gooseR::close()">close()</a></code></h3>
<p>Mark session inactive (client-side). This does not remove any
server-side Goose session.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamSession$close()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Invisible NULL</p>
</div></p><p></p><p><hr>
<a id="method-StreamSession-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamSession$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Stream Session R6 Class — StreamSession

<p><div class="r6-fields"></p><dl>
<dt><code>session_id</code></dt>
<dd><p>Unique session identifier</p></dd>


<dt><code>history</code></dt>
<dd><p>Query/response history</p></dd>


<dt><code>active</code></dt>
<dd><p>Whether session is active
Initialize session</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-StreamSession-new'><code>StreamSession$new()</code></a></p></li>
<li><p><a href='#method-StreamSession-query'><code>StreamSession$query()</code></a></p></li>
<li><p><a href='#method-StreamSession-get_history'><code>StreamSession$get_history()</code></a></p></li>
<li><p><a href='#method-StreamSession-close'><code>StreamSession$close()</code></a></p></li>
<li><p><a href='#method-StreamSession-clone'><code>StreamSession$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-StreamSession-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamSession$new(session_id)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>session_id</code></dt>
<dd><p>Session identifier
Send query in session</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-StreamSession-query"></a></p><div class='section' id='method-query-'>
<h3>Method <code>query()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamSession$query(query, show_output = TRUE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>query</code></dt>
<dd><p>Query to execute</p></dd>


<dt><code>show_output</code></dt>
<dd><p>Show streaming output</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>Response text
Get session history</p>
</div>

</div><p><hr>
<a id="method-StreamSession-get_history"></a></p><div class='section' id='method-get-history-'>
<h3>Method <code>get_history()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamSession$get_history()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Data frame of queries and responses
Close session</p>
</div>

</div><p><hr>
<a id="method-StreamSession-close"></a></p><div class='section' id='method-close-'>
<h3>Method <code><a href='https://rdrr.io/r/base/connections.html'>close()</a></code></h3>
<p>Mark session inactive (client-side). This does not remove any
server-side Goose session.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamSession$close()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Invisible NULL</p>
</div>

</div><p><hr>
<a id="method-StreamSession-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamSession$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


StreamSession: Stream Session R6 Class

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `query()`

Usage

Arguments

Returns

Method `get_history()`

Usage

Returns

Method `close()`

Usage

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method query()

Usage

Arguments

Returns

Method get_history()

Usage

Returns

Method close()

Usage

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `query()`

Method `get_history()`

Method `close()`

Method `clone()`