Update readme
This commit is contained in:
@@ -16,19 +16,6 @@ And then run the development server:
|
|||||||
|
|
||||||
You'll be able to access the app in development at http://development-tenant.fizzy.localhost:3006
|
You'll be able to access the app in development at http://development-tenant.fizzy.localhost:3006
|
||||||
|
|
||||||
## Working with AI features
|
|
||||||
|
|
||||||
To work on AI features you need the OpenAI API key stored in the development's credentials file. To decrypt the credentials,
|
|
||||||
you need place the key in a file `config/credentials/development.key`. You can copy the file from One Password in
|
|
||||||
"Fizzy - development.key".
|
|
||||||
|
|
||||||
To get semantic searches working for existing data you need to calculate all the vector embeds:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
Card.find_each(&:refresh_search_embedding)
|
|
||||||
Comment.find_each(&:refresh_search_embedding)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tests
|
### Tests
|
||||||
|
|
||||||
For testing OpenAI API requests, we use [VCR](https://github.com/vcr/vcr). If you want to test AI features exercising the API, you need to place the `config/credentials/test.key`
|
For testing OpenAI API requests, we use [VCR](https://github.com/vcr/vcr). If you want to test AI features exercising the API, you need to place the `config/credentials/test.key`
|
||||||
@@ -45,6 +32,18 @@ The full continuous integration tests can be run with:
|
|||||||
|
|
||||||
bin/ci
|
bin/ci
|
||||||
|
|
||||||
|
## Working with AI features
|
||||||
|
|
||||||
|
To work on AI features you need the OpenAI API key stored in the development's credentials file. To decrypt the credentials,
|
||||||
|
you need place the key in a file `config/credentials/development.key`. You can copy the file from One Password in
|
||||||
|
"Fizzy - development.key".
|
||||||
|
|
||||||
|
To get semantic searches working for existing data you need to calculate all the vector embeds:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
Card.find_each(&:refresh_search_embedding)
|
||||||
|
Comment.find_each(&:refresh_search_embedding)
|
||||||
|
```
|
||||||
|
|
||||||
## Deploying
|
## Deploying
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user