ai.z.openapi.api.fileparsing

Interface FileParsingApi

public interface FileParsingApi

File Parsing API Provides functionality for uploading files for parsing, and retrieving the parsing results.

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<FileParsingUploadResp>	createParseTask(okhttp3.MultipartBody multipartBody) Create a file parsing task.
retrofit2.Call<okhttp3.ResponseBody>	downloadParseResult(String taskId, String formatType) Get a file parsing result.
retrofit2.Call<FileParsingDownloadResp>	syncParse(okhttp3.MultipartBody multipartBody) Executes a synchronous file parsing operation.

Method Detail

createParseTask

@POST(value="files/parser/create")
io.reactivex.rxjava3.core.Single<FileParsingUploadResp> createParseTask(@Body
                                                                                                           okhttp3.MultipartBody multipartBody)

Create a file parsing task. Uploads a file and creates a document parsing job using specific tool type and file type.

Parameters:

multipartBody - File data with metadata including tool_type and file_type

Returns:

Information and status of the parsing job

downloadParseResult

@Streaming
 @GET(value="files/parser/result/{taskId}/{formatType}")
retrofit2.Call<okhttp3.ResponseBody> downloadParseResult(@Path(value="taskId")
                                                                                                                             String taskId,
                                                                                                                             @Path(value="formatType")
                                                                                                                             String formatType)

Get a file parsing result. Retrieves the parsing result by taskId and format type.

Parameters:

taskId - The unique task ID for the parsing job

formatType - The format type of the parsing result

Returns:

Parsing result content (JSON or raw format)

syncParse

@POST(value="files/parser/sync")
retrofit2.Call<FileParsingDownloadResp> syncParse(@Body
                                                                                   okhttp3.MultipartBody multipartBody)

Executes a synchronous file parsing operation. Uploads a file and returns the parsing result with specified tool and file type.

Parameters:

multipartBody - The multipart request body containing the file and related metadata (tool type, file type)

Returns:

Parsing result content as a FileParsingDownloadResp object