程序包 io.agentscope.core.rag.model

类 RetrieveConfig

java.lang.Object
io.agentscope.core.rag.model.RetrieveConfig
@Deprecated(forRemoval=true, since="2.0.0") public class RetrieveConfig extends Object
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0. The rag package is removed; integrate retrieval at the application layer.
Configuration for document retrieval operations.

This class uses the builder pattern to configure retrieval parameters such as the maximum number of results, the minimum similarity score threshold, and optional conversation history for context-aware retrieval.

  • 嵌套类概要

    嵌套类
    修饰符和类型
    类
    说明
    static class 
    RetrieveConfig.Builder
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Builder for RetrieveConfig.

  • 方法概要

    修饰符和类型
    方法
    说明
    static RetrieveConfig.Builder
    builder()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Creates a new builder instance.
    List<Msg>
    getConversationHistory()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Gets the conversation history for context-aware retrieval.
    int
    getLimit()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Gets the maximum number of documents to retrieve.
    double
    getScoreThreshold()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Gets the minimum similarity score threshold.
    String
    getVectorName()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Gets the vector name for retrieval.
    RetrieveConfig.Builder
    mutate()
    已过时, 待删除: 此 API 元素将从以后的版本中删除。
    Mutate the current instance to a new builder.

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

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 方法详细资料

    • getLimit

      public int getLimit()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Gets the maximum number of documents to retrieve.
      返回:
      the limit

    • getScoreThreshold

      public double getScoreThreshold()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Gets the minimum similarity score threshold.
      返回:
      the score threshold

    • getVectorName

      public String getVectorName()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Gets the vector name for retrieval.
      返回:
      the vector name, or null if not set

    • getConversationHistory

      public List<Msg> getConversationHistory()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Gets the conversation history for context-aware retrieval.

      This is an optional field used by knowledge bases that support multi-turn conversation context (e.g., Bailian Knowledge Base with query rewriting).

      返回:
      the conversation history, or null if not set

    • mutate

      public RetrieveConfig.Builder mutate()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Mutate the current instance to a new builder.
      返回:
      a new builder with the same values of this instance

    • builder

      public static RetrieveConfig.Builder builder()
      已过时, 待删除: 此 API 元素将从以后的版本中删除。
      Creates a new builder instance.
      返回:
      a new builder