Skip to content

Fix OCR parameter naming in document.md #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

suekou
Copy link

@suekou suekou commented Mar 7, 2025

@fracapuano fracapuano self-requested a review March 7, 2025 15:01
@fracapuano
Copy link
Collaborator

Hey @suekou 👋 thank you very much for contributing ⭐

  • From what I see, your PR mainly fixes two ~typos in the docs, (1) being consistent with camelcase typescript and (2) consistently using variable name client across both python & typescript examples
  • Makes a lot of sense to me, and thanks for contributing these fixes! Very much appreciated 🙏
  • However, before merging, I would appreciate it if you could confirm these are your two objectives. The PR provides pretty little context, and so does the reference PR on mistralai/client-ts
  • For next times, can you please add a brief explanation of what you are trying to achieve with your PRs? Even a one liner would make all the difference in the world 🙏

Again, thank you very much for spotting this out---ready to merge as soon as you can provide us with some extra context. Thank you again! 🚀

@suekou
Copy link
Author

suekou commented Mar 7, 2025

@fracapuano Sorry, I will provide some additional context:

  1. Regarding the arguments for the ocr.procsee method, as you can see in this line & this line, the expected argument is includeImageBase64 (camelCase) rather than include_image_base64. I have corrected this.

  2. As you pointed out, the documentation consistently instantiates the Mistral object using const client = new Mistral({apiKey: apiKey});. However, in the fixed code, it was named mistral, which breaks the consistency. I have updated it accordingly.

@pandora-s-git
Copy link
Contributor

Thanks a lot, fixed in recent update: #203

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants