docs: add model_instance explanation

[goasleep]

Linking #560

It seems that there are examples in the documentation that use this parameter model_instance, but this is not particularly easy to find, so it is listed separately in the documentation.

[VinciGit00]

does moonshot work on scrapegraph? we did not integrated them

[f-aguzzi]

@VinciGit00 this is related to issue #560 - @goasleep wanted to use an unsupported model with an OpenAI - like API, and figured out that he could use model instances to do so. It seems to work. This means we have a new use for model instances. I suggested we could add Moonshot directly, but goalsleep didn't think it was necessary at the moment.

[f-aguzzi]

@goasleep thanks for the idea and for the contribution - we'll wait for VinciGit's opinion and then merge your pull request.

[goasleep]

Yeah. it's working well.But I did not submit unit test cases to avoid adding additional complexity because a new api key was added. Here is a test example.

• env:
  • device:macbook air m3
  • os system: macos 14.6.1
  • python version: 3.12.4

[f-aguzzi]

Thanks a lot. Don't worry about the test cases - these things are hard to automate without having API keys for each provider. We have the same problem.

Maybe we could add a subfolder of model instance examples to the examples folder, though. We'll see.

[goasleep]

I sorry for adding the examples to this branch... Could you help to approval again?

[VinciGit00]

can you add also inside the folder examples/moonshor?

[goasleep]

can you add also inside the folder examples/moonshor?

Sure. I submitted a new commit

[github-actions]

🎉 This issue has been resolved in version 1.15.0-beta.1 🎉

The release is available on:

• v1.15.0-beta.1
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This issue has been resolved in version 1.15.0 🎉

The release is available on:

• v1.15.0
• GitHub release

Your semantic-release bot 📦🚀