module nemoguardrails.rails.llm.config#

用于 rails 配置的模块。

class Model#

由 rails 引擎使用的模型的配置。

通常，配置主模型，例如：{ “type”: “main”, “engine”: “openai”, “model”: “gpt-3.5-turbo-instruct” }

class Instruction#

用于自然语言指令的配置，应传递给 LLM。

class Document#

用于问答的文档的配置。

class SensitiveDataDetectionOptions#

class SensitiveDataDetection#

应检测哪些敏感数据的配置。

class MessageTemplate#

消息结构的模板。

class TaskPrompt#

将用于特定任务的提示的配置。

classmethod TaskPrompt.check_fields#

check_fields(values)

class EmbeddingSearchProvider#

嵌入搜索提供程序的配置。

class KnowledgeBaseConfig#

class CoreConfig#

核心内部机制的设置。

class InputRails#

输入 rails 的配置。

class OutputRails#

输出 rails 的配置。

class RetrievalRails#

检索 rails 的配置。

class SingleCallConfig#

主题 rails 的单 LLM 调用选项的配置。

class UserMessagesConfig#

关于如何解释用户消息的配置。

class DialogRails#

主题 rails 的配置。

class FactCheckingRailConfig#

用于事实检查 rail 的配置数据。

class RailsConfigData#

用于开箱即用的特定 rails 的配置数据。

class Rails#

特定 rails 的配置。

class RailsConfig#

用于模型和 rails 的配置对象。

TODO：为 user_messages、bot_messages 和 flows 添加类型化配置。

property RailsConfig.streaming_supported#

当前配置是否支持流式传输。

目前，如果存在输出 rails，则不支持流式传输。

method RailsConfig.from_content#

from_content(
    colang_content: Optional[str] = None,
    yaml_content: Optional[str] = None,
    config: Optional[dict] = None
)

从提供的 colang/YAML 内容/配置字典加载配置。

method RailsConfig.from_path#

from_path(
    config_path: str,
    test_set_percentage: Optional[float] = 0.0,
    test_set: Optional[Dict[str, List]] = {},
    max_samples_per_intent: Optional[int] = 0
)

从给定路径加载配置。

支持从单个文件或目录加载。

也用于测试 Guardrails 应用程序，在这种情况下，测试集是从配置文件中的意图样本随机创建的。在这种情况下，test_set_percentage 应大于 0。

如果我们想限制每个意图的样本数量，请将 max_samples_per_intent 设置为正数。 它对于测试应用程序很有用，但也用于在某些情况下限制意图中样本的数量。 对于每个意图，选择的样本是随机选择的。

classmethod RailsConfig.parse_object#

parse_object(obj)

从给定的字典解析配置对象。