[AIG]Initial websocket documentation #18247
Merged
Conversation
This file contains hidden or 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
daisyfaithauma
requested review from
a team,
G4brym,
kathayl and
mchenco
as code owners
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Deploying cloudflare-docs with
|
| Latest commit: |
2368b00
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e40745c1.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://aig-websockets.cloudflare-docs-7ou.pages.dev |
github-actions
bot
added
product:ai-gateway
Contributor
G4brym
approved these changes
Nov 18, 2024
kathayl
reviewed
Nov 18, 2024
|
|
||
| ## Setting up | ||
|
|
||
| 1. Generate an AI Gateway token with appropriate AI Gateway Run and opt in to using an authenticated gateway. |
Contributor
There was a problem hiding this comment.
is this the correct way to show RUN permission?
Contributor
Author
There was a problem hiding this comment.
I got it right off the documentation.
kathayl
reviewed
Nov 18, 2024
| ``` | ||
| wss://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id} | ||
| ``` | ||
| 3. Open a WebSocket connection authenticated with a Cloudflare token with the AI Gateway Run permission. |
Contributor
There was a problem hiding this comment.
is this the correct way to show RUN permission?
Contributor
Author
There was a problem hiding this comment.
I got it right off the documentation.
kathayl
reviewed
Nov 18, 2024
|
|
||
| The above will send a request to Workers AI Inference API, if it fails it will proceed to OpenAI. You can add as many fallbacks as you need, just by adding another JSON in the array. | ||
|
|
||
| ## Websockets API (beta) |
Contributor
There was a problem hiding this comment.
should beta be in words or be the beta label
Maddy-Cloudflare
approved these changes
Nov 19, 2024
Co-authored-by: Maddy <[email protected]>
harshil1712
pushed a commit
that referenced
this pull request
Dec 3, 2024
* Initial websocket documentation * Update src/content/docs/ai-gateway/get-started.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Update src/content/docs/ai-gateway/providers/universal.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Update src/content/docs/ai-gateway/configuration/websockets-api.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Update src/content/docs/ai-gateway/configuration/websockets-api.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Update src/content/docs/ai-gateway/configuration/websockets-api.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * grammar * Update websockets-api.mdx * added a badge * Update src/content/docs/ai-gateway/configuration/websockets-api.mdx Co-authored-by: Maddy <[email protected]> --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Kathy <[email protected]> Co-authored-by: Maddy <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Summary
Initial websocket documentation
Screenshots (optional)
Documentation checklist