fix: Minor updates on the docs #56
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noble-varghese
added
the
documentation
README.md
Outdated
| @@ -173,17 +173,21 @@ print(response.choices[0].message) | |||
| | Force Cache Refresh | `cache_force_refresh` | `True`, `False` (Boolean) | ❔ Optional | | |||
| | Cache Age | `cache_age` | `integer` (in seconds) | ❔ Optional | | |||
| | Trace ID | `trace_id` | `string` | ❔ Optional | | |||
| | Retries | `retry` | `integer` [0,5] | ❔ Optional | | |||
| | Retries | `retry` | `json object` - See details below | ❔ Optional | | |||
There was a problem hiding this comment.
It'll help if we can add a JSON example here directly. Let's not worry about the table structure as it's more important I think to have these details in a single place
So, the text here can say:
{dict} with two required keys: "attempts" which expects integers in [0,5] and "on_status_codes" which expects array of status codes like [429,502]
Example: { "attempts": 5, "on_status_codes":[429,500] }
README.md
Outdated
| | Metadata | `metadata` | `json object` [More info](https://docs.portkey.ai/key-features/custom-metadata) | ❔ Optional | | ||
|
|
||
| **Retries Details:** |
There was a problem hiding this comment.
We can remove this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixing some nit-pick changes on the docs.