ContextQMD
Back to Agentic

OpenAI Chat Completions

docs/marketplace/ts-sdks/openai-chat.mdx

8.4.43.0 KB
Original Source
<Tip> There's no need for an adapter with the OpenAI SDK since all agentic tools are compatible with OpenAI by default. </Tip>

Install

<CodeGroup> ```bash npm npm install openai @agentic/platform-tool-client ```
bash
pnpm add openai @agentic/platform-tool-client
bash
bun add openai @agentic/platform-tool-client
bash
yarn add openai @agentic/platform-tool-client
</CodeGroup>

Usage

This example uses the @agentic/search tool.

ts
import 'dotenv/config'

import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = new OpenAI()

  const messages: OpenAI.ChatCompletionMessageParam[] = [
    {
      role: 'system',
      content: 'You are a helpful assistant. Be as concise as possible.'
    },
    { role: 'user', content: 'What is the weather in San Francisco?' }
  ]

  {
    // First call to OpenAI to invoke the tool
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs,
      tool_choice: 'required'
    })

    const message = res.choices[0]!.message!
    const toolCall = message.tool_calls![0]!.function!
    const toolResult = await searchTool.callTool(
      toolCall.name,
      toolCall.arguments
    )

    messages.push(message)
    messages.push({
      role: 'tool',
      tool_call_id: message.tool_calls![0]!.id,
      content: JSON.stringify(toolResult)
    })
  }

  {
    // Second call to OpenAI to generate a text response
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs
    })
    const message = res.choices?.[0]?.message
    console.log(message?.content)
  }
}

await main()

Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/openai

<Info> You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart) to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`. </Info> <Info> The [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool comes with a generous free tier, but once that runs out, you'll need to sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file. </Info>
sh
git clone [email protected]:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/openai/bin/weather.ts

Additional resources