KAkarte
RAG

Get RAG File By Path

指定されたパスとサイト名からRAGファイルの詳細情報を取得します。

Required Scope

APIの実行に必要なScopeです。

beta.craft.rag.getFileByPath

Required Role

管理画面でScopeを追加する際に必要な権限です。

Craft > Craft 設定の閲覧
post/v2beta/craft/rag/getFileByPath

Request

  • Base URL
    https://api.karte.io
  • URL
    https://api.karte.io/v2beta/craft/rag/getFileByPath
  • Auth
    HTTP bearer

Headers

x-karte-apistring

今後利用する可能性のある予約語です。現在は設定不要です。

authorizationstring

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

content-typestring

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Request body

corpusIdstring required

RAGコーパスのID

pathstring required

ファイルパス（バケット名を除く）

siteNamestring required

Craft Sitesのサイト名

Example request

{
  "corpusId": "corpus-123",
  "path": "/path/to/file.pdf",
  "siteName": "test-site"
}

Response

Successful response

Example response

{
  "ragFile": {
    "id": "1234567890",
    "displayName": "document.pdf",
    "createTime": "2023-01-01T00:00:00Z",
    "updateTime": "2023-01-01T00:00:00Z",
    "filePaths": [
      "/path/to/file.pdf"
    ],
    "status": "ACTIVE",
    "siteName": "test-site"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.