Documentation Index
Fetch the complete documentation index at: https://docs.overshoot.ai/llms.txt
Use this file to discover all available pages before exploring further.
Intro
If you’re familiar with the Chat Completion API, feel free to skip to the next section. The Chat Completion API is the building block of almost every AI application today. Quick refresher: A Chat Completion Request contains primarily two attributes:model: The model the user would like to runmessages: A structured chat-form representation of the prompt. Basically a list containing system messages, user messages (”user questions”), assistant messages and tool calls.
Example of Chat Completion request
Example of Chat Completion request
request.json
openai SDK.
Example of Chat Completion request using OpenAI python library
Example of Chat Completion request using OpenAI python library
Using Overshoot with Chat Completion
When you create a stream and connect it to your camera source, Overshoot allows you to reference parts (or all) of your stream in the message content of your Chat Completion Request with a simple URL.- Use
type=image_urlto refer to a particular frame in the video. For example, the last frame can be referenced as follows:
- Use
type=video_urlto refer to a segment in the video. Unlike the frame, a video segment must have astartandend. If noendis specified, we default tonow. For example, to refer to the last 5 seconds of the stream,
- To look at the first 5 minutes of the stream, use
start_offset_msinstead.
Stream , Overshoot gives you a handle to reference any part (or all) of the stream in any conversation with any model.
That is, you can:
- Have a model look at multiple segments of the same stream in the same converstion
- The model can also watch segments from different streams at the same time
- Have small model watch the stream for a specific event and escalate it to a bigger model
- Have multiple models watch the same stream for a given event and only escalate it if event is triggered