oci-generativeaiinference 2.84.0 → 2.85.0

package/lib/model/chat-content.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatContent = void 0;
+const model = __importStar(require("../model"));
+const common = require("oci-common");
+var ChatContent;
+(function (ChatContent) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        if (obj && "type" in obj && obj.type) {
+            switch (obj.type) {
+                case "TEXT":
+                    return model.TextContent.getJsonObj(jsonObj, true);
+                default:
+                    if (common.LOG.logger)
+                        common.LOG.logger.info(`Unknown value for: ${obj.type}`);
+            }
+        }
+        return jsonObj;
+    }
+    ChatContent.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        if (obj && "type" in obj && obj.type) {
+            switch (obj.type) {
+                case "TEXT":
+                    return model.TextContent.getDeserializedJsonObj(jsonObj, true);
+                default:
+                    if (common.LOG.logger)
+                        common.LOG.logger.info(`Unknown value for: ${obj.type}`);
+            }
+        }
+        return jsonObj;
+    }
+    ChatContent.getDeserializedJsonObj = getDeserializedJsonObj;
+})(ChatContent = exports.ChatContent || (exports.ChatContent = {}));
+//# sourceMappingURL=chat-content.js.map

package/lib/model/chat-content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-content.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/chat-content.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAClC,qCAAsC;AAStC,IAAiB,WAAW,CA8B3B;AA9BD,WAAiB,WAAW;IAC1B,SAAgB,UAAU,CAAC,GAAgB;QACzC,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE;YACpC,QAAQ,GAAG,CAAC,IAAI,EAAE;gBAChB,KAAK,MAAM;oBACT,OAAO,KAAK,CAAC,WAAW,CAAC,UAAU,CAA6B,OAAQ,EAAE,IAAI,CAAC,CAAC;gBAClF;oBACE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM;wBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;aACnF;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAZe,sBAAU,aAYzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAgB;QACrD,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE;YACpC,QAAQ,GAAG,CAAC,IAAI,EAAE;gBAChB,KAAK,MAAM;oBACT,OAAO,KAAK,CAAC,WAAW,CAAC,sBAAsB,CACjB,OAAQ,EACpC,IAAI,CACL,CAAC;gBACJ;oBACE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM;wBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;aACnF;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAfe,kCAAsB,yBAerC,CAAA;AACH,CAAC,EA9BgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA8B3B"}

package/lib/model/chat-details.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import * as model from "../model";
+/**
+ * Details of the conversation for the model to respond.
+ */
+export interface ChatDetails {
+    /**
+     * The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+     */
+    "compartmentId": string;
+    "servingMode": model.DedicatedServingMode | model.OnDemandServingMode;
+    "chatRequest"?: model.GenericChatRequest | model.CohereChatRequest;
+}
+export declare namespace ChatDetails {
+    function getJsonObj(obj: ChatDetails): object;
+    function getDeserializedJsonObj(obj: ChatDetails): object;
+}

package/lib/model/chat-details.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatDetails = void 0;
+const model = __importStar(require("../model"));
+var ChatDetails;
+(function (ChatDetails) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "servingMode": obj.servingMode ? model.ServingMode.getJsonObj(obj.servingMode) : undefined,
+            "chatRequest": obj.chatRequest
+                ? model.BaseChatRequest.getJsonObj(obj.chatRequest)
+                : undefined
+        });
+        return jsonObj;
+    }
+    ChatDetails.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "servingMode": obj.servingMode
+                ? model.ServingMode.getDeserializedJsonObj(obj.servingMode)
+                : undefined,
+            "chatRequest": obj.chatRequest
+                ? model.BaseChatRequest.getDeserializedJsonObj(obj.chatRequest)
+                : undefined
+        });
+        return jsonObj;
+    }
+    ChatDetails.getDeserializedJsonObj = getDeserializedJsonObj;
+})(ChatDetails = exports.ChatDetails || (exports.ChatDetails = {}));
+//# sourceMappingURL=chat-details.js.map

package/lib/model/chat-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-details.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/chat-details.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAelC,IAAiB,WAAW,CA6B3B;AA7BD,WAAiB,WAAW;IAC1B,SAAgB,UAAU,CAAC,GAAgB;QACzC,MAAM,OAAO,mCACR,GAAG,GACH;YACD,aAAa,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC1F,aAAa,EAAE,GAAG,CAAC,WAAW;gBAC5B,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC;gBACnD,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAZe,sBAAU,aAYzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAgB;QACrD,MAAM,OAAO,mCACR,GAAG,GACH;YACD,aAAa,EAAE,GAAG,CAAC,WAAW;gBAC5B,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAC;gBAC3D,CAAC,CAAC,SAAS;YACb,aAAa,EAAE,GAAG,CAAC,WAAW;gBAC5B,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAC;gBAC/D,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAde,kCAAsB,yBAcrC,CAAA;AACH,CAAC,EA7BgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA6B3B"}

