Obtaining FAQ Document Chunks

Function

Obtain FAQ document chunks.

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
application_id	Yes	String	Definition: Application ID. For details about how to obtain the application ID, see Obtaining an Application ID. Constraints: Character string Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
file_id	Yes	String	Definition: File ID. Constraints: N/A Value range: Length: 1 to 64 characters. The value can contain only digits, letters, hyphens (-), and underscores (_). Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page_num	No	Integer	Definition: Page number of the current request, indicating the start page from data retrieval. The default value is 1, indicating to start from the first page. Constraints: N/A Value range: 1-65535 Default value: 1
page_size	No	Integer	Definition: Number of records displayed on each page, indicating the number of records returned per request. The default value is 10, indicating that 10 records are displayed on each page. Constraints: N/A Value range: 1-65535 Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
docs	Array of FileDocInfo objects	Definition: File segment list. Value range: N/A
page_num	Long	Definition: Page number in the request. Value range: N/A
page_size	Long	Definition: Page size in the request. Value range: N/A
total	Long	Definition: Total number of segments. Value range: N/A
version	Integer	Definition: Version information. Value range: N/A

**Table 4** FileDocInfo
Parameter	Type	Description
id	String	Definition: Chunk ID. Value range: N/A
timestamp	String	Definition: Segment creation timestamp. To ensure proper display of segment data, this field is not updated along with the segment data. Value range: N/A
title	String	Definition: Segment title. Value range: N/A
content	String	Definition: Segment content. Value range: N/A
page_num	Long	Definition: Segment page number, which is not involved in FAQ segment content. Value range: N/A
page_num_list	Array of longs	Definition: Segment page number. When the file type is PDF, a single segment can contain multiple pages. Value range: N/A
component_num	Long	Definition: Segment content sequence number, which is not involved in FAQ fragment content. Value range: N/A
element_id	String	Definition: File element ID. Value range: N/A
elements	Array of strings	Definition: Data element in HTML. Value range: N/A Constraints: This parameter is supported only in clusters 25.7.T1 or later.
pdf_coordinate	Object	Definition: Metadata used for locating text during PDF parsing. Example value: [ [ 202, 687 ], [ 1031, 687 ] ] Value range: N/A Constraints: This parameter is supported only in clusters 25.7.T1 or later.

Example Requests

Obtain FAQ document chunks.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/faq/batch/7d91f97d-5e31-443a-bfe4-1707985e0d0a/docs?page_size=10&page_num=1

Example Responses

Status code: 200

Response body for obtaining FAQ document chunk information.

{
  "page_num" : 1,
  "page_size" : 10,
  "total" : 2,
  "docs" : [ {
    "id" : "b2c69a8e-1c6d-4f38-b9d9-7e92e0f681f2_0",
    "timestamp" : "1716792840094",
    "title" : "What can I do if I cannot log in to my account?",
    "content" : "Make sure you use the correct username and password. If the login still fails, reset the password or contact customer service."
  }, {
    "id" : "9ac75dd7-5f5d-407e-a99a-05255c20c40a_0",
    "timestamp" : "1716792840094",
    "title" : "How do I apply for admission?",
    "content" : "Please check our official website or contact the Admissions Office for admission requirements, application deadlines, and required materials. We also provide admission consultant services."
  } ]
}