You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
langchain/templates/extraction-openai-functions
Erick Friis d83b720c40
templates: readme langsmith not private beta (#20173)
1 month ago
..
extraction_openai_functions templates: fix deps (#15439) 4 months ago
tests Templates (#12294) 7 months ago
LICENSE template updates (#12736) 7 months ago
README.md templates: readme langsmith not private beta (#20173) 1 month ago
extraction_openai_functions.ipynb docs, experimental[patch], langchain[patch], community[patch]: update storage imports (#15429) 4 months ago
poetry.lock templates: bump lockfile deps (#19001) 2 months ago
pyproject.toml templates: bump (#17074) 3 months ago

README.md

extraction-openai-functions

This template uses OpenAI function calling for extraction of structured output from unstructured input text.

The extraction output schema can be set in chain.py.

Environment Setup

Set the OPENAI_API_KEY environment variable to access the OpenAI models.

Usage

To use this package, you should first have the LangChain CLI installed:

pip install -U langchain-cli

To create a new LangChain project and install this as the only package, you can do:

langchain app new my-app --package extraction-openai-functions

If you want to add this to an existing project, you can just run:

langchain app add extraction-openai-functions

And add the following code to your server.py file:

from extraction_openai_functions import chain as extraction_openai_functions_chain

add_routes(app, extraction_openai_functions_chain, path="/extraction-openai-functions")

(Optional) Let's now configure LangSmith. LangSmith will help us trace, monitor and debug LangChain applications. You can sign up for LangSmith here. If you don't have access, you can skip this section

export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
export LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to "default"

If you are inside this directory, then you can spin up a LangServe instance directly by:

langchain serve

This will start the FastAPI app with a server is running locally at http://localhost:8000

We can see all templates at http://127.0.0.1:8000/docs We can access the playground at http://127.0.0.1:8000/extraction-openai-functions/playground

We can access the template from code with:

from langserve.client import RemoteRunnable

runnable = RemoteRunnable("http://localhost:8000/extraction-openai-functions")

By default, this package is set to extract the title and author of papers, as specified in the chain.py file.

LLM is leveraged by the OpenAI function by default.