LangServe for API deployment in LangChain

Introduction

LangServe helps you turn your language models into easy-to-use APIs. It makes sharing and using AI models simple without complex setup.

You want to let others use your language model through a web API.

You need a quick way to deploy a chatbot or text generator online.

You want to test your language model with different inputs remotely.

You want to build an app that talks to your language model over the internet.

Syntax

LangChain

from langchain.serving import LangServe

app = LangServe(llm=your_language_model)

app.run(host='0.0.0.0', port=8000)

LangServe wraps your language model into a web server.

You can customize the host and port to control where the API listens.

Examples

This example creates a LangServe API using OpenAI's GPT-4 model and runs it on default settings.

LangChain

from langchain.serving import LangServe
from langchain.llms import OpenAI

llm = OpenAI(model_name='gpt-4')
app = LangServe(llm=llm)
app.run()

Here, a simple custom model echoes the prompt. LangServe runs it on port 9000.

LangChain

from langchain.serving import LangServe

class MyModel:
    def __call__(self, prompt):
        return f"Echo: {prompt}"

app = LangServe(llm=MyModel())
app.run(port=9000)

Sample Program

This program creates a simple API that replies with the input text prefixed by 'You said:'. It runs locally on port 8080.

LangChain

from langchain.serving import LangServe

class SimpleEchoModel:
    def __call__(self, prompt: str) -> str:
        return f"You said: {prompt}"

app = LangServe(llm=SimpleEchoModel())

if __name__ == '__main__':
    app.run(host='127.0.0.1', port=8080)

Important Notes

Make sure your language model class has a __call__ method that takes a prompt string and returns a string.

Use host='0.0.0.0' to allow external access to your API.

Check your firewall or network settings if others cannot reach your API.

Summary

LangServe quickly turns language models into web APIs.

You can deploy your model locally or on a server for others to use.

It requires a simple class with a __call__ method to work.

Practice

1. What is the main purpose of LangServe in LangChain?

easy

A. To quickly turn language models into web APIs

B. To train new language models from scratch

C. To visualize language model outputs in charts

D. To store large datasets for language models

Solution

1. Step 1: Understand LangServe's role

   LangServe is designed to make language models accessible as web APIs easily.

2. Step 2: Compare options with LangServe's function

   Only To quickly turn language models into web APIs matches this purpose; others describe unrelated tasks.

3. Final Answer:

   To quickly turn language models into web APIs -> Option A

4. Quick Check:

   LangServe = API deployment [OK]

Hint: LangServe = language model + web API [OK]

Common Mistakes:

• Confusing LangServe with model training tools
• Thinking LangServe is for data storage
• Assuming LangServe creates visualizations

2. Which of the following is the correct minimal structure for a LangServe class?

easy

A. def MyAPI(input):
return input.upper()

B. class MyAPI:
def __call__(self, input):
return input.upper()

C. class MyAPI:
def call(self, input):
return input.upper()

D. class MyAPI:
def __init__(self, input):
return input.upper()

Solution

1. Step 1: Identify required method for LangServe

   LangServe requires a class with a __call__ method to handle requests.

2. Step 2: Check each option's method name and structure

   Only class MyAPI: def __call__(self, input): return input.upper() uses __call__ correctly; others use wrong method names or invalid return in __init__.

3. Final Answer:

   class with __call__ method -> Option B

4. Quick Check:

   __call__ method = correct structure [OK]

Hint: LangServe needs __call__, not call or __init__ [OK]

Common Mistakes:

• Using call instead of __call__
• Returning values from __init__ method
• Defining a function instead of a class

3. Given this LangServe class:

class EchoAPI:
    def __call__(self, input):
        return f"Echo: {input}"

What will be the output when calling EchoAPI()('hello')?

medium

A. "hello"

B. TypeError: 'EchoAPI' object is not callable

C. "Echo: hello"

D. "EchoAPI: hello"

Solution

1. Step 1: Understand __call__ method behavior

   The __call__ method formats the input by prefixing 'Echo: ' to it.

2. Step 2: Evaluate the call EchoAPI()('hello')

   Creating EchoAPI instance and calling it with 'hello' returns 'Echo: hello'.

3. Final Answer:

   "Echo: hello" -> Option C

4. Quick Check:

   __call__ returns formatted string [OK]

Hint: Calling instance runs __call__ method [OK]

Common Mistakes:

• Expecting raw input without prefix
• Thinking instance is not callable
• Confusing class name with output

4. What is wrong with this LangServe class?

class BadAPI:
    def call(self, input):
        return input[::-1]

medium

A. The return statement should convert input to uppercase

B. The input slicing syntax is incorrect

C. The class must inherit from a base LangServe class

D. The method should be named __call__, not call

Solution

1. Step 1: Check method name required by LangServe

   LangServe expects a __call__ method to make the class callable.

2. Step 2: Analyze method name in BadAPI

   BadAPI uses call instead of __call__, so it won't work as expected.

3. Final Answer:

   The method should be named __call__, not call -> Option D

4. Quick Check:

   __call__ method required [OK]

Hint: Method must be __call__, not call [OK]

Common Mistakes:

• Using call instead of __call__
• Assuming inheritance is mandatory
• Thinking input slicing is invalid

5. You want to deploy a LangServe API that reverses input text but only if the input is a non-empty string. Which class correctly implements this?

hard

A. class ReverseAPI:
def __call__(self, input):
if input is None or input == "":
return "Empty input"
return input[::-1]

B. class ReverseAPI:
def __call__(self, input):
return input[::-1] if input != None else "Empty input"

C. class ReverseAPI:
def __call__(self, input):
if input == "":
return "Empty input"
else:
return input[::-1]

D. class ReverseAPI:
def __call__(self, input):
if input != "":
return input[::-1]
return "Empty input"

Solution

1. Step 1: Identify conditions for input validation

   We must check if input is None or empty string to handle empty input properly.

2. Step 2: Evaluate each option's condition

   class ReverseAPI: def __call__(self, input): if input is None or input == "": return "Empty input" return input[::-1] checks both None and empty string correctly before reversing input.

3. Final Answer:

   Checks both None and empty string before reversing -> Option A

4. Quick Check:

   Check None and empty string before processing [OK]

Hint: Check None and empty string explicitly [OK]

Common Mistakes:

• Only checking for empty string, missing None
• Using != None instead of is None
• Not handling empty input cases