oci-aidocument 2.62.1 → 2.62.3

package/lib/aiservicedocument-waiter.d.ts

@@ -18,6 +18,14 @@ export declare class AIServiceDocumentWaiter {
     private client;
     private readonly config?;
     constructor(client: AIServiceDocumentClient, config?: Partial<import("oci-common/lib/waiter").WaiterConfigurationDetails> | undefined);
+    /**
+     * Waits forModel till it reaches any of the provided states
+     *
+     * @param request the request to send
+     * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
+     * @return response returns GetModelResponse | null (null in case of 404 response)
+     */
+    forModel(request: serviceRequests.GetModelRequest, ...targetStates: models.Model.LifecycleState[]): Promise<serviceResponses.GetModelResponse | null>;
     /**
      * Waits forProcessorJob till it reaches any of the provided states
      *
@@ -26,4 +34,19 @@ export declare class AIServiceDocumentWaiter {
      * @return response returns GetProcessorJobResponse
      */
     forProcessorJob(request: serviceRequests.GetProcessorJobRequest, ...targetStates: models.ProcessorJob.LifecycleState[]): Promise<serviceResponses.GetProcessorJobResponse>;
+    /**
+     * Waits forProject till it reaches any of the provided states
+     *
+     * @param request the request to send
+     * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
+     * @return response returns GetProjectResponse | null (null in case of 404 response)
+     */
+    forProject(request: serviceRequests.GetProjectRequest, ...targetStates: models.Project.LifecycleState[]): Promise<serviceResponses.GetProjectResponse | null>;
+    /**
+     * Waits forWorkRequest
+     *
+     * @param request the request to send
+     * @return response returns GetWorkRequestResponse
+     */
+    forWorkRequest(request: serviceRequests.GetWorkRequestRequest): Promise<serviceResponses.GetWorkRequestResponse>;
 }

package/lib/aiservicedocument-waiter.js

@@ -11,6 +11,25 @@
  * Copyright (c) 2020, 2023, 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;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -22,12 +41,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AIServiceDocumentWaiter = void 0;
+const models = __importStar(require("./model"));
 const oci_common_1 = require("oci-common");
 class AIServiceDocumentWaiter {
     constructor(client, config) {
         this.client = client;
         this.config = config;
     }
+    /**
+     * Waits forModel till it reaches any of the provided states
+     *
+     * @param request the request to send
+     * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
+     * @return response returns GetModelResponse | null (null in case of 404 response)
+     */
+    forModel(request, ...targetStates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return oci_common_1.genericTerminalConditionWaiter(this.config, () => this.client.getModel(request), response => targetStates.includes(response.model.lifecycleState), targetStates.includes(models.Model.LifecycleState.Deleted));
+        });
+    }
     /**
      * Waits forProcessorJob till it reaches any of the provided states
      *
@@ -40,6 +72,29 @@ class AIServiceDocumentWaiter {
             return oci_common_1.genericWaiter(this.config, () => this.client.getProcessorJob(request), response => targetStates.includes(response.processorJob.lifecycleState));
         });
     }
+    /**
+     * Waits forProject till it reaches any of the provided states
+     *
+     * @param request the request to send
+     * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
+     * @return response returns GetProjectResponse | null (null in case of 404 response)
+     */
+    forProject(request, ...targetStates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return oci_common_1.genericTerminalConditionWaiter(this.config, () => this.client.getProject(request), response => targetStates.includes(response.project.lifecycleState), targetStates.includes(models.Project.LifecycleState.Deleted));
+        });
+    }
+    /**
+     * Waits forWorkRequest
+     *
+     * @param request the request to send
+     * @return response returns GetWorkRequestResponse
+     */
+    forWorkRequest(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return oci_common_1.genericWaiter(this.config, () => this.client.getWorkRequest(request), response => (response.workRequest.timeFinished ? true : false));
+        });
+    }
 }
 exports.AIServiceDocumentWaiter = AIServiceDocumentWaiter;
 //# sourceMappingURL=aiservicedocument-waiter.js.map

package/lib/aiservicedocument-waiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"aiservicedocument-waiter.js","sourceRoot":"","sources":["../../../../lib/aidocument/lib/aiservicedocument-waiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;AAMH,2CAAgG;AAEhG,MAAa,uBAAuB;IAClC,YACU,MAA+B,EACtB,MAA4B;QADrC,WAAM,GAAN,MAAM,CAAyB;QACtB,WAAM,GAAN,MAAM,CAAsB;IAC5C,CAAC;IAEJ;;;;;;OAMG;IACU,eAAe,CAC1B,OAA+C,EAC/C,GAAG,YAAkD;;YAErD,OAAO,0BAAa,CAClB,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,EAC1C,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAe,CAAC,CACzE,CAAC;QACJ,CAAC;KAAA;CACF;AAvBD,0DAuBC"}
+{"version":3,"file":"aiservicedocument-waiter.js","sourceRoot":"","sources":["../../../../lib/aidocument/lib/aiservicedocument-waiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,gDAAkC;AAElC,2CAAgG;AAEhG,MAAa,uBAAuB;IAClC,YACU,MAA+B,EACtB,MAA4B;QADrC,WAAM,GAAN,MAAM,CAAyB;QACtB,WAAM,GAAN,MAAM,CAAsB;IAC5C,CAAC;IAEJ;;;;;;OAMG;IACU,QAAQ,CACnB,OAAwC,EACxC,GAAG,YAA2C;;YAE9C,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EACnC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAe,CAAC,EACjE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAC3D,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACU,eAAe,CAC1B,OAA+C,EAC/C,GAAG,YAAkD;;YAErD,OAAO,0BAAa,CAClB,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,EAC1C,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAe,CAAC,CACzE,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACU,UAAU,CACrB,OAA0C,EAC1C,GAAG,YAA6C;;YAEhD,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EACrC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAe,CAAC,EACnE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAC7D,CAAC;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACU,cAAc,CACzB,OAA8C;;YAE9C,OAAO,0BAAa,CAClB,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EACzC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAC/D,CAAC;QACJ,CAAC;KAAA;CACF;AA7ED,0DA6EC"}

package/lib/client.d.ts

@@ -86,9 +86,46 @@ export declare class AIServiceDocumentClient {
      * @param CancelProcessorJobRequest
      * @return CancelProcessorJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.1/aidocument/CancelProcessorJob.ts.html |here} to see how to use CancelProcessorJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/CancelProcessorJob.ts.html |here} to see how to use CancelProcessorJob API.
      */
     cancelProcessorJob(cancelProcessorJobRequest: requests.CancelProcessorJobRequest): Promise<responses.CancelProcessorJobResponse>;
+    /**
+     * Cancel the work request with the given ID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CancelWorkRequestRequest
+     * @return CancelWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeModelCompartmentRequest
+     * @return ChangeModelCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
+     */
+    changeModelCompartment(changeModelCompartmentRequest: requests.ChangeModelCompartmentRequest): Promise<responses.ChangeModelCompartmentResponse>;
+    /**
+     * Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeProjectCompartmentRequest
+     * @return ChangeProjectCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
+     */
+    changeProjectCompartment(changeProjectCompartmentRequest: requests.ChangeProjectCompartmentRequest): Promise<responses.ChangeProjectCompartmentResponse>;
+    /**
+     * Create a new model.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateModelRequest
+     * @return CreateModelResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/CreateModel.ts.html |here} to see how to use CreateModel API.
+     */
+    createModel(createModelRequest: requests.CreateModelRequest): Promise<responses.CreateModelResponse>;
     /**
      * Create a processor job for document analysis.
      *
@@ -96,9 +133,46 @@ export declare class AIServiceDocumentClient {
      * @param CreateProcessorJobRequest
      * @return CreateProcessorJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.1/aidocument/CreateProcessorJob.ts.html |here} to see how to use CreateProcessorJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/CreateProcessorJob.ts.html |here} to see how to use CreateProcessorJob API.
      */
     createProcessorJob(createProcessorJobRequest: requests.CreateProcessorJobRequest): Promise<responses.CreateProcessorJobResponse>;
