@sms/model-gpt-api

Interfaces

GptApiModelOptions

Defined in: packages/drivers/model/gpt-api/src/index.ts:34

Properties

apiKey?

optional apiKey?: string;

Defined in: packages/drivers/model/gpt-api/src/index.ts:36

Default: OPENAI_API_KEY from the environment (Node). In a Worker pass env.OPENAI_API_KEY.

baseURL?

optional baseURL?: string;

Defined in: packages/drivers/model/gpt-api/src/index.ts:43

client?

optional client?: Pick<OpenAI, "responses">;

Defined in: packages/drivers/model/gpt-api/src/index.ts:47

Bring your own client (Azure etc. expose the same responses.create).

debug?

optional debug?: (...args) => void;

Defined in: packages/drivers/model/gpt-api/src/index.ts:48

Parameters

Returns

void

effort?

optional effort?: "low" | "medium" | "high" | "minimal";

Defined in: packages/drivers/model/gpt-api/src/index.ts:42

reasoning.effort.

fetch?

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: packages/drivers/model/gpt-api/src/index.ts:45

Inject a fetch (tests, proxies).

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Returns

Promise<Response>

maxOutputTokens?

optional maxOutputTokens?: number;

Defined in: packages/drivers/model/gpt-api/src/index.ts:40

Default: 16000.

model?

optional model?: string;

Defined in: packages/drivers/model/gpt-api/src/index.ts:38

Default: ‘gpt-5.5’.

Functions

createGptApiModel()

function createGptApiModel(opts?): ModelService;

Defined in: packages/drivers/model/gpt-api/src/index.ts:149

Parameters

Returns

ModelService

gptApiModelPlugin()

function gptApiModelPlugin(opts?): SystemPlugin;

Defined in: packages/drivers/model/gpt-api/src/index.ts:154

createGptApiModel wrapped as the system plugin that provides model.

Parameters

Returns

SystemPlugin