openai · OpenAI Platform Docs
Web QA with embeddings
A step-by-step tutorial on building a retrieval-augmented generation system by crawling website content, generating embeddings, and implementing a question-answering search interface.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Web QA with embeddings
A step-by-step tutorial on building a retrieval-augmented generation system by crawling website content, generating embeddings, and implementing a question-answering search interface.
When To Use
Use when you need to implement a custom knowledge base search system that allows users to query specific website content using semantic similarity.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/web-qa-with-embeddings-workflow-guide.md | A tutorial guide explaining how to crawl a website, generate embeddings, and build a question-answering system. | Questions about a tutorial guide explaining how to crawl a website, generate embeddings, and build a question-answering system. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-bash-setup.bash | Bash commands to create a virtual environment and install required dependencies for the web QA with embeddings tutorial. | Exact payloads, commands, or snippets shown in Bash commands to create a virtual environment and install required dependencies for the web QA with embeddings tutorial. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-crawler-implement.python | A Python script that implements a web crawler and HTML parser to extract content for a web-based QA system using embeddings. | Exact payloads, commands, or snippets shown in A Python script that implements a web crawler and HTML parser to extract content for a web-based QA system using embe... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-hyperlink-extract.python | A Python function that retrieves hyperlinks from a given URL to facilitate web-based question answering with embeddings. | Exact payloads, commands, or snippets shown in A Python function that retrieves hyperlinks from a given URL to facilitate web-based question answering with embeddings. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation.python | A Python script demonstrating how to implement web-based question answering using embeddings and domain-specific hyperlink extraction. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to implement web-based question answering using embeddings and domain-specific hype... |
examples/web-qa-with-embeddings-python-crawl-implementation.python | A Python implementation of a web crawler function designed to parse URLs and store extracted text for a web QA system using embeddings. | Exact payloads, commands, or snippets shown in A Python implementation of a web crawler function designed to parse URLs and store extracted text for a web QA system... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation-2.python | A Python script demonstrating how to implement web-based question answering using OpenAI embeddings. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to implement web-based question answering using OpenAI embeddings. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation-3.python | A Python script demonstrating how to process text files and implement a web question-answering system using OpenAI embeddings. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to process text files and implement a web question-answering system using OpenAI em... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-tokenizer-usage.python | A Python script demonstrating how to use the tiktoken library to tokenize text data for the ada-002 model within a web QA workflow. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the tiktoken library to tokenize text data for the ada-002 model within a we... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-text-chunking.python | A Python function that splits text into smaller chunks based on a maximum token count for use in embedding-based retrieval. | Exact payloads, commands, or snippets shown in A Python function that splits text into smaller chunks based on a maximum token count for use in embedding-based retr... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings.python | A Python script demonstrating how to implement web-based question answering using text embeddings and pandas dataframes. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to implement web-based question answering using text embeddings and pandas dataframes. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation-4.python | A Python script demonstrating how to generate text embeddings using the OpenAI API and store them in a pandas DataFrame. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to generate text embeddings using the OpenAI API and store them in a pandas DataFrame. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-2.python | A Python script demonstrating how to load processed embeddings from a CSV file and prepare them for web-based question answering. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to load processed embeddings from a CSV file and prepare them for web-based questio... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation-5.python | A Python implementation demonstrating how to create a context for questions by finding the most similar context from a dataframe using embeddings. | Exact payloads, commands, or snippets shown in A Python implementation demonstrating how to create a context for questions by finding the most similar context from... |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-python-implementation-6.python | A Python implementation of a web question-answering function that retrieves context from a dataframe using embeddings. | Exact payloads, commands, or snippets shown in A Python implementation of a web question-answering function that retrieves context from a dataframe using embeddings. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-3.python | A Python script demonstrating how to perform web-based question answering using embeddings and a dataframe. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to perform web-based question answering using embeddings and a dataframe. |
examples/web-qa-with-embeddings-openai-web-qa-embeddings-model.response | A text response from an LLM demonstrating a web QA interaction using embeddings to handle unknown queries. | Exact payloads, commands, or snippets shown in A text response from an LLM demonstrating a web QA interaction using embeddings to handle unknown queries. |
What This Skill Covers
- This tutorial walks through a simple example of crawling a website (in this example, the OpenAI website), turning the crawled pages into embeddings using the...
- Main sections:
Setting up a web crawler,Building an embeddings index,Building a question answer system with your embeddings.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://developers.openai.com/api/docs/tutorials/web-qa-embeddings.md
