Skip to content

Conversation

@RihanArfan
Copy link
Contributor

@RihanArfan RihanArfan commented Apr 23, 2025

Summary

Changes type of streaming from object to boolean. Inferred type as @cloudflare/worker-types hasn't correctly typed aiSearch(), it uses search()'s params.. Inferred from the description saying default false, and Workers AI's streaming being a boolean too.

Documentation checklist

Additional

I am not 100% sure whether it's stream or streaming either.

image

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 23, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated the parameter type for streaming in the aiSearch() function documentation from object to boolean for accuracy.

  • Changed the type of streaming from object to boolean.
  • Clarified the inferred type based on the default value and existing documentation.
  • Ensured compliance with the documentation style guide.

Modified Files

  • src/content/partials/autorag/ai-search-api-params.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@RihanArfan
Copy link
Contributor Author

Closing - resolved in #21870

@RihanArfan RihanArfan closed this Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants