Prompt Buddy logoPrompt Buddy

openai · OpenAI Platform Docs

File search

Teaches how to implement the file search tool by uploading files to the File API, creating vector stores, adding files to those stores, and configuring retrieval parameters like result limits and metadata filtering.

Import to Prompt Buddy

Derived skill

Files assembled from official documentation

Viewing SKILL.md

File search

Teaches how to implement the file search tool by uploading files to the File API, creating vector stores, adding files to those stores, and configuring retrieval parameters like result limits and metadata filtering.

When To Use

Use when you need to augment a model's knowledge by enabling semantic and keyword search over a custom collection of uploaded files via vector stores.

Reference Files

FileContainsUse For
SKILL.mdEntry point: scope, routing table, and workflow.Start here.
docs/search-workflow-guide.mdA guide explaining how to use the file search tool by uploading files to the File API and managing vector stores for semantic retrieval.Questions about a guide explaining how to use the file search tool by uploading files to the File API and managing vector stores for...

What This Skill Covers

  • File search is a tool available in the Responses API. It enables models to retrieve information in a knowledge base of previously uploaded files through sema...
  • Main sections: How to use, Upload the file to the File API, Create a vector store, Add the file to the vector store, Check status.

Workflow

  1. Open the most relevant file under docs/ for the exact documented workflow and wording.
  2. Open schemas/ files for exact structured contracts.
  3. Open examples/ files for concrete requests, commands, snippets, and manifests.
  4. Do not add behavior or configuration that is not present in the attached source files.

Canonical source: https://developers.openai.com/api/docs/guides/tools-file-search.md