ドキュメント

AI構成

約3分で読めます · このページを GitHub で編集

← ShimoDocs Suite デプロイメント文書

AI 設定は接続に使用されます ShimoDocs Suite は、ベースモデル、画像モデル、オンライン検索、そして埋め込みサービスで使用できます。設定の完了後、機能は ShimoDocs Suite AIの会話、コンテンツ生成、画像処理、知識検索などは、対応するサービスにアクセスできます。

1. 設定する前に4つの能力の種類を理解する

4種類の構成の目的は異なり、必ずしもすべてを構成する必要はありません。使用する予定の ShimoDocs Suite 機能に基づいて選択してください。

構成タイプ 目的 構成が必要かどうか
ベースモデル 会話、文章作成、要約、書き換え、Q&A、その他のテキストやマルチモーダルタスクを処理します AI機能を使用する場合、通常は構成が必要です
画像モデル 画像を生成または編集します 画像生成または編集機能を使用する場合のみ構成が必要です
オンライン検索 外部検索サービスから情報を取得し、モデル参照を補完します オンライン検索機能を使用する場合のみ構成が必要です
埋め込み テキストをベクトルに変換し、ナレッジベース検索、意味検索などの機能に使用します 知識取得またはベクトル検索機能を使用する場合のみ構成が必要です

Tip

オンライン検索は通常独立した検索サービスであり、ベースモデルに組み込まれたオンライン機能とは異なります。

2. AI構成にアクセス

  1. にログインし、 MDP 操作プラットフォーム.
  2. 上部で選択 ShimoDocs Suite.
  3. 左のサイドバーで選択 テナント管理.
  4. 次を見つけます AI構成 カード。
  5. カードをクリックして「AIモデルと検索設定」ページに入ります。

3. まず接続するモデルサービスプロバイダーを選択します

使用する予定のモデルサービスをまず確認し、対応するセクションで設定してください。

モデルタイプ サービスプロバイダー
ベースモデル OpenAI Responsesプロトコルに対応するプロバイダー
画像モデル OpenAI Imageプロトコルに対応するプロバイダー
インターネット検索エンジンモデル 現在はVolcengineのみサポート
埋め込みモデル OpenAI埋め込みプロトコルに対応するプロバイダー

4. AIモデル設定

このセクションは設定に使用されます GPT-関連サービス。OpenAI公式サービス、Azure OpenAI、プロキシサービス、またはその他の互換性のあるインターフェースを使用するかどうかをエンジニアリングに確認してください。接続方法によってリクエストアドレスやモデルIDが異なる場合があります。

4.1 基本モデル

基本モデルは、対話、コンテンツ生成、要約、リライト、マルチモーダル理解の機能に使用されます。

プロバイダー設定

構成項目 例の値 説明
プロバイダー OpenAI(またはOpenAI Responsesプロトコル互換)を選択 OpenAI(またはOpenAI Responsesプロトコル互換)を選択
リクエスト URL / ベース URL https://myai.com/v1 OpenAI Responsesプロトコル互換の独自AIゲートウェイアドレスを選択
API キー sk-I••••haTO API AIゲートウェイによって割り当てられたキー
デフォルトモデル gpt-5.5 OpenAI Responsesプロトコル互換のモデル

Tip

ここで設定されたモデルプロバイダーはストリーミングモードをサポートする必要があります。 ShimoDocs クライアントとしてのAIは、モデルプロバイダーにリクエストする際には常に送信します。 stream: true モデルプロバイダーがストリーミングモードをサポートしていない場合、リクエストは失敗します。

モデル設定

構成項目 例の値 開発ノート
ステータス 有効 有効にする必要があります
モデルID gpt-5.5 有効なモデルID
モデル名 gpt-5.5 モデルIDと一致する必要があります
コンテキストウィンドウ 1024000 実際の条件に従って入力
テキスト入力 有効 有効にする必要があります
画像入力 有効 有効にする必要があります

4.2画像モデル

画像モデルは画像生成または画像編集に使用されます。現在のバージョンで実際にサポートされているモデルと機能を入力してください。

