Skip to content

Commit e310d84

Browse files
authored
feat: improve fields description (#6)
1 parent 8b6062d commit e310d84

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,8 @@ Generate a Private Deep Research from your pipeline (see official [API](https://
8585
## Development
8686

8787
```bash
88-
# Install dependencies
8988
npm install
90-
91-
# Build
92-
npm run build
93-
89+
npm run dev
9490
```
9591

9692
### Contributing

src/index.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@ const RETRIEVAL_TOOL: Tool = {
1919
inputSchema: {
2020
type: 'object',
2121
properties: {
22-
pipelineId: {
23-
type: 'string',
24-
description: 'The pipeline ID to retrieve documents from.',
25-
},
22+
2623
question: {
2724
type: 'string',
2825
description: 'The term to search for.',
@@ -31,6 +28,10 @@ const RETRIEVAL_TOOL: Tool = {
3128
type: 'number',
3229
description: 'The number of documents to retrieve.',
3330
},
31+
pipelineId: {
32+
type: 'string',
33+
description: 'The pipeline ID to retrieve documents from. If not specified explicitly, the value of VECTORIZE_PIPELINE_ID environment variable will be used.',
34+
},
3435
},
3536
required: process.env.VECTORIZE_PIPELINE_ID ? ['question', 'k'] : ['pipelineId', 'question', 'k'],
3637
},
@@ -45,7 +46,7 @@ const DEEP_RESEARCH_TOOL: Tool = {
4546
properties: {
4647
pipelineId: {
4748
type: 'string',
48-
description: 'The pipeline ID to retrieve documents from.',
49+
description: 'The pipeline ID to retrieve documents from. If not specified explicitly, the value of VECTORIZE_PIPELINE_ID environment variable will be used.',
4950
},
5051
query: {
5152
type: 'string',

0 commit comments

Comments
 (0)