RAG サービスの API の説明 - - Alibaba Cloud ドキュメントセンター

Platform for AI (PAI) の Retrieval-Augmented Generation (RAG) は、サービス管理やチャットなどの機能のために様々な API を提供します。このトピックでは、v0.3.0 より前のバージョンのイメージを使用してデプロイされた RAG サービスでサポートされている API と呼び出しメソッドについて説明します。

制限

このドキュメントは、v0.3.0 より前のバージョンのイメージを使用してデプロイされた RAG サービスにのみ適用されます。

イメージのバージョンを表示するには、次の操作を実行します。Elastic Algorithm Service (EAS) ページで、目的の RAG サービスの名前をクリックします。[概要] タブの [環境情報] セクションで、イメージのバージョンを表示します。

サービスのアクセスアドレスとトークンの取得

API を使用して RAG サービスを呼び出す前に、サービスのアクセスアドレスとトークンを取得します。

PAI コンソールにログインします。ページの上部でリージョンを選択します。次に、目的のワークスペースを選択し、[Elastic Algorithm Service (EAS)] をクリックします。
目的のサービスの名前をクリックします。[概要] タブの [基本情報] セクションで、[エンドポイント情報を表示] をクリックします。
[呼び出し方法] ダイアログボックスの [パブリックエンドポイント] タブで、サービス アクセスアドレス (EAS_SERVICE_URL) と トークン (EAS_Token) を取得します。
重要
- EAS_SERVICE_URL の末尾からスラッシュ (/) を削除します。
- パブリックエンドポイントを使用してサービスを呼び出すには、使用するクライアントがインターネット経由のアクセスをサポートしている必要があります。
- VPC エンドポイントを使用してサービスを呼び出すには、使用するクライアントがサービスと同じ VPC (VPC) にある必要があります。

チャット API

サービスと互換性のある OpenAI API を使用してサービスを呼び出します。サービスを呼び出す前に、ビジネス要件に基づいて RAG サービスの WebUI ページで対応する構成を完了する必要があります。

サポートされている機能

Web 検索: Web 検索パラメーターを設定する必要があります。
ナレッジベースクエリ: ナレッジベースファイルをアップロードする必要があります。
LLM チャット: 大規模言語モデル (LLM) サービスを使用して回答を提供します。LLM サービスを設定する必要があります。
エージェントチャット: RAG サービスの WebUI ページで agent 関連のコード構成を完了する必要があります。
データベースまたはテーブルクエリ: RAG サービスの WebUI ページで chat_db 関連のパラメーターを完了する必要があります。

メソッド
URL	`{EAS_SERVICE_URL}/v1/chat/completions`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # Elastic Algorithm Service (EAS) サービスのトークン。
HTTP 本文	{ "model": "default", // モデル名。値を default に設定します。 "messages": [ {"role": "user", "content": "Hello"}, {"role": "assistant", "content": "Hello, how can I help you?"}, {"role": "user", "content": "What is the capital of Zhejiang province"}, {"role": "assistant", "content": "Hangzhou is the capital of Zhejiang province."}, {"role": "user", "content": "What are some interesting places to visit"}, ], "stream": true, // ストリーミングモードを使用するかどうかを指定します。 "chat_knowledgebase": true, // ローカルナレッジベースをクエリするかどうかを指定します。 "search_web": false, // Web 検索を使用するかどうかを指定します。 "chat_llm": false, // LLM チャットのみを使用するかどうかを指定します。 "chat_agent": false, // エージェントを使用するかどうかを指定します。 "chat_db": false, // データベースをクエリするかどうかを指定します。 "index_name": "default_index", // RAG シナリオで使用されるインデックス名。サポートされているインデックス名は 1 つだけです。このパラメーターを空のままにすると、システムはデフォルトのインデックス名を使用します。 "max_tokens": 1024, // トークンの最大数 (例: 1024)。 "temperature": 0.1, // 生成されるコンテンツのランダム性を制御します。有効な値: [0,1]。値が小さいほど、生成されるコンテンツの決定性が高くなります。値が大きいほど、生成されるコンテンツのランダム性が高くなります。 } 重要複数の機能を同時に構成する場合、システムは search_web、chat_knowledgebase、chat_agent、chat_db、chat_llm の優先順位 (高いものから低いものへ) に基づいてそれらを呼び出します。さらに、各機能について、システムは予備的な意図認識を実行して、その機能を呼び出すか、LLM を直接使用して応答を生成するかを決定します。すべての機能を false に設定するか、機能を構成しない場合、デフォルトでローカルナレッジベース (`"chat_knowledgebase": true`) がクエリされます。

リクエスト例 (クリックして詳細を表示)

Web 検索

from openai import OpenAI

##### API 構成 #####
# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。

openai_api_key = ""
openai_api_base = "/v1"
client = OpenAI(
    api_key=openai_api_key,
    base_url=openai_api_base,
)


#### チャット ######
def chat():
    stream = True
    chat_completion = client.chat.completions.create(
        model="default",
        stream=stream,
        messages=[
            {"role": "user", "content": "Hello"},
            {"role": "assistant", "content": "Hello, how can I help you?"},
            {"role": "user", "content": "What is the capital of Zhejiang province"},
            {"role": "assistant", "content": "Hangzhou is the capital of Zhejiang province."},
            {"role": "user", "content": "What are some interesting places to visit"},
        ],
        extra_body={
            "search_web": True,
        },
    )

    if stream:
        for chunk in chat_completion:
            print(chunk.choices[0].delta.content, end="")
    else:
        result = chat_completion.choices[0].message.content
        print(result)


chat()

データベースクエリ

from openai import OpenAI

##### API 構成 #####
# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。

openai_api_key = ""
openai_api_base = "/v1"
client = OpenAI(
    api_key=openai_api_key,
    base_url=openai_api_base,
)


#### チャット ######
def chat():
    stream = True
    chat_completion = client.chat.completions.create(
        model="default",
        stream=stream,
        messages=[
            {"role": "user", "content": "How many cats are there"},
            {"role": "assistant", "content": "There are 2 cats"},
            {"role": "user", "content": "What about dogs"},
        ],
        extra_body={
            "chat_db": True,
        },
    )

    if stream:
        for chunk in chat_completion:
            print(chunk.choices[0].delta.content, end="")
    else:
        result = chat_completion.choices[0].message.content
        print(result)


chat()

管理 API

ナレッジベースファイルのアップロード

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/upload_data`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: multipart/form-data`
リクエストパラメーター	files: ファイル。 oss_path: Object Storage Service (OSS) パス。 index_name: インデックス名。デフォルト値は default_index です。

cURL リクエスト例 (クリックして詳細を表示)

単一ファイルのアップロード

 # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
 # "-F 'files=@" の後のパスをファイルへのパスに置き換えます。
 # index_name をナレッジベースインデックスの名前に設定します。
   curl -X 'POST' /api/v1/upload_data \
  -H 'Authorization: ' \
  -H 'Content-Type: multipart/form-data' \
  -F 'files=@example_data/paul_graham/paul_graham_essay.txt' \
  -F 'index_name=default_index'

複数ファイルのアップロード。例に示すように、各パラメーターがアップロードするファイルに対応する複数の -F 'files=@path' パラメーターを使用します。

  # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
  # "-F 'files=@" の後のパスをファイルへのパスに置き換えます。
  # index_name をナレッジベースインデックスの名前に設定します。
  curl -X 'POST' /api/v1/upload_data \
  -H 'Authorization: ' \
  -H 'Content-Type: multipart/form-data' \
  -F 'files=@example_data/paul_graham/paul_graham_essay.txt' \
  -F 'files=@example_data/another_file1.md' \
  -F 'files=@example_data/another_file2.pdf' \
  -F 'index_name=default_index'

レスポンス例 (クリックして詳細を表示)

  { "task_id": "2c1e557733764fdb9fefa0635389****" }

アップロードステータスのクエリ

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/get_upload_state`
リクエストメソッド	GET
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
# task_id を、ナレッジベースファイルをアップロードした後に返される task_id 値として設定します。
curl -X 'GET' '/api/v1/get_upload_state?task_id=2c1e557733764fdb9fefa0635389****' -H 'Authorization: '

レスポンス例 (クリックして詳細を表示)

  {
    "task_id": "2c1e557733764fdb9fefa0635389****",
    "status": "completed",
    "detail": null
  }

ナレッジベースのクエリ

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/query/retrieval`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: application/json`
リクエストパラメーター	question: ユーザーの質問 index_name: インデックスの名前。デフォルト値は default_index です。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
# question パラメーターをユーザーの質問として設定します。 
# index_name パラメーターにインデックス名を指定します。  
  curl -X 'POST' '<EAS_SERVICE_URL>/api/v1/query/retrieval' \
  -H 'Authorization: <EAS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
      "question": "What can I do when the x13-auto-arima component reports an error?",
      "index_name": "default_index"
  }'

レスポンス例 (クリックして詳細を表示)

{
  "docs": [
    {
      "text": "2.PAl-Studio/Designer FAQ 2.1. FAQ about algorithm components : \nCharacters that cannot be transcoded are displayed as \"blob.\" Ignore this error, because nodes in the downstream can read and process the data.\nWhat can I do when the x13-auto-arima component reports an error?\nMake sure that up to 1,200 training data samples are imported into the x13-auto-arima component.\nWhat can I do when the Doc2Vec component reports the CallExecutorToParseTaskFail error?",
      "score": 0.83608,
      "metadata": {
        "file_path": "***/pai_document.md",
        "file_name": "pai_document.md",
        "file_size": 3794,
        "creation_date": "2025-03-20",
        "last_modified_date": "2025-03-20"
      },
      "image_url": null
    }
  ]
}

chat_db テーブルをクエリするための EXCEL または CSV ファイルのアップロード

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/upload_datasheet`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: multipart/form-data`
リクエストパラメーター	EXCEL または CSV ファイル。

cURL リクエスト例 (クリックして詳細を表示)

  # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
  # "-F 'file=@" の後のパスを実際のファイルパスに置き換えます。
  curl -X 'POST' /api/v1/upload_datasheet \
  -H 'Authorization: ' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@example_data/titanic_train.csv'

レスポンス例 (クリックして詳細を表示)

  {
    "task_id": "3b12cf5fabee4a99a32895d2f693****",
    "destination_path": "./localdata/data_analysis/titanic_train.csv",
    "data_preview": "xxx"
  }

chat_db データベース情報を補足するための JSON ファイルのアップロード - Q&A ペア

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/upload_db_history`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: multipart/form-data`
リクエストパラメーター	file: JSON ファイル。 db_name: データベース名。

cURL リクエスト例 (クリックして詳細を表示)

  # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
  # " -F 'file=@" の後のパスを JSON ファイルパスに置き換えます。
  # db_name をデータベースの名前に設定します。
  curl -X 'POST' /api/v1/upload_db_history \
  -H 'Authorization: ' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@example_data/db_query_history.json' \
  -F 'db_name=my_pets'

レスポンス例 (クリックして詳細を表示)

  {
    "task_id": "204191f946384a54a48b13ec00fd****",
    "destination_path": "./localdata/data_analysis/nl2sql/history/my_pets_db_query_history.json"
  }

データベース情報のロード

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/query/load_db_info`
リクエストメソッド	POST
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
curl -X 'POST' <EAS_SERVICE_URL>/api/v1/query/load_db_info -H 'Authorization: <EAS_TOKEN>'

レスポンス例 (クリックして詳細を表示)

"Load database info successfully."

すべてのナレッジベースインデックスのクエリ

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/indexes`
リクエストメソッド	GET
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
curl -X 'GET' '/api/v1/indexes' -H 'Authorization: '

レスポンス例 (クリックして詳細を表示)

  {
    "indexes": {
      "default_index": {
        "index_name": "default_index",
        "vector_store_config": {
          "persist_path": "localdata/storage",
          "type": "faiss",
          "is_image_store": false
        },
        "embedding_config": {
          "source": "huggingface",
          "model": "bge-m3",
          "embed_batch_size": 10,
          "enable_sparse": false
        }
      }
    },
    "current_index_name": "default_index"
  }

ナレッジベースインデックスの作成

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/indexes/{index_name}`
リクエストメソッド	POST
リクエストヘッダー	Authorization: EAS_TOKEN # EAS サービスのトークン。 Content-Type: application/json
リクエストパラメーター	index_name: インデックス名。 vector_store_config: ベクトルデータベースの構成。 embedding_config: 埋め込みモデルの構成。

cURL リクエスト例 (クリックして詳細を表示)

    # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
    # <my_index> を新しいナレッジベースインデックスに置き換えます。
    # vector_store_config をベクトルデータベースの構成として設定します。
    curl -X 'POST' '/api/v1/indexes/' \
    -H 'Authorization: ' \
    -H 'Content-Type: application/json' \
    -d '{
        "index_name": "",
        "vector_store_config": {
            "type": "faiss"
        },
        "embedding_config": {
            "model": "bge-m3",
            "source": "huggingface"
        }
    }'

上記のコードの vector_store_config パラメーターは Faiss を例として使用しています。他のベクトルデータベースの vector_store_config 構成は次のとおりです。

Milvus

"vector_store_config":
      {
          "type":"milvus",
          "host":"c-xxxxx.milvus.aliyuncs.com",
          "port":19530,
          "user":"root",
          "password":"xxx",
          "database":"default",
          "collection_name":"test",
          "reranker_weights":[0.5,0.5]
      }

Hologres

"vector_store_config":
      {
          "type":"hologres",
          "host":"xxx",
          "port":xxx,
          "user":"xxx",
          "password":"xxx",
          "database":"default",
          "table_name":"test",
          "pre_delete_table":"false"
      }

Elasticsearch

"vector_store_config":
      {
          "type":"elasticsearch",
          "es_url":"xxx",
          "es_user":xxx,
          "es_password":"xxx",
          "es_index":"xxx"
      }

OpenSearch

"vector_store_config":
      {
          "type":"opensearch",
          "endpoint":"xxx",
          "instance_id":xxx,
          "username":"xxx",
          "password":"xxx",
          "table_name":"xxx"
      }

AnalyticDB

"vector_store_config":
      {
          "type":"analyticdb",
          "ak":"xxx",
          "sk":xxx,
          "region_id":"xxx",
          "instance_id":"xxx",
          "account":"xxx",
          "account_password":"xxx",
          "namespace":"xxx",
          "collection":"xxx"
      }

