@j-o-r/hello-dave 0.0.2 → 0.0.4

package/lib/API/x.ai/responses.js

@@ -0,0 +1,492 @@
+/*
+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} XAIOptions
+* @property {?string} [include=null] - Optional include parameter.
+* @property {XAIInput[]} [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 {'grok-4-1-fast-reasoning'|'grok-4-1-fast-non-reasoning'|'grok-code-fast-1'|'grok-4-fast-reasoning'|'grok-4-fast-non-reasoning'} [model='grok-4-fast-non-reasoning'] - 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 {Array<XSearchTool|XAIFunctionTool|MCPTool|CodeInterpreterTool|FileSearchTool|XAIWebSearchTool>} [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] Top-p sampling value between 0 and 1.
+* @property {?string} [previous_response_id] - Needed reponse_id to validate tool calls on the next request
+*/
+/// [start] ----- tools ----
+/**
+* @typedef {Object} XAIFunctionTool
+* @property {'function'} 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, ParameterProperty>} parameters.properties - An object describing each parameter property.
+* @property {string[]} [parameters.required] - An array of required parameter names.
+*/
+/**
+* @typedef {Object} ParameterProperty
+* @property {string} type - The data type of the parameter, e.g., "string".
+* @property {string} description - A brief description of the parameter.
+*/
+
+/**
+* @typedef {Object} WebSearchFilters
+* @property {string[]|null} [allowed_domains] - Whitelist of domains (max 5); cannot use with excluded_domains.
+* @property {string[]|null} [excluded_domains] - Blacklist of domains (max 5); cannot use with allowed_domains.
+* @property {("low"|"medium"|"high")|null} [search_context_size] - Context size; for OpenAI compatibility (reject if set).
+* @property {UserLocation|null} [user_location] - User location; for OpenAI compatibility (reject if set).
+*/
+/**
+* @typedef {Object} UserLocation
+* @property {string|null} [city] - City of the user's location.
+* @property {string|null} [country] - ISO 3166-1 alpha-2 country code.
+* @property {string|null} [region] - Region of the user's location.
+* @property {string|null} [timezone] - IANA timezone.
+* @property {"approximate"} type
+*/
+/**
+* @typedef {Object} XAIWebSearchTool
+* @property {string[]|null} [allowed_domains] - Whitelist of domains (max 5); cannot use with excluded_domains.
+* @property {boolean|null} [enable_image_understanding] - Enable image understanding.
+* @property {string[]|null} [excluded_domains] - Blacklist of domains (max 5); cannot use with allowed_domains.
+* @property {boolean|null} [external_web_access] - For OpenAI compatibility (reject if set).
+* @property {WebSearchFilters|null} [filters] - Filters; for OpenAI compatibility.
+* @property {"web_search"} type
+*/
+/**
+* @typedef {Object} XSearchTool
+* @property {string[]|null} [allowed_x_handles] - Whitelist of X handles; cannot use with excluded_x_handles.
+* @property {boolean|null} [enable_image_understanding] - Enable image understanding.
+* @property {boolean|null} [enable_video_understanding] - Enable video understanding.
+* @property {string[]|null} [excluded_x_handles] - Blacklist of X handles; cannot use with allowed_x_handles.
+* @property {string|null} [from_date] - ISO-8601 date (YYYY-MM-DD).
+* @property {string|null} [to_date] - ISO-8601 date (YYYY-MM-DD).
+* @property {"x_search"} type
+*/
+/**
+* @typedef {Object} FileSearchTool
+* @property {Object} filters - For OpenAI compatibility (reject if set).
+* @property {number|null} [max_num_results] - Max results (min 1).
+* @property {Object} ranking_options - For OpenAI compatibility (reject if set).
+* @property {string[]} vector_store_ids - List of vector store IDs.
+* @property {"file_search"} type
+*/
+/**
+* @typedef {Object} CodeInterpreterTool
+* @property {string|Object} container - Container ID or uploaded files object; for OpenAI compatibility (reject if set).
+* @property {"code_interpreter"} type
+*/
+/**
+* @typedef {Object} MCPTool
+* @property {string[]|null} [allowed_tools] - Allowed tools.
+* @property {string|null} [authorization] - Authorization details.
+* @property {string|null} [connector_id] - Connector ID.
+* @property {Object|null} [headers] - Headers.
+* @property {string|null} [require_approval] - Approval requirement.
+* @property {string|null} [server_description] - Server description.
+* @property {string} server_label - Server label.
+* @property {string} server_url - Server URL.
+* @property {"mcp"} type
+*/
+/// [end] ---- tools ----
+
+/**
+* @typedef {Object} XAIMessage
+* @property {'assistant'|'user'} role - The role of the participant (e.g., "assistant", "user").
+* @property {Array<XAIContent>} content - The content of the message.
+*/
+/**
+* @typedef {Object} XAIInputMessage
+* @property {'assistant'|'user'|'system'} role - The role of the participant (e.g., "assistant", "user").
+* @property {string} content - The content of the message.
+*/
+/**
+* @typedef {Object} XAIContent
+* @property {'output_text'|'input_text'} type - The type of content (e.g., "output_text", "input_text").
+* @property {string} text - The text content.
+*/
+/**
+* @typedef {Object} XAIFunctionCall
+* @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} XAIFunctionCallOutput
+* @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 {(XAIInputMessage|XAIFunctionCall|XAIFunctionCallOutput)} XAIInput
+*/
+
+const API_URL = 'https://api.x.ai/v1/responses';
+
+/**
+* Get the default headers
+* @returns {object}
+*/
+const getHeaders = () => {
+	if (!process.env['XAIKEY']) {
+		throw new Error('Missing XAIKEY! export XAIKEY=[XAIKEY]')
+	}
+	const KEY = process.env['XAIKEY'];
+	return {
+		'Content-Type': 'application/json',
+		'Authorization': `Bearer ${KEY}`
+	}
+}
+/**
+* Convert a toolset to something openai understands
+* @param {ToolSet} toolset
+* @returns {XAIFunctionTool[]}
+*/
+const generateTools = (toolset) => {
+	const list = toolset.list();
+	/** @type {XAIFunctionTool[]} */
+	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 {XAIInput[]}
+*/
+const generateHistory = (messages) => {
+	return messages.reduce((result, msg) => {
+		delete msg.sticky;
+		delete msg.ts;
+		if (['assistant', 'user'].includes(msg.role)) {
+			/** @type {XAIFunctionCall[]} */
+			// @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;
+	}, []);
+}
+/** @type SearchSources */
+const webSearch = [
+ {
+ 	type: 'x',
+ },
+ {
+ 	type: 'web',
+ 	safe_search: false
+ },
+ {
+ 	type: 'news',
+ 	safe_search: false
+ }
+	
+]
+
+/** @type {XAIOptions} */
+const defaultSettings = {
+	model: 'grok-4-fast-reasoning',
+	input: [
+		{
+			role: 'system',
+			content: 'Be precise and concise'
+		}
+	],
+	temperature: 0.2,
+	parallel_tool_calls: true,
+  tools: [],
+  // search_parameters: {
+  //     from_date: null,
+  //     max_search_results: 15,
+  //     mode: 'off',
+  //     return_citations: false,
+  //     sources: webSearch,
+  //     to_date: null
+  // },
+	store: false
+};
+
+
+// tools": [{"type": "web_search_preview"}],
+
+/**
+* Generate the POST body of a request
+* @param {Prompt} prompt
+* @param {ToolSet} [toolset]
+* @param {XAIOptions} [options]
+*/
+function getBody(prompt, toolset, options) {
+	// From the messages I only want assistant and user
+	/** @type {XAIOptions} */
+	// @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 = [...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 {XAIOptions} [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 annotations = '';
+			let messages = msg.content.map((item) => {
+				if (item.type === 'output_text') {
+					if (item['annotations'] && item.annotations.length > 0) {
+						const ann = item.annotations;
+						ann.forEach((a) => {
+							if (a.type === 'url_citation') {
+								annotations += `${a.url}\n`;
+							}
+						})
+					}
+					return { type: 'text', text: item.text }
+				}
+			});
+			if (annotations !== '') {
+				prompt.add('log', annotations)
+			}
+			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('@j-o-r/apiserver/types/request.js').FetchResponseObject} 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 {XAIOptions} [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) {
+			options = {};
+		}
+		options.previous_response_id = previousId;
+		await sleep('2s');
+		return request(prompt, toolset, options, counter)
+	} else {
+		return lastMessage
+	}
+}
+export { generateRequest, parseResponse, request }

