From f8624587be45db5cce16638d26984865fdcfb9ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Boschi?= Date: Fri, 28 Mar 2025 16:11:23 +0100 Subject: [PATCH] feat: improve fields description --- README.md | 6 +----- src/index.ts | 11 ++++++----- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4d9ad89..f21c49d 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/index.ts b/src/index.ts index c046cc1..94b5f01 100644 --- a/src/index.ts +++ b/src/index.ts @@ -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.', @@ -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'], }, @@ -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',