Interface CopilotSession

ReadonlysessionId

abort

• abort(): Promise<void>

  Stops the turn in flight.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Releases the session in memory, leaving what it persisted in place.

  Returns Promise<void>

on

• on<K extends keyof CopilotSessionEvents>(
      eventType: K,
      handler: (event: CopilotSessionEvents[K]) => void,
  ): () => void

  Registers a handler for one type of event and returns the function that removes it again.

  Type Parameters

  • K extends keyof CopilotSessionEvents

  Parameters

  • eventType: K
  • handler: (event: CopilotSessionEvents[K]) => void

  Returns () => void

send

• send(options: MessageOptions): Promise<string>

  Sends a turn and resolves with the id of the message it created.

  Parameters

  • options: MessageOptions

  Returns Promise<string>