Skip to content

Latest commit

 

History

History
422 lines (302 loc) · 29.1 KB

README.md

File metadata and controls

422 lines (302 loc) · 29.1 KB

Document

(document)

Overview

Available Operations

downloadDocument

Download

Example Usage

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.document.downloadDocument({
    documentId: "a00f07cb-c04c-4824-9b26-5b7eb5c274ae",
  });

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

run();

Standalone function

The standalone function version of this method:

import { IsoscelesCore } from "@isosceles-ai/sdk/core.js";
import { documentDownloadDocument } from "@isosceles-ai/sdk/funcs/documentDownloadDocument.js";

// Use `IsoscelesCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const isosceles = new IsoscelesCore({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const res = await documentDownloadDocument(isosceles, {
    documentId: "a00f07cb-c04c-4824-9b26-5b7eb5c274ae",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.DownloadDocumentRequest ✔️ 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<operations.DownloadDocumentResponseBody>

Errors

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

getDocument

Get Document

Example Usage

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.document.getDocument({
    documentId: "58c46dda-59e0-4c85-8fa3-4882b7168903",
  });

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

run();

Standalone function

The standalone function version of this method:

import { IsoscelesCore } from "@isosceles-ai/sdk/core.js";
import { documentGetDocument } from "@isosceles-ai/sdk/funcs/documentGetDocument.js";

// Use `IsoscelesCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const isosceles = new IsoscelesCore({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const res = await documentGetDocument(isosceles, {
    documentId: "58c46dda-59e0-4c85-8fa3-4882b7168903",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.GetDocumentRequest ✔️ 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.Document>

Errors

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

deleteDocument

Delete Document

Example Usage

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.document.deleteDocument({
    documentId: "5ca417c0-6d74-4752-a9cd-e2813ea67fd6",
  });

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

run();

Standalone function

The standalone function version of this method:

import { IsoscelesCore } from "@isosceles-ai/sdk/core.js";
import { documentDeleteDocument } from "@isosceles-ai/sdk/funcs/documentDeleteDocument.js";

// Use `IsoscelesCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const isosceles = new IsoscelesCore({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const res = await documentDeleteDocument(isosceles, {
    documentId: "5ca417c0-6d74-4752-a9cd-e2813ea67fd6",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.DeleteDocumentRequest ✔️ 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.DeleteResponse>

Errors

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

createDocumentReview

Create a new document review

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.document.createDocumentReview({});

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

run();

Standalone function

The standalone function version of this method:

import { IsoscelesCore } from "@isosceles-ai/sdk/core.js";
import { documentCreateDocumentReview } from "@isosceles-ai/sdk/funcs/documentCreateDocumentReview.js";

// Use `IsoscelesCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const isosceles = new IsoscelesCore({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const res = await documentCreateDocumentReview(isosceles, {});

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.CreateDocumentReviewRequestBody ✔️ 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.DocumentReview>

Errors

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

listDocumentReviews

Retrieve a list of document reviews

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

import { Isosceles } from "@isosceles-ai/sdk";

const isosceles = new Isosceles({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const result = await isosceles.document.listDocumentReviews({
    brainId: "08719a8d-017e-41ad-ac35-65ef5d5189d9",
  });

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

run();

Standalone function

The standalone function version of this method:

import { IsoscelesCore } from "@isosceles-ai/sdk/core.js";
import { documentListDocumentReviews } from "@isosceles-ai/sdk/funcs/documentListDocumentReviews.js";

// Use `IsoscelesCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const isosceles = new IsoscelesCore({
  security: {
    username: process.env["ACP_USERNAME"] ?? "",
    password: process.env["ACP_PASSWORD"] ?? "",
  },
});

async function run() {
  const res = await documentListDocumentReviews(isosceles, {
    brainId: "08719a8d-017e-41ad-ac35-65ef5d5189d9",
  });

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

  const { value: result } = res;

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

run();

Parameters

Parameter Type Required Description
request operations.ListDocumentReviewsRequest ✔️ 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.DocumentReviewDetail[]>

Errors

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