Skip to content

Commit

Permalink
feat(docs): Update analyze and models documentation
Browse files Browse the repository at this point in the history
- Updated the `analyze.mdx` file to include information about optional parameters and an example response.
- Fixed a typo in the `get-models.mdx` file by correcting the API endpoint URL.
- Added a hyperlink to the interactive demo page in the `models.mdx` file.

These changes improve the clarity and completeness of the documentation for analyzing messages and exploring models.
  • Loading branch information
BillChirico committed Nov 18, 2023
1 parent 380bc7c commit 732f84c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/endpoints/analyze.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ slug: /endpoints/analyze
---

# Analyze Endpoint

To analyze a message all you have to do is send a `POST` request to the following endpoint:
```
https://apollo.volvox.tech/api/analyze
Expand All @@ -24,6 +25,7 @@ X-Volvox-Api-Key: <YOUR_API_KEY>
```

### Optional Parameters

If you wish to only have select models be returned you can add
```json
modelNames: ["<MODEL_NAME>", "<MODEL_NAME>"]
Expand All @@ -40,6 +42,7 @@ curl https://apollo.volvox.tech/api/analyze -X POST
```

### Example Response

```json
[
{
Expand Down
2 changes: 1 addition & 1 deletion docs/endpoints/get-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ https://apollo.volvox.tech/api/analyze/models

### Example Request
```json
curl 'https://apollo.volvox.tech/api/Analyzer/Models'
curl 'https://apollo.volvox.tech/api/analyze/models'
```

### Example Response
Expand Down
3 changes: 2 additions & 1 deletion docs/metrics & models/models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,6 @@ Input = `I think you're adorable. Do you want to go on a date after work? Maybe
```

### Demo

Experience the capabilities of our models firsthand by testing your own inputs.
Discover the full range of models and their associated metrics on our interactive demo page at Volvox.Apollo.
Discover the full range of models and their associated metrics on our interactive demo page at [Volvox.Apollo](https://apollo.volvox.tech/).

0 comments on commit 732f84c

Please sign in to comment.