@j-o-r/hello-dave 0.0.0

package/lib/API/brave.com/search.js

@@ -0,0 +1,239 @@
+import Session from '../../Session.js';
+import { jsType } from '../../fafs.js';
+import { request as doRequest } from '@j-o-r/apiserver';
+/**
+* @typedef {import('../../ToolSet.js').default} ToolSet
+*/
+/**
+* @typedef {object} BraveRequest
+* @property {BRSearchAPIHeaders} headers
+* @property {string} url
+*
+* @typedef {object} BRSearchOptions 
+* 
+* @property {string}		[q] - question
+* @property {string}		[country] - Country Code
+* @property {string}		[search_lang] - The 2 or more character language code for which the search results are provided. 
+* @property {string}		[ui_lang] - Usually of the format <language_code>-<country_code> RFC 9110 
+* @property {number}		[count] - The number of search results returned in response. The maximum is 20
+* @property {number}		[offset] - The zero based offset that indicates number of search results per page (count) to skip before returning the result.
+* @property {string}		[safesearch] - off, moderate, strict 
+* @property {string}		[freshness] - pd (24 h) pw (1 week) pm (1 month) py (1 year) , YYYY-MM-DDtoYYYY-MM-DD (range 2022-04-01to2022-07-30)
+* @property {boolean}		[text_decoration] - Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).
+* @property {boolean}		[spellcheck] - Whether to spellcheck provided query.
+* @property {string}		[result_filter] - discussions,faq,infobox,news,query,summarizer,videos,web 
+* @property {string}		[goggles_id] - Goggles act as a custom re-ranking on top of Brave’s search index 
+* @property {string}		[units] - metric , imperial
+* @property {boolean}		[extra_snippets] - (only pro plan) A snippet is an excerpt from a page you get as a result of the query
+* @property {number}		[summary] - 1 | 0 (only pro plan) This parameter enables summary key generation in web search results. 
+*
+* @typedef {Object} BRSearchAPIHeaders
+* @property {string} [Accept="application/json"] - The default supported media type is application/json.
+* @property {string} [AcceptEncoding="gzip"] - The supported compression type is gzip.
+* @property {string} [ContentType="application/json"] - 
+* @property {string} [ApiVersion] - The Brave Web Search API version to use, denoted by the format YYYY-MM-DD. The latest version is used by default.
+* @property {string} [CacheControl] - Search will return cached web search results by default. To prevent caching, set the Cache-Control header to no-cache.
+* @property {string} [UserAgent] - The user agent of the client sending the request. Search can utilize the user agent to provide a different experience depending on the client.
+* @property {number} [XLocLat] - The latitude of the client's geographical location in degrees, to provide relevant local results. Must be >= -90.0 and <= +90.0 degrees.
+* @property {number} [XLocLong] - The longitude of the client's geographical location in degrees, to provide relevant local results. Must be >= -180.0 and <= +180.0 degrees.
+* @property {string} [XLocTimezone] - The IANA timezone for the client's device.
+* @property {string} [XLocCity] - The generic name of the client city.
+* @property {string} [XLocState] - The code representing the client’s state/region, can be up to 3 characters long.
+* @property {string} [XLocStateName] - The name of the client's state/region.
+* @property {string} [XLocCountry] - The two-letter code for the client's country.
+* @property {string} [XLocPostalCode] - The client's postal code.
+* @property {string} [XSubscriptionToken] - The secret token for the subscribed plan to authenticate the request. Can be obtained from API Keys.
+*/
+const API_URL = 'https://api.search.brave.com/res/v1/web/search';
+/** @type {BRSearchOptions} */
+const defaultBraveSettings = {
+	q: '',
+	country: 'NL',
+	search_lang: 'en',
+	ui_lang: 'en-US',
+	count: 10,
+	offset: 0,
+	safesearch: 'off',
+	freshness: '',
+	text_decoration: false,
+	spellcheck: true,
+	// discussions' or 'faq' or 'infobox' or 'news' or 'query' or 'videos' or 'web' or 'summarizer' or 'locations'
+	result_filter: 'discussions,faq,infobox,news,query,summarizer,videos,web',
+	units: 'metric',
+	summary: 0,
+};
+
+
+/**
+* Get the default headers
+* @returns {object}
+*/
+const getBraveHeaders = () => {
+	if (!process.env['BRAVESEARCHKEY']) {
+		throw new Error('Missing BRAVESEARCHKEY! export BRAVESEARCHKEY=<BRAVE_SEARCH_KEY>');
+	}
+	const KEY = process.env['BRAVESEARCHKEY'];
+	/** @type {BRSearchAPIHeaders} */
+	return {
+		'ContentType': 'application/json',
+		'Accept': 'application/json',
+		'XSubscriptionToken': `${KEY}`
+	}
+}
+/**
+* @param {string} propertyName
+* @return {string}
+*/
+function translatePropertyNameToHeaderName(propertyName) {
+	return propertyName
+		// Insert a hyphen before each uppercase letter or number that is either preceded by a lowercase letter or followed by an uppercase letter.
+		.replace(/([a-z])([A-Z0-9])|([A-Z0-9])([A-Z])/g, '$1$3-$2$4')
+		// Convert the entire string to lowercase to match header naming conventions.
+		.toLowerCase();
+}
+
+/**
+ * Recursively converts all object keys to camelCase.
+ * @param {Object} obj - The original object.
+ * @returns {Object} A new object with all keys converted to camelCase.
+ */
+function toHeaders(obj) {
+	return Object.entries(obj).reduce((newObj, [key, value]) => {
+		// @ts-ignore
+		newObj[translatePropertyNameToHeaderName(key)] = value;
+		return newObj;
+	}, {});
+}
+/** To query params
+* @param {object} obj
+* @retuns {string}
+*/
+const objectToQueryString = (obj) => {
+	const params = new URLSearchParams();
+	for (const key in obj) {
+		if (obj.hasOwnProperty(key)) {
+			// @ts-ignore
+			params.append(key, obj[key]);
+		}
+	}
+	return params.toString();
+}
+/**
+* Create an brave search request
+* It will use the last message as the search query to stay compatible with the prompt/records logic
+* @param {string} query
+* @param {BRSearchOptions} [opts] overwrite default request settings
+* @param {BRSearchAPIHeaders} [hdrs] - optional headers to pass
+* @returns {BraveRequest}
+* @throws {Error}
+*/
+const generateRequest = (query, opts = {}, hdrs = {}) => {
+	/** @type {BRSearchOptions} */
+	if (
+		jsType(query) !== 'String' ||
+		query.split('\n').length > 1 ||
+		query.trim() === '') {
+		throw Error('Brave Search query invalid string (query can only contain one line');
+	}
+	/** @type {BRSearchOptions} */
+	const options = { ...defaultBraveSettings, ...opts };
+	const headers = toHeaders({ ...getBraveHeaders(), ...hdrs });
+
+	if (query.trim() === '' || query.split('\n').length > 1) {
+	}
+	options.q = query;
+	const params = objectToQueryString(options)
+	return { headers, url: API_URL + `?${params}` };
+};
+
+/// ---------------------------------------------------
+
+/*
+* @param {string[]} sums 
+* @returns {string}
+*/
+const extractSummary = (sums) => {
+	if (!sums) {
+		sums = [];
+	}
+	let result = '';
+	let i = 0;
+	const len = sums.length
+	for (; i < len; i++) {
+		result = result + sums[i] + '\n\n';
+	}
+	return result;
+}
+
+/**
+ * Converts an array of objects to a markdown string.
+ * @param {Array<object>} entries - The array of objects.
+ * @returns {string} - The combined markdown string.
+ */
+function convertToMarkdown(entries) {
+	return entries.map((entry, index) => {
+		// @ts-ignore
+		let content = `### ${index + 1}. ${entry.title}\n\n${entry.description}\n\n[${entry.subtype} link](${entry.url})\n`;
+		// @ts-ignore
+		if (entry.extra_snippets) {
+			// @ts-ignore
+			content = `${content}\n${entry.extra_snippets.join('\n')}\n`;
+		}
+		return content;
+	}).join('\n');
+}
+
+/**
+* Process an openai response
+* @param {object} response
+* @returns {string}
+* @throws {Error}
+*/
+const parseResponse = (response) => {
+	// @ts-ignore
+	if (response.query['bad_results'] === false && response['web'] && response['web']['results'] && response.web.results.length > 0) {
+		// @ts-ignore
+		const sum = extractSummary(response.summary);
+		const msg = convertToMarkdown(response.web.results)
+		return sum + msg;
+	} else {
+		return 'No results.'
+	}
+}
+
+/**
+* Create an brave search request
+* It will use the last message as the search query to stay compatible with the prompt/records logic
+* @param {string} query
+* @param {BRSearchOptions} [opts] overwrite default request settings
+* @param {BRSearchAPIHeaders} [hdrs] - optional headers to pass
+* @throws {Error}
+* @returns {Promise<import('../../ToolSet.js').TSCallResponse>}
+*/
+async function request(query, opts = {}, hdrs = {}) {
+	/** @type {import('lib/Prompt').PRRecord[]} */
+	const records = [];
+	const record = Session.templateRecord();
+	const start = new Date().getTime();
+	const { headers, url } = generateRequest(query, opts, hdrs)
+	const res = await doRequest(url, 'GET', headers);
+	record.model = 'search';
+	record.id = 'ts:' + new Date().getTime();
+	record.environment = 'search.brave.com';
+	record.isoDate = new Date().toISOString();
+	record.tokensIn = 1;
+	record.tokensOut = 1;
+	record.duration = new Date().getTime() - start;
+	if (res.status !== 200) {
+		new Error(`${res.status}: response.response`)
+	}
+	records.push(record);
+	const response = parseResponse(res.response);
+	return { response, records }
+}
+
+export {
+	generateRequest,
+	parseResponse,
+	request
+}