package/lib/model/chat-result.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import * as model from "../model";
+/**
+ * The response to the chat conversation.
+ */
+export interface ChatResult {
+    /**
+     * The OCID of the model used in this inference request.
+     */
+    "modelId": string;
+    /**
+     * The version of the model.
+     */
+    "modelVersion": string;
+    "chatResponse": model.GenericChatResponse | model.CohereChatResponse;
+}
+export declare namespace ChatResult {
+    function getJsonObj(obj: ChatResult): object;
+    function getDeserializedJsonObj(obj: ChatResult): object;
+}

package/lib/model/chat-result.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatResult = void 0;
+const model = __importStar(require("../model"));
+var ChatResult;
+(function (ChatResult) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "chatResponse": obj.chatResponse
+                ? model.BaseChatResponse.getJsonObj(obj.chatResponse)
+                : undefined
+        });
+        return jsonObj;
+    }
+    ChatResult.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "chatResponse": obj.chatResponse
+                ? model.BaseChatResponse.getDeserializedJsonObj(obj.chatResponse)
+                : undefined
+        });
+        return jsonObj;
+    }
+    ChatResult.getDeserializedJsonObj = getDeserializedJsonObj;
+})(ChatResult = exports.ChatResult || (exports.ChatResult = {}));
+//# sourceMappingURL=chat-result.js.map

package/lib/model/chat-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-result.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/chat-result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAkBlC,IAAiB,UAAU,CAyB1B;AAzBD,WAAiB,UAAU;IACzB,SAAgB,UAAU,CAAC,GAAe;QACxC,MAAM,OAAO,mCACR,GAAG,GACH;YACD,cAAc,EAAE,GAAG,CAAC,YAAY;gBAC9B,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC;gBACrD,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAXe,qBAAU,aAWzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAe;QACpD,MAAM,OAAO,mCACR,GAAG,GACH;YACD,cAAc,EAAE,GAAG,CAAC,YAAY;gBAC9B,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,CAAC,YAAY,CAAC;gBACjE,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAXe,iCAAsB,yBAWrC,CAAA;AACH,CAAC,EAzBgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAyB1B"}

package/lib/model/citation.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+/**
+ * A section of the generated reply which cites external knowledge.
+ */
+export interface Citation {
+    /**
+     * The index of text that the citation starts at, counting from zero. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "start": number;
+    /**
+     * The index of text that the citation ends after, counting from zero. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "end": number;
+    /**
+     * The text of the citation
+     */
+    "text": string;
+    /**
+     * Identifiers of documents cited by this section of the generated reply.
+     */
+    "documentIds": Array<string>;
+}
+export declare namespace Citation {
+    function getJsonObj(obj: Citation): object;
+    function getDeserializedJsonObj(obj: Citation): object;
+}

package/lib/model/citation.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Citation = void 0;
+var Citation;
+(function (Citation) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    Citation.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    Citation.getDeserializedJsonObj = getDeserializedJsonObj;
+})(Citation = exports.Citation || (exports.Citation = {}));
+//# sourceMappingURL=citation.js.map

package/lib/model/citation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"citation.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/citation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AA2BH,IAAiB,QAAQ,CAWxB;AAXD,WAAiB,QAAQ;IACvB,SAAgB,UAAU,CAAC,GAAa;QACtC,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,mBAAU,aAIzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAa;QAClD,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,+BAAsB,yBAIrC,CAAA;AACH,CAAC,EAXgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAWxB"}