+    /**
+     * Create a new project.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateProjectRequest
+     * @return CreateProjectResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/CreateProject.ts.html |here} to see how to use CreateProject API.
+     */
+    createProject(createProjectRequest: requests.CreateProjectRequest): Promise<responses.CreateProjectResponse>;
+    /**
+     * Delete a model by identifier.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteModelRequest
+     * @return DeleteModelResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/DeleteModel.ts.html |here} to see how to use DeleteModel API.
+     */
+    deleteModel(deleteModelRequest: requests.DeleteModelRequest): Promise<responses.DeleteModelResponse>;
+    /**
+     * Delete a project by identifier.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteProjectRequest
+     * @return DeleteProjectResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/DeleteProject.ts.html |here} to see how to use DeleteProject API.
+     */
+    deleteProject(deleteProjectRequest: requests.DeleteProjectRequest): Promise<responses.DeleteProjectResponse>;
+    /**
+     * Get a model by identifier.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetModelRequest
+     * @return GetModelResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/GetModel.ts.html |here} to see how to use GetModel API.
+     */
+    getModel(getModelRequest: requests.GetModelRequest): Promise<responses.GetModelResponse>;
     /**
      * Get the details of a processor job.
      *
@@ -106,7 +180,93 @@ export declare class AIServiceDocumentClient {
      * @param GetProcessorJobRequest
      * @return GetProcessorJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.1/aidocument/GetProcessorJob.ts.html |here} to see how to use GetProcessorJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/GetProcessorJob.ts.html |here} to see how to use GetProcessorJob API.
      */
     getProcessorJob(getProcessorJobRequest: requests.GetProcessorJobRequest): Promise<responses.GetProcessorJobResponse>;
+    /**
+     * Get a project by identifier.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetProjectRequest
+     * @return GetProjectResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/GetProject.ts.html |here} to see how to use GetProject API.
+     */
+    getProject(getProjectRequest: requests.GetProjectRequest): Promise<responses.GetProjectResponse>;
+    /**
+     * Gets the status of the work request with the given ID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetWorkRequestRequest
+     * @return GetWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Returns a list of models in a compartment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListModelsRequest
+     * @return ListModelsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ListModels.ts.html |here} to see how to use ListModels API.
+     */
+    listModels(listModelsRequest: requests.ListModelsRequest): Promise<responses.ListModelsResponse>;
+    /**
+     * Returns a list of projects.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListProjectsRequest
+     * @return ListProjectsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ListProjects.ts.html |here} to see how to use ListProjects API.
+     */
+    listProjects(listProjectsRequest: requests.ListProjectsRequest): Promise<responses.ListProjectsResponse>;
+    /**
+     * Returns a (paginated) list of errors for a given work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestErrorsRequest
+     * @return ListWorkRequestErrorsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     */
+    listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
+    /**
+     * Return a (paginated) list of logs for a given work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestLogsRequest
+     * @return ListWorkRequestLogsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * Lists the work requests in a compartment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestsRequest
+     * @return ListWorkRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates the model metadata.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateModelRequest
+     * @return UpdateModelResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/UpdateModel.ts.html |here} to see how to use UpdateModel API.
+     */
+    updateModel(updateModelRequest: requests.UpdateModelRequest): Promise<responses.UpdateModelResponse>;
+    /**
+     * Update the project metadata.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateProjectRequest
+     * @return UpdateProjectResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.62.3/aidocument/UpdateProject.ts.html |here} to see how to use UpdateProject API.
+     */
+    updateProject(updateProjectRequest: requests.UpdateProjectRequest): Promise<responses.UpdateProjectResponse>;
 }