oci-generativeaiinference 2.77.1

package/lib/request/generate-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/GenerateText.ts.html |here} to see how to use GenerateTextRequest.
+ */
+export interface GenerateTextRequest extends common.BaseRequest {
+    /**
+     * Details for generating the text response.
+     */
+    "generateTextDetails": model.GenerateTextDetails;
+    /**
+     * 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/generate-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=generate-text-request.js.map

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

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

package/lib/request/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 EmbedTextRequest from "./embed-text-request";
+export import EmbedTextRequest = EmbedTextRequest.EmbedTextRequest;
+import * as GenerateTextRequest from "./generate-text-request";
+export import GenerateTextRequest = GenerateTextRequest.GenerateTextRequest;
+import * as SummarizeTextRequest from "./summarize-text-request";
+export import SummarizeTextRequest = SummarizeTextRequest.SummarizeTextRequest;

package/lib/request/index.js

@@ -0,0 +1,22 @@
+"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 });
+//# sourceMappingURL=index.js.map

package/lib/request/index.js.map

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

package/lib/request/summarize-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/SummarizeText.ts.html |here} to see how to use SummarizeTextRequest.
+ */
+export interface SummarizeTextRequest extends common.BaseRequest {
+    /**
+     * Details for summarizing the text.
+     */
+    "summarizeTextDetails": model.SummarizeTextDetails;
+    /**
+     * 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/summarize-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=summarize-text-request.js.map

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

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

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

@@ -0,0 +1,30 @@
+/**
+ *
+ *
+ * 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";
+export interface EmbedTextResponse {
+    /**
+     * For optimistic concurrency control. See {@code if-match}.
+     *
+     */
+    "etag": string;
+    /**
+     * Unique Oracle-assigned identifier for the request. If you need to contact
+     * Oracle about a particular request, please provide the request ID.
+     *
+     */
+    "opcRequestId": string;
+    /**
+     * The returned model.EmbedTextResult instance.
+     */
+    "embedTextResult": model.EmbedTextResult;
+}

package/lib/response/embed-text-response.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-response.js.map

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

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

package/lib/response/generate-text-response.d.ts

@@ -0,0 +1,30 @@
+/**
+ *
+ *
+ * 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";
+export interface GenerateTextResponse {
+    /**
+     * For optimistic concurrency control. See {@code if-match}.
+     *
+     */
+    "etag": string;
+    /**
+     * Unique Oracle-assigned identifier for the request. If you need to contact
+     * Oracle about a particular request, please provide the request ID.
+     *
+     */
+    "opcRequestId": string;
+    /**
+     * The returned model.GenerateTextResult instance.
+     */
+    "generateTextResult": model.GenerateTextResult;
+}

package/lib/response/generate-text-response.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=generate-text-response.js.map

package/lib/response/generate-text-response.js.map

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

package/lib/response/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 EmbedTextResponse from "./embed-text-response";
+export import EmbedTextResponse = EmbedTextResponse.EmbedTextResponse;
+import * as GenerateTextResponse from "./generate-text-response";
+export import GenerateTextResponse = GenerateTextResponse.GenerateTextResponse;
+import * as SummarizeTextResponse from "./summarize-text-response";
+export import SummarizeTextResponse = SummarizeTextResponse.SummarizeTextResponse;

package/lib/response/index.js

@@ -0,0 +1,22 @@
+"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 });
+//# sourceMappingURL=index.js.map

package/lib/response/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../lib/generativeaiinference/lib/response/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG"}

package/lib/response/summarize-text-response.d.ts

@@ -0,0 +1,30 @@
+/**
+ *
+ *
+ * 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";
+export interface SummarizeTextResponse {
+    /**
+     * For optimistic concurrency control. See {@code if-match}.
+     *
+     */
+    "etag": string;
+    /**
+     * Unique Oracle-assigned identifier for the request. If you need to contact
+     * Oracle about a particular request, please provide the request ID.
+     *
+     */
+    "opcRequestId": string;
+    /**
+     * The returned model.SummarizeTextResult instance.
+     */
+    "summarizeTextResult": model.SummarizeTextResult;
+}

package/lib/response/summarize-text-response.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=summarize-text-response.js.map

package/lib/response/summarize-text-response.js.map

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

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "oci-generativeaiinference",
+  "version": "2.77.1",
+  "description": "OCI NodeJS client for Generative Ai Inference Service",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oracle/oci-typescript-sdk"
+  },
+  "main": "./index.js",
+  "typings": "./index",
+  "scripts": {},
+  "author": {
+    "name": "Oracle Cloud Infrastructure",
+    "email": ""
+  },
+  "license": "(UPL-1.0 OR Apache-2.0)",
+  "dependencies": {
+    "oci-common": "2.77.1",
+    "oci-workrequests": "2.77.1"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "contributors": [
+    "Jyoti Saini <jyoti.s.saini@oracle.com>",
+    "Joe Levy <joe.levy@oracle.com>",
+    "Walt Tran <walt.tran@oracle.com>"
+  ]
+}