@crvouga/ mockingbird-service-lamacloud (中文(简体) )

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 拉玛克卢德 用于测试套件的平台 API(LlamaIndex管理索引): 项目和管道查询、管道文件(清单、获取、插入、更新、删除),以及 检索。 检索是决定性的:当测试设定一个时,一个脚本答案,否则就是 周期重叠对编审中文件的排名。 聊天知识工具 (单位:千美元)search_health_knowledge, (中文(简体) ), search_faq)和EMR聊天人-admin 知识 CRUD 运行对手 它没有供应商账户,没有嵌入,也没有决定.

• 行动范围: 支助
• 合同openapi.yaml()由Python客户端的官方电线模型手写 我们的后端适配器.

安装

npm install -D @crvouga/mockingbird-service-llamacloud

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-llamacloud serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与 任何获取服务器.

使用量

npx mockingbird-llamacloud serve --port 8805 --index acme-member-kb-v1 --project Default

对准应用程序:

import LlamaCloud from "@llamaindex/llama-cloud"
import { createRuntime } from "@crvouga/mockingbird-service-llamacloud"

// Test setup: a pipeline, and what retrieval answers for queries mentioning "apob".
// Anything else is ranked by term overlap over the documents the app upserted.
const emulator = createRuntime({ pipelines: [{ name: "acme-member-kb-v1", projectName: "Default" }] })
await emulator.fetch(
  new Request("http://llamacloud.test/__admin/retrieval", {
    method: "PUT",
    headers: { "content-type": "application/json" },
    body: JSON.stringify({
      match: { contains: "apob" },
      nodes: [{ text: "ApoB counts atherogenic particles.", score: 0.92, metadata: { file_name: "apob.md" } }],
    }),
  }),
)

// The LlamaCloud SDK your application already uses. Only its fetch changes: requests reach
// the emulator in this process instead of api.cloud.llamaindex.ai.
const llama = new LlamaCloud({
  apiKey: "llx-mockingbird",
  fetch: (url: RequestInfo | URL, init?: RequestInit) => emulator.fetch(new Request(url, init)),
})
const [pipeline] = await llama.pipelines.list({ project_name: "Default", pipeline_name: "acme-member-kb-v1" })
const { retrieval_nodes } = await llama.pipelines.retrieve(pipeline?.id ?? "", { query: "What does ApoB measure?" })
console.log(retrieval_nodes[0]?.node.text, retrieval_nodes[0]?.score) // ApoB counts atherogenic particles. 0.92

路线

全部在 Authorization: Bearer <key> (任何非空密钥,除非 apiKeys 已设定). 错误是 FastAPI 形状 : {"detail": "…"},以及422个 {"detail": [{loc, msg, type}]}。 。 。 .

检索

1. 作是语已. PUT /__admin/retrieval {match: {contains?, pipeline?}, nodes: [{text, score?, metadata?}]} 增加一条规则。 最近增加的规则 contains 在查询中显示 (对案件不敏感) pipeline (身份或名称)匹配其 nodes 逐字记录, 被截至上克. 一个没有分数的节点得到1,0.9,0.8,. . scripted_<n>。 。 。 .
2. 默认: 术语重叠 . 术语是小写字母数字词 2+ 字符减 常见止语. 文档的分数是查询中在它的 文本或内容 metadata.title,四舍五入到4个位置。 不匹配的文件被丢弃并绑定 保持插入顺序。 每个文档都是一个节点(id_: "<docId>_0")及其元数据收益 document_id 财务报告和审定财务报表 pipeline_id,后端读取的字段.

节点元数据在两者下发送 metadata (通过我们的后端阅读)和 extra_info (单位:千美元) 官方客户端模型的字段名). 没有身份证明, 谁是真正的API 发送是未经证实的.

Python 聊天 SDK: 经核实的呼叫序列

目录中将此列为未核实. 现已与安装的SDK核对: 拉玛-云层服务 0.6.88 (中文(简体) )拉玛-云 0.1.45 (中文(简体) ) 和马拉马指数核心 0.14.10 (中文(简体) ),则 版本消费者应用的Python聊天服务针. 车轮被读取 llamacloud.sdk.test.ts 运行服务的真实 LlamaCloudClient 在真实的 SDK 相对 模拟器. LlamaCloudIndex(name, project_name=…, api_key=…) 接下来是 .as_retriever(similarity_top_k=5).aretrieve(q) 发出这些呼吁:

1. GET /api/v1/projects?project_name=<name>数字 : resolve_project。没有匹配加价 No project found with name …,并且不止一场比赛也提高了.
2. GET /api/v1/pipelines?project_id=<id>&pipeline_name=<index>&pipeline_type=MANAGED数字 : resolve_pipeline。没有匹配加价 Unknown index name …。 。 。 .
3. GET /api/v1/pipelines/{id},则 GET /api/v1/projects/{project_id}数字 : as_retriever() 构建一个 LlamaCloudRetriever(project_id=…, pipeline_id=…),它再次通过id解决了两者.
4. POST /api/v1/pipelines/{id}/retrieve {query, dense_similarity_top_k: 5}。 。 。 .

基础 URL 来源 base_url 或者说 LLAMA_CLOUD_BASE_URL后退为 https://api.cloud.llamaindex.ai (单位:千美元)llama_index.core.ingestion.api_utils.get_client) (中文(简体) ). 这个 客户端没有通过 base_url,所以设置环境变量就够了。 SDK的烟花型号 严格: Pipeline.status 必须是 CREATED 或者说 DELETING,以及 embedding_config 实值 所需经费。 模拟器既能满足两者,而SDK测试如果形状漂移会失败.

差异 : python 客户端 llamacloud_project_name 默认为 "default" (小写. 这个 后端的默认值是 "Default". 项目检查准确,所以需要 LLAMACLOUD_PROJECT_NAME=Default,或种子 default 项目。 否则,客户会退化 以空取结果表示,接受测试涵盖这些结果.

运行 SDK 测试 :

uv venv /tmp/llama && VIRTUAL_ENV=/tmp/llama uv pip install \
  llama-cloud-services==0.6.88 llama-cloud==0.1.45 llama-index-core==0.14.10
MOCKINGBIRD_LLAMACLOUD_PYTHON=/tmp/llama/bin/python \
  MOCKINGBIRD_LLAMACLOUD_PY_CLIENT=/path/to/llamacloud_client.py bun test llamacloud.sdk

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets:

命名空间

消费者都无法添加信头,因此可以选择三个方式:

• 页:1 x-mockingbird-namespace 页眉;
• (单位:千美元) /__admin/ns/<name> 基准 URL 前缀;
• aPI 密钥 : PUT /__admin/credentials {"credentials": {"<LLAMACLOUD_API_KEY>": "<namespace>"}}。 。 。 .

每个命名空间从种子管道开始,默认情况下 acme-member-kb-v1 在项目中 Default。请求的日记记录了操作编号、状态和管道及文件编号。 这个 从不记录查询、文档文本或标题.

故意不模拟

• 真实的检索质量:没有嵌入,分块,混合搜索,重新排序,元数据过滤器, 图像或页面图节点,或 retrieval_mode 出行路线. 文件总是一个节点.
• 管道摄入状态和同步任务. 可立即取回上层文档.
• 文件上传( E)/api/v1/files, (中文(简体) ), pipeline_files),数据源,解析(LlamaParse)和 提取.
• 通过API创建项目或管道. 使用种子或 PUT /__admin/pipelines。 。 。 .
• 每个命名空间一个以上的组织.

API 密码

部分 嘲笑鸟。 。 。 .