package/lib/API/openai.com/README.md

@@ -0,0 +1 @@
+

package/lib/API/openai.com/reponses/MESSAGES.md

@@ -0,0 +1,69 @@
+## Message RESPONSE types OPENAI
+
+### message output in json examples:
+**tool calls**
+Tool calls are function_requests PRFunctionRequest
+```
+[
+  {
+    "index": 0,
+    "message": {
+      "role": "assistant",
+      "content": "\n",
+      "tool_calls": [
+        {
+          "id": "call_43974044",
+          "function": {
+            "name": "get_date_time",
+            "arguments": "{}"
+          },
+          "type": "function"
+        },
+        {
+          "id": "call_08990177",
+          "function": {
+            "name": "get_current_weather",
+            "arguments": "{\"location\":\"Amsterdam, The Netherlands\"}"
+          },
+          "type": "function"
+        }
+      ],
+      "refusal": null
+    },
+    "finish_reason": "stop"
+  }
+]
+
+```
+** assistant answer **
+```
+[
+  {
+    "index": 0,
+    "message": {
+      "role": "assistant",
+      "content": "\n",
+      "tool_calls": [
+        {
+          "id": "call_43974044",
+          "function": {
+            "name": "get_date_time",
+            "arguments": "{}"
+          },
+          "type": "function"
+        },
+        {
+          "id": "call_08990177",
+          "function": {
+            "name": "get_current_weather",
+            "arguments": "{\"location\":\"Amsterdam, The Netherlands\"}"
+          },
+          "type": "function"
+        }
+      ],
+      "refusal": null
+    },
+    "finish_reason": "stop"
+  }
+]
+```