DOC: What are Tracers `example_id` attributes meant for?

langchain-ai / langchain

🦜🔗 Build context-aware reasoning applications

https://python.langchain.com

MIT License

88.77k stars 13.96k forks source link

DOC: What are Tracers `example_id` attributes meant for? #18177

Open ldorigo opened 4 months ago

ldorigo commented 4 months ago

Checklist

[X] I added a very descriptive title to this issue.
[X] I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

Classes in the BaseTracer hierarchy take a "example_id" parameter. The docstring/api docs have a very vague description of "The example ID associated with the runs.". What is this supposed to be (for)?

Idea or request for content:

No response

ldorigo commented 4 weeks ago

@nfcampos @efriis @hinthornw (just mentioning random maintainers from memory): might I recommend against just having a bot randomly closing issues that haven't been solved with no reason and no human oversight? I understand you're a popular library and need to manage issues somehow, but it's a slap in the face to people who take the time to identify and report issues. (And in some cases like this one, I believe the problem/question is still there)

hinthornw commented 3 weeks ago

Will speak with them.

I'm assuming you're talking about the LangChainTracer, EvaluatorCallbackHandler, and the Run objects?

They're the dataset record ID used during evals. Marking an example_id on a trace/run associates it with that entry

Ya we should improve the docstring