pipopa ドキュメント

pipopaの完全なテクニカルドキュメントへようこそ。ここでは、APIの使用方法、統合ガイド、ベストプラクティスなど、開発者向けの詳細な情報を提供しています。

📌 バージョン情報

現在のAPIバージョン: v2.0.0

最終更新日: 2025年1月20日

はじめに

pipopaは、最新のAI技術を活用した企業向けチャットボットプラットフォームです。このドキュメントでは、pipopaを最大限に活用するための情報を提供します。

主な機能

  • 自然言語処理による高精度な応答
  • RAG技術による企業固有データの学習
  • リアルタイムのデータ同期
  • 100以上の外部システムとの連携
  • 詳細な分析とレポート機能

必要な環境

# Node.js
node >= 14.0.0
npm >= 6.0.0

# Python
python >= 3.7
pip >= 20.0.0

# その他
- 安定したインターネット接続
- APIキー（管理画面から取得）

クイックスタート

5分でpipopaを始めましょう。以下の手順に従って、最初のチャットボットを作成します。

1 APIキーの取得

管理画面にログインし、設定 → API管理からAPIキーを取得します。

YOUR_API_KEY: pk_live_xxxxxxxxxxxxxxxx

2 SDKのインストール

お使いの環境に合わせてSDKをインストールします。

# npm
npm install @pipopa/sdk

# yarn
yarn add @pipopa/sdk

# pip
pip install pipopa-sdk

3 初期化とテスト

以下のコードでpipopaを初期化し、テストメッセージを送信します。

// JavaScript
import { Pipopa } from '@pipopa/sdk';

const pipopa = new Pipopa({
  apiKey: 'YOUR_API_KEY',
  projectId: 'YOUR_PROJECT_ID'
});

// テストメッセージの送信
const response = await pipopa.chat({
  message: 'こんにちは',
  userId: 'test-user-001'
});

console.log(response.reply);
// => "こんにちは！pipopaです。何かお手伝いできることはありますか？"

インストール

JavaScript / TypeScript

# npm
npm install @pipopa/sdk

# yarn
yarn add @pipopa/sdk

# pnpm
pnpm add @pipopa/sdk

TypeScript定義ファイルは同梱されています。追加のインストールは不要です。

Python

# pip
pip install pipopa-sdk

# poetry
poetry add pipopa-sdk

# pipenv
pipenv install pipopa-sdk

Python 3.7以上が必要です。型ヒントが含まれています。

REST API

SDKを使用せずに、直接REST APIを呼び出すこともできます。

curl -X POST https://api.pipopa.ai/v2/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "こんにちは",
    "userId": "test-user-001",
    "projectId": "YOUR_PROJECT_ID"
  }'

基本的な使い方

シンプルなチャット

最も基本的な使い方です。ユーザーからのメッセージを送信し、AIからの応答を受け取ります。

const response = await pipopa.chat({
  message: '製品の在庫状況を教えてください',
  userId: 'user-123'
});

console.log(response);
// {
//   reply: '現在の在庫状況をお調べします...',
//   conversationId: 'conv-xxx',
//   timestamp: '2025-01-20T10:00:00Z'
// }

コンテキスト付きチャット

会話の文脈を保持するために、conversationIdを使用します。

// 最初のメッセージ
const firstResponse = await pipopa.chat({
  message: '東京の天気は？',
  userId: 'user-123'
});

// 続きの会話（conversationIdを使用）
const secondResponse = await pipopa.chat({
  message: '明日はどうですか？',
  userId: 'user-123',
  conversationId: firstResponse.conversationId
});
// AIは「東京の明日の天気」について回答します

メタデータの追加

ユーザー情報や追加のコンテキストをメタデータとして送信できます。

const response = await pipopa.chat({
  message: 'おすすめの商品を教えて',
  userId: 'user-123',
  metadata: {
    userType: 'premium',
    preferences: ['electronics', 'gadgets'],
    location: 'Tokyo',
    language: 'ja'
  }
});
// AIはメタデータを考慮してパーソナライズされた回答を生成します

Chat API リファレンス

エンドポイント

POST https://api.pipopa.ai/v2/chat

リクエストパラメータ

パラメータ型必須説明
messagestring✓ユーザーからのメッセージ
userIdstring✓ユーザーの一意識別子
projectIdstring✓プロジェクトID
conversationIdstring会話IDt（継続会話用）
metadataobject追加のメタデータ

レスポンス

{
  "reply": "ご質問ありがとうございます。在庫状況は...",
  "conversationId": "conv-abc123",
  "messageId": "msg-xyz789",
  "timestamp": "2025-01-20T10:00:00Z",
  "usage": {
    "promptTokens": 150,
    "completionTokens": 80,
    "totalTokens": 230
  }
}

エラーコード

コード説明対処法
400Bad Requestリクエストパラメータを確認
401UnauthorizedAPIキーを確認
429Too Many Requestsレート制限に達しました
500Internal Server Errorサポートに連絡

💡 サポートが必要ですか？

技術的な質問がある場合は、サポートチームまでお気軽にお問い合わせください。

お問い合わせ ヘルプセンター