oci-generativeaiinference 2.77.1

package/lib/model/on-demand-serving-mode.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";
+/**
+ * The model's serving mode is on-demand serving on a shared infrastructure.
+ */
+export interface OnDemandServingMode extends model.ServingMode {
+    /**
+     * The unique ID of a model to use. Can use list Models API to list available models.
+     */
+    "modelId": string;
+    "servingType": string;
+}
+export declare namespace OnDemandServingMode {
+    function getJsonObj(obj: OnDemandServingMode, isParentJsonObj?: boolean): object;
+    const servingType = "ON_DEMAND";
+    function getDeserializedJsonObj(obj: OnDemandServingMode, isParentJsonObj?: boolean): object;
+}

package/lib/model/on-demand-serving-mode.js

@@ -0,0 +1,59 @@
+"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.OnDemandServingMode = void 0;
+const model = __importStar(require("../model"));
+var OnDemandServingMode;
+(function (OnDemandServingMode) {
+    function getJsonObj(obj, isParentJsonObj) {
+        const jsonObj = Object.assign(Object.assign({}, (isParentJsonObj ? obj : model.ServingMode.getJsonObj(obj))), {});
+        return jsonObj;
+    }
+    OnDemandServingMode.getJsonObj = getJsonObj;
+    OnDemandServingMode.servingType = "ON_DEMAND";
+    function getDeserializedJsonObj(obj, isParentJsonObj) {
+        const jsonObj = Object.assign(Object.assign({}, (isParentJsonObj
+            ? obj
+            : model.ServingMode.getDeserializedJsonObj(obj))), {});
+        return jsonObj;
+    }
+    OnDemandServingMode.getDeserializedJsonObj = getDeserializedJsonObj;
+})(OnDemandServingMode = exports.OnDemandServingMode || (exports.OnDemandServingMode = {}));
+//# sourceMappingURL=on-demand-serving-mode.js.map

package/lib/model/on-demand-serving-mode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-demand-serving-mode.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/on-demand-serving-mode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAelC,IAAiB,mBAAmB,CAuBnC;AAvBD,WAAiB,mBAAmB;IAClC,SAAgB,UAAU,CAAC,GAAwB,EAAE,eAAyB;QAC5E,MAAM,OAAO,mCACR,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAyB,CAAC,GACpF,EAAE,CACN,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAPe,8BAAU,aAOzB,CAAA;IACY,+BAAW,GAAG,WAAW,CAAC;IACvC,SAAgB,sBAAsB,CACpC,GAAwB,EACxB,eAAyB;QAEzB,MAAM,OAAO,mCACR,CAAC,eAAe;YACjB,CAAC,CAAC,GAAG;YACL,CAAC,CAAE,KAAK,CAAC,WAAW,CAAC,sBAAsB,CAAC,GAAG,CAAyB,CAAC,GACxE,EAAE,CACN,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAZe,0CAAsB,yBAYrC,CAAA;AACH,CAAC,EAvBgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAuBnC"}

package/lib/model/serving-mode.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+/**
+ * The model's serving mode, which could be on-demand serving or dedicated serving.
+ */
+export interface ServingMode {
+    "servingType": string;
+}
+export declare namespace ServingMode {
+    function getJsonObj(obj: ServingMode): object;
+    function getDeserializedJsonObj(obj: ServingMode): object;
+}

package/lib/model/serving-mode.js

@@ -0,0 +1,79 @@
+"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.ServingMode = void 0;
+const model = __importStar(require("../model"));
+const common = require("oci-common");
+var ServingMode;
+(function (ServingMode) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        if (obj && "servingType" in obj && obj.servingType) {
+            switch (obj.servingType) {
+                case "DEDICATED":
+                    return model.DedicatedServingMode.getJsonObj(jsonObj, true);
+                case "ON_DEMAND":
+                    return model.OnDemandServingMode.getJsonObj(jsonObj, true);
+                default:
+                    if (common.LOG.logger)
+                        common.LOG.logger.info(`Unknown value for: ${obj.servingType}`);
+            }
+        }
+        return jsonObj;
+    }
+    ServingMode.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        if (obj && "servingType" in obj && obj.servingType) {
+            switch (obj.servingType) {
+                case "DEDICATED":
+                    return model.DedicatedServingMode.getDeserializedJsonObj(jsonObj, true);
+                case "ON_DEMAND":
+                    return model.OnDemandServingMode.getDeserializedJsonObj(jsonObj, true);
+                default:
+                    if (common.LOG.logger)
+                        common.LOG.logger.info(`Unknown value for: ${obj.servingType}`);
+            }
+        }
+        return jsonObj;
+    }
+    ServingMode.getDeserializedJsonObj = getDeserializedJsonObj;
+})(ServingMode = exports.ServingMode || (exports.ServingMode = {}));
+//# sourceMappingURL=serving-mode.js.map

