跳至主要内容

runGraphInFile

描述​

runGraphInFile 函数允许您执行在Rivet项目文件中定义的图形。这是开始使用Rivet最简单的方式。

语法​

function runGraphInFile(path: string, options: RunGraphOptions): Promise<Record<string, DataValue>>;

参数​

  • path (string): 表示Rivet项目文件路径的字符串。

  • options (RunGraphOptions): 一个类型为RunGraphOptions的对象。该类型用于向runGraphInFile函数传递各种参数。

返回​

返回一个解析为Record的Promise。该记录表示图处理完成后的输出结果。记录中的每个键对应图中输出节点的ID名称，值则是输入到该节点的数据值。

RunGraph选项​

RunGraphOptions 类型用于向 runGraphInFile 函数传递各种参数。它包含以下字段：

  • graph: 指定您要运行的graph。可以是graph的ID或显示名称。
  • inputs: 指定图的输入值。这些可以是普通的JavaScript值如"foo"，或是{type: 'string', value: 'foo'}对象。
  • context: 类似于inputs，但这些值对每个图表和子图表都可用。
  • externalFunctions: 这是定义可以从Rivet图中调用的集成点的方式。
  • openAiKey: 您的OpenAI API密钥。如果您在图中使用任何Chat节点，则此项为必填。
  • openAiOrganization: 如果您使用的是非默认的OpenAI组织，可以在此处指定您的组织。

更多详情，请参阅RunGraphOptions。

示例​

import { runGraphInFile, DataValue } from '@ironclad/rivet-node';

await runGraphInFile('./myProject.rivet', {
  graph: 'My Graph Name',
  inputs: {
    myInput: 'hello world',
  },
  context: {
    myContext: 'global value',
  },
  externalFunctions: {
    helloWorld: async (...args: unknown[]): Promise<DataValue> => {
      return {
        type: 'string',
        value: 'hello world',
      };
    },
  },
  onUserEvent: {
    myEvent: (data: DataValue): Promise<void> => {
      console.log(data);
    },
  },
  openAiKey: 'my-openai-key',
  openAiOrganization: 'my-organization',
});

另请参阅​