package/lib/API/x.ai/text.js

@@ -106,7 +106,7 @@ const defaultSettings = {
 			content: 'Be precise and concise'
 		}
 	],
-	// temperature: 0.2,
+	temperature: 0.2,
 	// response_format: { type: 'text' },
 	parallel_tool_calls: true,
 	// reasoning_effort: null,

package/lib/AgentClient.js

@@ -21,6 +21,7 @@ import { WebSocketClient } from "@j-o-r/apiserver";
 * @property {ToolSet} [toolset] - The toolset
 * @property {string} description - Custom introduction message.
 * @property {string} name - Logical name: e.g. search, code, os, support.
+* @property {string} secret - Websocket server access secret.
 * @property {string} [url='ws://127.0.0.1:8000/ws?params=1234']
 * @property {number} [intervalMs=250] - How often to pull one message from the queue.
 */
@@ -33,6 +34,7 @@ class AgentClient {
 	#prompt;
 	#description = '';
 	#name;
+	#secret = '';
 	/** @type {WebSocketClient} */
 	#ws;
 	#url = 'ws://127.0.0.1:8000/ws';
@@ -57,6 +59,7 @@ class AgentClient {
 		this.#prompt = options.prompt;
 		this.#description = options.description;
 		this.#name = options.name;
+		this.#secret = options.secret;
 		if (typeof options.intervalMs === 'number') this.#intervalMs = Math.max(1, options.intervalMs);
 		this.#registerPromptEvents();
 		this._start();
@@ -69,15 +72,19 @@ class AgentClient {
 		const events = Object.keys(this.#prompt.EVENTS);
 		events.forEach((evt) => {
 			this.#prompt.on(evt, (_msg) => {
-				if (evt === 'tool_error') {
-					console.log(JSON.stringify(_msg, null, '  '));
-				}
-				console.log(evt);
+		 		console.log(`** ${this.#name} e:${evt}**`);
+		 		if (evt === 'tool_request') {
+		 			console.log(`tool execute: ${_msg.name} ${_msg.call_id}`);
+		 		} else if (evt === 'tool_error') {
+		 			console.log(`tool error:`);
+		 			console.log(JSON.stringify(_msg, null, '  '));
+		 		}
 			});
 		});
 	}
 	_start() {
-		this.#ws = new WebSocketClient(this.#url);  // Match server port/path
+		const url = this.#url + '?wssrc_id=' + this.#secret;
+		this.#ws = new WebSocketClient(url);  // Match server port/path
 		this.#ws.onopen = () => {
 			// Send my introduction to the server
 			this.#ws.send(JSON.stringify({
@@ -86,7 +93,7 @@ class AgentClient {
 				content: this.#description,
 				id: new Date().getTime()
 			}));
-			console.log('INIT:>>')
+			console.log('introduction_send:>>')
 			console.log(this.#name);
 			console.log(this.#description);
 		};