Skip to content

Add table of contents to README #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,50 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i

[🚢 Hire me](https://peaceterms.com?utm_source=ruby-openai&utm_medium=readme&utm_id=26072023) | [🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)

# Table of Contents

- [Installation](#installation)
- [Bundler](#bundler)
- [Gem Install](#gem-install)
- [Usage](#usage)
- [Quickstart](#quickstart)
- [With Config](#with-config)
- [Custom timeout or base URI](#custom-timeout-or-base-uri)
- [Extra Headers per Client](#extra-headers-per-client)
- [Verbose Logging](#verbose-logging)
- [Azure](#azure)
- [Counting Tokens](#counting-tokens)
- [Models](#models)
- [Chat](#chat)
- [Streaming Chat](#streaming-chat)
- [Vision](#vision)
- [JSON Mode](#json-mode)
- [Functions](#functions)
- [Edits](#edits)
- [Embeddings](#embeddings)
- [Files](#files)
- [Finetunes](#finetunes)
- [Assistants](#assistants)
- [Threads and Messages](#threads-and-messages)
- [Runs](#runs)
- [Runs involving function tools](#runs-involving-function-tools)
- [Image Generation](#image-generation)
- [Image Edit](#image-edit)
- [Image Variations](#image-variations)
- [Moderations](#moderations)
- [Whisper](#whisper)
- [Translate](#translate)
- [Transcribe](#transcribe)
- [Speech](#speech)
- [Errors](#errors)
- [Development](#development)
- [Release](#release)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)

## Installation

### Bundler

Add this line to your application's Gemfile:
Expand Down