Tablestore

"vector_store_config":
      {
          "type":"tablestore",
          "endpoint":"xxx",
          "instance_name":xxx,
          "access_key_id":"xxx",
          "access_key_secret":"xxx",
          "table_name":"xxx"
      }

DashVector

"vector_store_config":
      {
          "type":"dashvector",
          "endpoint":"xxx",
          "api_key":xxx,
          "collection_name":"xxx",
          "partition_name":"xxx"
      }

レスポンス例 (クリックして詳細を表示)

  { "msg": "Add index 'my_index' successfully." }

ナレッジベースインデックスの更新

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/indexes/{index_name}`
リクエストメソッド	PATCH
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: application/json`
リクエストパラメーター	index_name: インデックス名。 vector_store_config: ベクトルデータベースの構成。 embedding_config: 埋め込みモデルの構成。

cURL リクエスト例 (クリックして詳細を表示)

    # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
    # <my_index> を更新するナレッジベースインデックスに置き換えます。
    # vector_store_config を更新するベクトルデータベースの構成として設定します。
    curl -X 'PATCH' '/api/v1/indexes/' \
    -H 'Authorization: ' \
    -H 'Content-Type: application/json' \
    -d '{
        "index_name": "",
        "vector_store_config": {
            "type": "faiss"
        },
        "embedding_config": {
            "model": "bge-m3",
            "source": "huggingface"
        }
    }'

