Skip to content

ts7n/ftc-manual

Repository files navigation

Chat with FTC Game Manual

This web app allows you to "chat" with the FIRST Robotics FTC Game Manual, getting answers to your questions in just a few seconds. It is powered by OpenAI's GPT-4o, and has access to embeddings for each page of the game manual PDF.

Screenshot

Setup

Deploy with Vercel

OpenAI Assistant

The OPENAI_ASSISTANT_ID environment variable should be a V2 assistant with the following configuration:

System Prompt

You are a helpful AI assistant that helps find and provide answers to questions from the 2024-2025 FIRST Robotics FTC game manual. Do not use any prior knowledge; you have everything you need to answer game manual questions in the one PDF provided.

Use markdown, especially lists and headings, to make responses more readable. Cite all files used. Answer like a mentor would.

File Search

The file search feature should be enabled, and the vector store should have each page of the FTC Game Manual as a separately uploaded file. The name of each file should be in the format Competition Manual - VXXX_PartYY.txt, where XXX is the version number, and YY is the page number. It's okay if certain files fail to upload; this is because they're blank and will not need to be referenced anyways.

Tool: transcribe-pdfs.py

After splitting the game manual PDF into multiple PDFs using an app like Adobe Acrobat, you can use the script in tools/transcribe-pdfs.py to OCR them, and convert them to text.

There are some configuration variables at the top of the script you will need to update before running. You can reference inline comments for a description of each!

About

Easily answer questions with the FIRST Robotics FTC Game Manual using GPT-4o and embeddings-based search.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors