@tmlmobilidade/go-providers-ai 20260828.1636.54

package/README.md

@@ -0,0 +1,3 @@
+## @tmlmobilidade/ai
+
+This package provides a wrapper for OCI Generative AI services.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './oci-generativeai.js';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './oci-generativeai.js';

package/dist/models.d.ts

@@ -0,0 +1,21 @@
+export interface AiModel {
+    ocid: string;
+    release_date: string;
+}
+/**
+ * Available AI models for the AI provider.
+ */
+export declare const availableAiModels: {
+    readonly 'cohere.command-a-03-2025 v1.0': {
+        readonly ocid: "ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyaaypm2hg4db3evqkmjfdli5mggcxrhp2i4qmhvggyb4ja";
+        readonly release_date: "2025-03-01";
+    };
+    readonly 'google.gemini-2.5-flash': {
+        readonly ocid: "ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyacn5rezarysrnds7bjsu6iy5nrxdvq6hyqcygode5o5xq";
+        readonly release_date: "2025-03-01";
+    };
+    readonly 'google.gemini-2.5-pro': {
+        readonly ocid: "ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyan6gecfjovk7wtgl3r65b5tmpuegfxojbp2mebjgtvhra";
+        readonly release_date: "2025-03-01";
+    };
+};

package/dist/models.js

@@ -0,0 +1,18 @@
+/* * */
+/**
+ * Available AI models for the AI provider.
+ */
+export const availableAiModels = {
+    'cohere.command-a-03-2025 v1.0': {
+        ocid: 'ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyaaypm2hg4db3evqkmjfdli5mggcxrhp2i4qmhvggyb4ja',
+        release_date: '2025-03-01',
+    },
+    'google.gemini-2.5-flash': {
+        ocid: 'ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyacn5rezarysrnds7bjsu6iy5nrxdvq6hyqcygode5o5xq',
+        release_date: '2025-03-01',
+    },
+    'google.gemini-2.5-pro': {
+        ocid: 'ocid1.generativeaimodel.oc1.eu-frankfurt-1.amaaaaaask7dceyan6gecfjovk7wtgl3r65b5tmpuegfxojbp2mebjgtvhra',
+        release_date: '2025-03-01',
+    },
+};

package/dist/oci-generativeai.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This is a simple wrapper around the OCI Generative AI SDK to make it easier
+ * to use in our application. It currently only supports running a text prompt
+ * through the "openai.gpt-oss-120b" model and getting a response.
+ */
+export interface OCIGenerativeAIRunOptions {
+    temperature?: number;
+}
+export declare class OCIGenerativeAIProvider {
+    private readonly ociClient;
+    constructor();
+    /**
+     * Runs a prompt through the OCI Generative AI service and returns the response.
+     * This is using the "openai.gpt-oss-120b" model, which is a 120B parameter model
+     * based on the open source Falcon-40B-Instruct-v2 architecture,
+     * but with more parameters and trained on more data.
+     * @param prompt The prompt to run through the model.
+     * @param options Optional generation parameters (defaults match the OCI SDK baseline).
+     * @returns The response from the model.
+     */
+    run(prompt: string, options?: OCIGenerativeAIRunOptions): Promise<string>;
+}

package/dist/oci-generativeai.js

