Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::danger Product in Beta
The Reveal SDK AI features are currently in beta, and we welcome your feedback to help us improve for the final release.
:::danger ベータ版の製品
Reveal SDK AI 機能は現在ベータ版であり、最終リリースに向けて改善するためのフィードバックをお待ちしております。

Please report any issues or suggestions through our support channels.
問題や提案がありましたら、サポート チャネルを通じてご報告ください。
:::
436 changes: 169 additions & 267 deletions i18n/ja/docusaurus-plugin-content-docs/current/web/ai/chat.md

Large diffs are not rendered by default.

Large diffs are not rendered by default.

218 changes: 109 additions & 109 deletions i18n/ja/docusaurus-plugin-content-docs/current/web/ai/insights.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
---
sidebar_label: Install Client SDK
sidebar_label: クライアント SDK のインストール
---

import BetaWarning from './_beta-message.md'

<BetaWarning />

# Installing the AI Client SDK
# AI クライアント SDK のインストール

The Reveal SDK AI Client is a TypeScript/JavaScript library that provides AI capabilities for your web applications. It works alongside the base Reveal SDK to add intelligent features like insights, dashboard generation, and conversational AI.
Reveal SDK AI クライアントは、Web アプリケーションに AI 機能を提供する TypeScript/JavaScript ライブラリです。基本の Reveal SDK と連携して、インサイト、ダッシュボード生成、会話型 AI などのインテリジェントな機能を追加します。

## Prerequisites
## 前提条件

Before installing the AI Client SDK, ensure you have:
AI クライアント SDK をインストールする前に、以下を確認してください:

1. The base [Reveal SDK Server](../install-server-sdk.md) installed and configured
2. The [Reveal SDK AI Server](install-server-sdk.md) installed and configured
3. Node.js 18+ and npm 9+ installed (for package-based installation)
1. 基本の [Reveal SDK サーバー](../install-server-sdk.md)がインストールされ、設定されていること
2. [Reveal SDK AI サーバー](install-server-sdk.md)がインストールされ、設定されていること
3. Node.js 18+ および npm 9+ がインストールされていること (パッケージベースのインストールの場合)

## Installation Methods
## インストール方法

### Install Using npm (Recommended)
### npm を使用してインストール (推奨)

The recommended way to install the AI Client SDK is through npm:
AI クライアント SDK をインストールする推奨方法は npm を使用することです:

```bash npm2yarn
npm install @revealbi/api
```

### Install Using CDN
### CDN を使用してインストール

For quick prototyping and demos, you can use the unpkg CDN:
迅速なプロトタイピングとデモのために、unpkg CDN を使用できます:

```html
<script src="https://unpkg.com/@revealbi/api/dist/index.umd.js"></script>
```

Or using jsDelivr:
または jsDelivr を使用:

```html
<script src="https://cdn.jsdelivr.net/npm/@revealbi/api/dist/index.umd.js"></script>
```

## TypeScript Support
## TypeScript サポート

The AI Client SDK is written in TypeScript and includes complete type definitions. No additional `@types` packages are needed.
AI クライアント SDK TypeScript で記述されており、完全な型定義が含まれています。追加の `@types` パッケージは必要ありません。

## Framework-Specific Setup
## フレームワーク固有のセットアップ

### Vanilla JavaScript
### 素の JavaScript

#### Using ES Modules
#### ES モジュールの使用

```html
<!DOCTYPE html>
Expand All @@ -72,7 +72,7 @@ The AI Client SDK is written in TypeScript and includes complete type definition
</html>
```

#### Using UMD Bundle
#### UMD バンドルの使用

```html
<!DOCTYPE html>
Expand All @@ -95,7 +95,7 @@ The AI Client SDK is written in TypeScript and includes complete type definition

### Angular

In your `main.ts` file, initialize before bootstrapping the application:
`main.ts` ファイルで、アプリケーションをブートストラップする前に初期化します:

```typescript
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
Expand All @@ -113,7 +113,7 @@ platformBrowserDynamic()

### React

