Get File Catalog

This page guides you through retrieving detailed information about a specific file stored in a Catalog using the Get File Catalog API.

This API provides metadata about a file, including its type, size, and processing status, as well as details on the content transformed through various pipelines. It also returns any chunks associated with the file, providing a comprehensive view of the file's data within the Catalog.

#Get File Catalog via API

#Example of Using fileUid

#Example of Using fileId

Note that the NAMESPACE_ID and CATALOG_ID path parameters must be replaced by the Catalog owner's ID (namespace) and the identifier of the Catalog you are querying. The fileUid and fileId fields identify the specific file within the Catalog that you want to retrieve information about.

#Example Response

A successful response will return detailed metadata about the file, including the transformed content and any chunks associated with it:

#Output Description

• originalData: The original file data encoded in base64.
• metadata: An object containing metadata about the file.
  • fileUid (string): The unique identifier of the file.
  • fileId (string): The file's ID.
  • fileType (string): The type of the file, e.g., FILE_TYPE_TEXT, FILE_TYPE_PDF, FILE_TYPE_HTML, FILE_TYPE_PPTX, FILE_TYPE_DOCX.
  • fileSize (string): The size of the file in bytes.
  • fileUploadTime (string): The time when the file was uploaded.
  • fileProcessStatus (string): The processing status of the file, which could be FILE_PROCESS_STATUS_COMPLETED, FILE_PROCESS_STATUS_FAILED, etc.
• text: An object containing the transformed text content.
  • pipelineIds (array): The IDs of the pipelines that processed the file.
  • transformedContent (string): The content transformed through the pipelines.
  • transformedContentChunkNum (integer): The number of chunks in the transformed content.
  • transformedContentTokenNum (integer): The number of tokens in the transformed content.
  • transformedContentUpdateTime (string): The last update time of the transformed content.
• chunks: An array of objects, each representing a chunk of the file's content.
  • uid (string): The unique identifier of the chunk.
  • type (string): The type of the chunk, e.g., CHUNK_TYPE_TEXT.
  • startPos (integer): The start position of the chunk in the file.
  • endPos (integer): The end position of the chunk in the file.
  • content (string): The content of the chunk.
  • tokensNum (integer): The number of tokens in the chunk.
  • embedding (array): The embedding vector of the chunk.
  • createTime (string): The time when the chunk was created.
  • retrievable (boolean): Whether the chunk is retrievable.

This API is essential for retrieving and understanding detailed information about files stored within a Catalog, enabling users to analyze file data at a granular level.