oci-generativeaiagent 2.106.0 → 2.106.1

package/lib/client.d.ts

@@ -196,6 +196,16 @@ export declare class GenerativeAiAgentClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/CreateKnowledgeBase.ts.html |here} to see how to use CreateKnowledgeBase API.
      */
     createKnowledgeBase(createKnowledgeBaseRequest: requests.CreateKnowledgeBaseRequest): Promise<responses.CreateKnowledgeBaseResponse>;
+    /**
+     * Creates a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateToolRequest
+     * @return CreateToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/CreateTool.ts.html |here} to see how to use CreateTool API.
+     */
+    createTool(createToolRequest: requests.CreateToolRequest): Promise<responses.CreateToolResponse>;
     /**
      * Deletes an agent.
      *
@@ -246,6 +256,16 @@ export declare class GenerativeAiAgentClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/DeleteKnowledgeBase.ts.html |here} to see how to use DeleteKnowledgeBase API.
      */
     deleteKnowledgeBase(deleteKnowledgeBaseRequest: requests.DeleteKnowledgeBaseRequest): Promise<responses.DeleteKnowledgeBaseResponse>;
+    /**
+     * Deletes a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteToolRequest
+     * @return DeleteToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/DeleteTool.ts.html |here} to see how to use DeleteTool API.
+     */
+    deleteTool(deleteToolRequest: requests.DeleteToolRequest): Promise<responses.DeleteToolResponse>;
     /**
      * Gets information about an agent.
      *
@@ -306,6 +326,16 @@ export declare class GenerativeAiAgentClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/GetKnowledgeBase.ts.html |here} to see how to use GetKnowledgeBase API.
      */
     getKnowledgeBase(getKnowledgeBaseRequest: requests.GetKnowledgeBaseRequest): Promise<responses.GetKnowledgeBaseResponse>;
+    /**
+     * Gets information about a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetToolRequest
+     * @return GetToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/GetTool.ts.html |here} to see how to use GetTool API.
+     */
+    getTool(getToolRequest: requests.GetToolRequest): Promise<responses.GetToolResponse>;
     /**
      * Gets the details of a work request.
      *
@@ -366,6 +396,16 @@ export declare class GenerativeAiAgentClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/ListKnowledgeBases.ts.html |here} to see how to use ListKnowledgeBases API.
      */
     listKnowledgeBases(listKnowledgeBasesRequest: requests.ListKnowledgeBasesRequest): Promise<responses.ListKnowledgeBasesResponse>;
+    /**
+     * Gets a list of tools.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListToolsRequest
+     * @return ListToolsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/ListTools.ts.html |here} to see how to use ListTools API.
+     */
+    listTools(listToolsRequest: requests.ListToolsRequest): Promise<responses.ListToolsResponse>;
     /**
      * Lists the errors for a work request.
      *
@@ -436,5 +476,15 @@ export declare class GenerativeAiAgentClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/UpdateKnowledgeBase.ts.html |here} to see how to use UpdateKnowledgeBase API.
      */
     updateKnowledgeBase(updateKnowledgeBaseRequest: requests.UpdateKnowledgeBaseRequest): Promise<responses.UpdateKnowledgeBaseResponse>;
+    /**
+     * Updates a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateToolRequest
+     * @return UpdateToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/UpdateTool.ts.html |here} to see how to use UpdateTool API.
+     */
+    updateTool(updateToolRequest: requests.UpdateToolRequest): Promise<responses.UpdateToolResponse>;
 }
 export {};

package/lib/client.js

@@ -859,6 +859,85 @@ class GenerativeAiAgentClient {
             }
         });
     }
+    /**
+     * Creates a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateToolRequest
+     * @return CreateToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/CreateTool.ts.html |here} to see how to use CreateTool API.
+     */
+    createTool(createToolRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation GenerativeAiAgentClient#createTool.");
+            const operationName = "createTool";
+            const apiReferenceLink = "";
+            const pathParams = {};
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-retry-token": createToolRequest.opcRetryToken,
+                "opc-request-id": createToolRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createToolRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/tools",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(createToolRequest.createToolDetails, "CreateToolDetails", model.CreateToolDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "tool",
+                    bodyModel: model.Tool,
+                    type: "model.Tool",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("location"),
+                            key: "location",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("content-location"),
+                            key: "contentLocation",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Deletes an agent.
      *
@@ -1164,6 +1243,67 @@ class GenerativeAiAgentClient {
             }
         });
     }
+    /**
+     * Deletes a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteToolRequest
+     * @return DeleteToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/DeleteTool.ts.html |here} to see how to use DeleteTool API.
+     */
+    deleteTool(deleteToolRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation GenerativeAiAgentClient#deleteTool.");
+            const operationName = "deleteTool";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{toolId}": deleteToolRequest.toolId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": deleteToolRequest.ifMatch,
+                "opc-request-id": deleteToolRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteToolRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/tools/{toolId}",
+                method: "DELETE",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Gets information about an agent.
      *
@@ -1542,6 +1682,70 @@ class GenerativeAiAgentClient {
             }
         });
     }
+    /**
+     * Gets information about a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetToolRequest
+     * @return GetToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/GetTool.ts.html |here} to see how to use GetTool API.
+     */
+    getTool(getToolRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation GenerativeAiAgentClient#getTool.");
+            const operationName = "getTool";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{toolId}": getToolRequest.toolId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getToolRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getToolRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/tools/{toolId}",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "tool",
+                    bodyModel: model.Tool,
+                    type: "model.Tool",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Gets the details of a work request.
      *
@@ -1964,6 +2168,77 @@ class GenerativeAiAgentClient {
             }
         });
     }
+    /**
+     * Gets a list of tools.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListToolsRequest
+     * @return ListToolsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/ListTools.ts.html |here} to see how to use ListTools API.
+     */
+    listTools(listToolsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation GenerativeAiAgentClient#listTools.");
+            const operationName = "listTools";
+            const apiReferenceLink = "";
+            const pathParams = {};
+            const queryParams = {
+                "compartmentId": listToolsRequest.compartmentId,
+                "lifecycleState": listToolsRequest.lifecycleState,
+                "displayName": listToolsRequest.displayName,
+                "agentId": listToolsRequest.agentId,
+                "limit": listToolsRequest.limit,
+                "page": listToolsRequest.page,
+                "sortOrder": listToolsRequest.sortOrder,
+                "sortBy": listToolsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listToolsRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listToolsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/tools",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "toolCollection",
+                    bodyModel: model.ToolCollection,
+                    type: "model.ToolCollection",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Lists the errors for a work request.
      *
@@ -2421,6 +2696,68 @@ class GenerativeAiAgentClient {
             }
         });
     }
+    /**
+     * Updates a tool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateToolRequest
+     * @return UpdateToolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/generativeaiagent/UpdateTool.ts.html |here} to see how to use UpdateTool API.
+     */
+    updateTool(updateToolRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation GenerativeAiAgentClient#updateTool.");
+            const operationName = "updateTool";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{toolId}": updateToolRequest.toolId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": updateToolRequest.ifMatch,
+                "opc-request-id": updateToolRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateToolRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/tools/{toolId}",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateToolRequest.updateToolDetails, "UpdateToolDetails", model.UpdateToolDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
 }
 exports.GenerativeAiAgentClient = GenerativeAiAgentClient;
 GenerativeAiAgentClient.serviceEndpointTemplate = "https://agent.generativeai.{region}.oci.{secondLevelDomain}";