メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.therefrain.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
ログインとデータ抽出

import { Refrain, loadRunbook } from "@refrainai/sdk";

const client = new Refrain({
  ai: {
    modelId: "claude-sonnet-4-6",
    provider: "anthropic",
    apiKey: process.env.ANTHROPIC_API_KEY!,
  },
  headless: true,
});

const runbook = await loadRunbook("./runbooks/login-and-extract.yaml");

const report = await client.execute(runbook, {
  contextMarkdown: "# 認証情報\n- ステージング環境を使用",
  variables: { email: "[email protected]" },
  secrets: { password: process.env.APP_PASSWORD! },
  screenshotDir: "./screenshots",
});

// キャプチャした値にアクセス
for (const step of report.steps) {
  if (step.capturedValues) {
    console.log(`ステップ ${step.ordinal}:`, step.capturedValues);
  }
}

console.log(`結果: ${report.succeeded}/${report.totalSteps} 成功`);
await client.dispose();

​
カスタムロガー

ロギングフレームワークとの統合： 
import { Refrain, CallbackLogger, loadRunbook } from "@refrainai/sdk";
import type { LoggerFactory } from "@refrainai/sdk";

const loggerFactory: LoggerFactory = {
  createLogger: () =>
    new CallbackLogger((level, message) => {
      // ロガーに転送（例: winston, pino）
      console.log(`[refrain:${level}] ${message}`);
    }),
  createSpinner: () => ({
    start: (msg) => console.log(`[spinner] ${msg}...`),
    stop: (msg) => console.log(`[spinner] ${msg}`),
  }),
};

const client = new Refrain({
  ai: {
    modelId: "claude-sonnet-4-6",
    provider: "anthropic",
    apiKey: process.env.ANTHROPIC_API_KEY!,
  },
  loggerFactory,
  debug: true,
});

const runbook = await loadRunbook("./flow.yaml");
const report = await client.execute(runbook, {
  contextMarkdown: "",
  debugLogPath: "./debug.jsonl",
});

await client.dispose();

​
ファイルのダウンロードとエクスポート

import { Refrain, loadRunbook } from "@refrainai/sdk";

const client = new Refrain({
  ai: {
    modelId: "claude-sonnet-4-6",
    provider: "anthropic",
    apiKey: process.env.ANTHROPIC_API_KEY!,
  },
});

const runbook = await loadRunbook("./runbooks/export-data.yaml");

const report = await client.execute(runbook, {
  contextMarkdown: "",
  outputDir: "./output",
  mergeDownloads: true,
});

if (report.downloadedFiles?.length) {
  console.log("ダウンロード済み:", report.downloadedFiles);
}

await client.dispose();

​
異なる AI プロバイダーの使用

ai 設定でプロバイダーとモデルを指定します： 
const client = new Refrain({
  ai: {
    modelId: "gpt-4o",
    provider: "openai",
    apiKey: process.env.OPENAI_API_KEY!,
  },
});
Refrain は Anthropic、OpenAI、Google、Azure、Bedrock、Vertex、OpenAI 互換プロバイダーに対応しています。プロバイダー固有の設定（Azure リソース名、Bedrock リージョン、Vertex プロジェクト）については AI プロバイダーを設定する と AiConfig 型リファレンス を参照してください。