構成項目 例の値 エンジニアリングノート
ステータス 有効 有効にする必要があります
プロバイダー OpenAI(またはOpenAI画像プロトコル互換) OpenAI(またはOpenAI画像プロトコル互換)
モデル名 gpt-image-2 OpenAIの画像プロトコルと互換性が必要
リクエスト URL / ベース URL https://myai.com/v1 OpenAI Responsesプロトコルと互換性のあるAIゲートウェイアドレスを選択
API キー sk-I••••haTO API AIゲートウェイによって割り当てられたキー
機能 画像生成、画像編集 デフォルトの画像生成、画像編集を維持

Tip

現在はOpenAI Imageのみ対応 API プロトコル

4.3 インターネット検索モデル

ネットワーク検索は現在、Volcengineの構成のみ対応

構成項目 例の値 エンジニアリングノート
ステータス 有効 実際のニーズに応じて有効化。有効にする場合は、現在の構成グループのその他すべての項目の値も入力する必要があります
サービスプロバイダー Volcengine 現在はVolcengineのみサポート
API エンドポイント https://open.feedcoopapi.com/search_api/web_search Volcengineのデフォルトネットワーク検索アドレス
API キー mCmh•••••••• ネットワーク検索サービスプロバイダーから取得
タイムアウト設定 120秒 単一のネットワーク検索リクエストがこの時間を超えると失敗します。120秒に設定することを推奨

4.4 埋め込みモデル

埋め込みモデルはナレッジベースの検索や意味検索に使用されます。モデルIDと次元は実際のベクトル出力と一致する必要があります

構成項目 例の値 開発ノート
サービスプロバイダー OpenAI(またはOpenAI埋め込みモデル互換) OpenAI(またはOpenAI埋め込みモデル互換)
基本 URL https://myai.com/v1 OpenAI Responses プロトコルに対応した自分のAIゲートウェイアドレスを選択してください
API キー ak-•••••••• 埋め込みモデル提供者から取得
埋め込みモデル qwen3-embedding:4b モデルID
次元 整数値 次元は埋め込みモデルに関連しています。次元パラメータについては提供者に確認できます
開発確認項目 内容
対応する埋め込みモデル OpenAI(またはOpenAI埋め込みモデル互換)
推奨ベクトル次元 埋め込みモデルに関連
異なる次元の場合、ベクトルデータを再構築する必要がありますか はい

Tip

現在、OpenAI Embedding のみ対応 API プロトコル

4.5 GPT 設定完了確認

確認項目 期待される結果 実際の結果
基本モデル会話 AIセッションに簡単な質問を入力 モデルが対応する結果を返す
長文処理 長文を出力 モデルが長文内容に基づいて対応する結果を返す
画像入力または画像処理 認識用に画像を入力 認識された内容を返すことが可能
インターネット検索 フライトまたは列車のチケット情報を取得するようにプロンプトします フライトまたは列車のチケット結果を返すことができます
埋め込みベクトル化 サイト全体でAI検索を行うためにキーワードを使用します 予想される一致コンテンツを返すことができます

5. 各構成項目の業務上の意味

このセクションでは、ページ上の各構成項目の目的について統一的な説明を提供します。初めて設定する場合は、前述のベンダーテンプレートに従って入力し、その後このセクションに戻り、各フィールドが実際の業務要件を満たしているかを確認できます。

5.1 基本モデルプロバイダ構成項目

構成項目 業務上の意味 誤って入力した場合の一般的な影響 必須
プロバイダー システムにどのモデル適応方法を使用するかを示します。2つのサービスが類似のインターフェースに対応していても、プロバイダのオプションによってリクエスト形式、認証方法、結果の解析方法が決まる場合があります。 保存に失敗する、リクエスト形式の不一致、またはレスポンスを解析できない可能性があります。 はい
リクエスト URL / ベース URL 入力アドレス ShimoDocs Suite モデルサービスにリクエストを送信する際にアクセスします。 アドレスが正しくない場合、モデルに接続できません。パスレベルが間違っていると、インターフェースが存在しないように見えることがあります。 はい
API キー モデルサービスが呼び出し元を識別し、権限を確認するために使用する資格情報。 資格情報が間違っている、期限切れである、または権限が不十分な場合は、通常、認証失敗が表示されます。 はい
デフォルトモデル ビジネス機能が明示的にモデルを指定しない場合に、システムが優先的に呼び出すモデル。 設定されていないか、利用できないモデルに設定されている場合、いくつかのAI機能は使用できないことがあります。 はい

5.2 基本モデル設定項目