package/lib/model/serving-mode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serving-mode.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/serving-mode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AAClC,qCAAsC;AAStC,IAAiB,WAAW,CA2C3B;AA3CD,WAAiB,WAAW;IAC1B,SAAgB,UAAU,CAAC,GAAgB;QACzC,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,IAAI,GAAG,IAAI,aAAa,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE;YAClD,QAAQ,GAAG,CAAC,WAAW,EAAE;gBACvB,KAAK,WAAW;oBACd,OAAO,KAAK,CAAC,oBAAoB,CAAC,UAAU,CACL,OAAQ,EAC7C,IAAI,CACL,CAAC;gBACJ,KAAK,WAAW;oBACd,OAAO,KAAK,CAAC,mBAAmB,CAAC,UAAU,CACL,OAAQ,EAC5C,IAAI,CACL,CAAC;gBACJ;oBACE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM;wBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;aAC1F;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IApBe,sBAAU,aAoBzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAgB;QACrD,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,IAAI,GAAG,IAAI,aAAa,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE;YAClD,QAAQ,GAAG,CAAC,WAAW,EAAE;gBACvB,KAAK,WAAW;oBACd,OAAO,KAAK,CAAC,oBAAoB,CAAC,sBAAsB,CACjB,OAAQ,EAC7C,IAAI,CACL,CAAC;gBACJ,KAAK,WAAW;oBACd,OAAO,KAAK,CAAC,mBAAmB,CAAC,sBAAsB,CACjB,OAAQ,EAC5C,IAAI,CACL,CAAC;gBACJ;oBACE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM;wBAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;aAC1F;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IApBe,kCAAsB,yBAoBrC,CAAA;AACH,CAAC,EA3CgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA2C3B"}

package/lib/model/summarize-text-details.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 request to summarize text.
+ */
+export interface SummarizeTextDetails {
+    /**
+     * The input string to be summarized.
+     */
+    "input": string;
+    "servingMode": model.DedicatedServingMode | model.OnDemandServingMode;
+    /**
+     * The OCID of compartment that the user is authorized to use to call into the Generative AI service.
+     */
+    "compartmentId": string;
+    /**
+     * Whether or not to include the original inputs in the response.
+     */
+    "isEcho"?: boolean;
+    /**
+      * A number that sets the randomness of the generated output. Lower temperatures mean less random generations.
+  * <p>
+  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;
+    /**
+     * A free-form instruction for modifying how the summaries get generated. Should complete the sentence \"Generate a summary _\". For example, \"focusing on the next steps\" or \"written by Yoda\".
+     */
+    "additionalCommand"?: string;
+    /**
+     * Indicates the approximate length of the summary. If \"AUTO\" is selected, the best option will be picked based on the input text.
+     */
+    "length"?: SummarizeTextDetails.Length;
+    /**
+     * Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points. If \"AUTO\" is selected, the best option will be picked based on the input text.
+     */
+    "format"?: SummarizeTextDetails.Format;
+    /**
+     * Controls how close to the original text the summary is. High extractiveness summaries will lean towards reusing sentences verbatim, while low extractiveness summaries will tend to paraphrase more.
+     */
+    "extractiveness"?: SummarizeTextDetails.Extractiveness;
+}
+export declare namespace SummarizeTextDetails {
+    enum Length {
+        Short = "SHORT",
+        Medium = "MEDIUM",
+        Long = "LONG",
+        Auto = "AUTO"
+    }
+    enum Format {
+        Paragraph = "PARAGRAPH",
+        Bullets = "BULLETS",
+        Auto = "AUTO"
+    }
+    enum Extractiveness {
+        Low = "LOW",
+        Medium = "MEDIUM",
+        High = "HIGH",
+        Auto = "AUTO"
+    }
+    function getJsonObj(obj: SummarizeTextDetails): object;
+    function getDeserializedJsonObj(obj: SummarizeTextDetails): object;
+}

