GetDocumentChunkList

Operation description

Prerequisites

Activate Alibaba Cloud Model Studio and Tongyi Gold Service.
Obtain the workspaceId and 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 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
dianjin:GetDocumentChunkList	none	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

dianjin:GetDocumentChunkList

none

*All Resource

*

None

Request syntax

POST /{workspaceId}/api/library/getDocumentChunk HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	Path parameter, workspace ID	llm-xxxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request body parameters.
chunkIdList	array	No	List of document chunk IDs
	string	No	Document chunk ID	83648326438746
docId	string	Yes	Document ID	182364872346
libraryId	string	Yes	Library ID	dsjgfdjgfxxx
order	string	No	Sorting method	desc
orderBy	string	No	Sort field	gmtCreate
page	integer	No	Page number	1
pageSize	integer	No	Page size	10
searchQuery	string	No	Search query keyword	test

Response elements

Element	Type	Description	Example
	object	ResultCode<PageVO >
cost	integer	Time consumed	null
data	object	Response data
currentPage	integer	Current page	1
pageSize	integer	Records per page	10
records	array<object>	Records
	array<object>
chunkId	string	Document chunk ID	28377468263482764
chunkMeta	object	Document chunk metadata	{"a":"1"}
chunkOssUrl	string	Document chunk OSS address	oss-xxxx-hangzhou.com/test.pdf
chunkText	string	Document chunk text	这是一段测试文本
chunkType	string	Document chunk type Valid values: faq : FAQ text : Text graph : Graph table : Table structure : Structure	text
docId	string	Document ID	8947387648356
fileType	string	Document type	pdf
libraryId	string	Library ID	jhsdvne
libraryName	string	Library name	测试文档库
nextChunkId	string	Next document chunk ID	947538465
pos	array<object>	Document chunk position
	object	Layout position information
axisArray	array	Coordinate
	number	Coordinate	394.3
page	integer	Page number	1
textHighlightArea	array	Text highlight area, used for highlighting text-type files
	integer	Text highlight area	38
preChunkId	string	Previous document chunk ID	9848346548365
score	number	Document chunk score	0.5
title	string	Document title	test
totalPages	integer	Total pages	10
totalRecords	integer	Total records	100
dataType	string	Data type	null
errCode	string	Error code	0
message	string	Error message	ok
requestId	string	Request ID	2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF
success	boolean	Success status	true
time	string	Timestamp	2024-04-24 11:54:34

Examples

Success response JSON format

{
  "cost": 0,
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "records": [
      {
        "chunkId": "28377468263482764",
        "chunkMeta": {
          "a": "1"
        },
        "chunkOssUrl": "oss-xxxx-hangzhou.com/test.pdf",
        "chunkText": "这是一段测试文本",
        "chunkType": "text",
        "docId": "8947387648356",
        "fileType": "pdf",
        "libraryId": "jhsdvne",
        "libraryName": "测试文档库",
        "nextChunkId": "947538465",
        "pos": [
          {
            "axisArray": [
              394.3
            ],
            "page": 1,
            "textHighlightArea": [
              38
            ]
          }
        ],
        "preChunkId": "9848346548365",
        "score": 0.5,
        "title": "test"
      }
    ],
    "totalPages": 10,
    "totalRecords": 100
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "2B8F6DC9-6FAF-576F-9095-CCD90FB2BDDF",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Operation description

​Try it now

​RAM authorization

​Request syntax

​Path Parameters

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes