@modelprofile.com/flexharness-providers 10.5.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.
@@ -2,6 +2,7 @@ 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
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';
@@ -3,6 +3,7 @@ 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
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90c19wcm92aWRlcnMvb3BlbmFpL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBQ3hDLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBRWpFLE9BQU8sRUFBRSxtQkFBbUIsRUFBRSxlQUFlLEVBQTRCLE1BQU0sNEJBQTRCLENBQUM7QUFDNUcsT0FBTyxFQUFFLDBCQUEwQixFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDekUsT0FBTyxFQUFFLHlDQUF5QyxFQUFFLHNDQUFzQyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDcEksT0FBTyxFQUNMLGdDQUFnQyxFQUNoQyx3Q0FBd0MsRUFDeEMsMkNBQTJDLEVBQzNDLDZCQUE2QixFQUM3QixpQ0FBaUMsRUFDakMsc0JBQXNCLEdBU3ZCLE1BQU0sNkJBQTZCLENBQUM7QUFDckMsT0FBTyxFQUNMLHVCQUF1QixFQUN2QixxQ0FBcUMsRUFDckMsMkJBQTJCLEdBTzVCLE1BQU0sOEJBQThCLENBQUM7QUFnQ3RDLE1BQU0sQ0FBQyxNQUFNLHlCQUF5QixHQUFHLEdBQXlFLEVBQUUsQ0FBQyxDQUFDO0lBQ3BILEVBQUUsRUFBRSxRQUFRO0lBQ1osUUFBUSxFQUFFLENBQUMsT0FBTyxFQUFFLEVBQUU7UUFDcEIsTUFBTSxHQUFHLEdBQUcsT0FBTyxDQUFDLEdBQUcsSUFBSSxXQUFXLENBQUM7UUFDdkMsSUFBSSxHQUFHLEtBQUssV0FBVyxJQUFJLEdBQUcsS0FBSyxNQUFNLEVBQUUsQ0FBQztZQUMxQyxNQUFNLElBQUksS0FBSyxDQUFDLHVCQUF1QixNQUFNLENBQUMsR0FBRyxDQUFDLCtCQUErQixDQUFDLENBQUM7UUFDckYsQ0FBQztRQUNELE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDO1FBQzVDLElBQUksVUFBVSxJQUFJLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzVDLE1BQU0sTUFBTSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLElBQUksS0FBSyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDbEUsTUFBTSxJQUFJLEtBQUssQ0FBQyxtQ0FBbUMsTUFBTSxjQUFjLEdBQUcsMkJBQTJCLENBQUMsQ0FBQztRQUN6RyxDQUFDO1FBQ0QsTUFBTSxNQUFNLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLFFBQVEsSUFBSTtZQUNsRSxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU07WUFDdEIsR0FBRyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLEVBQUUsT0FBTyxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDO1NBQ3pELENBQUMsQ0FBQztRQUNILE1BQU0sS0FBSyxHQUFHLEdBQUcsS0FBSyxNQUFNLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ2xGLE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUM7UUFDdEMsTUFBTSxNQUFNLEdBQUcsT0FBTyxDQUFDLDBCQUEwQixDQUFDO1lBQ2hELFFBQVEsRUFBRSxRQUFRO1lBQ2xCLFFBQVEsRUFBRSxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsVUFBVSxFQUFFLGFBQWEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLG1CQUFtQixDQUFDLE9BQU8sQ0FBQztTQUM1RixDQUFDLENBQUM7UUFDSCxPQUFPLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQztZQUMvQixLQUFLO1lBQ0wsVUFBVSxFQUFFLFVBQVUsRUFBRSxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxFQUFFLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUM7U0FDaEYsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztDQUNGLENBQUMsQ0FBQyJ9
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX3Byb3ZpZGVycy9vcGVuYWkvcGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFDOUMsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sSUFBSSxDQUFDO0FBQ3ZDLE9BQU8sRUFBRSxZQUFZLEVBQUUsaUJBQWlCLEVBQUUsQ0FBQztBQU8zQyxPQUFPLEVBQUUsMEJBQTBCLEVBQUUsZ0JBQWdCLEVBQUUsY0FBYyxFQUFFLE1BQU0sc0NBQXNDLENBQUM7QUFDcEgsT0FBTyxFQUFFLDBCQUEwQixFQUFFLGdCQUFnQixFQUFFLGNBQWMsRUFBRSxDQUFDIn0=
6
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzX3Byb3ZpZGVycy9vcGVuYWkvcGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBQ3RELE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxNQUFNLElBQUksQ0FBQztBQUN2QyxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sRUFBRSxpQkFBaUIsRUFBRSxDQUFDO0FBUW5ELE9BQU8sRUFBRSwwQkFBMEIsRUFBRSxnQkFBZ0IsRUFBRSxjQUFjLEVBQUUsTUFBTSxzQ0FBc0MsQ0FBQztBQUNwSCxPQUFPLEVBQUUsMEJBQTBCLEVBQUUsZ0JBQWdCLEVBQUUsY0FBYyxFQUFFLENBQUMifQ==
@@ -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.0",
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.5.0",
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"
@@ -4,6 +4,7 @@ import { classifyOpenAiLimit } from './smartai.limits.openai.js';
4
4
  export { classifyOpenAiLimit, readOpenAiError, type IOpenAiErrorDetails } from './smartai.limits.openai.js';
5
5
  export { classifyOpenAiChatGptLimit } from './smartai.chatgpt.limits.js';
6
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).
@@ -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);