構成項目 業務上の意味 誤って入力した場合の一般的な影響 必須
ステータス モデルが呼び出し可能かどうかを制御します ShimoDocs Suite閉じた後でも、設定は保持できますが、通常、ビジネスはモデルの使用を継続できません。 モデル設定が正しくても、状態が閉じている場合、ビジネスでは利用不可として表示されることがあります。 はい
モデルID モデルサービスインターフェースが認識するモデル名または一意識別子。 サーバー名と一致しない場合、通常、モデルが存在しないことを示すメッセージが表示されます。 はい
モデル名 管理者がオペレーションプラットフォームでモデルを区別しやすくするために表示される名前。 名前が重複しているか不明瞭な場合、誤ったモデルを選択しやすく、実際のリクエストに参加しているかどうかはエンジニアリングによって確認されます。 はい
コンテキストウィンドウ モデルが1回のリクエストで処理できる情報の総量で、通常は入力テキストの長さ、会話履歴、出力空間に影響します。 モデルの実際の容量より大きく設定するとリクエストが失敗する可能性があり、小さすぎると内容が切り捨てられたり、送信できなかったりします。 はい
テキスト入力 モデルがテキスト内容を受け入れられるかどうかを示します。 誤ってオフに設定すると、テキスト関連機能でこのモデルを選択または呼び出せない場合があります。 はい
画像入力 ベースモデルがユーザーアップロード画像を理解できるかどうかを示します。これはマルチモーダル入力機能であり、画像生成とは異なります。 画像をサポートしていないモデルで有効にするとリクエストが失敗する可能性があり、オフにすると画像理解機能が利用できなくなります。 はい

5.3 画像モデルの設定オプション

構成項目 業務上の意味 設定ミスの一般的な影響 必須
ステータス 画像生成または編集機能が画像モデルを呼び出せるかどうかを制御します。 ステータスがオフの場合、関連する画像機能でモデルを使用できません。 はい
サービスプロバイダー 画像リクエストに使用されるインターフェース適応方法を決定します。 間違って選択すると、リクエストパラメータや返却形式が互換性がない可能性があります。 はい
モデル名 / モデルID 呼び出す実際の画像モデルを指定します。このフィールドが表示名なのかリクエストIDなのかは、エンジニアリングによって確認する必要があります。 名前がサーバーと一致しない場合、モデルが存在しないことを示している可能性があります。 はい
基本 URL 画像生成または編集リクエストが送信されるサービスアドレス。 アドレスまたはパスが正しくない場合、画像サービスを呼び出すことはできません。 はい
API キー 画像サービスを呼び出すために使用される認証資格情報。 エラー、期限切れ、または権限不足により認証に失敗します。 はい
機能 画像生成、画像編集など、モデルがサポートする画像機能を宣言します。 モデルがサポートしていない機能が設定されている場合、ビジネスエントリは表示されますが、呼び出しは失敗します。 はい

注:現在、サポートされているのは OpenAI 画像 API プロトコルのみです

5.4 インターネット検索設定

構成項目 業務上の意味 間違っている場合の一般的な影響 必須
ステータス が制御するかどうか ShimoDocs Suite は現在の検索サービスを呼び出すことができます。 ステータスがオフの場合、モデルは引き続き使用可能かもしれませんが、インターネット検索結果を取得することはできません。 いいえ
サービスプロバイダー 使用する検索サービスの種類とそのインターフェース適応方法を指定します。 誤って選択した場合、リクエストと結果の解析が互換性がない可能性があります。 いいえ
インターフェースアドレス 検索リクエストを開始する際にアクセスされるサービスエンドポイント。 アドレスが正しくない場合、インターネット機能がタイムアウトするか接続に失敗することがあります。 いいえ
API キー 検索サービスで使用される認証資格情報。 不正確または権限が不十分な場合、検索リクエストは拒否されます。 いいえ
タイムアウト設定 単一の検索で待機する最大時間;これを超えると、システムは待機を停止し、失敗または結果なしとして扱います。 短すぎると頻繁にタイムアウトが発生し、長すぎるとユーザーの待機時間が増加します。 いいえ

5.5 埋め込み設定

埋め込みモデルは必ずしも有効にする必要はありませんが、有効にしない場合、ドキュメントの内容をベクトル化できないため、システムはユーザーのナレッジベースに関する質問を処理できません。

