Add documentation for AI bindings inputs #19295
Closed
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
thomasgauvin
requested review from
a team,
craigsdennis,
daisyfaithauma,
markdembo,
mchenco and
rita3ko
as code owners
github-actions
bot
added
the
product:workers-ai
github-actions
bot
assigned
craigsdennis,
daisyfaithauma,
markdembo,
mchenco and
rita3ko
thomasgauvin
commented
Jan 18, 2025
Deploying cloudflare-docs with
|
| Latest commit: |
4f0890e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://10d75481.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://thomasgauvin-patch-6.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
Contributor
|
Hmmm... Probably better to guide to the model page right? I didn't know this page had code samples on it! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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.
The AI bindings inputs (as far as I can tell) are undocumented. This PR adds some documentation for these.
Workers AI bindings inputs are currently partially documented, which may lead developers confused as they expect the docs to be exhaustive.
This adds docs based on REST API documentation and the types defined in the workers-sdk codebase. https://developers.cloudflare.com/api/resources/ai/methods/run/#(params)%200%20%3E%20(param)%20body%20%3E%20(schema)%20%3E%20(variant)%207%20%3E%20(property)%20repetition_penalty
Future improvements may involve documenting more than just
AiTextGenerationInputbut that requires more structural changes to docs.