上下文.dev Convex 组件

打电话 背景情况.dev API 从您的 Convex 动作。 此组件将 Contex.dev REST API 与已键入的助手和孤立的组件动作相接- 没有数据存储在 Convex 中 .

先决条件

• 一个 Convex app (开始(中文(简体) )
• A 类 背景.dev API 密钥

安装

npm install @context-dot-dev/convex

设置

将组件添加到您的 Convex app 配置中,并通过组件 env 连接您的 API 密钥 :

import contextDev from "@context-dot-dev/convex/convex.config.js";
import { defineApp } from "convex/server";
import { v } from "convex/values";

const app = defineApp({
  env: {
    CONTEXT_DEV_API_KEY: v.string(),
  },
});

app.use(contextDev, {
  env: {
    CONTEXT_DEV_API_KEY: app.env.CONTEXT_DEV_API_KEY,
  },
});

export default app;

设定 CONTEXT_DEV_API_KEY 在您的对流部署中:

npx convex env set CONTEXT_DEV_API_KEY your_api_key_here
npx convex dev

使用量

已键入帮助客户端( 建议)

创建共享客户端并从您的动作中调用 :

import { ContextDev } from "@context-dot-dev/convex";
import { v } from "convex/values";

import { components } from "./_generated/api.js";
import { action } from "./_generated/server.js";

const contextDev = new ContextDev(components.contextDev);

export const brand = action({
  args: { domain: v.string() },
  handler: async (ctx, args) => {
    return await contextDev.retrieveBrand(ctx, {
      params: { domain: args.domain },
    });
  },
});

export const scrapeMarkdown = action({
  args: { url: v.string() },
  handler: async (ctx, args) => {
    return await contextDev.scrapeMarkdown(ctx, {
      params: { url: args.url },
    });
  },
});

直接组成部分行动

也可以直接调用组件动作 ctx.runAction数字 :

import { v } from "convex/values";

import { components } from "./_generated/api.js";
import { action } from "./_generated/server.js";

export const brand = action({
  args: { domain: v.string() },
  handler: async (ctx, args) => {
    return await ctx.runAction(components.contextDev.brand.retrieve, {
      params: { domain: args.domain },
    });
  },
});

API 参考

获得终点 params后端点 body 也可以采取 params 当操作定义了查询参数时。 回复在恢复功能前被验证为JSON.

帮助方法

构成部分行动小组

原始组成部分行动可在下列项下提供:

• components.contextDev.brand
• components.contextDev.web
• components.contextDev.ai
• components.contextDev.industry
• components.contextDev.people

从上下文推断出参数和响应类型.dev OpenAPI spec, 因此您的编辑器将自动完成 params 财务报告和审定财务报表 body 字段.

缓存

这一构成部分在Convex的数据中没有持久性。 上下文.dev 缓存通过 API 参数控制,例如 maxAgeMs 个人请求.

学多点

• 背景. dev 文档
• 对流组件