ChatGPT Integration

The LLM Gateway makes it easy to expose your commerce capabilities as tools for OpenAI's GPT models. This allows you to build custom GPTs or integrate shopping into your own ChatGPT-powered applications.

Overview

OpenAI uses "Function Calling" to allow the model to interact with external APIs. The gateway automatically converts your Zod-based tool definitions into the JSON Schema format that OpenAI expects.

Usage with OpenAI SDK

1. Setup the OpenAI Adapter

1import { OpenAIAdapter } from '@commercegateway/commerce-gateway/openai';
2 
3const adapter = new OpenAIAdapter({
4  backends: { products: myBackend },
5  tools: ['search_products', 'get_product_details'],
6});

2. Generate Tool Definitions

Pass the generated tools to the OpenAI chat completions API:

1const response = await openai.chat.completions.create({
2  model: 'gpt-4-turbo',
3  messages: [{ role: 'user', content: 'Do you have any blue shirts?' }],
4  tools: adapter.getOpenAITools(), "cmt">// Automatically generated
5});

3. Handle Tool Calls

When the model decides to call a tool, use the gateway to execute it and return the result:

1if (response.choices[0].message.tool_calls) {
2  const toolCall = response.choices[0].message.tool_calls[0];
3  const result = await adapter.executeTool(toolCall);
4  
5  "cmt">// Send result back to OpenAI
6  const finalResponse = await openai.chat.completions.create({
7    model: 'gpt-4-turbo',
8    messages: [
9      ...messages,
10      response.choices[0].message,
11      {
12        role: 'tool',
13        tool_call_id: toolCall.id,
14        content: JSON.stringify(result),
15      },
16    ],
17  });
18}

Creating a Custom GPT

If you want to create a "Store Assistant" GPT on the OpenAI Store:

1. Deploy your LLM Gateway to a public URL (e.g., using Vercel).
2. In the GPT Editor, go to Actions -> Create new action.
3. Import the OpenAPI schema generated by the gateway at https://your-gateway.com/openapi.json.
4. Configure your API key for authentication.

Best Practices

• Model Selection: Use gpt-4-turbo or newer for the most reliable tool calling.
• System Prompt: Give the model clear instructions on when and how to use the commerce tools.
• Error Handling: OpenAI is sensitive to malformed tool responses. The gateway handles this by always returning structured JSON even on failure.