package/lib/model/summarize-text-details.js

@@ -0,0 +1,82 @@
+"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.SummarizeTextDetails = void 0;
+const model = __importStar(require("../model"));
+var SummarizeTextDetails;
+(function (SummarizeTextDetails) {
+    let Length;
+    (function (Length) {
+        Length["Short"] = "SHORT";
+        Length["Medium"] = "MEDIUM";
+        Length["Long"] = "LONG";
+        Length["Auto"] = "AUTO";
+    })(Length = SummarizeTextDetails.Length || (SummarizeTextDetails.Length = {}));
+    let Format;
+    (function (Format) {
+        Format["Paragraph"] = "PARAGRAPH";
+        Format["Bullets"] = "BULLETS";
+        Format["Auto"] = "AUTO";
+    })(Format = SummarizeTextDetails.Format || (SummarizeTextDetails.Format = {}));
+    let Extractiveness;
+    (function (Extractiveness) {
+        Extractiveness["Low"] = "LOW";
+        Extractiveness["Medium"] = "MEDIUM";
+        Extractiveness["High"] = "HIGH";
+        Extractiveness["Auto"] = "AUTO";
+    })(Extractiveness = SummarizeTextDetails.Extractiveness || (SummarizeTextDetails.Extractiveness = {}));
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "servingMode": obj.servingMode ? model.ServingMode.getJsonObj(obj.servingMode) : undefined
+        });
+        return jsonObj;
+    }
+    SummarizeTextDetails.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {
+            "servingMode": obj.servingMode
+                ? model.ServingMode.getDeserializedJsonObj(obj.servingMode)
+                : undefined
+        });
+        return jsonObj;
+    }
+    SummarizeTextDetails.getDeserializedJsonObj = getDeserializedJsonObj;
+})(SummarizeTextDetails = exports.SummarizeTextDetails || (exports.SummarizeTextDetails = {}));
+//# sourceMappingURL=summarize-text-details.js.map

package/lib/model/summarize-text-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarize-text-details.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/summarize-text-details.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;;;;;;;;;;;;;;;;;;;;AAEH,gDAAkC;AA6ClC,IAAiB,oBAAoB,CA2CpC;AA3CD,WAAiB,oBAAoB;IACnC,IAAY,MAKX;IALD,WAAY,MAAM;QAChB,yBAAe,CAAA;QACf,2BAAiB,CAAA;QACjB,uBAAa,CAAA;QACb,uBAAa,CAAA;IACf,CAAC,EALW,MAAM,GAAN,2BAAM,KAAN,2BAAM,QAKjB;IAED,IAAY,MAIX;IAJD,WAAY,MAAM;QAChB,iCAAuB,CAAA;QACvB,6BAAmB,CAAA;QACnB,uBAAa,CAAA;IACf,CAAC,EAJW,MAAM,GAAN,2BAAM,KAAN,2BAAM,QAIjB;IAED,IAAY,cAKX;IALD,WAAY,cAAc;QACxB,6BAAW,CAAA;QACX,mCAAiB,CAAA;QACjB,+BAAa,CAAA;QACb,+BAAa,CAAA;IACf,CAAC,EALW,cAAc,GAAd,mCAAc,KAAd,mCAAc,QAKzB;IAED,SAAgB,UAAU,CAAC,GAAyB;QAClD,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;SAC3F,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IATe,+BAAU,aASzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAyB;QAC9D,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;SACd,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAXe,2CAAsB,yBAWrC,CAAA;AACH,CAAC,EA3CgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA2CpC"}

package/lib/model/summarize-text-result.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+/**
+ * Summarize text result to return to caller.
+ */
+export interface SummarizeTextResult {
+    /**
+     * A unique identifier for this SummarizeTextResult.
+     */
+    "id": string;
+    /**
+     * The original input. Only included if \"isEcho\" set to true.
+     */
+    "input"?: string;
+    /**
+     * Summary result corresponding to input.
+     */
+    "summary": string;
+    /**
+     * The OCID of the model used in this inference request.
+     */
+    "modelId"?: string;
+    /**
+     * The version of the model.
+     */
+    "modelVersion"?: string;
+}
+export declare namespace SummarizeTextResult {
+    function getJsonObj(obj: SummarizeTextResult): object;
+    function getDeserializedJsonObj(obj: SummarizeTextResult): object;
+}

