@j-o-r/hello-dave 0.0.0

package/lib/API/openai.com/reponses/text.js

@@ -0,0 +1,416 @@
+/*
+https://platform.openai.com/docs/api-reference/responses/create
+Allthough we can use store = true and previous_response_id: response.id,
+Stil all tokens are billed.
+*/
+import { GLOBAL } from '../../../fafs.js'
+import { request as doRequest } from '@j-o-r/apiserver';
+import { sleep } from '@j-o-r/sh';
+/**
+* @typedef {import('../../../Prompt.js').default} Prompt
+* @typedef {import('../../../ToolSet.js').default} ToolSet
+*/
+/**
+* @typedef {'code_interpreter_call.outputs'|'computer_call_output.output.image_url'|'file_search_call.results'|'message.input_image.image_url'|'message.output_text.logprobs'|'reasoning.encrypted_conten'} Includes
+*/
+/**
+* @typedef {Object} OAOptions
+* @property {boolean} [background=false] - Whether to run in the background.
+* @property {?string} [include=null] - Optional include parameter.
+* @property {OAInput[]} [input=[]] - Array of input objects.
+* @property {string} [instructions=''] - Instructions for the model.
+* @property {number} [max_output_tokens=4000] - Maximum number of output tokens.
+* @property {number} [max_tool_calls=10] - Maximum number of tool calls allowed.
+* @property {?Object} [metadata=null] - Optional metadata object.
+* @property {'gpt-4.1'|'GPT-4o'|'o3'|'o3-mini'|'o4-mini'|'o1'|'o3-pro'} [model='gpt-4.1'] - Model version to use.
+* @property {?string} [prompt=null] - Reusable prompt string.
+* @property {Object} [reasoning={effort: 'medium', summary: 'auto'}] - Reasoning configuration.
+* @property {'low'|'medium'|'high'|null} reasoning.effort - Effort level for reasoning.
+* @property {'auto'|'concise'|'detailed'} reasoning.summary - Summary type for reasoning.
+* @property {'low'|'medium'|'high'} [search]
+* @property {'auto'} [service_tier='auto'] - Service tier option, default is auto-selected.
+* @property {boolean} [store=false] - Whether to store the response or not.
+* @property {boolean} [stream=false] - Whether to stream the response or not.
+* @property {number} [temperature=1] - Sampling temperature between 0 and 2.
+* @property {Object} [text={format: {type: "text"}}] - text format
+* @property {'text'|'json_schema'} text.format - Summary type for reasoning.
+* @property {boolean} [parallel_tool_calls=true] - Allow parallel tool calls if true.
+* @property {'auto'} [tool_choice='auto'] - Tool choice setting, default is auto-selected.
+* @property {OAToolCall[]} tools=[] Array of tool call objects.
+* @property {?number } top_logprobs=null An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
+* @property {?number } top_p=1 Top-p sampling value between 0 and 1.
+* @property {?string} [previous_response_id] - Needed reponse_id to validate tool calls on the next request
+*/
+/**
+* @typedef {Object} OAToolCall
+* @property {string} type - The type of the tool call, e.g., "function".
+* @property {string} name - The name of the function.
+* @property {string} description - A brief description of what the function does.
+* @property {Object} parameters - The parameters required by the function.
+* @property {string} parameters.type - The type of parameters object, usually "object".
+* @property {Object.<string, OAParameterProperty>} parameters.properties - An object describing each parameter property.
+* @property {string[]} [parameters.required] - An array of required parameter names.
+*/
+
+/**
+* @typedef {Object} OAParameterProperty
+* @property {string} type - The data type of the parameter, e.g., "string".
+* @property {string} description - A brief description of the parameter.
+*/
+/**
+* @typedef {Object} OAMessage
+* @property {'assistant'|'user'} role - The role of the participant (e.g., "assistant", "user").
+* @property {Array<OAContent>} content - The content of the message.
+*/
+/**
+* @typedef {Object} OAContent
+* @property {'output_text'|'input_text'} type - The type of content (e.g., "output_text", "input_text").
+* @property {string} text - The text content.
+*/
+/**
+* @typedef {Object} OAFunctionCall
+* @property {string} id - Unique identifier for the function call.
+* @property {'function_call'} type - Indicates this is a function call (e.g., "function_call").
+* @property {string} call_id - Unique identifier for the specific function call instance.
+* @property {string} name - The name of the function being called.
+* @property {string} arguments - JSON string representing arguments passed to the function.
+*/
+/**
+* @typedef {Object} OAFunctionCallOutput
+* @property {'function_call_output'} type - Indicates this is a function call output (e.g., "function_call_output").
+* @property {string} call_id - Identifier linking to the related function call.
+* @property {string} output - JSON string representing the output from the function call.
+*/
+/**
+* Represents an OpenAI API response request INPUT structure.
+*
+* @typedef {(OAMessage|OAFunctionCall|OAFunctionCallOutput)} OAInput
+*/
+
+const API_URL = 'https://api.openai.com/v1/responses';
+
+/**
+* Get the default headers
+* @returns {object}
+*/
+const getHeaders = (USER_AGENT = '@j-o-r/agents') => {
+	if (!process.env['OPENAIKEY']) {
+		throw new Error('Missing OPENAIKEY!export OPENAIKEY=<OPENAI_API_KEY>')
+	}
+	const KEY = process.env['OPENAIKEY'];
+	return {
+		'User-Agent': USER_AGENT,
+		'Content-Type': 'application/json',
+		'Authorization': `Bearer ${KEY}`
+	}
+}
+
+
+/**
+* Convert a toolset to something openai understands
+* @param {ToolSet} toolset
+* @returns {OAToolCall[]}
+*/
+const generateTools = (toolset) => {
+	const list = toolset.list();
+	/** @type {OAToolCall[]} */
+	const result = [];
+	list.forEach((item) => {
+		result.push({
+			type: 'function',
+			name: item.name,
+			description: item.description,
+			parameters: item.parameters
+		})
+	});
+	return result;
+}
+
+/**
+* Convert messages to OPENAI requirements 
+* @param {import("lib/Session").Message[]} messages
+* @returns {OAInput[]}
+*/
+const generateHistory = (messages) => {
+	return messages.reduce((result, msg) => {
+		delete msg.sticky;
+		delete msg.ts;
+		if (['assistant', 'user'].includes(msg.role)) {
+			/** @type {OAFunctionCall[]} */
+			// @ts-ignore
+			const fr = msg.content.map(
+				/** @param {import('../../../Prompt.js').FunctionRequest} item */
+				(item) => {
+					// Transform function requests
+					if (item.type === 'function_request') {
+						return {
+							// @ts-ignore
+							// id: item.function_request.id,
+							type: 'function_call',
+							call_id: item.function_request.call_id,
+							name: item.function_request.name,
+							arguments: item.function_request.parameters
+						}
+					}
+				}).filter(item => item !== undefined);
+			if (fr.length > 0) {
+				result.push(...fr);
+			}
+			// transform normal text input
+			const content = msg.content.map((item) => {
+				if (item.type == 'text') {
+					item.type = msg.role === 'user' ? 'input_text' : 'output_text'
+					return item;
+				}
+			}).filter(item => item !== undefined);
+			if (content.length > 0) {
+				msg.content = content;
+				result.push(msg);
+			}
+		} else if (['tool'].includes(msg.role)) {
+			// transform function responses
+			const ar = msg.content.map(
+				/** @param {import('../../../Prompt.js').FunctionResponse} item */
+				(item) => {
+					if (item.type === 'function_response') {
+						return {
+							type: 'function_call_output',
+							call_id: item.function_response.call_id,
+							output: item.function_response.response
+						}
+					}
+				}).filter(item => item !== undefined);
+			if (ar.length > 0) {
+				result.push(...ar);
+			}
+		}
+		return result;
+	}, []);
+}
+
+
+
+// tools": [{"type": "web_search_preview"}],
+//** @type {OAOptions} */
+const defaultSettings = {
+	background: false,
+	// search: undefined,
+	// include: null,
+	// input: [],
+	// instructions: '',
+	// max_output_tokens: 4000,
+	// metadata: null,
+	model: 'o3',
+	// // https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts
+	// prompt: null,
+	// https://platform.openai.com/docs/api-reference/responses/create#responses-create-reasoning
+	// reasoning must be present fot the function_calls to work
+	//  reasoning: {
+	//  	effort: null, // null|'low'|'medium'|'high'  
+	//  	summary: null       // auto, concise, or detailed
+	//  },
+	// service_tier: 'auto',
+	// store: false,
+	stream: false,
+	// temperature: 0.2, // value between 0 -2
+	// text: { format: { type: "text" } }, // optional
+	parallel_tool_calls: true,
+	max_tool_calls: 10,
+	// // tool_choice: 'auto', // optional
+	// // tools: [], 
+	// top_logprobs: 0,
+	// top_p: 1,
+	// truncation: null,
+}
+
+
+
+/**
+* Generate the POST body of a request
+* @param {Prompt} prompt
+* @param {ToolSet} [toolset]
+* @param {OAOptions} [options]
+*/
+function getBody(prompt, toolset, options) {
+	// From the messages I only want assistant and user
+	/** @type {OAOptions} */
+	// @ts-ignore
+	const body = { ...defaultSettings, ...options };
+	// const body = options ? mergeOptions(DEFAULT_OPTIONS, options) : DEFAULT_OPTIONS;
+	body.instructions = prompt.hasSystemprompt ? prompt.system_prompt : '';
+	// the last messages should be a role tool or user else the model cannot handle the request
+	const messages = prompt.messages;
+	if (!['user', 'tool'].includes(messages[messages.length - 1].role)) {
+		throw new Error('Missing last user question or tool');
+	}
+	body.input = generateHistory(messages);
+	if (toolset) {
+		// @ts-ignore
+		body.tool_choice = toolset.toolChoice;
+		body.tools = generateTools(toolset);
+		body.parallel_tool_calls = true;
+		// parallel_tool_calls
+	}
+	// Add OPENAI SEARCH
+	// in the toolset
+	if (body.search) {
+		if (!body.tools) {
+			body.tools = [];
+		}
+		body.tools.push({
+			type: 'web_search_preview',
+			// @ts-ignore
+			search_context_size: body.search
+		})
+	}
+	delete body.search;
+	return body;
+
+}
+/**
+* @param {Prompt} prompt
+* @param {ToolSet} [toolset]
+* @param {OAOptions} [options]
+*/
+function generateRequest(prompt, toolset, options) {
+	const headers = getHeaders();
+	const url = API_URL;
+	const body = getBody(prompt, toolset, options);
+	return { url, headers, body }
+}
+/**
+* Parse response messages (output)
+* @param {Array<*>} messages
+* @param {Prompt} prompt
+*/
+function parseMessages(messages, prompt) {
+	/** @type {import('../../../Prompt.js').FunctionRequest[]} */
+	const toolcall = [];
+	let i = 0;
+	const len = messages.length;
+	for (; i < len; i++) {
+		const msg = messages[i];
+		// types: 
+		const type = msg.type;
+		if (type === 'reasoning') {
+			let messages = msg.summary.map((item) => {
+				if (item.type === 'summary_text') {
+					return { type: 'text', text: item.text }
+				}
+			});
+			messages = messages.filter(item => item !== undefined);
+			if (messages.length > 0) {
+				prompt.addMultiModal('reasoning', messages);
+			}
+		} else if (type === 'message') {
+			let messages = msg.content.map((item) => {
+				if (item.type === 'output_text') {
+					return { type: 'text', text: item.text }
+				}
+			});
+			messages = messages.filter(item => item !== undefined);
+			if (messages.length > 0) {
+				prompt.addMultiModal('assistant', messages);
+			}
+		} else if (type === 'image_generation_call') {
+			prompt.addMultiModal('assistant', [{ type: 'image_url', url: msg.result }]);
+		} else if (type === 'function_call' || msg.status === 'complete') {
+			toolcall.push({
+				type: 'function_request',
+				function_request: {
+					name: msg.name,
+					id: msg.id,
+					call_id: msg.call_id,
+					parameters: msg.arguments
+				}
+
+			});
+		}
+	}
+	if (toolcall.length > 0) {
+		prompt.addMultiModal('assistant', toolcall);
+	}
+}
+
+/**
+* Parse a response
+* @param {number} duration - Fetch time in MS
+* @param {Prompt} prompt
+* @param {import('../../../request.js').FetchResponse} res
+* @param {import('../../../ToolSet.js').default} [toolset]
+*/
+async function parseResponse(duration, prompt, res, toolset) {
+	if (res.status !== 200) {
+		throw new Error(`${res.status}: ${JSON.stringify(res.response, null, '  ')}`)
+	}
+	// 1 = make a records
+	const record = prompt.templateRecord();
+	record.model = res.response.model;
+	record.id = res.response.id;
+	record.environment = API_URL;
+	record.isoDate = new Date(res.response.created_at * 1000).toISOString();
+	record.tokensIn = res.response.usage.input_tokens;
+	record.tokensOut = res.response.usage.output_tokens;
+	record.duration = duration;
+	// Parse the messages and and those to the prompt
+	parseMessages(res.response.output, prompt);
+	if (toolset) {
+		// Inspect for function_request and execute if so
+		await toolset.execute(prompt);
+	}
+	prompt.addRecord(record);
+}
+
+/**
+* Do a request
+* @param {Prompt} prompt
+* @param {ToolSet|null} toolset
+* @param {OAOptions} [options]:
+* @param {number} [counter] - leave empty this counts the number of requests when doing recursive request calls
+* @return {Promise<import('../../../Session.js').Message>}
+*/
+async function request(prompt, toolset = null, options, counter = 0) {
+	// Max number of recurusive calls
+	const counterMax = GLOBAL.max_recursive_requests;
+	const start = new Date().getTime();
+	if (counter === 0) {
+		// Fresh request
+		delete options.previous_response_id
+	}
+	// Generate the request
+	const { url, headers, body } = generateRequest(prompt, toolset, options);
+  prompt.emit(prompt.EVENTS.http_request, {url, counter, body});
+	const res = await doRequest(url, 'POST', headers, body);
+  prompt.emit(prompt.EVENTS.http_response, res);
+	if (res.status !== 200) {
+		throw new Error(`${res.status}: ${JSON.stringify(res.response, null, '  ')}`)
+	}
+	/*
+  https://platform.openai.com/docs/assistants/deep-dive#runs-and-run-steps
+	status` can be: in_progress, completed, incomplete (plus searching / generating / failed for some tool-call items)
+	*/
+	const duration = new Date().getTime() - start;
+	await parseResponse(duration, prompt, res, toolset);
+  const previousId = res.response.id;
+	counter = 1 + counter;
+	if (counter >= counterMax) {
+		throw new Error('Max number of recursive calls reached');
+	}
+	const lastMessage = prompt.getLastMessage();
+	if (!lastMessage) throw new Error('No message found');
+	if (lastMessage.role === 'tool') {
+		// need to do another roundtrip to include the funtion_responses
+		// And add the previousId for toolsets to work
+		if (!options) {
+			// @ts-ignore
+			options = {previous_response_id: previousId}
+		} else {
+			options.previous_response_id = previousId
+		}
+		await sleep('2s');
+		return request(prompt, toolset, options, counter)
+	} else {
+		return lastMessage
+	}
+}
+export { generateRequest, parseResponse, request }