import openai from "../../openai.app.mjs";
import common from "../common/common.mjs";
import constants from "../../common/constants.mjs";
export default {
...common,
name: "Chat using File Search",
version: "0.0.6",
key: "openai-chat-using-file-search",
description: "Chat with your files knowledge base (vector stores). [See the documentation](https://platform.openai.com/docs/guides/tools-file-search)",
type: "action",
props: {
openai,
alert: {
type: "alert",
alertType: "info",
content: "To use this action, you need to have set up a knowledge base in a vector store and uploaded files to it. [More infomation here](https://platform.openai.com/docs/guides/tools-file-search?lang=javascript#overview).",
},
modelId: {
propDefinition: [
openai,
"chatCompletionModelId",
],
},
vectorStoreId: {
propDefinition: [
openai,
"vectorStoreId",
],
description: "The identifier of a vector store. Currently supports only one vector store at a time",
},
input: {
type: "string",
label: "Chat Input",
description: "Text inputs to the model used to generate a response",
},
instructions: {
type: "string",
label: "Instructions",
description: "Inserts a system (or developer) message as the first item in the model's context",
optional: true,
},
includeSearchResults: {
type: "boolean",
label: "Include Search Results",
description: "Include the search results in the response",
default: false,
optional: true,
},
maxNumResults: {
type: "integer",
label: "Max Number of Results",
description: "Customize the number of results you want to retrieve from the vector store",
optional: true,
},
metadataFiltering: {
type: "boolean",
label: "Metadata Filtering",
description: "Configure how the search results are filtered based on file metadata",
optional: true,
reloadProps: true,
},
previousResponseId: {
type: "string",
label: "Previous Response ID",
description: "The unique ID of the previous response to the model. Use this to create multi-turn conversations",
optional: true,
},
truncation: {
type: "string",
label: "Truncation",
description: "Specifies the truncation mode for the response if it's larger than the context window size",
optional: true,
default: "auto",
options: [
"auto",
"disabled",
],
},
responseFormat: {
type: "string",
label: "Response Format",
description: "- **Text**: Returns unstructured text output.\n- **JSON Schema**: Enables you to define a [specific structure for the model's output using a JSON schema](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses).",
options: [
"text",
"json_schema",
],
default: "text",
optional: true,
reloadProps: true,
},
skipThisStep: {
type: "boolean",
label: "Skip This Step",
description: "Pass in a boolean custom expression to skip this step's execution at runtime",
optional: true,
default: false,
},
},
additionalProps() {
const {
modelId,
metadataFiltering,
responseFormat,
} = this;
const props = {};
if (this.openai.isReasoningModel(modelId)) {
props.reasoningEffort = {
type: "string",
label: "Reasoning Effort",
description: "Constrains effort on reasoning for reasoning models",
optional: true,
options: [
"low",
"medium",
"high",
],
};
}
if (metadataFiltering) {
props.filters = {
type: "object",
label: "Filters",
description: "Filter the search results based on file metadata. [See the documentation here](https://platform.openai.com/docs/guides/retrieval#attribute-filtering)",
};
}
if (responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
props.jsonSchema = {
type: "string",
label: "JSON Schema",
description: "Define the schema that the model's output must adhere to. [Generate one here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
};
}
return props;
},
methods: {
...common.methods,
},
async run({ $ }) {
if (this.skipThisStep) {
$.export("$summary", "Step execution skipped");
return;
}
const data = {
model: this.modelId,
input: this.input,
instructions: this.instructions,
previous_response_id: this.previousResponseId,
truncation: this.truncation,
tools: [
{
type: "file_search",
vector_store_ids: [
this.vectorStoreId,
],
max_num_results: this.maxNumResults,
},
],
};
if (this.includeSearchResults) {
data.include = [
"output[*].file_search_call.search_results",
];
}
if (this.filters) {
data.tools[0].filters = this.filters;
}
if (this.openai.isReasoningModel(this.modelId) && this.reasoningEffort) {
data.reasoning = {
...data.reasoning,
effort: this.reasoningEffort,
};
}
if (this.openai.isReasoningModel(this.modelId) && this.generateSummary) {
data.reasoning = {
...data.reasoning,
generate_summary: this.generateSummary,
};
}
if (this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
try {
data.text = {
format: {
type: this.responseFormat,
...JSON.parse(this.jsonSchema),
},
};
} catch (error) {
throw new Error("Invalid JSON format in the provided JSON Schema");
}
}
const response = await this.openai.responses({
$,
data,
});
if (response) {
$.export("$summary", `Successfully sent chat with id ${response.id}`);
$.export("chat_responses", response.output);
}
return response;
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.