すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:SplitDoc

最終更新日:Dec 28, 2024

テキストのセグメント化とベクトル化を実行します。

リクエスト構文

POST /v3/openapi/apps/{app_group_identity}/actions/knowledge-split

注記: app_group_identity は OpenSearch インスタンスの名前を指定します。

リクエスト パラメーター

SplitDoc

パラメーター

タイプ

説明

備考

title

String

データのタイトル。

このパラメーターは省略可能です。

content

String

処理対象のデータコンテンツ。

このパラメーターは必須です。

use_embedding

Boolean

ベクトル化を実行するかどうかを指定します。

有効な値: true および false。

このパラメーターを指定しない場合、デフォルト値の false が使用されます。

model

String

使用するベクトル化モデル。

リクエストの例

{
  "title":"Test title",
  "content":"Test text",
  "use_embedding":true,
}

レスポンス パラメーター

パラメーター

タイプ

説明

chunks

List<ChunkContext>

セグメント化後のチャンク。

ChunkContext

パラメーター

タイプ

説明

chunk_id

String

チャンク ID。

chunk

Stirng

チャンク。

embedding

String

ベクトル化後のベクトル。

type

String

テキストのタイプ。

有効な値: text および image。

img_url

String

画像の URL。このパラメーターは、type の値が image の場合に返されます。

レスポンスの例

{
  "request_id":"111111111",
  "status":"OK";
  "errors":[],
  "result":[
  {
    "chunk_id":"1",
    "chunk":"Chunk 1",
    "embedding":"-0.010441,-0.002826,-0.022911,0.000847,0.025610,0.019213,-0.019912,0.008210,0.011974,-0.010120,-0.003866,-0.008091,-0.006889,-0.034774,...-0.012572,0.009668,0.010963,-0.005273,-0.005072,-0.002190,-0.001554,-0.000058",
    "type":"text"
  },
  {
    "chunk_id":"2",
    "chunk":"Chunk 2",
    "embedding":"-0.010441,-0.002826,-0.022911,0.000847,0.025610,0.019213,-0.019912,0.008210,0.011974,-0.010120,-0.003866,-0.008091,-0.006889,-0.034774,...-0.012572,0.009668,0.010963,-0.005273,-0.005072,-0.002190,-0.001554,-0.000058",
    "type":"image",
    "img_url":"http://127.0.0.1"
  },
  {
    "chunk_id":"3",
    "chunk":"Chunk 3",
    "type":"text"
  }
]
}