Instructor-js 项目教程
instructor-jsstructured extraction for llms项目地址:https://gitcode.com/gh_mirrors/in/instructor-js
1、项目的目录结构及介绍
instructor-js/
├── README.md
├── package.json
├── src/
│ ├── client.ts
│ ├── index.ts
│ ├── instructor.ts
│ ├── modes/
│ │ ├── function.ts
│ │ ├── json.ts
│ │ └── tools.ts
│ ├── utils/
│ │ ├── debug.ts
│ │ └── helpers.ts
├── tsconfig.json
└── .gitignore
- README.md: 项目说明文件,包含项目的基本介绍和使用指南。
- package.json: 项目的依赖管理文件,包含项目的依赖包和脚本命令。
- src/: 源代码目录。
- client.ts: 客户端模块,用于与LLM流进行交互。
- index.ts: 项目的入口文件。
- instructor.ts: 核心模块,包含Instructor类的实现。
- modes/: 不同模式的实现,如函数模式、JSON模式等。
- utils/: 工具函数目录,包含调试和辅助函数。
- tsconfig.json: TypeScript配置文件。
- .gitignore: Git忽略文件配置。
2、项目的启动文件介绍
项目的启动文件是 src/index.ts
。该文件负责初始化并导出主要的模块和功能,使得其他模块可以通过该入口文件进行调用。
// src/index.ts
export * from './instructor';
export * from './client';
3、项目的配置文件介绍
项目的配置文件主要是 tsconfig.json
和 package.json
。
tsconfig.json
tsconfig.json
是TypeScript的配置文件,定义了编译选项和项目结构。
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"outDir": "./dist",
"strict": true,
"esModuleInterop": true
},
"include": ["src"]
}
package.json
package.json
包含了项目的元数据和依赖信息,以及一些脚本命令。
{
"name": "instructor-js",
"version": "1.0.0",
"description": "Structured extraction in Typescript powered by LLMs",
"main": "dist/index.js",
"scripts": {
"build": "tsc",
"start": "node dist/index.js"
},
"dependencies": {
"zod": "^3.11.6",
"openai": "^3.1.0"
},
"devDependencies": {
"typescript": "^4.4.3"
}
}
通过这些配置文件,开发者可以轻松地构建和运行项目。
instructor-jsstructured extraction for llms项目地址:https://gitcode.com/gh_mirrors/in/instructor-js