模式
LangSmith API 的模式。
module-attribute ¶
与运行关联的附件。每个条目都是一个 (mime_type, bytes) 或 (mime_type, file_path) 的元组。
基类：NamedTuple
如果使用，将被存储为附件的注解类型。
示例
.. code-block:: python
from langsmith import traceable
from langsmith.schemas import Attachment
@traceable
def my_function(bar: int, my_val: Attachment):
# my_val will be stored as an attachment
# bar will be stored as inputs
return bar
基类： ExampleBase
示例模型。
| 方法 | 描述 |
|---|---|
__init__ |
初始化一个 Dataset 对象。 |
__repr__ |
返回 RunBase 对象的字符串表示。 |
基类: BaseModel
基础运行模式。
“运行” (Run) 是一个跨度 (span)，表示您 LLM 应用中的单个工作或操作单元。这可能是一次对 LLM 或链的调用，一次对提示格式化的调用，或一次对可运行 lambda 的调用。如果您熟悉 OpenTelemetry，您可以将“运行”看作一个跨度。
| 方法 | 描述 |
|---|---|
__repr__ |
返回 RunBase 对象的字符串表示。 |
instance-attribute ¶
run_type: str
运行的类型，例如 tool、chain、llm、retriever、embedding、prompt、parser。
class-attribute instance-attribute ¶
与运行相关的附加元数据或设置。
class-attribute instance-attribute ¶
reference_example_id: UUID | None = None
对此运行可能基于的示例的引用。
class-attribute instance-attribute ¶
parent_run_id: UUID | None = None
父运行的标识符，如果此运行是子运行。
class-attribute instance-attribute ¶
attachments: Attachments | dict[str, AttachmentInfo] = Field(default_factory=dict)
与运行关联的附件。每个条目都是 (mime_type, bytes) 的元组。
模式的配置类。
基类： RunBase
从数据库加载时的运行模式。
| 方法 | 描述 |
|---|---|
__init__ |
初始化一个 Run 对象。 |
__repr__ |
返回 RunBase 对象的字符串表示。 |
class-attribute instance-attribute ¶
已弃用：此运行的子运行 ID。
class-attribute instance-attribute ¶
此运行的子运行，如果通过客户端指示加载。默认情况下不会填充这些数据，因为这是一个较重的查询。
class-attribute instance-attribute ¶
此运行的反馈统计信息。
class-attribute instance-attribute ¶
completion_tokens: int | None = None
作为输出生成的令牌数量。
class-attribute instance-attribute ¶
提示（输入）令牌计数的明细。
不需要与总提示令牌数相加。
class-attribute instance-attribute ¶
补全（输出）令牌计数的明细。
不需要与总补全令牌数相加。
class-attribute instance-attribute ¶
first_token_time: datetime | None = None
第一个令牌被处理的时间。
class-attribute instance-attribute ¶
total_cost: Decimal | None = None
与补全令牌相关的总估计 LLM 成本。
class-attribute instance-attribute ¶
prompt_cost: Decimal | None = None
与提示（输入）令牌相关的估计成本。
class-attribute instance-attribute ¶
completion_cost: Decimal | None = None
与补全令牌相关的估计成本。
class-attribute instance-attribute ¶
提示（输入）令牌成本的明细。
不需要与总提示令牌成本相加。
class-attribute instance-attribute ¶
补全（输出）令牌成本的明细。
不需要与总补全令牌成本相加。
class-attribute instance-attribute ¶
父运行 ID 的列表。
class-attribute instance-attribute ¶
运行的点状顺序。
这是一个由 {time}{run-uuid}.* 组成的字符串，以便追踪可以按其执行顺序排序。
示例
- 父级：20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
- 子级
- 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
- 20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
property ¶
output_token_details 的别名。
property ¶
prompt_cost_details 的别名。
property ¶
completion_cost_details 的别名。
instance-attribute ¶
run_type: str
运行的类型，例如 tool、chain、llm、retriever、embedding、prompt、parser。
class-attribute instance-attribute ¶
与运行相关的附加元数据或设置。
class-attribute instance-attribute ¶
reference_example_id: UUID | None = None
对此运行可能基于的示例的引用。
class-attribute instance-attribute ¶
parent_run_id: UUID | None = None
父运行的标识符，如果此运行是子运行。
class-attribute instance-attribute ¶
attachments: Attachments | dict[str, AttachmentInfo] = Field(default_factory=dict)
与运行关联的附件。每个条目都是 (mime_type, bytes) 的元组。
模式的配置类。
基类： RunBase
带有标注队列信息的运行模式。
| 方法 | 描述 |
|---|---|
__repr__ |
返回 RunBase 对象的字符串表示。 |
class-attribute instance-attribute ¶
last_reviewed_time: datetime | None = None
此运行的最后审查时间。
instance-attribute ¶
run_type: str
运行的类型，例如 tool、chain、llm、retriever、embedding、prompt、parser。
class-attribute instance-attribute ¶
与运行相关的附加元数据或设置。
class-attribute instance-attribute ¶
reference_example_id: UUID | None = None
对此运行可能基于的示例的引用。
class-attribute instance-attribute ¶
parent_run_id: UUID | None = None
父运行的标识符，如果此运行是子运行。
class-attribute instance-attribute ¶
attachments: Attachments | dict[str, AttachmentInfo] = Field(default_factory=dict)
与运行关联的附件。每个条目都是 (mime_type, bytes) 的元组。
模式的配置类。
基类: BaseModel
反馈模式。
class-attribute instance-attribute ¶
feedback_source: FeedbackSourceBase | None = None
反馈的来源。
class-attribute instance-attribute ¶
session_id: UUID | None = None
此反馈记录所关联的项目 ID（Session = Project）。
class-attribute instance-attribute ¶
comparative_experiment_id: UUID | None = None
如果在“比较实验”中记录，这是实验的 ID。
class-attribute instance-attribute ¶
feedback_group_id: UUID | None = None
对于偏好评分，此组 ID 在被比较的组中每个运行的反馈之间共享。
run in the group that was being compared.
模式的配置类。
基类：TypedDict
表示应该*如何*解释反馈值。
instance-attribute ¶
categories: list[FeedbackCategory] | None
如果反馈是分类的，这定义了服务器将接受的有效类别。不适用于连续或自由形式的反馈类型。
基类：FeedbackBase
用于创建反馈的模式。
class-attribute instance-attribute ¶
feedback_config: FeedbackConfig | None = None
反馈的配置
class-attribute instance-attribute ¶
session_id: UUID | None = None
此反馈记录所关联的项目 ID（Session = Project）。
class-attribute instance-attribute ¶
comparative_experiment_id: UUID | None = None
如果在“比较实验”中记录，这是实验的 ID。
class-attribute instance-attribute ¶
feedback_group_id: UUID | None = None
对于偏好评分，此组 ID 在被比较的组中每个运行的反馈之间共享。
run in the group that was being compared.
模式的配置类。
基类：FeedbackBase
用于获取反馈的模式。
class-attribute instance-attribute ¶
feedback_source: FeedbackSourceBase | None = None
反馈的来源。在这种情况下
class-attribute instance-attribute ¶
session_id: UUID | None = None
此反馈记录所关联的项目 ID（Session = Project）。
class-attribute instance-attribute ¶
comparative_experiment_id: UUID | None = None
如果在“比较实验”中记录，这是实验的 ID。
class-attribute instance-attribute ¶
feedback_group_id: UUID | None = None
对于偏好评分，此组 ID 在被比较的组中每个运行的反馈之间共享。
run in the group that was being compared.
模式的配置类。
基类: BaseModel
关于 LangSmith 服务器的信息。
class-attribute instance-attribute ¶
license_expiration_time: datetime | None = None
许可证到期的时间。
class-attribute instance-attribute ¶
batch_ingest_config: BatchIngestConfig | None = None
实例标志。
基类: BaseModel
表示带有元数据的提示（Prompt）。
class-attribute instance-attribute ¶
original_repo_id: str | None = None
原始提示的 ID（如果已派生）。
class-attribute instance-attribute ¶
upstream_repo_id: str | None = None
上游提示的 ID（如果已派生）。
class-attribute instance-attribute ¶
liked_by_auth_user: bool | None = None
提示是否被已认证用户点赞。
class-attribute instance-attribute ¶
last_commit_hash: str | None = None
最后一次提交的哈希值。
用于提示排序字段的枚举。
基类：TypedDict
消息的使用元数据，例如令牌计数。
这是跨模型一致的令牌使用情况的标准表示。
instance-attribute ¶
input_token_details: NotRequired[InputTokenDetails]
输入令牌计数的细分。
不需要总计为完整的输入令牌数。不需要包含所有键。
instance-attribute ¶
output_token_details: NotRequired[OutputTokenDetails]
输出令牌计数的细分。
不需要总计为完整的输出令牌数。不需要包含所有键。
instance-attribute ¶
input_cost_details: NotRequired[InputCostDetails]
输入令牌的成本详情。
instance-attribute ¶
output_cost_details: NotRequired[OutputCostDetails]
输出令牌的成本详情。