上記のコードの vector_store_config パラメーターは Faiss を例として使用しています。他のベクトルデータベースの vector_store_config 構成については、「ナレッジベースインデックスの作成」をご参照ください。

レスポンス例 (クリックして詳細を表示)

  { "msg": "Update index 'my_index' successfully." }

ナレッジベースインデックスの削除

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/indexes/{index_name}`
リクエストメソッド	DELETE
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: application/json`
リクエストパラメーター	index_name: インデックス名。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
# <my_index> を削除するナレッジベースインデックスに置き換えます。
curl -X 'DELETE' '/api/v1/indexes/' -H 'Authorization: ' -H 'Content-Type: application/json' -d '{"index_name":""}'

レスポンス例 (クリックして詳細を表示)

  { "msg": "Delete index 'my_index' successfully." }

RAG サービスの構成のクエリ

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/config`
リクエストメソッド	GET
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。

cURL リクエスト例 (クリックして詳細を表示)

# <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
curl -X 'GET' '/api/v1/config' -H 'Authorization: '

レスポンス例 (クリックして詳細を表示)

  {
    "system": {
      "default_web_search": false,
      "query_type": "websearch"
    },
    "data_reader": {
      "concat_csv_rows": false,
      "enable_mandatory_ocr": false,
      "format_sheet_data_to_json": false,
      "sheet_column_filters": null,
      "number_workers": 4
    },
    "node_parser": {
      "type": "Sentence",
      "chunk_size": 500,
      "chunk_overlap": 10,
      "enable_multimodal": true,
      "paragraph_separator": "\n\n\n",
      "sentence_window_size": 3,
      "sentence_chunk_overlap": 200,
      "breakpoint_percentile_threshold": 95,
      "buffer_size": 1
    },
    "index": {
      "vector_store": {
        "persist_path": "localdata/storage",
        "type": "faiss",
        "is_image_store": false
      },
      "enable_multimodal": true,
      "persist_path": "localdata/storage"
    },
    "embedding": {
      "source": "huggingface",
      "model": "bge-m3",
      "embed_batch_size": 10,
      "enable_sparse": false
    },
    "multimodal_embedding": {
      "source": "cnclip",
      "model": "ViT-L-14",
      "embed_batch_size": 10,
      "enable_sparse": false
    },
    "llm": {
      "source": "openai_compatible",
      "temperature": 0.1,
      "system_prompt": null,
      "max_tokens": 4000,
      "base_url": "https://dashscope.aliyuncs.com/compatible-mode/v1",
      "api_key": "sk-xxx",
      "model": "qwen-max"
    },
    "multimodal_llm": {
      "source": "openai_compatible",
      "temperature": 0.1,
      "system_prompt": null,
      "max_tokens": 4000,
      "base_url": "https://dashscope.aliyuncs.com/compatible-mode/v1",
      "api_key": "sk-xxx",
      "model": ""
    },
    "functioncalling_llm": null,
    "agent": {
      "system_prompt": "You are a travel assistant, xxx",
      "python_scripts": "xxx",
      "function_definition": "xxx",
      "api_definition": "xxx"
    },
    "chat_store": {
      "type": "local",
      "persist_path": "localdata/storage"
    },
    "data_analysis": {
      "type": "mysql",
      "nl2sql_prompt": "Give a question, xxx",
      "synthesizer_prompt": "Give a question, xxx",
      "database": "my_pets",
      "tables": [],
      "descriptions": {},
      "enable_enhanced_description": false,
      "enable_db_history": true,
      "enable_db_embedding": true,
      "max_col_num": 100,
      "max_val_num": 1000,
      "enable_query_preprocessor": true,
      "enable_db_preretriever": true,
      "enable_db_selector": true,
      "user": "root",
      "password": "xxx",
      "host": "127.0.0.1",
      "port": 3306
    },
    "intent": {
      "descriptions": {
        "rag": "\nThis tool can help you get more specific information from the knowledge base.\n",
        "tool": "\nThis tool can help you get travel information about time, weather, flights, train and hotels.\n"
      }
    },
    "node_enhancement": {
      "tree_depth": 3,
      "max_clusters": 52,
      "proba_threshold": 0.1
    },
    "oss_store": {
      "bucket": "",
      "endpoint": "oss-cn-hangzhou.aliyuncs.com",
      "ak": null,
      "sk": null
    },
    "postprocessor": {
      "reranker_type": "no-reranker",
      "similarity_threshold": 0.5
    },
    "retriever": {
      "vector_store_query_mode": "default",
      "similarity_top_k": 3,
      "image_similarity_top_k": 2,
      "search_image": false,
      "hybrid_fusion_weights": [0.7, 0.3]
    },
    "search": {
      "source": "google",
      "search_count": 10,
      "serpapi_key": "142xxx",
      "search_lang": "zh-CN"
    },
    "synthesizer": {
      "use_multimodal_llm": false,
      "system_role_template": "You are xxx",
      "custom_prompt_template": "Your goal is to provide accurate, useful, and easy-to-understand information. xxx"
    },
    "query_rewrite": {
      "enabled": true,
      "rewrite_prompt_template": "# Role\nYou are a professional information retrieval expert, xxx",
      "llm": {
        "source": "openai_compatible",
        "temperature": 0.1,
        "system_prompt": null,
        "max_tokens": 4000,
        "base_url": "https://dashscope.aliyuncs.com/compatible-mode/v1",
        "api_key": null,
        "model": ""
      }
    },
    "guardrail": {
      "endpoint": null,
      "region": null,
      "access_key_id": null,
      "access_key_secret": null,
      "custom_advice": null
    }
  }

RAG サービスの構成の更新

メソッド
URL	`{EAS_SERVICE_URL}/api/v1/config`
リクエストメソッド	PATCH
リクエストヘッダー	`Authorization: EAS_TOKEN` # EAS サービスのトークン。 `Content-Type: application/json`
リクエストパラメーター	new_config: 更新された構成。

cURL リクエスト例 (クリックして詳細を表示)

    # <EAS_TOKEN> と <EAS_SERVICE_URL> をそれぞれサービストークンとサービスアクセスアドレスに置き換えます。
    curl -X 'PATCH' '{EAS_SERVICE_URL}/api/v1/config' \
    -H 'Authorization: EAS_TOKEN' \
    -H 'Content-Type: application/json' \
    -d '{
        "system": {
          "default_web_search": false,
          "query_type": "websearch"
        },
        "data_reader": {
          "concat_csv_rows": false,
          "enable_mandatory_ocr": false,
          "format_sheet_data_to_json": false,
          "sheet_column_filters": null,
          "number_workers": 4
        },
        "node_parser": {
          "type": "Sentence",
          "chunk_size": 500,
          "chunk_overlap": 10,
          "enable_multimodal": true,
          "paragraph_separator": "\n\n\n",
          "sentence_window_size": 3,
          "sentence_chunk_overlap": 200,
          "breakpoint_percentile_threshold": 95,
          "buffer_size": 1
        },
        ...
    }' # (詳細については、「RAG サービスの構成のクエリ」セクションのレスポンス例をご参照ください。)

レスポンス例 (クリックして詳細を表示)

  { "msg": "Update RAG configuration successfully." }