Skip to content
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

Add langfuse blueprint #3418

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mingshl
Copy link
Collaborator

@mingshl mingshl commented Jan 22, 2025

Description

Add langfuse blueprint to ml-commons documentation. Thanks @jngz-es for helping with the basic authentication configuration.

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Mingshi Liu <[email protected]>

## 2. Create Connector for Langfuse:
The following connector is connecting to the API for getting a prompt. There are other apis from Langfuse that is available to connect to, please refer to https://api.reference.langfuse.com/#get-/api/public/comments.
Note: The username:password should be Base64 encoded. The username is the Langfuse Public Key, and the password is the Langfuse Secret Key.
Copy link
Contributor

@brianf-aws brianf-aws Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets make this a new line here since when we render it the sentence Note: ... gets attached to the last sentence

Suggested change
Note: The username:password should be Base64 encoded. The username is the Langfuse Public Key, and the password is the Langfuse Secret Key.
The following connector is connecting to the API for getting a prompt. There are other apis from Langfuse that is available to connect to, please refer to https://api.reference.langfuse.com/#get-/api/public/comments.
Note: The username:password should be Base64 encoded. The username is the Langfuse Public Key, and the password is the Langfuse Secret Key.

"description": "The connector to Langfuse",
"protocol": "http",
"parameters": {
"promptName": "<YOUR_PROMPT_NAME>"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This promptName gets used in the url but also in the payload? Must you use this same promptName consistently throughout all predictions?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the promptName need a default value in the connectors in the url. This is a GET api, so the payload is not important. But I tried and we need something in the payload, that's why put the same promptName

}
]
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a mini explanation of the inference result would be a bonus

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, I will try add some explanations

@@ -0,0 +1,167 @@
### Langfuse Connector Blueprint:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think this makes sense to me but A little bit more context (in the beginning of the document) in the beginning would be great as a reader.

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.

2 participants