Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 6.54 KB

README.md

File metadata and controls

99 lines (72 loc) · 6.54 KB

Tasks

(tasks)

Overview

Query the status of analysis tasks.

Available Operations

getStatus

Get the status of an analysis task.

Example Usage

import { CloudinaryAnalysis } from "@cloudinary/analysis";

const cloudinaryAnalysis = new CloudinaryAnalysis({
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAnalysis.tasks.getStatus({
    taskId: "053f4bde4b933c8ecef23724ecde63b667c1ea21816d56c161c7ec1df6297da4b43109625650e9edf0f42152cc4cc32c8ad57824ac75ba8e05020f827c415559ac1248076a2d72c0a73af0479cca77eb",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAnalysisCore } from "@cloudinary/analysis/core.js";
import { tasksGetStatus } from "@cloudinary/analysis/funcs/tasksGetStatus.js";

// Use `CloudinaryAnalysisCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAnalysis = new CloudinaryAnalysisCore({
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await tasksGetStatus(cloudinaryAnalysis, {
    taskId: "053f4bde4b933c8ecef23724ecde63b667c1ea21816d56c161c7ec1df6297da4b43109625650e9edf0f42152cc4cc32c8ad57824ac75ba8e05020f827c415559ac1248076a2d72c0a73af0479cca77eb",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request operations.GetAnalysisTaskStatusRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.GetTaskStatusResponse>

Errors

Error Type Status Code Content Type
errors.ErrorResponse 400, 401, 403, 404 application/json
errors.RateLimitedResponse 429 application/json
errors.ErrorResponse 500 application/json
errors.APIError 4XX, 5XX */*