Skip to content

OpenAIAssistantAdapter.mdx

Latest commit

 

History

History
65 lines (51 loc) · 2.02 KB

OpenAIAssistantAdapter.mdx

File metadata and controls

65 lines (51 loc) · 2.02 KB
Raw
title OpenAIAssistantAdapter
description Copilot Runtime adapter for OpenAI Assistant API.

{ /*

  • ATTENTION! DO NOT MODIFY THIS FILE!
  • This page is auto-generated. If you want to make any changes to this page, changes must be made at:
  • packages/runtime/src/service-adapters/openai/openai-assistant-adapter.ts */ } Copilot Runtime adapter for the OpenAI Assistant API.

Example

import { CopilotRuntime, OpenAIAssistantAdapter } from "@copilotkit/runtime";
import OpenAI from "openai";
 
const copilotKit = new CopilotRuntime();
 
const openai = new OpenAI({
  organization: "<your-organization-id>",
  apiKey: "<your-api-key>",
});
 
return new OpenAIAssistantAdapter({
  openai,
  assistantId: "<your-assistant-id>",
  codeInterpreterEnabled: true,
  fileSearchEnabled: true,
});

Constructor Parameters

The ID of the assistant to use. An optional OpenAI instance to use. If not provided, a new instance will be created. Whether to enable code interpretation. Whether to enable file search. Whether to disable parallel tool calls. You can disable parallel tool calls to force the model to execute tool calls sequentially. This is useful if you want to execute tool calls in a specific order so that the state changes introduced by one tool call are visible to the next tool call. (i.e. new actions or readables) Whether to keep the role in system messages as "System". By default, it is converted to "developer", which is used by newer OpenAI models