Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erikdebruijn/grokapi
An experimental Ruby Gem for chatting with Grok (with a nice DSL)
https://github.com/erikdebruijn/grokapi
Last synced: about 2 months ago
JSON representation
An experimental Ruby Gem for chatting with Grok (with a nice DSL)
- Host: GitHub
- URL: https://github.com/erikdebruijn/grokapi
- Owner: ErikDeBruijn
- License: mit
- Created: 2023-12-21T00:34:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-22T08:19:47.000Z (about 1 year ago)
- Last Synced: 2023-12-22T09:50:27.850Z (about 1 year ago)
- Language: Ruby
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GrokApi
The is an experiment out of curiosity to see if Grok, X's Brand new AI can be used programmatically. Apparently it can!
Really cool use cases are:
- Grok as a voice-assistant to be used to control your home or vehicle, etc.
- You can even ask it to output valid, well-formatted JSON enabling you to parse real-time events programmatically.
## Pre-requisites
You'll need to have a X premium+ membership. As of the time of writing this, Grok is in an early-access program, to which you can apply [here](https://grok.x.ai/).
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add grok_api
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install grok_api
## Usage
You'll need to set the following environment variables in the .env file in the root of your project:
- `GROK_BEARER_TOKEN`. The `AAAAAAAAAAAAAAAAAAAA` etc. that comes after `Bearer`
- `GROK_COOKIE`. Starts with `guest_id=v1%3A168`
- `GROK_CSRF_TOKEN`. Started with `b4caa52c` in my case.
To get the values for these variables, go to X.com in the browser, access Grok (see pre-requisites) and open the Javascript Console. Make sure the Network panel is selected and the session is being recorded.
Then perform a query on grok. Filter on `Fetch/XHR` to find a valid request. Copy the request with headers. I used Copy as cURL.
You can apply this at the top of your script, as long as you don't share that section with others:
```ruby
ENV['GROK_BEARER_TOKEN'] = 'your_token_string_here'
ENV['GROK_COOKIE'] = 'your_cookie_string_here'
ENV['GROK_CSRF_TOKEN'] = 'your_csrf_token_here'
```
Then you can start a conversation and chat with Grok:
```ruby
client = GrokApi::Client.new
client.start_conversation
client.chat do
say "Is the Improbability Drive incredible, or just highly improbable?"
chat!
end
```
The chat will be printed by default:
```
2023-12-21 01:24:00 +0100: 💬 New conversation started on "Is the Improbability Drive incredible, or just hig"
2023-12-21 01:24:00 +0100: 💬 You: Is the Improbability Drive incredible, or just highly improbable?
2023-12-21 01:24:00 +0100: 🤖 Grok: The Improbability Drive is, in fact, incredibly improbable. It's so improbable that it's almost impossible, which is what makes it so incredible. It's like finding a functioning smartphone in a pile of rocks - highly improbable, yet quite incredible if it actually happens.
```
When you continue the chat by say more, it will continue the conversation with Grok:
```
2023-12-21 17:09:40 +0100: 💬 You: From what book was that reference, again?
2023-12-21 17:12:27 +0100: 🤖 Grok: The reference to the Improbability Drive is from the book "The Hitchhiker's Guide to the Galaxy" by Douglas Adams. It's a science fiction comedy series that follows the adventures of Arthur Dent, an unwitting human hitchhiker, and his alien friend, Ford Prefect, as they journey through the galaxy after Earth is destroyed to make way for an intergalactic bypass. The Improbability Drive is a key plot device in the series, allowing their spaceship, the Heart of Gold, to travel faster than light by manipulating probability.[link](#tweet=1736401424098165204)
```
```md
## ToDo's:
- [ ] Add a dot env example someone can copy (?).
- [ ] properly support a continued conversation (keep track of and include the conversation-stack)
- [ ] auto start a conversation if we don't have one yet `start_conversation unless @conversationId`
- [ ] use streaming API to parse messages during flushing of the output buffer
- [ ] add a chat interface `bin/chat`
- [ ] host an openAI compatible API?
- [ ] Proxy?
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/erikdebruijn/GrokApi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ErikDeBruijn/GrokApi/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the GrokApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ErikDeBruijn/GrokApi/blob/main/CODE_OF_CONDUCT.md).