In your `index.tsx` or `main.tsx` file, initialize before rendering:
`index.tsx` または `main.tsx` ファイルで、レンダリングする前に初期化します:

```typescript
import React from 'react';
Expand All @@ -134,7 +134,7 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Vue

In your `main.ts` file, initialize before mounting the application:
`main.ts` ファイルで、アプリケーションをマウントする前に初期化します:

```typescript
import { createApp } from 'vue';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
---
sidebar_label: Install Server SDK
sidebar_label: サーバー SDK のインストール
---

import BetaWarning from './_beta-message.md'

<BetaWarning />

# Installing the AI Server SDK
# AI サーバー SDK のインストール

The Reveal SDK AI Server provides the backend services needed to power AI features in your applications. It integrates with LLM providers and manages AI operations like insight generation, dashboard creation, and conversational analytics.
Reveal SDK AI サーバーは、アプリケーションで AI 機能を強化するために必要なバックエンド サービスを提供します。LLM プロバイダーと統合し、インサイト生成、ダッシュボード作成、会話型分析などの AI 操作を管理します。

## Prerequisites
## 前提条件

Before installing the AI Server SDK, ensure you have:
AI サーバー SDK をインストールする前に、以下を確認してください:

1. The base [Reveal SDK Server](../install-server-sdk.md) installed and configured
2. .NET 8.0 or higher
3. Access to at least one LLM provider (OpenAI, Anthropic, Google, etc.)
4. LLM provider API keys configured
1. 基本の [Reveal SDK サーバー](../install-server-sdk.md)がインストールされ、設定されていること
2. .NET 8.0 以上であること
3. 少なくとも 1 つの LLM プロバイダー (OpenAIAnthropicGoogle など) へのアクセス権があること
4. LLM プロバイダーの API キーが設定されていること

## Installation Methods
## インストール方法

### ASP.NET Core

The AI Server SDK for ASP.NET Core is distributed as a NuGet package.
ASP.NET Core 用 AI サーバー SDK は NuGet パッケージとして配布されています。

#### Step 1: Install the NuGet Package
#### 手順 1: NuGet パッケージのインストール

Right-click your Solution or Project and select **Manage NuGet Packages** for Solution.
ソリューションまたはプロジェクトを右クリックし、ソリューションの **[NuGet パッケージの管理]** を選択します。

![](../images/getting-started-nuget-packages-manage.jpg)

In the package manager dialog, open the **Browse** tab and install the **Reveal.Sdk.AI.AspNetCore** NuGet package into your project.
パッケージ マネージャー ダイアログで **[参照]** タブを開き、**Reveal.Sdk.AI.AspNetCore** NuGet パッケージをプロジェクトにインストールします。

**Package Name:** `Reveal.Sdk.AI.AspNetCore`
**パッケージ名:** `Reveal.Sdk.AI.AspNetCore`

Or using the Package Manager Console:
または、パッケージ マネージャー コンソールを使用する場合:

```bash
Install-Package Reveal.Sdk.AI.AspNetCore
```

Or using the .NET CLI:
または、.NET CLI を使用する場合:

```bash
dotnet add package Reveal.Sdk.AI.AspNetCore
```

#### Step 2: Configure Services
#### 手順 2: サービスの構成

Open and modify the `Program.cs` file to add the AI services. The AI SDK extends the base Reveal SDK, so you need both configured:
`Program.cs` ファイルを開いて変更し、AI サービスを追加します。AI SDK は基本の Reveal SDK を拡張するため、両方を設定する必要があります:

```csharp
using Reveal.Sdk;
using Reveal.Sdk.AI;

var builder = WebApplication.CreateBuilder(args);

// Add Reveal SDK (required)
// Reveal SDK を追加 (必須)
builder.Services.AddControllers().AddReveal();

// Add Reveal AI services
// Reveal AI サービスを追加
builder.Services.AddRevealAI();

var app = builder.Build();
app.Run();
```

#### Step 3: Configure LLM Provider
#### 手順 3: LLM プロバイダーの設定