package/lib/model/summarize-text-result.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.SummarizeTextResult = void 0;
+var SummarizeTextResult;
+(function (SummarizeTextResult) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    SummarizeTextResult.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    SummarizeTextResult.getDeserializedJsonObj = getDeserializedJsonObj;
+})(SummarizeTextResult = exports.SummarizeTextResult || (exports.SummarizeTextResult = {}));
+//# sourceMappingURL=summarize-text-result.js.map

package/lib/model/summarize-text-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarize-text-result.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/summarize-text-result.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AA+BH,IAAiB,mBAAmB,CAWnC;AAXD,WAAiB,mBAAmB;IAClC,SAAgB,UAAU,CAAC,GAAwB;QACjD,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,8BAAU,aAIzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAwB;QAC7D,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,0CAAsB,yBAIrC,CAAA;AACH,CAAC,EAXgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAWnC"}

package/lib/model/token-likelihood.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+/**
+ * An object that contains the returned token and its corresponding likelihood.
+ */
+export interface TokenLikelihood {
+    /**
+      * A word, part of a word, or a punctuation.
+  * <p>
+  For example, apple is a token and friendship is made up of two tokens, friend and ship. When you run a model, you can set the maximum number of output tokens. Estimate three tokens per word.
+  *
+      */
+    "token"?: string;
+    /**
+     * The likelihood of this token during generation. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     */
+    "likelihood"?: number;
+}
+export declare namespace TokenLikelihood {
+    function getJsonObj(obj: TokenLikelihood): object;
+    function getDeserializedJsonObj(obj: TokenLikelihood): object;
+}

package/lib/model/token-likelihood.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.TokenLikelihood = void 0;
+var TokenLikelihood;
+(function (TokenLikelihood) {
+    function getJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    TokenLikelihood.getJsonObj = getJsonObj;
+    function getDeserializedJsonObj(obj) {
+        const jsonObj = Object.assign(Object.assign({}, obj), {});
+        return jsonObj;
+    }
+    TokenLikelihood.getDeserializedJsonObj = getDeserializedJsonObj;
+})(TokenLikelihood = exports.TokenLikelihood || (exports.TokenLikelihood = {}));
+//# sourceMappingURL=token-likelihood.js.map

package/lib/model/token-likelihood.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-likelihood.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/model/token-likelihood.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AAsBH,IAAiB,eAAe,CAW/B;AAXD,WAAiB,eAAe;IAC9B,SAAgB,UAAU,CAAC,GAAoB;QAC7C,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,0BAAU,aAIzB,CAAA;IACD,SAAgB,sBAAsB,CAAC,GAAoB;QACzD,MAAM,OAAO,mCAAQ,GAAG,GAAK,EAAE,CAAE,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAJe,sCAAsB,yBAIrC,CAAA;AACH,CAAC,EAXgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAW/B"}

package/lib/request/embed-text-request.d.ts

@@ -0,0 +1,36 @@
+/**
+ *
+ *
+ * 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";
+import common = require("oci-common");
+/**
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/generativeaiinference/EmbedText.ts.html |here} to see how to use EmbedTextRequest.
+ */
+export interface EmbedTextRequest extends common.BaseRequest {
+    /**
+     * Details for generating the embed response.
+     */
+    "embedTextDetails": model.EmbedTextDetails;
+    /**
+     * A token that uniquely identifies a request so it can be retried in case of a timeout or
+     * server error without risk of executing that same action again. Retry tokens expire after 24
+     * hours, but can be invalidated before then due to conflicting operations. For example, if a resource
+     * has been deleted and purged from the system, then a retry of the original creation request
+     * might be rejected.
+     *
+     */
+    "opcRetryToken"?: string;
+    /**
+     * The client request ID for tracing.
+     */
+    "opcRequestId"?: string;
+}

package/lib/request/embed-text-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ *
+ *
+ * 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 });
+//# sourceMappingURL=embed-text-request.js.map

package/lib/request/embed-text-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embed-text-request.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/request/embed-text-request.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}