io.agentscope.core.rag.model.DocumentMetadata

@Deprecated(forRemoval=true, since="2.0.0") public class DocumentMetadata extends Object

已过时, 待删除: 此 API 元素将从以后的版本中删除。

since 2.0.0. The rag package is removed; integrate retrieval at the application layer.

Document metadata containing content and chunking information.

This class stores metadata about a document chunk, including the content (which can be text, image, video, etc.), document ID, chunk ID, and optional custom payload fields.

The content field uses ContentBlock which is a sealed hierarchy supporting different content types (TextBlock, ImageBlock, VideoBlock, etc.).

The payload field allows storing custom metadata such as file name, department, author, creation time, tags, and other business-specific fields. These fields are stored as key-value pairs and will be persisted to vector databases along with the document content.

Example usage with payload:


 Map<String, Object> payload = new HashMap<>();
 payload.put("filename", "report.pdf");
 payload.put("department", "Finance");
 payload.put("author", "John Doe");
 payload.put("created_at", "2024-01-15T10:30:00Z");
 payload.put("tags", Arrays.asList("urgent", "quarterly"));

 TextBlock content = TextBlock.builder().text("Document content").build();
 DocumentMetadata metadata = new DocumentMetadata(content, "doc-123", "chunk-0", payload);

嵌套类概要

嵌套类

修饰符和类型

类

说明

static class

DocumentMetadata.Builder

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Builder for constructing DocumentMetadata instances with fluent API.
构造器概要

构造器

构造器

说明

DocumentMetadata(ContentBlock content, String docId, String chunkId)

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Creates a new DocumentMetadata instance without custom payload.

DocumentMetadata(ContentBlock content, String docId, String chunkId, Map<String,Object> payload)

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Creates a new DocumentMetadata instance with custom payload.
方法概要

修饰符和类型

方法

说明

static DocumentMetadata.Builder

builder()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Creates a new builder for constructing DocumentMetadata instances.

String

getChunkId()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets the chunk ID.

ContentBlock

getContent()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets the content block.

String

getContentText()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets the text content from the content block.

String

getDocId()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets the document ID.

Map<String,Object>

getPayload()

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets the custom payload metadata.

Object

getPayloadValue(String key)

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Gets a specific payload value by key.

boolean

hasPayloadKey(String key)

已过时, 待删除: 此 API 元素将从以后的版本中删除。

Checks if the payload contains a specific key.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料
- DocumentMetadata
  
  public DocumentMetadata(ContentBlock content, String docId, String chunkId)
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Creates a new DocumentMetadata instance without custom payload.
  This constructor is provided for backward compatibility. For new code, consider using the constructor with payload parameter or the builder pattern if you need to add custom metadata fields.
  
  参数:
  
  content - the content block (text, image, video, etc.)
  
  docId - the document ID
  
  chunkId - the chunk ID within the document
- DocumentMetadata
  
  public DocumentMetadata(ContentBlock content, String docId, String chunkId, Map<String,Object> payload)
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Creates a new DocumentMetadata instance with custom payload.
  The payload map is copied to prevent external modifications. The returned payload from getPayload() will be an unmodifiable view.
  
  参数:
  
  content - the content block (text, image, video, etc.)
  
  docId - the document ID
  
  chunkId - the chunk ID within the document
  
  payload - the custom metadata fields (can be null or empty)
  
  抛出:
  
  IllegalArgumentException - if content, docId, or chunkId is null
方法详细资料
- getContent
  
  public ContentBlock getContent()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets the content block.
  
  返回:
  
  the content block
- getDocId
  
  public String getDocId()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets the document ID.
  
  返回:
  
  the document ID
- getChunkId
  
  public String getChunkId()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets the chunk ID.
  
  返回:
  
  the chunk ID
- getPayload
  
  public Map<String,Object> getPayload()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets the custom payload metadata.
  Returns an unmodifiable map of custom metadata fields. This map contains business-specific fields such as filename, department, author, tags, etc. The map is never null but may be empty if no payload was provided.
  
  返回:
  
  an unmodifiable map of custom metadata fields (never null)
- getPayloadValue
  
  public Object getPayloadValue(String key)
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets a specific payload value by key.
  This is a convenience method to retrieve individual payload values without needing to access the entire payload map.
  
  参数:
  
  key - the payload key
  
  返回:
  
  the payload value, or null if the key doesn't exist
  
  抛出:
  
  NullPointerException - if key is null
- hasPayloadKey
  
  public boolean hasPayloadKey(String key)
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Checks if the payload contains a specific key.
  Use this method to safely check for the existence of a payload field before attempting to retrieve its value.
  
  参数:
  
  key - the payload key to check
  
  返回:
  
  true if the key exists in the payload, false otherwise
  
  抛出:
  
  NullPointerException - if key is null
- getContentText
  
  public String getContentText()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  
  Gets the text content from the content block.
  This is a convenience method that extracts text from the ContentBlock. For TextBlock, it returns the text. For other block types, it returns their string representation.
  
  返回:
  
  the text content, or empty string if not available
- builder
  
  public static DocumentMetadata.Builder builder()
  
  已过时, 待删除: 此 API 元素将从以后的版本中删除。
  Creates a new builder for constructing DocumentMetadata instances.
  The builder pattern provides a fluent API for creating DocumentMetadata with optional payload fields. This is especially useful when you need to add multiple custom metadata fields.
  Example usage:
  DocumentMetadata metadata = DocumentMetadata.builder() .content(TextBlock.builder().text("Content").build()) .docId("doc-123") .chunkId("chunk-0") .addPayload("filename", "report.pdf") .addPayload("department", "Finance") .build();
  返回:
  
  a new builder instance

类 DocumentMetadata

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DocumentMetadata

DocumentMetadata

方法详细资料

getContent

getDocId

getChunkId

getPayload

getPayloadValue

hasPayloadKey

getContentText

builder