Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dreamcode): CopilotExtension is now CopilotAgent #54

Merged
merged 1 commit into from
Sep 4, 2024
Merged

docs(dreamcode): CopilotExtension is now CopilotAgent #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 31 additions & 37 deletions dreamcode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,37 +20,31 @@ Please, any questions/feedback/feelings are welcome. This is a safe space. Pleas
```js
import { createServer } from "http";

import {
CopilotExtension,
createNodeMiddleware,
} from "@octokit/copilot-extension";
import { CopilotAgent, createNodeMiddleware } from "@octokit/copilot-extension";

const copilotExtension = new CopilotExtension({
const agent = new CopilotAgent({
userAgent: "my-app-name",
});

copilotExtension.on(
"message",
async ({ message, octokit, prompt, respond, log }) => {
log.info("Received a message:", message.content);

const { data: user } = await octokit.request("GET /user");
await respond.text(`Hello, ${user.login}!`);

await respond.confirmation({
title: "Would you like to hear a joke?",
message: "I have a joke about construction, but I'm still working on it.",
id: "joke",
// optional
meta: {
other: "data",
},
});
}
);
agent.on("message", async ({ message, octokit, prompt, respond, log }) => {
log.info("Received a message:", message.content);

const { data: user } = await octokit.request("GET /user");
await respond.text(`Hello, ${user.login}!`);

await respond.confirmation({
title: "Would you like to hear a joke?",
message: "I have a joke about construction, but I'm still working on it.",
id: "joke",
// optional
meta: {
other: "data",
},
});
});

// https://github.com/github/copilot-partners/blob/6d1cde3a1abb147da53f1a39864661dc824d40b5/docs/confirmations.md
copilotExtension.on(
agent.on(
"confirmation",
async ({ confirmation, octokit, prompt, respond, log }) => {
if (confirmation.id === "joke") {
Expand All @@ -69,6 +63,9 @@ copilotExtension.on(
await respond.text("Hmm, something went wrong. Please try again later.");
}
);

createServer(createNodeMiddleware(agent)).listen(3000);
agent.log.info("Listening on http://localhost:3000");
```

### Book a flight
Expand All @@ -78,12 +75,9 @@ I'm using [@daveebbelaar](https://github.com/daveebbelaar)'s example of a flight
```js
import { createServer } from "http";

import {
CopilotExtension,
createNodeMiddleware,
} from "@octokit/copilot-extension";
import { CopilotAgent, createNodeMiddleware } from "@octokit/copilot-extension";

const copilotExtension = new CopilotExtension({
const copilotAgent = new CopilotAgent({
userAgent: "book-a-flight",

// TBD: are we supporting a default model? Globally, or for an enterprise/organization/user?
Expand Down Expand Up @@ -169,33 +163,33 @@ const copilotExtension = new CopilotExtension({

// you can still hook into messages and function calls before they are passed through
// to the chat completions API.
copilotExtension.on("message", async ({ log }) => {
copilotAgent.on("message", async ({ log }) => {
log.info("Received a message:", message.content);

// if you don't want a request to be forwarded to the chat completions API, call `await respond.done()` explicitly
});
copilotExtension.on("function_call", async ({ log, name, parameters }) => {
copilotAgent.on("function_call", async ({ log, name, parameters }) => {
log.info(
"Received a function call for %s with parameters %o",
name,
parameters
);
});

createServer(createNodeMiddleware(copilotExtension)).listen(3000);
copilotExtension.log.info("Listening on http://localhost:3000");
createServer(createNodeMiddleware(copilotAgent)).listen(3000);
copilotAgent.log.info("Listening on http://localhost:3000");
```

For other environments, these methods are available:

```js
// verify the payload and call handlers
await copilotExtension.verifyAndReceive({ payload, signature, keyId });
await copilotAgent.verifyAndReceive({ payload, signature, keyId });
// same, but skip verification
await copilotExtension.receive({ payload });
await copilotAgent.receive({ payload });

// and if you don't want to use the event-based API
const { isValidRequest, payload } = await copilotExtension.verifyAndParse(
const { isValidRequest, payload } = await copilotAgent.verifyAndParse(
payload,
signature,
keyId
Expand Down