設定項目 業務上の意味 誤って入力した場合の一般的な影響 必須かどうか
基本 URL テキストベクトル化リクエストに送信されるサービスアドレス。アドレスが間違っている場合、ベクトルデータは生成または更新できません。いいえ
API キー 埋め込みサービスで使用される認証資格情報。エラー、期限切れ、権限不足によりベクトル化に失敗します。いいえ
埋め込みモデル テキストをベクトルに変換する実際のモデルID。モデルが存在しないか、または一致しない場合はベクトルを生成できません。いいえ
次元 各テキスト行によって生成される最終的なベクトル長は、モデルの実際の出力およびベクトル格納設定と一致する必要があります。 次元が一致しない場合、通常は書き込みや取得ができません。次元を変更した場合、既存のベクトルを再生成する必要がある場合があります。いいえ

注意: 現在、OpenAI埋め込みのみ API プロトコル

6. 推奨設定順序

重複を減らすためには、次の順序で設定することを推奨します:

  1. まず、どのAI機能を有効にする必要があるかを確認します ShimoDocs Suite.
  2. プロトコル要件を満たすベースモデルを選択します。
  3. プロバイダーを設定し、少なくとも1つのベースモデルを追加します。
  4. 検証済みの利用可能モデルをデフォルトモデルとして設定します。
  5. 業務ニーズに応じて画像モデルを設定します。
  6. 業務ニーズに応じてネットワーク検索を設定します。
  7. ナレッジベースやセマンティック検索を使用する場合は、Embeddingを設定します。
  8. 保存後、各機能を個別に確認してください。ページ上の「有効」表示だけで設定の成功を判断しないでください。

7. 有効な設定ルール

エンジニアリング確認が必要な問題 内容
設定を保存した後、すぐに反映されますか すぐには反映されません。1~2分待つ必要があります
サービスを再起動する必要がありますか サービスの再起動は不要です
開いているページで新しい設定が反映されますか 現在のページを更新する必要があります
複数モデル間の優先選択 サポートされていません
デフォルトのモデルが使用できない場合、自動的に切り替わりますか? サポートされていません

8. 一般的な問題のトラブルシューティング

現象 一般的な原因 トラブルシューティング方法
接続モデルサービスの障害 リクエストアドレス、ネットワーク、証明書、またはポート設定の異常 サービスアドレスを確認、 DNS、ポート、証明書、およびファイアウォールポリシー
認証失敗を促す API キーエラー、有効期限切れ、または権限不足 確認 API キーが正しく、ターゲットモデルまたはサービスにアクセスできること
モデルが存在しないことを促す モデルIDがサーバー側の名前と一致しない 完全なモデルIDを確認し、大文字小文字およびバージョン接尾辞を確認
テキストは利用可能だが画像は利用不可 モデルが画像入力をサポートしていないか、画像入力スイッチが有効になっていない モデルの機能および入力スイッチを確認
画像機能エントリが存在するが呼び出しに失敗 機能がモデルの実際の能力と一致していない 画像モデルがサポートする生成および編集機能を確認
オンライン検索で頻繁にタイムアウトが発生する 検索サービスが遅い、ネットワークが不安定、またはタイムアウト設定が短すぎる ネットワークの待機時間、サービスのパフォーマンス、タイムアウト設定を確認する
埋め込み書き込みの失敗 出力次元がベクター保存設定と一致していない モデルの実際の出力次元と保存設定を確認する

Q&A

  1. 設定が有効かどうかを確認する方法は?

設定が完了したら、エディターのサイドバーに移動してAIセッションを開き、機能が動作しているかどうかを確認できます:

  • メッセージは通常通り返信されるはずです
  • 画像モデルが設定されている場合は、『Xxxの画像を生成』のようなコマンドを送信し、コマンドが正しく実行されるかを確認できます
  • オンライン検索が設定されている場合は、『今日の北京の天気をオンラインで検索』のようなコマンドを送信し、結果が期待通りかを確認できます
  1. /chat/completions インターフェースをサポートしていますか?

現在はサポートされていません。現在はOpenAI Responsesのみ対応しています API プロトコルがサポートされています。DeepseekやXiaomi-Mimoなどの公式APIがこのプロトコルをサポートしていることが知られています。vLLMやOllamaのようなローカル展開ソリューションもResponsesプロトコルをサポートしています。