コンテンツにスキップ
KARTE Craft Developer Portal

Craft RAG

const { rag } = MODULES;

指定できるモデルはCraft RAGで利用できるモデル一覧をご確認ください。

Table of Contents

Section titled “Table of Contents”

RetrieveResultValue

Section titled “RetrieveResultValue”

Type: Object

Properties

Section titled “Properties”
  • filePath string ソースファイルのパス
  • text string テキストチャンク
  • score number クエリの密なエンベディングベクトルとコンテキストテキストベクトル間のスコア

RagDataSchema

Section titled “RagDataSchema”

Type: Object

Properties

Section titled “Properties”
  • key string メタデータのキー名
  • type ("INTEGER" | "FLOAT" | "STRING" | "DATETIME" | "BOOLEAN" | "LIST") メタデータキーのデータ型

RagMetadata

Section titled “RagMetadata”

Type: Object

Properties

Section titled “Properties”

retrieveContexts

Section titled “retrieveContexts”

関連コンテキストをベクトル検索で取得する

Parameters

Section titled “Parameters”

  • param Object

    • param.corpusId string RAG ID
    • param.text string 関連コンテキストを取得するためのクエリテキスト
    • param.vectorDistanceThreshold number? ベクトル距離がこの閾値より小さいコンテキストのみを返します
    • param.topK number? 返すコンテキストの数
    • param.llmRankerModel string? LLMランカーのモデル名。利用可能なモデルはCraft RAG で利用できるモデル一覧を参照
    • param.rankServiceModel string? ランクサービスのモデル名。利用可能なモデルはCraft RAG で利用できるモデル一覧を参照
    • param.metadataFilter string? CEL（Common Expression Language）構文のメタデータフィルタ文字列（例: category == "HR"）

Returns Promise<Array<RetrieveResultValue>>

createDataSchemas

Section titled “createDataSchemas”

RAGコーパスのメタデータスキーマを定義する

Parameters

Section titled “Parameters”

Returns Promise<Object>

attachMetadata

Section titled “attachMetadata”

既存のRAGファイルにメタデータを付与する

Parameters

Section titled “Parameters”

Returns Promise<Object>

listDataSchemas

Section titled “listDataSchemas”

RAGコーパスに定義されたメタデータスキーマを一覧取得する

Parameters

Section titled “Parameters”

Returns Promise<Object>

listMetadata

Section titled “listMetadata”

RAGファイルに付与されたメタデータを一覧取得する

Parameters

Section titled “Parameters”

  • param Object

    • param.corpusId string RAGコーパス ID
    • param.fileId string RAGファイル ID

Returns Promise<Object>