Class BeakerSession

constructor

• new BeakerSession(options?: IBeakerSessionOptions): BeakerSession

  Parameters

  • Optionaloptions: IBeakerSessionOptions

  Returns BeakerSession

notebook

kernel

• get kernel(): null | IKernelConnection

  A reference to the Jupyter KernelConnection object for this session.

  Returns null | IKernelConnection

kernelInfo

• get kernelInfo(): any

  Returns any

lastKernelModel

• get lastKernelModel(): any

  Returns any

prevClientId

• get prevClientId(): undefined | string

  Returns undefined | string

renderer

• get renderer(): BeakerRenderer

  Returns BeakerRenderer

services

• get services(): ServiceManager

  A reference to the Jupyter ServiceManager which contains all of the services for this session.

  Returns ServiceManager

session

• get session(): SessionContext

  A reference to the underlying Jupyter SessionContext for this Beaker Session.

  Returns SessionContext

sessionId

• get sessionId(): string

  Returns string

sessionReady

• get sessionReady(): Promise<void>

  A promise that resolves once everything the session requires are also ready.

  Returns Promise<void>

status

• get status(): BeakerKernelStatus

  Returns the status of the Beaker kernel

  Returns BeakerKernelStatus

activeContext

• activeContext(): Promise<IActiveContextInfo>

  Returns a promise that once resolved provides detailed information about the active context.

  Returns Promise<IActiveContextInfo>

addCodeCell

• addCodeCell(source: string, metadata?: {}, outputs?: never[]): BeakerCodeCell

  Parameters

  • source: string

    The code contents of the cell.
  • metadata: {} = {}

    (Optional) Any metadata to be associated with the cell.
  • outputs: never[] = []

    (Optional) Any outputs that should be included/displayed.

  Returns BeakerCodeCell

  • A reference to the generated cell

addMarkdownCell

• addMarkdownCell(source: string, metadata?: {}): BeakerMarkdownCell

  Convenience method for adding a MarkdownCell to the notebook

  Parameters

  • source: string

    The raw markdown encoded text that should be rendered upon execute
  • metadata: {} = {}

    (Optional) Any metadata to be associated with the cell.

  Returns BeakerMarkdownCell

  • A reference to the generated cell

addQueryCell

• addQueryCell(source: string, metadata?: {}): BeakerQueryCell

  Convenience method for adding a QueryCell to the notebook

  Parameters

  • source: string

    The contents of the query for the LLM as a plain string
  • metadata: {} = {}

    (Optional) Any metadata to be associated with the cell.

  Returns BeakerQueryCell

  • A reference to the generated cell

addRawCell

• addRawCell(source: string, metadata?: {}): BeakerRawCell

  Convenience method for adding a RawCell to the notebook

  Parameters

  • source: string

    The raw contents to be included in the raw cell.
  • metadata: {} = {}

    (Optional) Any metadata to be associated with the cell.

  Returns BeakerRawCell

  • A reference to the generated cell

availableContexts

• availableContexts(): Promise<IBeakerAvailableContexts>

  Returns a promise, that once resolved provides all Beaker contexts available in the session.

  Returns Promise<IBeakerAvailableContexts>

executeAction

• executeAction(
      actionName: string,
      payload: JSONObject,
      messageId?: string,
  ): IBeakerFuture

  Executes a Beaker Action, handling all of the message

  The usual IBeakerFuture response handlers can be applied to the returned future to do act upon the responses.

  Parameters

  • actionName: string

    Name of the action to execute
  • payload: JSONObject

    Payload to pass along with the action
  • OptionalmessageId: string

    (Optional) Id for request message. If not provided, will be generated automatically.

  Returns IBeakerFuture

  • A future

interrupt

• interrupt(): Promise<any>

  Interrupt the kernel activity, stopping execution in both the beaker LLM ReAct loop and the subkernel as needed. See

  Returns Promise<any>

  • A future

loadNotebook

• loadNotebook(notebookJSONObject: object): void

  Populates the sessions notebook with the provided notebook json

  Parameters

  • notebookJSONObject: object

    The json representation of a notebook, as found inside an .ipynb file

  Returns void

reconnect

• reconnect(): Promise<SessionContext>

  Low-level method for reconnecting to the kernel.

  Returns Promise<SessionContext>

reset

• reset(): void

  Completely resets the session, clearing the notebook and history, and restarting the fresh kernel so it is in a fresh state.

  Returns void

sendBeakerMessage

• sendBeakerMessage(
      messageType: string,
      content: JSONObject,
      messageId?: string,
      metadata?: { [key: string]: any },
  ): IBeakerFuture

  Low-level method for sending a message to the Beaker kernel over the "shell" channel.

  Parameters

  • messageType: string

    The message type, as passed in msg.header.msg_type
  • content: JSONObject

    Any JSON-encodable payload to be included with the message
  • OptionalmessageId: string

    (Optional) Pre-defined id for the message. One will be generated if not provided.
  • Optionalmetadata: { [key: string]: any }

  Returns IBeakerFuture

setContext

• setContext(contextPayload: any): Promise<IActiveContextInfo>

  Parameters

  • contextPayload: any

  Returns Promise<IActiveContextInfo>