openai-cookbook icon indicating copy to clipboard operation
openai-cookbook copied to clipboard

Add cookbook on RAG observability with LangChain and MLflow

Open daniellok-db opened this issue 5 months ago • 1 comments

Summary

Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.

This PR adds a new cookbook demonstrating an observability tool (MLflow Tracing) when building a RAG chain with LangChain and OpenAI.

Motivation

Why are these changes necessary? How do they improve the cookbook?

There are a few cookbooks on RAG at the moment, but none of them have observability as a focus. This notebook links together a few open source libraries to showcase new debugging tools (e.g. tracing) and how they can be helpful when building a RAG application.


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • [x] I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • [x] I have conducted a self-review of my content based on the contribution guidelines:
    • [x] Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • [x] Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • [x] Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • [x] Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • [x] Correctness: The information I include is correct and all of my code executes successfully.
    • [x] Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

daniellok-db avatar Sep 05 '24 06:09 daniellok-db