package/lib/model/cohere-chat-request.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import * as model from "../model";
+/**
+ * Details for the chat request for Cohere models.
+ */
+export interface CohereChatRequest extends model.BaseChatRequest {
+    /**
+     * Text input for the model to respond to.
+     */
+    "message": string;
+    /**
+     * A list of previous messages between the user and the model, meant to give the model conversational context for responding to the user's message.
+     */
+    "chatHistory"?: Array<model.CohereMessage>;
+    /**
+     * list of relevant documents that the model can cite to generate a more accurate reply.
+     * Some suggested keys are \"text\", \"author\", and \"date\". For better generation quality, it is
+     * recommended to keep the total word count of the strings in the dictionary to under 300
+     * words.
+     *
+     */
+    "documents"?: Array<any>;
+    /**
+     * When true, the response will only contain a list of generated search queries, but no search will take place, and no reply from the model to the user's message will be generated.
+     */
+    "isSearchQueriesOnly"?: boolean;
+    /**
+     * When specified, the default Cohere preamble will be replaced with the provided one. Preambles are a part of the prompt used to adjust the model's overall behavior and conversation style. Default preambles vary for different models.
+     */
+    "preambleOverride"?: string;
+    /**
+     * Whether to stream back partial progress. If set, tokens are sent as data-only server-sent events as they become available.
+     */
+    "isStream"?: boolean;
+    /**
+     * The maximum number of tokens to predict for each response. Includes input plus output tokens. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "maxTokens"?: number;
+    /**
+     * A number that sets the randomness of the generated output. A lower temperature means a less random generations.
+     * Use lower numbers for tasks with a correct answer such as question answering or summarizing. High temperatures can generate hallucinations or factually incorrect information. Start with temperatures lower than 1.0 and increase the temperature for more creative outputs, as you regenerate the prompts to refine the outputs.
+     *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "temperature"?: number;
+    /**
+      * An integer that sets up the model to use only the top k most likely tokens in the generated output. A higher k introduces more randomness into the output making the output text sound more natural. Default value is 0 which disables this method and considers all tokens. To set a number for the likely tokens, choose an integer between 1 and 500.
+  * <p>
+  If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20, but the probabilities of the top 10 add up to .75, then only the top 10 tokens are chosen.
+  *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+      */
+    "topK"?: number;
+    /**
+      * If set to a probability 0.0 < p < 1.0, it ensures that only the most likely tokens, with total probability mass of p, are considered for generation at each step.
+  * <p>
+  To eliminate tokens with low likelihood, assign p a minimum percentage for the next token's likelihood. For example, when p is set to 0.75, the model eliminates the bottom 25 percent for the next token. Set to 1.0 to consider all tokens and set to 0 to disable. If both k and p are enabled, p acts after k.
+  *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+      */
+    "topP"?: number;
+    /**
+     * To reduce repetitiveness of generated tokens, this number penalizes new tokens based on their frequency in the generated text so far. Greater numbers encourage the model to use new tokens, while lower numbers encourage the model to repeat the tokens. Set to 0 to disable.
+     *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "frequencyPenalty"?: number;
+    /**
+      * To reduce repetitiveness of generated tokens, this number penalizes new tokens based on whether they've appeared in the generated text so far. Greater numbers encourage the model to use new tokens, while lower numbers encourage the model to repeat the tokens.
+  * <p>
+  Similar to frequency penalty, a penalty is applied to previously present tokens, except that this penalty is applied equally to all tokens that have already appeared, regardless of how many times they've appeared. Set to 0 to disable.
+  *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+      */
+    "presencePenalty"?: number;
+    "apiFormat": string;
+}
+export declare namespace CohereChatRequest {
+    function getJsonObj(obj: CohereChatRequest, isParentJsonObj?: boolean): object;
+    const apiFormat = "COHERE";
+    function getDeserializedJsonObj(obj: CohereChatRequest, isParentJsonObj?: boolean): object;
+}

package/lib/model/cohere-chat-request.js

@@ -0,0 +1,71 @@
+"use strict";
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CohereChatRequest = void 0;
+const model = __importStar(require("../model"));
+var CohereChatRequest;
+(function (CohereChatRequest) {
+    function getJsonObj(obj, isParentJsonObj) {
+        const jsonObj = Object.assign(Object.assign({}, (isParentJsonObj ? obj : model.BaseChatRequest.getJsonObj(obj))), {
+            "chatHistory": obj.chatHistory
+                ? obj.chatHistory.map(item => {
+                    return model.CohereMessage.getJsonObj(item);
+                })
+                : undefined
+        });
+        return jsonObj;
+    }
+    CohereChatRequest.getJsonObj = getJsonObj;
+    CohereChatRequest.apiFormat = "COHERE";
+    function getDeserializedJsonObj(obj, isParentJsonObj) {
+        const jsonObj = Object.assign(Object.assign({}, (isParentJsonObj
+            ? obj
+            : model.BaseChatRequest.getDeserializedJsonObj(obj))), {
+            "chatHistory": obj.chatHistory
+                ? obj.chatHistory.map(item => {
+                    return model.CohereMessage.getDeserializedJsonObj(item);
+                })
+                : undefined
+        });
+        return jsonObj;
+    }
+    CohereChatRequest.getDeserializedJsonObj = getDeserializedJsonObj;
+})(CohereChatRequest = exports.CohereChatRequest || (exports.CohereChatRequest = {}));
+//# sourceMappingURL=cohere-chat-request.js.map

