UpdateDatasetDocument-阿里云帮助中心

Updates a document in a dataset.

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 Action element 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 Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
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
aimiaobi:UpdateDatasetDocument	update	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:UpdateDatasetDocument

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see Get the workspace ID.	xxxx
Document	object	Yes	The document to update.
DocUuid	string	No	Unique ID of the document in the system.	xxx
Title	string	No	Document title.	xx
DocId	string	No	User-defined unique ID for the document.	xxx
CategoryUuid	string	No		xx
Tags	array	No
	string	No		xx
Extend1	string	No		xxx
Extend2	string	No		xxxx
Extend3	string	No		xxx
DatasetId	integer	No	Unique identifier of the dataset.	1
DatasetName	string	No	Name of the dataset.	数据集名称

Response elements

Element	Type	Description	Example
	object	Response body.
Data	object	Business data.
DocUuid	string	Internal unique ID of the document.	内部文档唯一ID
Title	string	Document title.	文章标题
DocId	string	User-defined unique ID for the document.	用户指定的文档唯一ID
Tags	array
	string		xx
CategoryUuid	string		xx
Extend1	string		xx
Extend2	string		xx
Extend3	string		xx
RequestId	string	Unique ID of the request.	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.	true
Code	string	Status code.	NoData
Message	string	Error message.	success
HttpStatusCode	integer	HTTP status code.	200

Examples

Success response

JSON format

{
  "Data": {
    "DocUuid": "内部文档唯一ID",
    "Title": "文章标题",
    "DocId": "用户指定的文档唯一ID",
    "Tags": [
      "xx"
    ],
    "CategoryUuid": "xx",
    "Extend1": "xx",
    "Extend2": "xx",
    "Extend3": "xx"
  },
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.