社内文書を検索できるようにする
この機能は、渡したテキストを検索しやすい単位(チャンク)に自動で分割し、意味で検索できる索引として保存します。保存後は検索クエリを投げるだけで、意味の近い部分を取り出せます。
オンラインで実行
アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。
テキストを検索可能な形に変換する
社内マニュアルや規程集は、長いままでは検索の対象になりません。この機能はテキストを段落程度の単位(チャンク)に自動で分割し、それぞれを埋め込みベクトルに変換して索引に保存します。以降は保存した索引に検索を投げるだけで、関連する部分を取り出せます。
分割の単位は「チャンク」という考え方
チャンクとは、検索の最小単位として区切られたテキストの断片です。長すぎる文書をそのまま検索すると関連度が薄まるため、意味のまとまりごとに分けて保存します。分割の粒度は、入力するテキストの見出しや改行といった構造にある程度沿って決まります。
更新のたびに追加できる
索引は一度作って終わりではなく、規程が改定されたときや新しい記事が増えたときに追加で登録できます。古い内容を消す運用は、索引側の管理として別途行います。
料金と上限
基本料金$0.002に加え、1,000チャンクごとに$0.0015が加算されます。1つの索引は最大10,000チャンクまで、1回のリクエストで扱えるのは最大20,000トークンです。数百ページの規程集でも十分な余裕があります。
活用例
社内規程集を検索できるようにする
総務担当者が、就業規則や経費規程のテキストを索引化し、条文の文言を覚えていなくても意味で探せるようにしています。
公開マニュアルの検索基盤に
ソフトウェア企業が、製品マニュアルのテキストを索引化し、サポートページの検索機能の基盤として使っています。
議事録の蓄積を検索対象にする
ある企業が、月ごとの議事録テキストを索引に追加し続け、過去の決定事項を後から探せるようにしています。
よくある質問
チャンクとは何ですか?
検索の最小単位として自動で区切られたテキストの断片です。文書の長さに応じて複数のチャンクに分かれます。
索引に保存したテキストは後から追加できますか?
できます。改定や新規追加のたびに、既存の索引に追加で登録できます。
1つの索引にはどれくらいの量を保存できますか?
最大10,000チャンクです。数百ページ規模の文書集でも収まる目安です。
索引化しただけで検索できますか?
索引の作成と検索は別の機能です。索引化のあとに検索の機能を使って問い合わせます。
料金はどう計算されますか?
基本$0.002に、1,000チャンクごとに$0.0015が加算されます。米ドル建てです。
社外に出せない文書でも使えますか?
索引化のためにテキストを送信する処理のため、社外秘の文書は取り扱い方針に沿ってご判断ください。
開発者向け — APIアクセス
このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。
エンドポイント
Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。
お使いのスタックから呼び出す
curl -X POST https://api.kit.forhosting.com/search/index-text \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"…"}'const res = await fetch("https://api.kit.forhosting.com/search/index-text", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"text": "…"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/search/index-text",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"text": "…"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/search/index-text", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"text":"…"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"text":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/search/index-text", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)リクエスト例
{
"text": "…"
}レスポンス例
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "search.index_text",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。
料金
単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。
制限
max_chunks | 10000 |
max_tokens | 20000 |
エラー
| HTTP | コード | 意味 |
|---|---|---|
401 | unauthorized | APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。 |
402 | insufficient_balance | 残高が不足しています。チャージ後に再度お試しください。 |
404 | unknown_type | 指定されたタスクタイプは存在しません。タイプ名を確認してください。 |
429 | rate_limited | リクエストが多すぎます。しばらく待ってから再度お試しください。 |