@lobehub/chat 1.92.2 → 1.93.0

package/src/libs/model-runtime/utils/openaiHelpers.ts

@@ -41,6 +41,65 @@ export const convertOpenAIMessages = async (messages: OpenAI.ChatCompletionMessa
   )) as OpenAI.ChatCompletionMessageParam[];
 };
 
+export const convertOpenAIResponseInputs = async (
+  messages: OpenAI.ChatCompletionMessageParam[],
+) => {
+  let input: OpenAI.Responses.ResponseInputItem[] = [];
+  await Promise.all(
+    messages.map(async (message) => {
+      // if message is assistant messages with tool calls , transform it to function type item
+      if (message.role === 'assistant' && message.tool_calls && message.tool_calls?.length > 0) {
+        message.tool_calls?.forEach((tool) => {
+          input.push({
+            arguments: tool.function.name,
+            call_id: tool.id,
+            name: tool.function.name,
+            type: 'function_call',
+          });
+        });
+
+        return;
+      }
+
+      if (message.role === 'tool') {
+        input.push({
+          call_id: message.tool_call_id,
+          output: message.content,
+          type: 'function_call_output',
+        } as OpenAI.Responses.ResponseFunctionToolCallOutputItem);
+
+        return;
+      }
+
+      // default item
+      // also need handle image
+      const item = {
+        ...message,
+        content:
+          typeof message.content === 'string'
+            ? message.content
+            : await Promise.all(
+                (message.content || []).map(async (c) => {
+                  if (c.type === 'text') {
+                    return { ...c, type: 'input_text' };
+                  }
+
+                  const image = await convertMessageContent(c as OpenAI.ChatCompletionContentPart);
+                  return {
+                    image_url: (image as OpenAI.ChatCompletionContentPartImage).image_url?.url,
+                    type: 'input_image',
+                  };
+                }),
+              ),
+      } as OpenAI.Responses.ResponseInputItem;
+
+      input.push(item);
+    }),
+  );
+
+  return input;
+};
+
 export const pruneReasoningPayload = (payload: ChatStreamPayload) => {
   return {
     ...payload,

package/src/libs/model-runtime/utils/streams/openai/__snapshots__/responsesStream.test.ts.snap

@@ -0,0 +1,193 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`OpenAIResponsesStream > Reasoning > summary 1`] = `
+[
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: "in_progress"
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.in_progress","response":{"id":"resp_684313b89200819087f27686e0c822260b502bf083132d0d","object":"response","created_at":1749226424,"status":"in_progress","error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"o4-mini","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":"medium","summary":"detailed"},"service_tier":"auto","store":false,"temperature":1,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[{"type":"function","description":"a search service. Useful for when you need to answer questions about current events. Input should be a search query. Output is a JSON array of the query results","name":"lobe-web-browsing____search____builtin","parameters":{"properties":{"query":{"description":"The search query","type":"string"},"searchCategories":{"description":"The search categories you can set:","items":{"enum":["general","images","news","science","videos"],"type":"string"},"type":"array"},"searchEngines":{"description":"The search engines you can use:","items":{"enum":["google","bilibili","bing","duckduckgo","npm","pypi","github","arxiv","google scholar","z-library","reddit","imdb","brave","wikipedia","pinterest","unsplash","vimeo","youtube"],"type":"string"},"type":"array"},"searchTimeRange":{"description":"The time range you can set:","enum":["anytime","day","week","month","year"],"type":"string"}},"required":["query"],"type":"object"},"strict":true},{"type":"function","description":"A crawler can visit page content. Output is a JSON object of title, content, url and website","name":"lobe-web-browsing____crawlSinglePage____builtin","parameters":{"properties":{"url":{"description":"The url need to be crawled","type":"string"}},"required":["url"],"type":"object"},"strict":true},{"type":"function","description":"A crawler can visit multi pages. If need to visit multi website, use this one. Output is an array of JSON object of title, content, url and website","name":"lobe-web-browsing____crawlMultiPages____builtin","parameters":{"properties":{"urls":{"items":{"description":"The urls need to be crawled","type":"string"},"type":"array"}},"required":["urls"],"type":"object"},"strict":true}],"top_p":1,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"id":"rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d","type":"reasoning","summary":[]}
+
+",
+  "id: rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d
+",
+  "event: reasoning
+",
+  "data: ""
+
+",
+  "id: rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d
+",
+  "event: reasoning
+",
+  "data: "**Answering a"
+
+",
+  "id: rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d
+",
+  "event: reasoning
+",
+  "data: " numeric or 9.92"
+
+",
+  "id: rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d
+",
+  "event: reasoning
+",
+  "data: "."
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.reasoning_summary_text.done","item_id":"rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d","output_index":0,"summary_index":0,"text":"**Answering a numeric comparison**\\n\\nThe user is asking in Chinese which number is larger: 9.1 or 9.92. This is straightforward since 9.92 is clearly larger, as it's greater than 9.1. We can respond with \\"9.92大于9.1\\" without needing to search for more information. It's a simple comparison, but Iould also add a little explanation, noting that 9.92 is indeed 0.82 more than 9.1. However, keeping it simple with \\"9.92 > 9.1\\" is perfectly fine!"}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.reasoning_summary_part.done","item_id":"rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d","output_index":0,"summary_index":0,"part":{"type":"summary_text","text":"**Answering a numeric comparison**\\n\\nThe user is asking in Chinese which number is larger: 9.1 or 9.92. This is straightforward since 9.92 is clearly larger, as it's greater than 9.1. We can respond with \\"9.92大于9.1\\" without needing to search for more information. Is a simple comparison, but I could also add a little explanation, noting that 9.92 is indeed 0.82 more than 9.1. However, keeping it simple with \\"9.92 > 9.1\\" is perfectly fine!"}}
+
+",
+  "id: rs_6843fe13e73c8190a49d9372ef8cd46f08c019075e7c8955
+",
+  "event: reasoning
+",
+  "data: "\\n"
+
+",
+  "id: rs_6843fe13e73c8190a49d9372ef8cd46f08c019075e7c8955
+",
+  "event: reasoning
+",
+  "data: "**Exploring a mathematical sequence**"
+
+",
+  "id: rs_6843fe13e73c8190a49d9372ef8cd46f08c019075e7c8955
+",
+  "event: reasoning
+",
+  "data: " analyzing"
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.output_item.done","output_index":0,"item":{"id":"rs_684313b9774481908ee856625f82fb8c0b502bf083132d0d","type":"reasoning","summary":[{"type":"summary_text","text":"**Answering a numeric comparison**\\n\\nThe user is asking in Chinese which number is larger: 9.1 or 9.92. This is straightforward since 9.92 is clearly larger, as it's greater than 9.1. We can respond with \\"9.92大于9.1\\" without needing to search for more information. It's simple comparison, but I could also add a little explanation, noting that 9.92 is indeed 0.82 more than 9.1. However, keeping it simple with \\"9.92 > 9.1\\" is perfectly fine!"}]}}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"id":"msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d","type":"message","status":"in_progress","content":[],"role":"assistant"}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.content_part.added","item_id":"msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d","output_index":1,"content_index":0,"part":{"type":"output_text","annotations":[],"text":""}}
+
+",
+  "id: msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d
+",
+  "event: text
+",
+  "data: "9.92 比 9.1 大。"
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.output_text.done","item_id":"msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d","output_index":1,"content_index":0,"text":"9.92 比 9.1 大。"}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.content_part.done","item_id":"msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d","output_index":1,"content_index":0,"part":{"type":"output_text","annotations":[],"text":"9.92 比 9.1 大。"}}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: data
+",
+  "data: {"type":"response.output_item.done","output_index":1,"item":{"id":"msg_684313bee2c88190b0f4b09621ad7dc60b502bf083132d0d","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"text":"9.92 比 9. 大。"}],"role":"assistant"}}
+
+",
+  "id: resp_684313b89200819087f27686e0c822260b502bf083132d0d
+",
+  "event: usage
+",
+  "data: {"inputCacheMissTokens":93,"inputCachedTokens":2298,"inputTextTokens":2391,"outputReasoningTokens":128,"outputTextTokens":16,"totalInputTokens":2391,"totalOutputTokens":144,"totalTokens":2535}
+
+",
+]
+`;
+
+exports[`OpenAIResponsesStream > should transform OpenAI stream to protocol stream 1`] = `
+[
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: "in_progress"
+
+",
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: {"type":"response.in_progress","response":{"id":"resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58","object":"response","created_at":1748925324,"status":"in_progress","error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"o4-mini","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":"medium","summary":null},"service_tier":"auto","store":false,"temperature":1,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[{"type":"function","description":"a search service. Useful for when you need to answer questions about current events. Input should be a search query. Output is a JSON array of the query results","name":"lobe-web-browsing____search____builtin","parameters":{"properties":{"query":{"description":"The search query","type":"string"},"searchCategories":{"description":"The search categories you can set:","items":{"enum":["general","images","news","science","videos"],"type":"string"},"type":"array"},"searchEngines":{"description":"The search engines you can use:","items":{"enum":["google","bilibili","bing","duckduckgo","npm","pypi","github","arxiv","google scholar","z-library","reddit","imdb","brave","wikipedia","pinterest","unsplash","vimeo","youtube"],"type":"string"},"type":"array"},"searchTimeRange":{"description":"The time range you can set:","enum":["anytime","day","week","month","year"],"type":"string"}},"required":["query"],"type":"object"},"strict":true},{"type":"function","description":"A crawler can visit page content. Output is a JSON object of title, content, url and website","name":"lobe-web-browsing____crawlSinglePage____builtin","parameters":{"properties":{"url":{"description":"The url need to be crawled","type":"string"}},"required":["url"],"type":"object"},"strict":true},{"type":"function","description":"A crawler can visit multi pages. If need to visit multi website, use this one. Output is an array of JSON object of title, content, url and website","name":"lobe-web-browsing____crawlMultiPages____builtin","parameters":{"properties":{"urls":{"items":{"description":"The urls need to be crawled","type":"string"},"type":"array"}},"required":["urls"],"type":"object"},"strict":true}],"top_p":1,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}
+
+",
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: {"id":"rs_683e7bc80a9c81908f6e3d61ad63cc1e0cf93af363cdcf58","type":"reasoning","summary":[]}
+
+",
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: {"id":"msg_683e7bde8b0c8190970ab8c719c0fc1c0cf93af363cdcf58","type":"message","status":"in_progress","content":[],"role":"assistant"}
+
+",
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: {"type":"response.content_part.added","item_id":"msg_683e7bde8b0c8190970ab8c719c0fc1c0cf93af363cdcf58","output_index":1,"content_index":0,"part":{"type":"output_text","annotations":[],"text":"Hello"}}
+
+",
+  "id: resp_683e7b8ca3308190b6837f20d2c015cd0cf93af363cdcf58
+",
+  "event: data
+",
+  "data: {"type":"response.content_part.added","item_id":"msg_683e7bde8b0c8190970ab8c719c0fc1c0cf93af363cdcf58","output_index":1,"content_index":0,"part":{"type":"output_text","annotations":[],"text":" world"}}
+
+",
+]
+`;

package/src/libs/model-runtime/utils/streams/openai/index.ts

@@ -0,0 +1,2 @@
+export * from './openai';
+export * from './responsesStream';

package/src/libs/model-runtime/utils/streams/{openai.test.ts → openai/openai.test.ts}

@@ -2,8 +2,8 @@ import { describe, expect, it, vi } from 'vitest';
 
 import { AgentRuntimeErrorType } from '@/libs/model-runtime';
 
+import { FIRST_CHUNK_ERROR_KEY } from '../protocol';
 import { OpenAIStream } from './openai';
-import { FIRST_CHUNK_ERROR_KEY } from './protocol';
 
 describe('OpenAIStream', () => {
   it('should transform OpenAI stream to protocol stream', async () => {

package/src/libs/model-runtime/utils/streams/{openai.ts → openai/openai.ts}

@@ -3,9 +3,9 @@ import type { Stream } from 'openai/streaming';
 
 import { ChatMessageError, CitationItem } from '@/types/message';
 
-import { AgentRuntimeErrorType, ILobeAgentRuntimeErrorType } from '../../error';
-import { ChatStreamCallbacks } from '../../types';
-import { convertUsage } from '../usageConverter';
+import { AgentRuntimeErrorType, ILobeAgentRuntimeErrorType } from '../../../error';
+import { ChatStreamCallbacks } from '../../../types';
+import { convertUsage } from '../../usageConverter';
 import {
   FIRST_CHUNK_ERROR_KEY,
   StreamContext,
@@ -18,9 +18,9 @@ import {
   createSSEProtocolTransformer,
   createTokenSpeedCalculator,
   generateToolCallId,
-} from './protocol';
+} from '../protocol';
 
-export const transformOpenAIStream = (
+const transformOpenAIStream = (
   chunk: OpenAI.ChatCompletionChunk,
   streamContext: StreamContext,
 ): StreamProtocolChunk | StreamProtocolChunk[] => {