Skip to content

README.md

Latest commit

 

History

History
233 lines (170 loc) · 17.8 KB

README.md

File metadata and controls

233 lines (170 loc) · 17.8 KB
Raw

Beta.Rag.IngestionPipelineConfigurations

Overview

Available Operations

list

For the current workspace, lists all of the registered ingestion pipeline configurations.

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.beta.rag.ingestionPipelineConfigurations.list();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { betaRagIngestionPipelineConfigurationsList } from "@mistralai/mistralai/funcs/betaRagIngestionPipelineConfigurationsList.js";

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

async function run() {
  const res = await betaRagIngestionPipelineConfigurationsList(mistral);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("betaRagIngestionPipelineConfigurationsList failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
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.IngestionPipelineConfiguration[]>

Errors

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

register

Register an ingestion configuration.

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.beta.rag.ingestionPipelineConfigurations.register({
    name: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { betaRagIngestionPipelineConfigurationsRegister } from "@mistralai/mistralai/funcs/betaRagIngestionPipelineConfigurationsRegister.js";

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

async function run() {
  const res = await betaRagIngestionPipelineConfigurationsRegister(mistral, {
    name: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("betaRagIngestionPipelineConfigurationsRegister failed:", res.error);
  }
}

run();

Parameters

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

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

updateRunInfo

Update Run Info

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.beta.rag.ingestionPipelineConfigurations.updateRunInfo({
    id: "6b630c1b-b57e-4237-a015-ff6247cbbcf8",
    updateRunInfo: {
      executionTime: new Date("2024-06-27T06:29:04.390Z"),
      chunksCount: 983906,
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { betaRagIngestionPipelineConfigurationsUpdateRunInfo } from "@mistralai/mistralai/funcs/betaRagIngestionPipelineConfigurationsUpdateRunInfo.js";

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

async function run() {
  const res = await betaRagIngestionPipelineConfigurationsUpdateRunInfo(mistral, {
    id: "6b630c1b-b57e-4237-a015-ff6247cbbcf8",
    updateRunInfo: {
      executionTime: new Date("2024-06-27T06:29:04.390Z"),
      chunksCount: 983906,
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("betaRagIngestionPipelineConfigurationsUpdateRunInfo failed:", res.error);
  }
}

run();

Parameters

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

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*