Configure at least one LLM provider. Add this configuration after `AddRevealAI()`:
少なくとも 1 つの LLM プロバイダーを設定します。`AddRevealAI()` の後にこの構成を追加します:

**For OpenAI:**
**OpenAI の場合:**

```csharp
builder.Services.AddRevealAI()
Expand All @@ -82,7 +82,7 @@ builder.Services.AddRevealAI()
});
```

**For Anthropic Claude:**
**Anthropic Claude の場合:**

```csharp
builder.Services.AddRevealAI()
Expand All @@ -93,9 +93,9 @@ builder.Services.AddRevealAI()
});
```

#### Step 4: Store API Keys Securely
#### 手順 4: API キーを安全に保存

Store your LLM provider API keys in `appsettings.json` or User Secrets:
LLM プロバイダーの API キーを `appsettings.json` またはユーザー シークレットに保存します:

```json title="appsettings.json"
{
Expand All @@ -108,23 +108,23 @@ Store your LLM provider API keys in `appsettings.json` or User Secrets:
}
```

:::danger Never Commit API Keys
:::danger API キーをコミットしないでください

Never commit API keys to source control. Always use environment variables, User Secrets, or a secure key management service.
API キーをソース管理にコミットしないでください。常にユーザー シークレット、環境変数、または安全なキー管理サービスを使用してください。

:::

#### Complete Example
#### 完全な例

Here's a complete `Program.cs` with AI features configured:
AI 機能が設定された完全な `Program.cs` を次に示します:

```csharp title="Program.cs"
using Reveal.Sdk;
using Reveal.Sdk.AI;

var builder = WebApplication.CreateBuilder(args);

// Add CORS for cross-origin requests
// クロスオリジン リクエスト用の CORS を追加
builder.Services.AddCors(options =>
{
options.AddDefaultPolicy(policy =>
Expand All @@ -135,7 +135,7 @@ builder.Services.AddCors(options =>
});
});

// Add base Reveal SDK
// ベース Reveal SDK を追加
builder.Services.AddControllers().AddReveal(revealBuilder =>
{
revealBuilder.AddSettings(settings =>
Expand All @@ -144,7 +144,7 @@ builder.Services.AddControllers().AddReveal(revealBuilder =>
});
});

// Add Reveal AI with OpenAI provider
// OpenAI プロバイダーで Reveal AI を追加
builder.Services.AddRevealAI()
.ConfigureOpenAI(options =>
{
Expand All @@ -160,39 +160,39 @@ app.MapControllers();
app.Run();
```

### Node.js (Coming Soon)
### Node.js (近日公開)

Node.js support for the AI Server SDK is under development and will be available in a future release.
AI サーバー SDK の Node.js サポートは開発中であり、今後のリリースで利用可能になる予定です。

For now, ASP.NET Core is the recommended server platform for AI features.
現時点では、AI 機能には ASP.NET Core が推奨されるサーバー プラットフォームです。

### Java (Coming Soon)
### Java (近日公開)

Java support for the AI Server SDK is under development and will be available in a future release.
AI サーバー SDK の Java サポートは開発中であり、今後のリリースで利用可能になる予定です。

For now, ASP.NET Core is the recommended server platform for AI features.
現時点では、AI 機能には ASP.NET Core が推奨されるサーバー プラットフォームです。

## Verify Installation
## インストールの確認

After installation, verify the AI SDK is properly configured:
インストール後、AI SDK が正しく設定されていることを確認します:

### Step 1: Run Your Application
### 手順 1: アプリケーションの実行

```bash
dotnet run
```

### Step 2: Check AI Endpoints
### 手順 2: AI エンドポイントの確認

The AI SDK adds several endpoints under `/api/reveal/ai/`:
AI SDK `/api/reveal/ai/` の下にいくつかのエンドポイントを追加します:

Test the providers endpoint:
プロバイダー エンドポイントをテストします:

```bash
curl http://localhost:5000/api/reveal/ai/providers
```

Expected response:
期待されるレスポンス:
```json
{
"providers": ["openai", "anthropic"]
Expand Down
Loading