Skip to content

Commit

Permalink
Fixes for README.md w/ yard
Browse files Browse the repository at this point in the history
  • Loading branch information
ksylvest committed Oct 16, 2024
1 parent b3f18a3 commit 822f789
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ OmniAI standardizes the APIs of various AI / LLM companies such as Anthropic, Go

## Examples

### Example #1: [Chat](examples/chat)
### Example #1: [Chat](https://github.com/ksylvest/omniai/blob/main/examples/chat)

```ruby
require 'omniai/anthropic'
Expand All @@ -38,7 +38,7 @@ The animals in the photos are:
2. A dog (*Canis familiaris*).
```

### Example #2: [Text-to-Speech](examples/text_to_speech)
### Example #2: [Text-to-Speech](https://github.com/ksylvest/omniai/blob/main/examples/text_to_speech)

```ruby
require 'omniai/openai'
Expand All @@ -52,7 +52,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'wb') do |file|
end
```

### Example #3: [Speech-to-Text](examples/speech_to_text)
### Example #3: [Speech-to-Text](https://github.com/ksylvest/omniai/blob/main/examples/speech_to_text)

```ruby
require 'omniai/openai'
Expand All @@ -65,7 +65,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'rb') do |file|
end
```

### Example #4: [Tools](examples/tools)
### Example #4: [Tools](https://github.com/ksylvest/omniai/blob/main/examples/tools)

```ruby
require 'omniai/google'
Expand Down Expand Up @@ -98,7 +98,7 @@ puts(completion.text)
The weather is 24° celcius in London and 42° fahrenheit in Seattle.
```

### Example #5: [Embeddings](examples/embeddings)
### Example #5: [Embeddings](https://github.com/ksylvest/omniai/blob/main/examples/embeddings)

```ruby
require 'omniai/mistral'
Expand Down Expand Up @@ -211,7 +211,7 @@ require 'omniai/openai'
require 'logger'

logger = Logger.new(STDOUT)
client = OmniAI::Example::Client.new(logger:)
client = OmniAI::OpenAI::Client.new(logger:)
```

```
Expand Down

0 comments on commit 822f789

Please sign in to comment.