DocumentExtraction
Extracts the content of documents from URLs.
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 |
|---|---|---|---|---|
aimiaobi:DocumentExtraction | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | Unique identifier of the workspace: AgentKey | xxxxx_p_efm |
| Urls | array | Yes | List of URLs to extract. | |
string | No | URL. Maximum length is 2048 characters. |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PlainResult | ||
| Code | string | Status code | successful |
| Data | array<object> | Business data | |
object | Document object | ||
| Author | string | Author | Author |
| Content | string | Content | Article content |
| DocId | string | Custom unique ID for the document | Custom unique ID for document |
| DocUuid | string | Internal unique identifier for the document | 8df2d69d63a247b6b52ff455b2d426b6 |
| PubTime | string | Publication time | 2024-05-14 08:54:33 |
| Source | string | Source | News source |
| Summary | string | Article summary | Article summary |
| Tag | string | Tag | Article tag |
| Title | string | Title | Article title |
| Url | string | Article URL | |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Error message | successful |
| RequestId | string | Unique request identifier | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates success: true for success, false for failure | true |
Examples
Success response
JSON format
{
"Code": "successful",
"Data": [
{
"Author": "Author",
"Content": "Article content",
"DocId": "Custom unique ID for document",
"DocUuid": "8df2d69d63a247b6b52ff455b2d426b6",
"PubTime": "2024-05-14 08:54:33",
"Source": "News source",
"Summary": "Article summary",
"Tag": "Article tag",
"Title": "Article title",
"Url": "https://www.example.com/aaa.docx"
}
],
"HttpStatusCode": 200,
"Message": "successful",
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.