-
Notifications
You must be signed in to change notification settings - Fork 71
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
docs(weave): Upload and document Service API notebook #3170
Conversation
Preview this PR with FeatureBee: https://beta.wandb.ai/?betaVersion=02ebde2c0e27f71cca898a4f332128b42f1de87d |
@wandb/weave-team help with a GH check requested please:
|
|
||
<!--- @wandbcode{service-api-colab} --> | ||
|
||
In the following notebook, you will learn how to use the Weave Service API to log traces. Specifically, you will use the Service API to: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a first-party trace_server_interface
for this -- curious why you're using the raw HTTP endpoint instead of that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The initial code was created by @m-rgba - maybe they can provide that context? I just documented the code as it was. @andrewtruong do you think it would be promoting an anti pattern by using the raw endpoint? If so, I can go back in and update the notebook to use trace_server_interface?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @andrewtruong - so when I initially created it:
- I made them while I was making a OpenWebUI plugin and didn't want the user to have to install any packages.
- Customer asked for some examples using the REST API since they were having trouble with the client.
My argument for why I feel like this could be valuable:
- It's a good escape-hatch for anyone running where they can't use our client, or are having trouble with our client, but they want to send us traces.
- The service API is the most language neutral method for sending us traces.
If either of these are true, our current OpenAPI docs get the user like 95% there - but are pretty easy to flesh out parts like - what's the shape of a completion we're expecting, or how should they format token counts.
100% open to this being an anti-pattern though, if we're updating the API or other reasons.
We could also do both, where we can have examples for manually creating traces with the client as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For python we should recommend the first-party stuff, and for other languages we can recommend this HTTP approach.
That said, I'm not against it. We can still show python using the service API
Description
https://wandb.atlassian.net/browse/DOCS-1050
Before merge, need to address failing GH check #3170 (comment)
Testing