Skip to content

feat: improve fields description #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2025
Merged

feat: improve fields description #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,8 @@ Generate a Private Deep Research from your pipeline (see official [API](https://
## Development

```bash
# Install dependencies
npm install

# Build
npm run build

npm run dev
```

### Contributing
Expand Down
11 changes: 6 additions & 5 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ const RETRIEVAL_TOOL: Tool = {
inputSchema: {
type: 'object',
properties: {
pipelineId: {
type: 'string',
description: 'The pipeline ID to retrieve documents from.',
},

question: {
type: 'string',
description: 'The term to search for.',
Expand All @@ -31,6 +28,10 @@ const RETRIEVAL_TOOL: Tool = {
type: 'number',
description: 'The number of documents to retrieve.',
},
pipelineId: {
type: 'string',
description: 'The pipeline ID to retrieve documents from. If not specified explicitly, the value of VECTORIZE_PIPELINE_ID environment variable will be used.',
},
},
required: process.env.VECTORIZE_PIPELINE_ID ? ['question', 'k'] : ['pipelineId', 'question', 'k'],
},
Expand All @@ -45,7 +46,7 @@ const DEEP_RESEARCH_TOOL: Tool = {
properties: {
pipelineId: {
type: 'string',
description: 'The pipeline ID to retrieve documents from.',
description: 'The pipeline ID to retrieve documents from. If not specified explicitly, the value of VECTORIZE_PIPELINE_ID environment variable will be used.',
},
query: {
type: 'string',
Expand Down