@@ -0,0 +1,107 @@
+/* * */
+import { readFileSync } from 'node:fs';
+import { NoRetryConfigurationDetails, Region, SimpleAuthenticationDetailsProvider } from 'oci-common';
+import { GenerativeAiInferenceClient } from 'oci-generativeaiinference';
+import { availableAiModels } from './models.js';
+export class OCIGenerativeAIProvider {
+    //
+    ociClient;
+    constructor() {
+        //
+        //
+        // Validate that all required environment variables are set
+        if (!process.env.OCI_AI_FINGERPRINT)
+            throw new Error('Missing OCI_AI_FINGERPRINT environment variable for OCI Generative AI Provider');
+        if (!process.env.OCI_AI_PRIVATE_KEY_PATH && !process.env.OCI_AI_PRIVATE_KEY)
+            throw new Error('Missing OCI_AI_PRIVATE_KEY_PATH or OCI_AI_PRIVATE_KEY environment variable for OCI Generative AI Provider');
+        if (!process.env.OCI_AI_REGION)
+            throw new Error('Missing OCI_AI_REGION environment variable for OCI Generative AI Provider');
+        if (!process.env.OCI_AI_TENANCY)
+            throw new Error('Missing OCI_AI_TENANCY environment variable for OCI Generative AI Provider');
+        if (!process.env.OCI_AI_USER)
+            throw new Error('Missing OCI_AI_USER environment variable for OCI Generative AI Provider');
+        if (!process.env.OCI_AI_COMPARTMENT)
+            throw new Error('Missing OCI_AI_COMPARTMENT environment variable for OCI Generative AI Provider');
+        //
+        // Resolve private key
+        const privateKeyPath = process.env.OCI_AI_PRIVATE_KEY_PATH;
+        const privateKeyValue = process.env.OCI_AI_PRIVATE_KEY;
+        if (!privateKeyPath && !privateKeyValue)
+            throw new Error('OCI_AI_PRIVATE_KEY or OCI_AI_PRIVATE_KEY_PATH is not set');
+        let privateKey;
+        if (privateKeyPath)
+            privateKey = readFileSync(privateKeyPath, 'utf8');
+        else if (privateKeyValue)
+            privateKey = privateKeyValue.replace(/\\n/g, '\n');
+        else
+            throw new Error('Could not resolve private key for OCI Generative AI Provider (missing OCI_AI_PRIVATE_KEY or OCI_AI_PRIVATE_KEY_PATH)');
+        //
+        // Build the OCI client using the environment variables for authentication
+        this.ociClient = new GenerativeAiInferenceClient({
+            authenticationDetailsProvider: new SimpleAuthenticationDetailsProvider(process.env.OCI_AI_TENANCY, process.env.OCI_AI_USER, process.env.OCI_AI_FINGERPRINT, privateKey, null, Region.fromRegionId(process.env.OCI_AI_REGION)),
+        });
+        this.ociClient.endpoint = `https://inference.generativeai.${process.env.OCI_AI_REGION}.oci.oraclecloud.com`;
+    }
+    /**
+     * Runs a prompt through the OCI Generative AI service and returns the response.
+     * This is using the "openai.gpt-oss-120b" model, which is a 120B parameter model
+     * based on the open source Falcon-40B-Instruct-v2 architecture,
+     * but with more parameters and trained on more data.
+     * @param prompt The prompt to run through the model.
+     * @param options Optional generation parameters (defaults match the OCI SDK baseline).
+     * @returns The response from the model.
+     */
+    async run(prompt, options) {
+        //
+        //
+        // Build the chat request, in the most complicated way possible
+        // because the OCI SDK is a nightmare to work with.
+        // (This was written by AI, I swear.)
+        const chatRequest = {
+            chatDetails: {
+                chatRequest: {
+                    apiFormat: 'GENERIC',
+                    frequencyPenalty: 0,
+                    maxTokens: 2048,
+                    messages: [
+                        {
+                            content: [
+                                {
+                                    // @ts-expect-error — OMG this has to be the most convoluted way to send
+                                    // a simple text message I've ever seen in my life.
+                                    text: prompt,
+                                    type: 'TEXT',
+                                },
+                            ],
+                            role: 'USER',
+                        },
+                    ],
+                    presencePenalty: 0,
+                    temperature: options?.temperature ?? 0,
+                    topK: 1,
+                    topP: 0.95,
+                },
+                compartmentId: process.env.OCI_AI_COMPARTMENT,
+                servingMode: {
+                    modelId: availableAiModels['google.gemini-2.5-flash'].ocid,
+                    servingType: 'ON_DEMAND',
+                },
+            },
+            retryConfiguration: NoRetryConfigurationDetails,
+        };
+        //
+        // Send the chat request and return the response.
+        // Again, this is the most convoluted way to get a simple text response from the model.
+        const chatResponse = await this.ociClient.chat(chatRequest);
+        if (!('chatResult' in chatResponse)) {
+            throw new Error('Invalid response from OCI Generative AI service: ' + JSON.stringify(chatResponse));
+        }
+        if (!('choices' in chatResponse.chatResult.chatResponse)) {
+            throw new Error('Invalid response from OCI Generative AI service: ' + JSON.stringify(chatResponse));
+        }
+        // @ts-expect-error — Yes, I know this is a nightmare to read,
+        // but this is the documented way to get the text response from the model.
+        return chatResponse.chatResult.chatResponse.choices[0].message.content[0].text;
+        //
+    }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@tmlmobilidade/go-providers-ai",
+	"version": "20260828.1636.54",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/go#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"services"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint && tsc --noEmit",
+		"lint:fix": "eslint --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"oci-common": "2.139.0",
+		"oci-generativeaiinference": "2.139.0"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/go-utils-tsconfig": "*",
+		"@types/node": "26.1.2",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.1",
+		"typescript": "6.0.3"
+	}
+}