1. Reference
2. UIKit
3. Copilot

Copilot component

<wy-copilot> | WyCopilot

The copilot component renders a complete and functional user interface for chatting with an AI agent. It needs to be configured with an AI agent and can have instructions and use any contextual data you provide (as long as it's a string).

The copilot chat is agent-to-user which means each user has their own private chat with the agent. Each time the copilot component is loaded a fresh chat is started, but it can optionally be configured with a uid to persist the conversation.

If you specify a uid it needs to be unique per user and agent (if you intend to use several agents). For ease-of-use, you can do this automatically by specifying the autoUid property instead of the uid property.

Importing

If you installed the UIKit with npm you can use the following snippet to import the component into your project. Otherwise, if you installed the UIKit as a <script> you can ignore this section.

import { WyCopilot } from "@weavy/uikit-web";

Examples

Generic copilot

The agent property is required and should correspond to an agent in your environment. You may switch between agents whenever you like, but remember that the conversation also changes.

Here we use the built-in agent with uid assistant.

<wy-copilot agent="assistant"></wy-copilot>

Copilot with instructions and contextual data

<div id="my-sample-content">
  <h1>ACME</h1>
  <ul>
    <li>Wile E. Coyote</li>
    <li>Daffy Duck</li>
    <li>Porky Pig</li>
  </ul>
</div>

<wy-copilot uid="my-copilot" agent="assistant"></wy-copilot>

<script>
  const copilot = document.querySelector("#my-copilot");
  copilot.instructions = "Answer in a whacky way with many emojis.";
  copilot.contextualData =
    document.querySelector("#my-sample-content").innerHTML;
</script>

Copilot with a custom button and suggestions

You may use slots to provide custom functionality to the copilot. This example shows a button to reset the conversation and some custom suggestions.

When the suggestions have the .suggestion class, they automatically get their text inserted into the editor when clicked.

In this example we use the pre-styled weavy sub components, but you may use any elements or components you like.

<wy-copilot uid="my-copilot" agent="assistant">
  <wy-button
    slot="actions"
    kind="icon"
    onclick="document.querySelector('#my-copilot').reset()"
  >
    <wy-icon name="stars"></wy-icon>
  </wy-button>

  <wy-button slot="suggestion-list" class="suggestion"
    >Summarize this page</wy-button
  >
  <wy-button slot="suggestion-list" class="suggestion"
    >What keywords are used?</wy-button
  >
</wy-copilot>

All Weavy sub components can be found by importing WeavyComponents from the UI Kit.

HTML attributes

Attributes can be set when using the component in HTML. All attributes have corresponding Javascript properties.

Most attributes are optional and/or has sensible default values. Any required attributes are indicated with an asterisk (*).

Learn more about attributes and properties.

JavaScript properties

Properties can be used in JavaScript. Some of them have corresponding HTML attributes where applicable.

JavaScript methods

Methods for the component are available in JavaScript. Methods that are async return a promise.

DOM Events

The component triggers custom events that bubbles up the DOM tree. They can be listened to using the addEventListener() method.

Learn more about events.

Slots

The slots can be used to inject elements into the component. All predefined child nodes of the slot will be replaced with the injected content.

To prevent child nodes from rendering before the component has loaded you can hide them using CSS.

wy-copilot:not(:defined) {
  display: none;
}

Available features

The following features are available for the component. Configure them with a space separated list using the features attribute. Features that are available but disabled by default are indicated by parenthesis ().

Learn more about features.