Upload a document to a document library. The system parses the document, splits it into chunks, and builds an index.
Operation description
Before you use this operation, review the Tongyi Dianjin pricing details.
Prerequisites
- You have activated Alibaba Cloud Model Studio and Tongyi Dianjin.
- You have obtained a workspace ID. For more information, see Get the workspace ID.
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:UploadDocument | none | *All Resource
| None | None |
Request syntax
Path Parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | Path parameter. The workspace ID. | llm-xxxxx |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| body | object | No | The request body. | |
| data | string | No | File metadata. You can use this to filter results during retrieval. | {\"cateogry\": \"Report\"} |
| fileName | string | Yes | The full file name, including the extension. Supported formats are PDF, DOC, DOCX, Markdown, PPT, and PPTX. File size must not exceed 100 MB. PDF, DOC, DOCX, PPT, and PPTX files must not exceed 500 pages. | test.pdf |
| fileUrl | string | Yes | The OSS URL of the file. If the file is not publicly readable, include a signature in the URL. If you use the SDK to upload files, upload the file directly. You do not need to provide an OSS URL. For more information, see the SDK documentation. | |
| libraryId | string | Yes | The document library ID. | sjdhbcsj |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response object. | ||
| cost | integer | The processing time, in milliseconds. | null |
| data | string | The returned data. | 1782981430906818562 |
| dataType | string | The data type. | null |
| errCode | string | The error code. | 0 |
| message | string | The error message. | ok |
| requestId | string | The request ID. | ff3fef67-48d9-4379-a237-9ba8143fe739 |
| success | boolean | Indicates whether the operation succeeded. | true |
| time | string | Timestamp. | 2024-04-24 11:54:34 |
Examples
Success response
JSON format