GetDatasetDocument-阿里云帮助中心

Retrieve the data source document.

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.

Test

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:GetDatasetDocument

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Unique identifier of your Alibaba Cloud Model Studio workspace. Get the workspace ID	xxxx
DatasetId	integer	No	Unique identifier of the dataset.	1
DatasetName	string	No	Name of the dataset.	数据集名称
DocUuid	string	No	Internal unique identifier of the document.	xxx
DocId	string	No	User-defined unique ID of the document.	xxx
IncludeFields	array	No	List of fields to include in the response.
	string	No	Field names to include. For example, metadata.	metadata

Response elements

Element	Type	Description	Example
	object	Response object.
Data	object	Business data.
DocUuid	string	Unique ID of the document in the document system.	xxx
Url	string	URL of the article.	https://www.aliyun.com
Content	string	Content of the article.	文章内容
Summary	string	Summary of the article.	文章摘要
Title	string	Title of the document.	文档标题
PubTime	string	Publication time in yyyy-MM-dd HH:mm:ss format.	2024-05-14 08:54:33
SourceFrom	string	Source of the document.	来源
DisableHandleMultimodalMedia	boolean	Whether this record is indexed in the multimodal index library.	true
DocId	string	User-side unique ID of the document.	xxx
Metadata	object	Dictionary information.
Text	string	Metadata for the document dimension.	xx
VideoShots	array<object>	Video sharding information.
	object	Video sharding information.
StartTime	integer	Start time of the video shard in milliseconds.	1000
EndTime	integer	End time of the video shard in milliseconds.	2000
Text	string	Content of the video shard.	xxx
AsrSentences	array<object>	ASR results.
	object	ASR result.
StartTime	integer	Start time in milliseconds.	1000
EndTime	integer	End time in milliseconds.	2000
Text	string	ASR text content.	xxx
KeyValues	array<object>
	object
Key	string		xx
Value	string		xx
DocType	string	Document type. For example, video or image.	video
Status	integer	Document status. 100 means success. 0 means failure. 1 means indexing or queued.	100
CategoryUuid	string		xx
Tags	array
	string		xx
Extend1	string		xx
Extend2	string		xx
Extend3	string		xx
RequestId	string	Unique identifier of the request.	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the operation succeeded. true means success. false means 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": "xxx",
    "Url": "https://www.aliyun.com",
    "Content": "文章内容",
    "Summary": "文章摘要",
    "Title": "文档标题\n\n",
    "PubTime": "2024-05-14 08:54:33",
    "SourceFrom": "来源",
    "DisableHandleMultimodalMedia": true,
    "DocId": "xxx",
    "Metadata": {
      "Text": "xx",
      "VideoShots": [
        {
          "StartTime": 1000,
          "EndTime": 2000,
          "Text": "xxx"
        }
      ],
      "AsrSentences": [
        {
          "StartTime": 1000,
          "EndTime": 2000,
          "Text": "xxx"
        }
      ],
      "KeyValues": [
        {
          "Key": "xx",
          "Value": "xx"
        }
      ]
    },
    "DocType": "video",
    "Status": 100,
    "CategoryUuid": "xx",
    "Tags": [
      "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.