Skip to content

Latest commit

 

History

History
280 lines (207 loc) · 18.2 KB

README.md

File metadata and controls

280 lines (207 loc) · 18.2 KB
Raw

Images

(images)

Overview

Given a prompt and/or an input image, the model will generate a new image.

Available Operations

createImage

Creates an image given a prompt.

Example Usage

import { ArgotOpenAi } from "argot-open-ai";

const argotOpenAi = new ArgotOpenAi({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await argotOpenAi.images.createImage({
    prompt: "A cute baby sea otter",
    model: "dall-e-3",
    n: 1,
    quality: "standard",
    responseFormat: "url",
    size: "1024x1024",
    style: "vivid",
    user: "user-1234",
  });

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

run();

Standalone function

The standalone function version of this method:

import { ArgotOpenAiCore } from "argot-open-ai/core.js";
import { imagesCreateImage } from "argot-open-ai/funcs/imagesCreateImage.js";

// Use `ArgotOpenAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const argotOpenAi = new ArgotOpenAiCore({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const res = await imagesCreateImage(argotOpenAi, {
    prompt: "A cute baby sea otter",
    model: "dall-e-3",
    n: 1,
    quality: "standard",
    responseFormat: "url",
    size: "1024x1024",
    style: "vivid",
    user: "user-1234",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request components.CreateImageRequest ✔️ 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.ImagesResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

createImageEdit

Creates an edited or extended image given an original image and a prompt.

Example Usage

import { ArgotOpenAi } from "argot-open-ai";
import { openAsBlob } from "node:fs";

const argotOpenAi = new ArgotOpenAi({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await argotOpenAi.images.createImageEdit({
    image: await openAsBlob("example.file"),
    prompt: "A cute baby sea otter wearing a beret",
    model: "dall-e-2",
    n: 1,
    responseFormat: "url",
    size: "1024x1024",
    user: "user-1234",
  });

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

run();

Standalone function

The standalone function version of this method:

import { ArgotOpenAiCore } from "argot-open-ai/core.js";
import { imagesCreateImageEdit } from "argot-open-ai/funcs/imagesCreateImageEdit.js";
import { openAsBlob } from "node:fs";

// Use `ArgotOpenAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const argotOpenAi = new ArgotOpenAiCore({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const res = await imagesCreateImageEdit(argotOpenAi, {
    image: await openAsBlob("example.file"),
    prompt: "A cute baby sea otter wearing a beret",
    model: "dall-e-2",
    n: 1,
    responseFormat: "url",
    size: "1024x1024",
    user: "user-1234",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request components.CreateImageEditRequest ✔️ 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.ImagesResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

createImageVariation

Creates a variation of a given image.

Example Usage

import { ArgotOpenAi } from "argot-open-ai";
import { openAsBlob } from "node:fs";

const argotOpenAi = new ArgotOpenAi({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await argotOpenAi.images.createImageVariation({
    image: await openAsBlob("example.file"),
    model: "dall-e-2",
    n: 1,
    responseFormat: "url",
    size: "1024x1024",
    user: "user-1234",
  });

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

run();

Standalone function

The standalone function version of this method:

import { ArgotOpenAiCore } from "argot-open-ai/core.js";
import { imagesCreateImageVariation } from "argot-open-ai/funcs/imagesCreateImageVariation.js";
import { openAsBlob } from "node:fs";

// Use `ArgotOpenAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const argotOpenAi = new ArgotOpenAiCore({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const res = await imagesCreateImageVariation(argotOpenAi, {
    image: await openAsBlob("example.file"),
    model: "dall-e-2",
    n: 1,
    responseFormat: "url",
    size: "1024x1024",
    user: "user-1234",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request components.CreateImageVariationRequest ✔️ 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.ImagesResponse>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*