Update the text content of a document chunk in a document.
Operation description
Before using this API, ensure you understand the billing methods and pricing of the Tongyi Gold product.
Prerequisites
You must activate Alibaba Cloud Model Studio and Tongyi Gold services.
Obtain the workspaceId. For more information, see the workspace identity.
Try it now
Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.
RAM authorization
The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
-
Action: The actions can be used in the
Actionelement of RAM permission policy statements to grant permissions to perform the operation. - API: The API that you can call to perform the action.
- Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
-
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
- Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.
Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
dianjin:UpdateDocumentChunk | update | *All Resource
| None | None |
Request syntax
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | Workspace ID. | llm-xxxxx |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| body | object | No | Request body parameters. | |
| libraryId | string | Yes | Library ID. | sjdgdsfg |
| chunks | array<object> | Yes | List of document chunks. | |
object | Yes | Document chunk. | ||
| chunkId | string | Yes | Document chunk ID. | 1987834755763847 |
| chunkText | string | Yes | Document chunk text. | This is a test text |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | ResultCode | ||
| success | boolean | Is successful. | true |
| dataType | string | Data type. | null |
| time | string | Timestamp. | 2024-01-01 00:00:00 |
| errCode | string | Error code. | 0 |
| message | string | Error message. | ok |
| data | string | Response data. | SUCCESS |
| requestId | string | Request ID. | 003D019A-1BB3-53EC-A0D2-CE76DA5D73B1 |
| cost | integer | Processing time | null |
Examples
Success response
JSON format