@modelprofile.com/flexharness-providers 10.4.0 → 10.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist_ts_providers/openai/index.d.ts +2 -1
- package/dist_ts_providers/openai/index.js +3 -2
- package/dist_ts_providers/openai/plugins.d.ts +3 -2
- package/dist_ts_providers/openai/plugins.js +3 -3
- package/dist_ts_providers/openai/smartai.chatgpt.middleware.d.ts +7 -0
- package/dist_ts_providers/openai/smartai.chatgpt.middleware.js +38 -4
- package/dist_ts_providers/openai/smartai.websearch.openai.d.ts +30 -0
- package/dist_ts_providers/openai/smartai.websearch.openai.js +10 -0
- package/package.json +2 -2
- package/readme.md +8 -0
- package/ts_providers/openai/index.ts +2 -1
- package/ts_providers/openai/plugins.ts +3 -2
- package/ts_providers/openai/readme.md +47 -0
- package/ts_providers/openai/smartai.chatgpt.middleware.ts +39 -3
- package/ts_providers/openai/smartai.websearch.openai.ts +34 -0
- package/ts_providers/readme.md +8 -0
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import * as plugins from './plugins.js';
|
|
2
2
|
export { classifyOpenAiLimit, readOpenAiError, type IOpenAiErrorDetails } from './smartai.limits.openai.js';
|
|
3
3
|
export { classifyOpenAiChatGptLimit } from './smartai.chatgpt.limits.js';
|
|
4
|
-
export { createOpenAiChatGptInstructionsMiddleware } from './smartai.chatgpt.middleware.js';
|
|
4
|
+
export { createOpenAiChatGptInstructionsMiddleware, normalizeOpenAiChatGptResponsesRequest } from './smartai.chatgpt.middleware.js';
|
|
5
|
+
export { createOpenAiWebSearchTool, type IOpenAiWebSearchToolOptions } from './smartai.websearch.openai.js';
|
|
5
6
|
export { createOpenAiChatGptAccessHeaders, createOpenAiChatGptAccessModelConnection, createOpenAiChatGptResolvingModelConnection, OPENAI_CHATGPT_CODEX_BASE_URL, OPENAI_CHATGPT_DEFAULT_ORIGINATOR, OpenAiChatGptAuthError, type IOpenAiChatGptAccess, type IOpenAiChatGptAccessConnectionOptions, type IOpenAiChatGptAccessGrant, type IOpenAiChatGptAccessResolveRequest, type IOpenAiChatGptReadAccess, type IOpenAiChatGptResolvingConnectionOptions, type IOpenAiChatGptWorkspaceIdentity, type TOpenAiChatGptRequestOutcome, } from './smartai.chatgpt.openai.js';
|
|
6
7
|
export { listOpenAiChatGptModels, OPENAI_CHATGPT_CATALOG_CLIENT_VERSION, OpenAiChatGptModelListError, type IOpenAiChatGptModel, type IOpenAiChatGptModelListOptions, type IOpenAiChatGptModelReasoningEffort, type IOpenAiChatGptModelServiceTier, type TOpenAiChatGptInputModality, type TOpenAiChatGptModelListErrorCode, } from './smartai.chatgpt.catalog.js';
|
|
7
8
|
export type TOpenAiReasoningEffort = 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';
|
|
@@ -2,7 +2,8 @@ import * as plugins from './plugins.js';
|
|
|
2
2
|
import { classifyOpenAiLimit } from './smartai.limits.openai.js';
|
|
3
3
|
export { classifyOpenAiLimit, readOpenAiError } from './smartai.limits.openai.js';
|
|
4
4
|
export { classifyOpenAiChatGptLimit } from './smartai.chatgpt.limits.js';
|
|
5
|
-
export { createOpenAiChatGptInstructionsMiddleware } from './smartai.chatgpt.middleware.js';
|
|
5
|
+
export { createOpenAiChatGptInstructionsMiddleware, normalizeOpenAiChatGptResponsesRequest } from './smartai.chatgpt.middleware.js';
|
|
6
|
+
export { createOpenAiWebSearchTool } from './smartai.websearch.openai.js';
|
|
6
7
|
export { createOpenAiChatGptAccessHeaders, createOpenAiChatGptAccessModelConnection, createOpenAiChatGptResolvingModelConnection, OPENAI_CHATGPT_CODEX_BASE_URL, OPENAI_CHATGPT_DEFAULT_ORIGINATOR, OpenAiChatGptAuthError, } from './smartai.chatgpt.openai.js';
|
|
7
8
|
export { listOpenAiChatGptModels, OPENAI_CHATGPT_CATALOG_CLIENT_VERSION, OpenAiChatGptModelListError, } from './smartai.chatgpt.catalog.js';
|
|
8
9
|
export const createOpenAiModelProvider = () => ({
|
|
@@ -33,4 +34,4 @@ export const createOpenAiModelProvider = () => ({
|
|
|
33
34
|
});
|
|
34
35
|
},
|
|
35
36
|
});
|
|
36
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
37
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19wcm92aWRlcnMvb3BlbmFpL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBRWpFLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxlQUFlLEVBQTRCLE1BQU0sNEJBQTRCLENBQUM7QUFDNUcsT0FBTyxFQUFFLDBCQUEwQixFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDekUsT0FBTyxFQUFFLHlDQUF5QyxFQUFFLHNDQUFzQyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDcEksT0FBTyxFQUFFLHlCQUF5QixFQUFvQyxNQUFNLCtCQUErQixDQUFDO0FBQzVHLE9BQU8sRUFDTCxnQ0FBZ0MsRUFDaEMsd0NBQXdDLEVBQ3hDLDJDQUEyQyxFQUMzQyw2QkFBNkIsRUFDN0IsaUNBQWlDLEVBQ2pDLHNCQUFzQixHQVN2QixNQUFNLDZCQUE2QixDQUFDO0FBQ3JDLE9BQU8sRUFDTCx1QkFBdUIsRUFDdkIscUNBQXFDLEVBQ3JDLDJCQUEyQixHQU81QixNQUFNLDhCQUE4QixDQUFDO0FBZ0N0QyxNQUFNLENBQUMsTUFBTSx5QkFBeUIsR0FBRyxHQUF5RSxFQUFFLENBQUMsQ0FBQztJQUNwSCxFQUFFLEVBQUUsUUFBUTtJQUNaLFFBQVEsRUFBRSxDQUFDLE9BQU8sRUFBRSxFQUFFO1FBQ3BCLE1BQU0sR0FBRyxHQUFHLE9BQU8sQ0FBQyxHQUFHLElBQUksV0FBVyxDQUFDO1FBQ3ZDLElBQUksR0FBRyxLQUFLLFdBQVcsSUFBSSxHQUFHLEtBQUssTUFBTSxFQUFFLENBQUM7WUFDMUMsTUFBTSxJQUFJLEtBQUssQ0FBQyx1QkFBdUIsTUFBTSxDQUFDLEdBQUcsQ0FBQywrQkFBK0IsQ0FBQyxDQUFDO1FBQ3JGLENBQUM7UUFDRCxNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBVSxFQUFFLElBQUksQ0FBQztRQUM1QyxJQUFJLFVBQVUsSUFBSSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUM1QyxNQUFNLE1BQU0sR0FBRyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxJQUFJLEtBQUssR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2xFLE1BQU0sSUFBSSxLQUFLLENBQUMsbUNBQW1DLE1BQU0sY0FBYyxHQUFHLDJCQUEyQixDQUFDLENBQUM7UUFDekcsQ0FBQztRQUNELE1BQU0sTUFBTSxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSxRQUFRLElBQUk7WUFDbEUsTUFBTSxFQUFFLE9BQU8sQ0FBQyxNQUFNO1lBQ3RCLEdBQUcsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxFQUFFLE9BQU8sRUFBRSxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQztTQUN6RCxDQUFDLENBQUM7UUFDSCxNQUFNLEtBQUssR0FBRyxHQUFHLEtBQUssTUFBTSxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUNsRixNQUFNLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDO1FBQ3RDLE1BQU0sTUFBTSxHQUFHLE9BQU8sQ0FBQywwQkFBMEIsQ0FBQztZQUNoRCxRQUFRLEVBQUUsUUFBUTtZQUNsQixRQUFRLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLFVBQVUsRUFBRSxhQUFhLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxtQkFBbUIsQ0FBQyxPQUFPLENBQUM7U0FDNUYsQ0FBQyxDQUFDO1FBQ0gsT0FBTyxPQUFPLENBQUMsaUJBQWlCLENBQUM7WUFDL0IsS0FBSztZQUNMLFVBQVUsRUFBRSxVQUFVLEVBQUUsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sRUFBRSxVQUFVLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDO1NBQ2hGLENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRixDQUFDLENBQUMifQ==
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { createOpenAI } from '@ai-sdk/openai';
|
|
1
|
+
import { createOpenAI, openai } from '@ai-sdk/openai';
|
|
2
2
|
import { wrapLanguageModel } from 'ai';
|
|
3
|
-
export { createOpenAI, wrapLanguageModel };
|
|
3
|
+
export { createOpenAI, openai, wrapLanguageModel };
|
|
4
|
+
export type { Tool } from 'ai';
|
|
4
5
|
export type { OpenAIChatLanguageModelOptions as OpenAIChatProviderOptions, OpenAIProviderSettings, OpenAIResponsesProviderOptions, } from '@ai-sdk/openai';
|
|
5
6
|
export type { LanguageModelV4CallOptions, LanguageModelV4Middleware } from '@ai-sdk/provider';
|
|
6
7
|
import { createModelLimitMiddleware, readEpochSeconds, readJsonRecord } from '@modelprofile.com/flexharness-models';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { createOpenAI } from '@ai-sdk/openai';
|
|
1
|
+
import { createOpenAI, openai } from '@ai-sdk/openai';
|
|
2
2
|
import { wrapLanguageModel } from 'ai';
|
|
3
|
-
export { createOpenAI, wrapLanguageModel };
|
|
3
|
+
export { createOpenAI, openai, wrapLanguageModel };
|
|
4
4
|
import { createModelLimitMiddleware, readEpochSeconds, readJsonRecord } from '@modelprofile.com/flexharness-models';
|
|
5
5
|
export { createModelLimitMiddleware, readEpochSeconds, readJsonRecord };
|
|
6
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX3Byb3ZpZGVycy9vcGVuYWkvcGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBQ3RELE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxNQUFNLElBQUksQ0FBQztBQUN2QyxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxpQkFBaUIsRUFBRSxDQUFDO0FBUW5ELE9BQU8sRUFBRSwwQkFBMEIsRUFBRSxnQkFBZ0IsRUFBRSxjQUFjLEVBQUUsTUFBTSxzQ0FBc0MsQ0FBQztBQUNwSCxPQUFPLEVBQUUsMEJBQTBCLEVBQUUsZ0JBQWdCLEVBQUUsY0FBYyxFQUFFLENBQUMifQ==
|
|
@@ -8,3 +8,10 @@ import type * as plugins from './plugins.js';
|
|
|
8
8
|
* instructions prefix a prompt cache keys on. A caller's own `instructions` or `systemMessageMode` is kept.
|
|
9
9
|
*/
|
|
10
10
|
export declare function createOpenAiChatGptInstructionsMiddleware(): plugins.LanguageModelV4Middleware;
|
|
11
|
+
/**
|
|
12
|
+
* Apply the ChatGPT instruction dialect to an already serialized Responses request (for HTTP gateways).
|
|
13
|
+
* Leading system/developer messages become the dynamic instructions prefix unless one was supplied.
|
|
14
|
+
* Later instructions keep their order as developer messages. Other request fields are preserved.
|
|
15
|
+
* This does not authenticate, choose a model, change storage/streaming policy, or mutate the input.
|
|
16
|
+
*/
|
|
17
|
+
export declare function normalizeOpenAiChatGptResponsesRequest(body: Readonly<Record<string, unknown>>): Record<string, unknown>;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const isNonEmptyString = (value) => typeof value === 'string' && value.trim().length > 0;
|
|
2
2
|
/** The number of system messages the prompt opens with, before its first other message. */
|
|
3
|
-
const
|
|
4
|
-
const firstOther = prompt.findIndex((message) => message.role !== 'system');
|
|
3
|
+
const countLeadingInstructions = (prompt, serialized = false) => {
|
|
4
|
+
const firstOther = prompt.findIndex((message) => message.role !== 'system' && !(serialized && message.role === 'developer'));
|
|
5
5
|
return firstOther === -1 ? prompt.length : firstOther;
|
|
6
6
|
};
|
|
7
7
|
const joinSystemInstructions = (messages) => {
|
|
@@ -27,7 +27,7 @@ export function createOpenAiChatGptInstructionsMiddleware() {
|
|
|
27
27
|
transformParams: async ({ params }) => {
|
|
28
28
|
const providerOptions = params.providerOptions ?? {};
|
|
29
29
|
const openAiProviderOptions = providerOptions.openai ?? {};
|
|
30
|
-
const leadingCount =
|
|
30
|
+
const leadingCount = countLeadingInstructions(params.prompt);
|
|
31
31
|
const shouldHoist = leadingCount > 0 && !isNonEmptyString(openAiProviderOptions.instructions);
|
|
32
32
|
const instructions = shouldHoist ? joinSystemInstructions(params.prompt.slice(0, leadingCount)) : undefined;
|
|
33
33
|
const prompt = shouldHoist ? params.prompt.slice(leadingCount) : params.prompt;
|
|
@@ -57,4 +57,38 @@ export function createOpenAiChatGptInstructionsMiddleware() {
|
|
|
57
57
|
},
|
|
58
58
|
};
|
|
59
59
|
}
|
|
60
|
-
|
|
60
|
+
const isRecord = (value) => value !== null && typeof value === 'object' && !Array.isArray(value);
|
|
61
|
+
/**
|
|
62
|
+
* Apply the ChatGPT instruction dialect to an already serialized Responses request (for HTTP gateways).
|
|
63
|
+
* Leading system/developer messages become the dynamic instructions prefix unless one was supplied.
|
|
64
|
+
* Later instructions keep their order as developer messages. Other request fields are preserved.
|
|
65
|
+
* This does not authenticate, choose a model, change storage/streaming policy, or mutate the input.
|
|
66
|
+
*/
|
|
67
|
+
export function normalizeOpenAiChatGptResponsesRequest(body) {
|
|
68
|
+
if (body.instructions !== undefined && body.instructions !== null && typeof body.instructions !== 'string') {
|
|
69
|
+
throw new Error('Responses instructions must be a string or null.');
|
|
70
|
+
}
|
|
71
|
+
const result = { ...body };
|
|
72
|
+
delete result.prompt_cache_retention;
|
|
73
|
+
if (!Array.isArray(body.input))
|
|
74
|
+
return result;
|
|
75
|
+
const input = body.input;
|
|
76
|
+
const prefix = countLeadingInstructions(input.map((item) => isRecord(item) ? item : {}), true);
|
|
77
|
+
const shouldHoist = prefix > 0 && body.instructions === undefined;
|
|
78
|
+
if (shouldHoist) {
|
|
79
|
+
const instructions = input.slice(0, prefix).map((item) => {
|
|
80
|
+
const content = item.content;
|
|
81
|
+
if (typeof content === 'string')
|
|
82
|
+
return content;
|
|
83
|
+
if (!Array.isArray(content) || !content.every((part) => isRecord(part) && part.type === 'input_text' && typeof part.text === 'string')) {
|
|
84
|
+
throw new Error('ChatGPT instruction messages must contain text only.');
|
|
85
|
+
}
|
|
86
|
+
return content.map((part) => part.text).join('');
|
|
87
|
+
}).filter(isNonEmptyString).join('\n');
|
|
88
|
+
// An empty prefix is an explicit empty instruction, not an invented prompt.
|
|
89
|
+
result.instructions = instructions;
|
|
90
|
+
}
|
|
91
|
+
result.input = input.slice(shouldHoist ? prefix : 0).map((item) => isRecord(item) && item.role === 'system' ? { ...item, role: 'developer' } : item);
|
|
92
|
+
return result;
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhaS5jaGF0Z3B0Lm1pZGRsZXdhcmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19wcm92aWRlcnMvb3BlbmFpL3NtYXJ0YWkuY2hhdGdwdC5taWRkbGV3YXJlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxLQUFjLEVBQW1CLEVBQUUsQ0FBQyxPQUFPLEtBQUssS0FBSyxRQUFRLElBQUksS0FBSyxDQUFDLElBQUksRUFBRSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7QUFJbkgsMkZBQTJGO0FBQzNGLE1BQU0sd0JBQXdCLEdBQUcsQ0FBQyxNQUFxQyxFQUFFLFVBQVUsR0FBRyxLQUFLLEVBQVUsRUFBRTtJQUNyRyxNQUFNLFVBQVUsR0FBRyxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxLQUFLLFFBQVEsSUFBSSxDQUFDLENBQUMsVUFBVSxJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztJQUM3SCxPQUFPLFVBQVUsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDO0FBQ3hELENBQUMsQ0FBQztBQUVGLE1BQU0sc0JBQXNCLEdBQUcsQ0FBQyxRQUFpQixFQUFzQixFQUFFO0lBQ3ZFLE1BQU0sWUFBWSxHQUFHLFFBQVE7U0FDMUIsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDO1NBQ2pDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0lBRTVCLE9BQU8sWUFBWSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQztBQUN2RSxDQUFDLENBQUM7QUFFRixNQUFNLG1DQUFtQyxHQUFHLENBQUMsT0FBMkIsRUFBVyxFQUFFO0lBQ25GLE9BQU8sT0FBTyxDQUFDLG9CQUFvQixLQUFLLFNBQVMsSUFBSSxPQUFPLENBQUMsc0JBQXNCLEtBQUssU0FBUyxDQUFDO0FBQ3BHLENBQUMsQ0FBQztBQUVGOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLFVBQVUseUNBQXlDO0lBQ3ZELE9BQU87UUFDTCxvQkFBb0IsRUFBRSxJQUFJO1FBQzFCLGVBQWUsRUFBRSxLQUFLLEVBQUUsRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFO1lBQ3BDLE1BQU0sZUFBZSxHQUFHLE1BQU0sQ0FBQyxlQUFlLElBQUksRUFBRSxDQUFDO1lBQ3JELE1BQU0scUJBQXFCLEdBQUcsZUFBZSxDQUFDLE1BQU0sSUFBSSxFQUFFLENBQUM7WUFDM0QsTUFBTSxZQUFZLEdBQUcsd0JBQXdCLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQzdELE1BQU0sV0FBVyxHQUFHLFlBQVksR0FBRyxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxxQkFBcUIsQ0FBQyxZQUFZLENBQUMsQ0FBQztZQUM5RixNQUFNLFlBQVksR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLHNCQUFzQixDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxZQUFZLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7WUFDNUcsTUFBTSxNQUFNLEdBQUcsV0FBVyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQztZQUMvRSxNQUFNLG1CQUFtQixHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEtBQUssUUFBUSxDQUFDLENBQUM7WUFDaEYsTUFBTSxzQkFBc0IsR0FBRyxtQkFBbUIsSUFBSSxxQkFBcUIsQ0FBQyxpQkFBaUIsS0FBSyxTQUFTLENBQUM7WUFDNUcsTUFBTSx5QkFBeUIsR0FBRyxtQ0FBbUMsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDO1lBRTdGLElBQUksQ0FBQyxXQUFXLElBQUksQ0FBQyxzQkFBc0IsSUFBSSxDQUFDLHlCQUF5QixFQUFFLENBQUM7Z0JBQzFFLE9BQU8sTUFBTSxDQUFDO1lBQ2hCLENBQUM7WUFFRCxNQUFNLHlCQUF5QixHQUF1QixFQUFFLEdBQUcscUJBQXFCLEVBQUUsQ0FBQztZQUNuRixPQUFPLHlCQUF5QixDQUFDLG9CQUFvQixDQUFDO1lBQ3RELE9BQU8seUJBQXlCLENBQUMsc0JBQXNCLENBQUM7WUFDeEQsSUFBSSxZQUFZLEVBQUUsQ0FBQztnQkFDakIseUJBQXlCLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztZQUN4RCxDQUFDO1lBQ0QsSUFBSSxzQkFBc0IsRUFBRSxDQUFDO2dCQUMzQix5QkFBeUIsQ0FBQyxpQkFBaUIsR0FBRyxXQUFXLENBQUM7WUFDNUQsQ0FBQztZQUVELE9BQU87Z0JBQ0wsR0FBRyxNQUFNO2dCQUNULE1BQU07Z0JBQ04sZUFBZSxFQUFFO29CQUNmLEdBQUcsZUFBZTtvQkFDbEIsTUFBTSxFQUFFLHlCQUF5QjtpQkFDbEM7YUFDMkMsQ0FBQztRQUNqRCxDQUFDO0tBQ0YsQ0FBQztBQUNKLENBQUM7QUFHRCxNQUFNLFFBQVEsR0FBRyxDQUFDLEtBQWMsRUFBb0MsRUFBRSxDQUFDLEtBQUssS0FBSyxJQUFJLElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUU1STs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxzQ0FBc0MsQ0FBQyxJQUF1QztJQUM1RixJQUFJLElBQUksQ0FBQyxZQUFZLEtBQUssU0FBUyxJQUFJLElBQUksQ0FBQyxZQUFZLEtBQUssSUFBSSxJQUFJLE9BQU8sSUFBSSxDQUFDLFlBQVksS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUMzRyxNQUFNLElBQUksS0FBSyxDQUFDLGtEQUFrRCxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUNELE1BQU0sTUFBTSxHQUFHLEVBQUUsR0FBRyxJQUFJLEVBQUUsQ0FBQztJQUMzQixPQUFPLE1BQU0sQ0FBQyxzQkFBc0IsQ0FBQztJQUNyQyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDO1FBQUUsT0FBTyxNQUFNLENBQUM7SUFDOUMsTUFBTSxLQUFLLEdBQWMsSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQyxNQUFNLE1BQU0sR0FBRyx3QkFBd0IsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDL0YsTUFBTSxXQUFXLEdBQUcsTUFBTSxHQUFHLENBQUMsSUFBSSxJQUFJLENBQUMsWUFBWSxLQUFLLFNBQVMsQ0FBQztJQUNsRSxJQUFJLFdBQVcsRUFBRSxDQUFDO1FBQ2hCLE1BQU0sWUFBWSxHQUFHLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFO1lBQ3ZELE1BQU0sT0FBTyxHQUFJLElBQWdDLENBQUMsT0FBTyxDQUFDO1lBQzFELElBQUksT0FBTyxPQUFPLEtBQUssUUFBUTtnQkFBRSxPQUFPLE9BQU8sQ0FBQztZQUNoRCxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLFlBQVksSUFBSSxPQUFPLElBQUksQ0FBQyxJQUFJLEtBQUssUUFBUSxDQUFDLEVBQUUsQ0FBQztnQkFDdkksTUFBTSxJQUFJLEtBQUssQ0FBQyxzREFBc0QsQ0FBQyxDQUFDO1lBQzFFLENBQUM7WUFDRCxPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7UUFDbkQsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3ZDLDRFQUE0RTtRQUM1RSxNQUFNLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztJQUNyQyxDQUFDO0lBQ0QsTUFBTSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUNoRSxRQUFRLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLElBQUksS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDLEVBQUUsR0FBRyxJQUFJLEVBQUUsSUFBSSxFQUFFLFdBQVcsRUFBRSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNwRixPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDIn0=
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import * as plugins from './plugins.js';
|
|
2
|
+
/** Options of OpenAI's provider-executed web search, as the Responses API `web_search` tool takes them. */
|
|
3
|
+
export interface IOpenAiWebSearchToolOptions {
|
|
4
|
+
/**
|
|
5
|
+
* `true` lets a search read live pages; `false` answers from OpenAI's cached index, the mode Codex uses by
|
|
6
|
+
* default. Unset leaves the choice to the backend.
|
|
7
|
+
*/
|
|
8
|
+
externalWebAccess?: boolean;
|
|
9
|
+
/** Domains the search may use, or must not use. */
|
|
10
|
+
filters?: {
|
|
11
|
+
allowedDomains?: string[];
|
|
12
|
+
blockedDomains?: string[];
|
|
13
|
+
};
|
|
14
|
+
/** How much of what it found the search puts into the model's context. */
|
|
15
|
+
searchContextSize?: 'low' | 'medium' | 'high';
|
|
16
|
+
/** Where results should be local to. */
|
|
17
|
+
userLocation?: {
|
|
18
|
+
type: 'approximate';
|
|
19
|
+
country?: string;
|
|
20
|
+
city?: string;
|
|
21
|
+
region?: string;
|
|
22
|
+
timezone?: string;
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* OpenAI's web search, executed by the provider: the model searches and reads results on OpenAI's side and
|
|
27
|
+
* the host fetches nothing, so no request of the host reaches the web. Add it to a run's tools under the name
|
|
28
|
+
* `web_search`. It is a Responses API tool, so it works with `api: 'responses'` and the ChatGPT connections.
|
|
29
|
+
*/
|
|
30
|
+
export declare const createOpenAiWebSearchTool: (optionsArg?: IOpenAiWebSearchToolOptions) => plugins.Tool;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as plugins from './plugins.js';
|
|
2
|
+
/**
|
|
3
|
+
* OpenAI's web search, executed by the provider: the model searches and reads results on OpenAI's side and
|
|
4
|
+
* the host fetches nothing, so no request of the host reaches the web. Add it to a run's tools under the name
|
|
5
|
+
* `web_search`. It is a Responses API tool, so it works with `api: 'responses'` and the ChatGPT connections.
|
|
6
|
+
*/
|
|
7
|
+
export const createOpenAiWebSearchTool = (optionsArg = {}) =>
|
|
8
|
+
// a provider-defined tool only describes the search; creating it sends no request
|
|
9
|
+
plugins.openai.tools.webSearch(optionsArg);
|
|
10
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhaS53ZWJzZWFyY2gub3BlbmFpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHNfcHJvdmlkZXJzL29wZW5haS9zbWFydGFpLndlYnNlYXJjaC5vcGVuYWkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxjQUFjLENBQUM7QUEwQnhDOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSx5QkFBeUIsR0FBRyxDQUFDLGFBQTBDLEVBQUUsRUFBZ0IsRUFBRTtBQUN0RyxrRkFBa0Y7QUFDbEYsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FBQyxDQUFDIn0=
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"author": "Task Venture Capital GmbH",
|
|
3
3
|
"license": "MIT",
|
|
4
4
|
"name": "@modelprofile.com/flexharness-providers",
|
|
5
|
-
"version": "10.
|
|
5
|
+
"version": "10.6.0",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"description": "Model providers, authentication, account management, media and research integrations in one package.",
|
|
8
8
|
"main": "./dist_ts_providers/index.js",
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
"@ai-sdk/provider": "^4.0.17",
|
|
84
84
|
"@ai-sdk/xai": "^5.0.5",
|
|
85
85
|
"@anthropic-ai/sdk": "0.128.0",
|
|
86
|
-
"@modelprofile.com/flexharness-models": "10.
|
|
86
|
+
"@modelprofile.com/flexharness-models": "10.6.0",
|
|
87
87
|
"ai": "^7.0.111",
|
|
88
88
|
"openai": "^7.22.0",
|
|
89
89
|
"proper-lockfile": "^4.1.2"
|
package/readme.md
CHANGED
|
@@ -51,6 +51,14 @@ and resolves once more after a rejected token, and `listOpenAiChatGptModels()`
|
|
|
51
51
|
reads the model catalog with the same access. Neither parses the token; see
|
|
52
52
|
`openai/readme.md`.
|
|
53
53
|
|
|
54
|
+
HTTP gateways can normalize already serialized Responses JSON with
|
|
55
|
+
`normalizeOpenAiChatGptResponsesRequest(body)` from `/openai` before using the
|
|
56
|
+
resolving connection's authenticated `settings.fetch`. It hoists leading
|
|
57
|
+
system/developer text when `instructions` is absent, preserves explicitly supplied
|
|
58
|
+
instructions (including empty or null), keeps later instructions in order as
|
|
59
|
+
developer messages, and removes unsupported cache retention without mutating the
|
|
60
|
+
input. See `openai/readme.md` for the request boundary.
|
|
61
|
+
|
|
54
62
|
The package includes the applicable OpenAI Codex license and third-party notices.
|
|
55
63
|
|
|
56
64
|
## License and Legal Information
|
|
@@ -3,7 +3,8 @@ import { classifyOpenAiLimit } from './smartai.limits.openai.js';
|
|
|
3
3
|
|
|
4
4
|
export { classifyOpenAiLimit, readOpenAiError, type IOpenAiErrorDetails } from './smartai.limits.openai.js';
|
|
5
5
|
export { classifyOpenAiChatGptLimit } from './smartai.chatgpt.limits.js';
|
|
6
|
-
export { createOpenAiChatGptInstructionsMiddleware } from './smartai.chatgpt.middleware.js';
|
|
6
|
+
export { createOpenAiChatGptInstructionsMiddleware, normalizeOpenAiChatGptResponsesRequest } from './smartai.chatgpt.middleware.js';
|
|
7
|
+
export { createOpenAiWebSearchTool, type IOpenAiWebSearchToolOptions } from './smartai.websearch.openai.js';
|
|
7
8
|
export {
|
|
8
9
|
createOpenAiChatGptAccessHeaders,
|
|
9
10
|
createOpenAiChatGptAccessModelConnection,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { createOpenAI } from '@ai-sdk/openai';
|
|
1
|
+
import { createOpenAI, openai } from '@ai-sdk/openai';
|
|
2
2
|
import { wrapLanguageModel } from 'ai';
|
|
3
|
-
export { createOpenAI, wrapLanguageModel };
|
|
3
|
+
export { createOpenAI, openai, wrapLanguageModel };
|
|
4
|
+
export type { Tool } from 'ai';
|
|
4
5
|
export type {
|
|
5
6
|
OpenAIChatLanguageModelOptions as OpenAIChatProviderOptions,
|
|
6
7
|
OpenAIProviderSettings,
|
|
@@ -116,6 +116,37 @@ The `/auth` subpath keeps its connections, which derive identity from the token
|
|
|
116
116
|
re-exports the ChatGPT limit classifier, the instructions middleware, the Codex base URL, the
|
|
117
117
|
default originator and `OpenAiChatGptAuthError` from here.
|
|
118
118
|
|
|
119
|
+
## Web search
|
|
120
|
+
|
|
121
|
+
`createOpenAiWebSearchTool(options?)` returns OpenAI's web search as a provider-executed tool: the model
|
|
122
|
+
searches and reads results on OpenAI's side, so the host sends no request to the web. Add it to a run's tools
|
|
123
|
+
under the name `web_search`, next to the host's own tools. It is a Responses API tool, so it works with the
|
|
124
|
+
default `api: 'responses'` and with both ChatGPT connections, whose Codex backend serves it.
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
import { runAgent } from '@modelprofile.com/flexharness-agent';
|
|
128
|
+
import { createOpenAiWebSearchTool } from '@modelprofile.com/flexharness-providers/openai';
|
|
129
|
+
|
|
130
|
+
const result = await runAgent({
|
|
131
|
+
...setup,
|
|
132
|
+
prompt: 'What is the head diameter of an M3 socket head cap screw?',
|
|
133
|
+
maxSteps: 4,
|
|
134
|
+
tools: { web_search: createOpenAiWebSearchTool({ externalWebAccess: true }) },
|
|
135
|
+
});
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
| Option | Sent as | Meaning |
|
|
139
|
+
| --- | --- | --- |
|
|
140
|
+
| `externalWebAccess` | `external_web_access` | `true` reads live pages; `false` answers from OpenAI's cached index, the mode Codex uses by default. Unset leaves it to the backend. |
|
|
141
|
+
| `filters.allowedDomains`, `filters.blockedDomains` | `filters.allowed_domains`, `filters.blocked_domains` | Domains the search may, or must not, use. |
|
|
142
|
+
| `searchContextSize` | `search_context_size` | `low`, `medium` or `high`: how much of what it found reaches the model. |
|
|
143
|
+
| `userLocation` | `user_location` | An approximate location results should be local to. |
|
|
144
|
+
|
|
145
|
+
A search arrives in the run as a tool call the provider executed, so the agent records it and never runs it
|
|
146
|
+
locally. Runs on OpenAI send `store: false`, so a later step of the same run replays the conversation without
|
|
147
|
+
references to the search item, which an unstored response could not resolve. Treat search results as
|
|
148
|
+
untrusted input.
|
|
149
|
+
|
|
119
150
|
## Issue Reporting and Security
|
|
120
151
|
|
|
121
152
|
Report issues and security concerns through [community.foss.global](https://community.foss.global).
|
|
@@ -140,3 +171,19 @@ Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
140
171
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
141
172
|
|
|
142
173
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
174
|
+
|
|
175
|
+
### Serialized Responses requests
|
|
176
|
+
|
|
177
|
+
`normalizeOpenAiChatGptResponsesRequest(body)` applies the ChatGPT instruction
|
|
178
|
+
dialect to JSON received by an HTTP gateway. Call it before sending that JSON to
|
|
179
|
+
`connection.settings.fetch`. It leaves explicit `instructions` unchanged, even an
|
|
180
|
+
empty string or null. When instructions are absent, leading system/developer
|
|
181
|
+
messages become the top-level instruction prefix. Text parts in one message are
|
|
182
|
+
joined without an added separator; messages are joined with a newline. Non-text
|
|
183
|
+
instruction prefixes are rejected. Later system messages become developer
|
|
184
|
+
messages in their original positions. `prompt_cache_retention` is removed.
|
|
185
|
+
|
|
186
|
+
The function returns a new body and never changes the input. Model, storage,
|
|
187
|
+
streaming, tool, reasoning, and other request fields retain their values. It does
|
|
188
|
+
not supply authentication, choose an account, enable persistence, or change the
|
|
189
|
+
requested response format. API-key OpenAI traffic should use its own dialect.
|
|
@@ -5,8 +5,8 @@ const isNonEmptyString = (value: unknown): value is string => typeof value === '
|
|
|
5
5
|
type TPrompt = plugins.LanguageModelV4CallOptions['prompt'];
|
|
6
6
|
|
|
7
7
|
/** The number of system messages the prompt opens with, before its first other message. */
|
|
8
|
-
const
|
|
9
|
-
const firstOther = prompt.findIndex((message) => message.role !== 'system');
|
|
8
|
+
const countLeadingInstructions = (prompt: readonly { role?: unknown }[], serialized = false): number => {
|
|
9
|
+
const firstOther = prompt.findIndex((message) => message.role !== 'system' && !(serialized && message.role === 'developer'));
|
|
10
10
|
return firstOther === -1 ? prompt.length : firstOther;
|
|
11
11
|
};
|
|
12
12
|
|
|
@@ -36,7 +36,7 @@ export function createOpenAiChatGptInstructionsMiddleware(): plugins.LanguageMod
|
|
|
36
36
|
transformParams: async ({ params }) => {
|
|
37
37
|
const providerOptions = params.providerOptions ?? {};
|
|
38
38
|
const openAiProviderOptions = providerOptions.openai ?? {};
|
|
39
|
-
const leadingCount =
|
|
39
|
+
const leadingCount = countLeadingInstructions(params.prompt);
|
|
40
40
|
const shouldHoist = leadingCount > 0 && !isNonEmptyString(openAiProviderOptions.instructions);
|
|
41
41
|
const instructions = shouldHoist ? joinSystemInstructions(params.prompt.slice(0, leadingCount)) : undefined;
|
|
42
42
|
const prompt = shouldHoist ? params.prompt.slice(leadingCount) : params.prompt;
|
|
@@ -69,3 +69,39 @@ export function createOpenAiChatGptInstructionsMiddleware(): plugins.LanguageMod
|
|
|
69
69
|
},
|
|
70
70
|
};
|
|
71
71
|
}
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
const isRecord = (value: unknown): value is Record<string, unknown> => value !== null && typeof value === 'object' && !Array.isArray(value);
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Apply the ChatGPT instruction dialect to an already serialized Responses request (for HTTP gateways).
|
|
78
|
+
* Leading system/developer messages become the dynamic instructions prefix unless one was supplied.
|
|
79
|
+
* Later instructions keep their order as developer messages. Other request fields are preserved.
|
|
80
|
+
* This does not authenticate, choose a model, change storage/streaming policy, or mutate the input.
|
|
81
|
+
*/
|
|
82
|
+
export function normalizeOpenAiChatGptResponsesRequest(body: Readonly<Record<string, unknown>>): Record<string, unknown> {
|
|
83
|
+
if (body.instructions !== undefined && body.instructions !== null && typeof body.instructions !== 'string') {
|
|
84
|
+
throw new Error('Responses instructions must be a string or null.');
|
|
85
|
+
}
|
|
86
|
+
const result = { ...body };
|
|
87
|
+
delete result.prompt_cache_retention;
|
|
88
|
+
if (!Array.isArray(body.input)) return result;
|
|
89
|
+
const input: unknown[] = body.input;
|
|
90
|
+
const prefix = countLeadingInstructions(input.map((item) => isRecord(item) ? item : {}), true);
|
|
91
|
+
const shouldHoist = prefix > 0 && body.instructions === undefined;
|
|
92
|
+
if (shouldHoist) {
|
|
93
|
+
const instructions = input.slice(0, prefix).map((item) => {
|
|
94
|
+
const content = (item as Record<string, unknown>).content;
|
|
95
|
+
if (typeof content === 'string') return content;
|
|
96
|
+
if (!Array.isArray(content) || !content.every((part) => isRecord(part) && part.type === 'input_text' && typeof part.text === 'string')) {
|
|
97
|
+
throw new Error('ChatGPT instruction messages must contain text only.');
|
|
98
|
+
}
|
|
99
|
+
return content.map((part) => part.text).join('');
|
|
100
|
+
}).filter(isNonEmptyString).join('\n');
|
|
101
|
+
// An empty prefix is an explicit empty instruction, not an invented prompt.
|
|
102
|
+
result.instructions = instructions;
|
|
103
|
+
}
|
|
104
|
+
result.input = input.slice(shouldHoist ? prefix : 0).map((item) =>
|
|
105
|
+
isRecord(item) && item.role === 'system' ? { ...item, role: 'developer' } : item);
|
|
106
|
+
return result;
|
|
107
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import * as plugins from './plugins.js';
|
|
2
|
+
|
|
3
|
+
/** Options of OpenAI's provider-executed web search, as the Responses API `web_search` tool takes them. */
|
|
4
|
+
export interface IOpenAiWebSearchToolOptions {
|
|
5
|
+
/**
|
|
6
|
+
* `true` lets a search read live pages; `false` answers from OpenAI's cached index, the mode Codex uses by
|
|
7
|
+
* default. Unset leaves the choice to the backend.
|
|
8
|
+
*/
|
|
9
|
+
externalWebAccess?: boolean;
|
|
10
|
+
/** Domains the search may use, or must not use. */
|
|
11
|
+
filters?: {
|
|
12
|
+
allowedDomains?: string[];
|
|
13
|
+
blockedDomains?: string[];
|
|
14
|
+
};
|
|
15
|
+
/** How much of what it found the search puts into the model's context. */
|
|
16
|
+
searchContextSize?: 'low' | 'medium' | 'high';
|
|
17
|
+
/** Where results should be local to. */
|
|
18
|
+
userLocation?: {
|
|
19
|
+
type: 'approximate';
|
|
20
|
+
country?: string;
|
|
21
|
+
city?: string;
|
|
22
|
+
region?: string;
|
|
23
|
+
timezone?: string;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* OpenAI's web search, executed by the provider: the model searches and reads results on OpenAI's side and
|
|
29
|
+
* the host fetches nothing, so no request of the host reaches the web. Add it to a run's tools under the name
|
|
30
|
+
* `web_search`. It is a Responses API tool, so it works with `api: 'responses'` and the ChatGPT connections.
|
|
31
|
+
*/
|
|
32
|
+
export const createOpenAiWebSearchTool = (optionsArg: IOpenAiWebSearchToolOptions = {}): plugins.Tool =>
|
|
33
|
+
// a provider-defined tool only describes the search; creating it sends no request
|
|
34
|
+
plugins.openai.tools.webSearch(optionsArg);
|
package/ts_providers/readme.md
CHANGED
|
@@ -51,6 +51,14 @@ and resolves once more after a rejected token, and `listOpenAiChatGptModels()`
|
|
|
51
51
|
reads the model catalog with the same access. Neither parses the token; see
|
|
52
52
|
`openai/readme.md`.
|
|
53
53
|
|
|
54
|
+
HTTP gateways can normalize already serialized Responses JSON with
|
|
55
|
+
`normalizeOpenAiChatGptResponsesRequest(body)` from `/openai` before using the
|
|
56
|
+
resolving connection's authenticated `settings.fetch`. It hoists leading
|
|
57
|
+
system/developer text when `instructions` is absent, preserves explicitly supplied
|
|
58
|
+
instructions (including empty or null), keeps later instructions in order as
|
|
59
|
+
developer messages, and removes unsupported cache retention without mutating the
|
|
60
|
+
input. See `openai/readme.md` for the request boundary.
|
|
61
|
+
|
|
54
62
|
The package includes the applicable OpenAI Codex license and third-party notices.
|
|
55
63
|
|
|
56
64
|
## License and Legal Information
|