package/lib/model/cohere-chat-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cohere-chat-request.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/cohere-chat-request.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AA2ElC,IAAiB,iBAAiB,CAmCjC;AAnCD,WAAiB,iBAAiB;IAChC,SAAgB,UAAU,CAAC,GAAsB,EAAE,eAAyB;QAC1E,MAAM,OAAO,mCACR,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAuB,CAAC,GACtF;YACD,aAAa,EAAE,GAAG,CAAC,WAAW;gBAC5B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACzB,OAAO,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC,CAAC;gBACJ,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAbe,4BAAU,aAazB,CAAA;IACY,2BAAS,GAAG,QAAQ,CAAC;IAClC,SAAgB,sBAAsB,CACpC,GAAsB,EACtB,eAAyB;QAEzB,MAAM,OAAO,mCACR,CAAC,eAAe;YACjB,CAAC,CAAC,GAAG;YACL,CAAC,CAAE,KAAK,CAAC,eAAe,CAAC,sBAAsB,CAAC,GAAG,CAAuB,CAAC,GAC1E;YACD,aAAa,EAAE,GAAG,CAAC,WAAW;gBAC5B,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACzB,OAAO,KAAK,CAAC,aAAa,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;gBAC1D,CAAC,CAAC;gBACJ,CAAC,CAAC,SAAS;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAlBe,wCAAsB,yBAkBrC,CAAA;AACH,CAAC,EAnCgB,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAmCjC"}

package/lib/model/cohere-chat-response.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Generative AI Service Inference API
+ * OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.
+
+Use the Generative AI service inference API to access your custom model endpoints, or to try the out-of-the-box models to [generate text](#/en/generative-ai-inference/latest/GenerateTextResult/GenerateText), [summarize](#/en/generative-ai-inference/latest/SummarizeTextResult/SummarizeText), and [create text embeddings](#/en/generative-ai-inference/latest/EmbedTextResult/EmbedText).
+
+To use a Generative AI custom model for inference, you must first create an endpoint for that model. Use the [Generative AI service management API](/#/en/generative-ai/latest/) to [create a custom model](#/en/generative-ai/latest/Model/) by fine-tuning an out-of-the-box model, or a previous version of a custom model, using your own data. Fine-tune the custom model on a  [fine-tuning dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/). Then, create a [hosting dedicated AI cluster](#/en/generative-ai/latest/DedicatedAiCluster/) with an [endpoint](#/en/generative-ai/latest/Endpoint/) to host your custom model. For resource management in the Generative AI service, use the [Generative AI service management API](/#/en/generative-ai/latest/).
+
+To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).
+
+ * OpenAPI spec version: 20231130
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import * as model from "../model";
+/**
+ * The response to the chat conversation.
+ */
+export interface CohereChatResponse extends model.BaseChatResponse {
+    /**
+     * Contents of the reply generated by the model.
+     */
+    "text": string;
+    /**
+     * Inline citations for the generated reply.
+     */
+    "citations"?: Array<model.Citation>;
+    /**
+     * Denotes that a search for documents is required.
+     */
+    "isSearchRequired"?: boolean;
+    /**
+     * Why the generation was completed.
+     */
+    "finishReason": CohereChatResponse.FinishReason;
+    /**
+     * Generated search queries.
+     */
+    "searchQueries"?: Array<model.SearchQuery>;
+    /**
+     * Documents seen by the model when generating the reply. Each document is a JSON String
+     * representing the field and values of the document.
+     *
+     */
+    "documents"?: Array<any>;
+    "apiFormat": string;
+}
+export declare namespace CohereChatResponse {
+    enum FinishReason {
+        Complete = "COMPLETE",
+        ErrorToxic = "ERROR_TOXIC",
+        ErrorLimit = "ERROR_LIMIT",
+        Error = "ERROR",
+        UserCancel = "USER_CANCEL",
+        MaxTokens = "MAX_TOKENS",
+        /**
+         * This value is used if a service returns a value for this enum that is not recognized by this
+         * version of the SDK.
+         */
+        UnknownValue = "UNKNOWN_VALUE"
+    }
+    function getJsonObj(obj: CohereChatResponse, isParentJsonObj?: boolean): object;
+    const apiFormat = "COHERE";
+    function getDeserializedJsonObj(obj: CohereChatResponse, isParentJsonObj?: boolean): object;
+}