5.2.1.20.12. ベクトルデータベースコンテンツ登録¶
ベクトルデータベースにコンテンツを登録するためのタスクです。
5.2.1.20.12.1. 入力値¶
im_addVectorDbContents <object> *
├─ category <string> *
├─ contents <object[]> *
│ ├─ embeddings <float[]> *
│ ├─ text <string> *
│ ├─ metadata <map>
│ └─ originSourceId <string>
└─ locale <locale>
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_addVectorDbContents | 必須 | object | なし | - |
| category | 必須 | string | なし | 登録するコンテンツのカテゴリを指定してください。
intra-mart 標準の ID 形式 のみ指定できます。
「IM_」「IM-」で始まるカテゴリは、システムで予約されているため指定できません（大文字小文字の区別はありません）。
|
| contents | 必須 | object | リスト | 登録するコンテンツを指定してください。 |
| embeddings | 必須 | float | リスト | コンテンツに埋め込むベクトル表現を指定してください。 |
| text | 必須 | string | なし | コンテンツに埋め込むベクトル表現の生成元テキストを指定してください。 |
| metadata | 任意 | map | なし | コンテンツに付与するメタデータを指定してください。 |
| originSourceId | 任意 | string | なし | コンテンツの参照元となる情報源を識別するIDを指定してください。
例：ファイル名、WebサイトのURLなど、登録するコンテンツの出所を特定できる値を指定します。
IDには制御文字、ダブルクォート、シングルクォート、セミコロン、不等号、パイプ、バックスラッシュ、アスタリスクは使用できません。
|
| locale | 任意 | locale | なし | 登録するコンテンツのロケール（ベクトル表現の生成元テキストのロケール）を指定してください。
未指定の場合はテナントのデフォルトロケールが適用されます。
|
コラム
登録するコンテンツに埋め込むベクトル表現は、「埋め込み」等を使用して事前に生成する必要があります。
また、ベクトル表現を生成できるテキストの長さ（最大トークン）は、各生成AIサービスで規定されていますので、適切な長さに調整または分割してベクトル表現を生成してください。
各生成AIサービスで利用可能な埋め込みモデルについては「IM-Copilot 利用ガイド」の「サポートモデル」を参照してください。
注意
テキストが単語や文節など意味を持つ最小単位に分割されると、ベクトル表現の品質が低下して意図した情報が正しく表現されない可能性があります。
例えば、〇〇社の情報を登録する場合、「〇〇社の設立日は2019年5月1日です。」という文章を「〇〇社の設立日は」「2019年5月1日です。」のように分割すると、「設立日」と「2019年5月1日」という2つの要素の関係性が分からなくなる可能性があります。
5.2.1.20.12.2. 出力値¶
im_addVectorDbContents <any>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_addVectorDbContents | any | なし | 出力値として利用可能な値はありません。 |