ナレッジベース内の指定されたテキストチャンクの内容とタイトルを変更し、そのチャンクがナレッジベースの検索に参加するかどうかを指定します。
操作説明
-
主な制限事項: このオペレーションはドキュメント検索ナレッジベースのみをサポートしています。データクエリおよび画像 Q&Aナレッジベースはサポートされていません。
-
権限要件:
- Resource Access Management (RAM) ユーザー: このオペレーションを呼び出す前に、Model Studio の API 権限 を取得し(このオペレーションに必要な sfm:UpdateChunk 権限を含む
AliyunBailianDataFullAccessポリシーを使用できます)、ワークスペースに参加してください。 - Alibaba Cloud アカウント: デフォルトで権限を持ち、このオペレーションを直接呼び出すことができます。
- Resource Access Management (RAM) ユーザー: このオペレーションを呼び出す前に、Model Studio の API 権限 を取得し(このオペレーションに必要な sfm:UpdateChunk 権限を含む
-
呼び出し方法: 最新の Model Studio SDK を使用してください。SDK は複雑な署名計算ロジックをカプセル化し、呼び出し手順を簡素化します。
-
反映までの遅延: 更新は通常即座に反映されます。ピーク時には、わずかな遅延(数秒)が発生する場合があります。
-
冪等性: このオペレーションは冪等です。すでに更新済みのテキストチャンクに対して同じ操作を繰り返した場合、成功レスポンスが返されます。
レート制限: このオペレーションは、頻繁に呼び出された場合にスロットリングされます。1 秒あたり10 回を超えないようにしてください。スロットリングされた場合は、後で再試行してください。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。
-
アクション:特定のリソースに対して実行可能な操作。ポリシー構文では
Action要素として指定します。 -
API:アクションを具体的に実行するための API。
-
アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。
-
リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
Resource要素で対応する ARN を指定してください。 - リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーの
Resource要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
-
依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。
アクション | アクセスレベル | リソースタイプ | 条件キー | 依存アクション |
|---|---|---|---|---|
sfm:UpdateChunk | update | *All Resource
| なし | なし |
リクエスト構文
POST /{WorkspaceId}/chunk/update HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ナレッジベースのワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法を参照してください。 | llm-3z7uw7fwz0vexxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| PipelineId | string | 必須 | ナレッジベース ID。これは CreateIndex オペレーションによって返される | 79c0alxxxx |
| DataId | string | 必須 | ファイル ID。これは AddFile オペレーションによって返される | doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| ChunkId | string | 必須 | 変更するテキストチャンクの ID。この値は ListChunks オペレーションを呼び出すことで取得できます。値はレスポンスの Node.Metadata._id フィールドにあります。 | llm-5ip55o1zrzxx_09fe52x_xxxxx_033b551e10024029992e79767b151fxx_10024xx_0 |
| IsDisplayedChunkContent | boolean | 必須 | このテキストチャンクがナレッジベースの検索に参加するかどうかを指定します。有効な値:
デフォルト値: true。 | true |
| content | string | 必須 | テキストチャンクの新しい内容。内容の長さは10〜6000 文字で、ナレッジベース作成時に指定された最大セグメント長を超えることはできません。 | 在哲学中所获得的确定性类型不是科学的确定性(即对每个人的理智来说都一样的确定性),而是一种要在人类的整体本质中才能获得的亲证。哲学的每一形态都不同于科学,因为所有的哲学都没有得到一致的认可... |
| title | string | 任意 | テキストチャンクの新しいタイトル。長さは0〜50 文字に制限されます。空文字列を使用できます。空文字列を渡すと、既存のタイトルがクリアされます。このパラメータを渡さない場合、元のタイトルが保持されます。 | 什么是哲学 |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ | ||
| RequestId | string | リクエスト ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | エラーステータスコード。 | |
| Message | string | エラーメッセージ。 | |
| Success | boolean | オペレーションが成功したかどうかを示します。有効な値:
| true |
| Data | boolean | リクエスト成功時に返されるビジネスデータ。 | true |
| Status | string | オペレーションによって返されるステータスコード。 | "200" |
例
成功レスポンス
JSONJSON
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "",
"Message": "",
"Success": true,
"Data": true,
"Status": "\"200\""
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。