├── support_agent ├── __init__.py ├── nodes │ ├── __init__.py │ ├── safe_agent.py │ ├── verify_information.py │ └── assistant_node.py ├── tools │ ├── __init__.py │ └── safe_tools.py ├── consts.py ├── state.py └── graph.py ├── graph.png ├── static └── logo.png ├── pyproject.toml ├── db └── profile.json ├── app.py ├── README.md ├── .gitignore └── LICENSE /support_agent/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /support_agent/nodes/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /support_agent/tools/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /graph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emarco177/langgraph-customer-support/main/graph.png -------------------------------------------------------------------------------- /static/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emarco177/langgraph-customer-support/main/static/logo.png -------------------------------------------------------------------------------- /support_agent/consts.py: -------------------------------------------------------------------------------- 1 | # NODE NAMEs 2 | COLLECT_INFO = "collect_info" 3 | ASSISTANT = "assistant" 4 | VERIFY_INFORMATION = "verify_information" 5 | CLEAR_PROVIDED_INFORMATION = "clear_provided_information" 6 | SAFE_ACTION = "safe_action" 7 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "langgraph-customer-support" 3 | version = "0.1.0" 4 | description = "" 5 | authors = ["Eden Marco "] 6 | readme = "README.md" 7 | 8 | [tool.poetry.dependencies] 9 | python = "^3.10" 10 | langchain = "^0.2.5" 11 | langgraph = "^0.0.69" 12 | langchain-openai = "^0.1.8" 13 | langchain-community = "^0.2.4" 14 | black = "^24.4.2" 15 | python-dotenv = "^1.0.1" 16 | fastapi = "^0.111.0" 17 | langserve = "^0.2.2" 18 | sse-starlette = "^2.1.0" 19 | pydantic = "1.10.13" 20 | aiosqlite = "^0.20.0" 21 | langchain-mistralai = "^0.1.8" 22 | isort = "^5.13.2" 23 | 24 | 25 | [build-system] 26 | requires = ["poetry-core"] 27 | build-backend = "poetry.core.masonry.api" 28 | -------------------------------------------------------------------------------- /support_agent/tools/safe_tools.py: -------------------------------------------------------------------------------- 1 | import json 2 | from typing import Any, Dict 3 | 4 | from langchain_core.messages import AIMessage 5 | from langchain_core.tools import tool 6 | 7 | 8 | @tool 9 | def get_info_from_db(name: str) -> Dict[str, Any]: 10 | """ 11 | :return: A dictionary with all information about a person 12 | """ 13 | 14 | with open( 15 | "/Users/edenmarco/GithubProjects/langgraph-customer-support/db/profile.json", 16 | "r", 17 | ) as file: 18 | users_info = json.load(file) 19 | 20 | for user_info in users_info: 21 | if f"{user_info['first_name']} {user_info['last_name']}" == name: 22 | return user_info 23 | raise ValueError(f"Couldn't find user {name} in DB") 24 | 25 | 26 | safe_tools = [get_info_from_db] 27 | -------------------------------------------------------------------------------- /support_agent/state.py: -------------------------------------------------------------------------------- 1 | from typing import Annotated, Optional, TypedDict 2 | 3 | from langchain_core.pydantic_v1 import BaseModel, Field 4 | from langgraph.graph import add_messages 5 | 6 | 7 | class RequiredInformation(BaseModel): 8 | provided_name: Optional[str] = Field( 9 | description="the provided full name of the user" 10 | ) 11 | provided_id: Optional[int] = Field(description="the provided id name of the user") 12 | provided_city_of_birth: Optional[str] = Field( 13 | description="the provided city of birth of the user" 14 | ) 15 | provided_4_digits: Optional[int] = Field( 16 | description="the provided user last 4 digits of credit card" 17 | ) 18 | 19 | 20 | class AssistantGraphState(TypedDict): 21 | 22 | user_question: str 23 | required_information: RequiredInformation 24 | messages: Annotated[list, add_messages] 25 | verified: bool 26 | -------------------------------------------------------------------------------- /support_agent/nodes/safe_agent.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | from typing import Any, Dict 3 | 4 | from langchain_core.prompts import ChatPromptTemplate 5 | from langchain_mistralai import ChatMistralAI 6 | from langchain_openai import ChatOpenAI 7 | 8 | from support_agent.state import AssistantGraphState 9 | from support_agent.tools.safe_tools import safe_tools 10 | 11 | # model_with_tools = ChatMistralAI(model="mistral-large-latest").bind_tools(safe_tools) 12 | model_with_tools = ChatOpenAI().bind_tools(safe_tools) 13 | primary_assistant_prompt = ChatPromptTemplate.from_messages( 14 | [ 15 | ( 16 | "system", 17 | "You are a helpful customer support assistant. " "\nCurrent time: {time}.", 18 | ), 19 | ("placeholder", "{messages}"), 20 | ] 21 | ).partial(time=datetime.now(), tool_names=[tool.name for tool in safe_tools]) 22 | 23 | 24 | def assistant_with_tools(state: AssistantGraphState) -> Dict[str, Any]: 25 | chain = primary_assistant_prompt | model_with_tools 26 | res = chain.invoke(input=state) 27 | return {"messages": [res]} 28 | -------------------------------------------------------------------------------- /support_agent/nodes/verify_information.py: -------------------------------------------------------------------------------- 1 | import json 2 | from typing import Any, Dict 3 | 4 | from support_agent.state import AssistantGraphState, RequiredInformation 5 | 6 | 7 | def verify_information(state: AssistantGraphState) -> Dict[str, Any]: 8 | EDEN_INDEX = 0 9 | required_information: RequiredInformation = state["required_information"] 10 | with open( 11 | "/Users/edenmarco/GithubProjects/langgraph-customer-support/db/profile.json", 12 | "r", 13 | ) as file: 14 | user_info = json.load(file)[EDEN_INDEX] 15 | if ( 16 | user_info["secret"]["id"] == required_information.provided_id 17 | and user_info["secret"]["city_of_birth"] 18 | == required_information.provided_city_of_birth 19 | and user_info["secret"]["last_4_digits"] 20 | == required_information.provided_4_digits 21 | and required_information.provided_name 22 | == f"{user_info['first_name']} {user_info['last_name']}" 23 | ): 24 | print("Verification Success") 25 | return {"verified": True} 26 | 27 | print("Verification Failed") 28 | return {"verified": False} 29 | -------------------------------------------------------------------------------- /db/profile.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "username": "edenmarco", 4 | "profile_pic_url": "https://storage.cloud.google.com/publick-profile-pics/1610187870291.jpeg", 5 | "first_name": "Eden", 6 | "last_name": "Marco", 7 | "occupation": "LLM Specialist at Google", 8 | "headline": "LLMs @ Google Cloud | Best-selling Udemy Instructor | Backend & GenAI", 9 | "summary": "Backend developer, Udemy.com best seller instructor", 10 | "secret": {"id":777777777, "city_of_birth": "Los Angeles", "last_4_digits": 5555} 11 | }, 12 | { 13 | "public_identifier": "jacoblee93", 14 | "profile_pic_url": "https://storage.cloud.google.com/publick-profile-pics/1685590344428.jpeg", 15 | "first_name": "Jacob", 16 | "last_name": "Lee", 17 | "follower_count": 3292, 18 | "occupation": "Founding Software Engineer at LangChain", 19 | "headline": "Founding Software Engineer", 20 | "summary": "Seasoned software engineer and architect with years of experience designing and implementing scalable systems from first principles. Startup executive comfortable leading and mentoring a team amidst uncertainty while remaining focused on broader objectives. Passionate about developers, community building, and AGI.", 21 | "country": "US", 22 | "city": "San Francisco", 23 | "state": "California", 24 | "secret": { 25 | "id": 888888888, 26 | "last_4_digits": 6666 27 | } 28 | } 29 | ] -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | from dotenv import load_dotenv 2 | 3 | load_dotenv() 4 | from typing import List, Union 5 | 6 | import uvicorn 7 | from fastapi import FastAPI 8 | from fastapi.middleware.cors import CORSMiddleware 9 | from langchain_core.messages import AIMessage, HumanMessage, SystemMessage 10 | from langchain_core.pydantic_v1 import BaseModel 11 | from langserve import add_routes 12 | 13 | from support_agent.graph import graph 14 | 15 | 16 | class ChatInputType(BaseModel): 17 | input: List[Union[HumanMessage, AIMessage, SystemMessage]] 18 | 19 | 20 | def test_locally(): 21 | for output in graph.stream( 22 | {"user_question": "What information do you have on me?"}, 23 | config={"configurable": {"thread_id": 888}}, 24 | ): 25 | for key, value in output.items(): 26 | if "messages" in value: 27 | try: 28 | last_msg = value["messages"][-1] 29 | last_msg.pretty_print() 30 | except Exception as e: 31 | print(last_msg) 32 | print(graph.get_state({"configurable": {"thread_id": 3}})) 33 | 34 | 35 | def start() -> None: 36 | app = FastAPI( 37 | title="Gen UI Backend", 38 | version="1.0", 39 | description="A simple api server using Langchain's Runnable interfaces", 40 | ) 41 | 42 | origins = [ 43 | "http://localhost", 44 | "http://localhost:3000", 45 | ] 46 | 47 | app.add_middleware( 48 | CORSMiddleware, 49 | allow_origins=origins, 50 | allow_credentials=True, 51 | allow_methods=["*"], 52 | allow_headers=["*"], 53 | ) 54 | 55 | # unnable = graph.with_types(input_type=ChatInputType, output_type=dict) 56 | 57 | add_routes(app, graph, path="/chat", playground_type="chat") 58 | print("Starting server...") 59 | uvicorn.run(app, host="0.0.0.0", port=8000) 60 | 61 | 62 | if __name__ == "__main__": 63 | # start() 64 | test_locally() 65 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Advanced Customer Support control flow with LangGraph🦜🕸 4 | 5 | Implementation of a customer support agent that collects user information, validates it, and only then assists the user. 6 | The state is persisted to allow continuation and provide a more advanced user experience. 7 | 8 | 9 | 10 | ![Logo](https://github.com/emarco177/langgraph-customer-support/blob/main/static/logo.png) 11 | 12 | 13 | 14 | ## Features 15 | 16 | - **Human In the Loop**: Continuously gather input from the user until the agent has all required information. 17 | - **Persistent Storage**: Checkpoint LangGraph state after each node execution to an SQLite database. 18 | ## Environment Variables 19 | 20 | To run this project, you will need to add the following environment variables to your .env file 21 | 22 | `PYTHONPATH=/{YOUR_PATH_TO_PROJECT}/langgraph-customer-support` 23 | 24 | `MISTRALAI_API_KEY` 25 | 26 | `LANGCHAIN_API_KEY` 27 | 28 | `LANGCHAIN_TRACING_V2=true` 29 | 30 | `LANGCHAIN_PROJECT` 31 | 32 | ## Run Locally 33 | 34 | Clone the project 35 | 36 | ```bash 37 | git clone https://github.com/emarco177/langgraph-customer-support.git 38 | ``` 39 | 40 | Go to the project directory 41 | 42 | ```bash 43 | cd langgraph-customer-support 44 | ``` 45 | 46 | Install dependencies 47 | 48 | ```bash 49 | poetry install 50 | ``` 51 | 52 | Start the flask server 53 | 54 | ```bash 55 | poetry run app.py 56 | ``` 57 | 58 | 59 | ## Running Tests 60 | 61 | To run tests, run the following command 62 | 63 | ```bash 64 | poetry run pytest . -s -v 65 | ``` 66 | 67 | ## 🔗 Links 68 | [![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://www.udemy.com/course/langgraph/?referralCode=FEA50E8CBA24ECD48212) 69 | [![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/eden-marco/) 70 | [![twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://www.udemy.com/user/eden-marco/) -------------------------------------------------------------------------------- /support_agent/graph.py: -------------------------------------------------------------------------------- 1 | from dotenv import load_dotenv 2 | 3 | load_dotenv() 4 | 5 | from langgraph.checkpoint.sqlite import SqliteSaver 6 | from langgraph.prebuilt.tool_node import ToolNode 7 | 8 | from support_agent.nodes.safe_agent import assistant_with_tools 9 | from support_agent.tools.safe_tools import safe_tools 10 | 11 | from langgraph.graph import END, StateGraph 12 | 13 | from support_agent.consts import ( 14 | ASSISTANT, 15 | COLLECT_INFO, 16 | SAFE_ACTION, 17 | VERIFY_INFORMATION, 18 | ) 19 | from support_agent.nodes.assistant_node import assistant_node, collect_info 20 | from support_agent.nodes.verify_information import verify_information 21 | from support_agent.state import AssistantGraphState, RequiredInformation 22 | 23 | 24 | def provided_all_details(state: AssistantGraphState) -> str: 25 | if "required_information" not in state: 26 | return "need to collect more information" 27 | provided_information: RequiredInformation = state["required_information"] 28 | if ( 29 | provided_information.provided_name 30 | and provided_information.provided_id 31 | and provided_information.provided_city_of_birth 32 | and provided_information.provided_4_digits 33 | ): 34 | return "all information collected" 35 | 36 | else: 37 | return "need to collect more information" 38 | 39 | 40 | def verified(state: AssistantGraphState) -> str: 41 | verified_successfully = state["verified"] 42 | 43 | if verified_successfully: 44 | return "agent_with_tools" 45 | else: 46 | return ASSISTANT 47 | 48 | 49 | def route_safe_no_safe(state: AssistantGraphState) -> str: 50 | ai_message = state["messages"][-1] 51 | 52 | first_tool_call = ai_message.tool_calls[0] 53 | if first_tool_call["name"] in [tool.name for tool in safe_tools]: 54 | return "safe_tools" 55 | else: 56 | raise END 57 | 58 | 59 | workflow = StateGraph(AssistantGraphState) 60 | workflow.add_node(ASSISTANT, assistant_node) 61 | workflow.add_node(COLLECT_INFO, collect_info) 62 | workflow.add_node(VERIFY_INFORMATION, verify_information) 63 | workflow.add_node("agent_with_tools", assistant_with_tools) 64 | workflow.add_node("safe_tools", ToolNode(safe_tools)) 65 | 66 | 67 | workflow.set_entry_point(ASSISTANT) 68 | workflow.add_edge(ASSISTANT, COLLECT_INFO) 69 | workflow.add_conditional_edges( 70 | COLLECT_INFO, 71 | provided_all_details, 72 | { 73 | "need to collect more information": "assistant", 74 | "all information collected": "verify_information", 75 | }, 76 | ) 77 | workflow.add_conditional_edges( 78 | VERIFY_INFORMATION, 79 | verified, 80 | {"agent_with_tools": "agent_with_tools", ASSISTANT: ASSISTANT}, 81 | ) 82 | workflow.add_edge("safe_tools", END) 83 | workflow.add_conditional_edges( 84 | "agent_with_tools", route_safe_no_safe, {"safe_tools": "safe_tools", END: END} 85 | ) 86 | memory = SqliteSaver.from_conn_string(":checkpoints.sqlite:") 87 | graph = workflow.compile(checkpointer=memory) 88 | 89 | graph.get_graph().draw_mermaid_png(output_file_path="graph.png") 90 | -------------------------------------------------------------------------------- /support_agent/nodes/assistant_node.py: -------------------------------------------------------------------------------- 1 | from typing import Any, Dict, List 2 | 3 | from langchain_core.messages import HumanMessage 4 | from langchain_core.prompts import ChatPromptTemplate 5 | from langchain_mistralai import ChatMistralAI 6 | 7 | from support_agent.state import AssistantGraphState, RequiredInformation 8 | 9 | llm = ChatMistralAI(model="mistral-large-latest") 10 | system = """You are a a helper assistant \n tasked with helping a customer. 11 | 1. You first need to collect their information before you can validated them. 12 | 2. After your collect ALL information say thank you and that you 13 | are going to validate that information in the backend systems. 14 | 15 | The information needs to be collected: 16 | 17 | class RequiredInformation(BaseModel): 18 | provided_name: Optional[str] = Field( 19 | description="the provided full name of the user" 20 | ) 21 | provided_id: Optional[int] = Field(description="the provided id name of the user") 22 | provided_city_of_birth: Optional[str] = Field( 23 | description="the provided city of birth of the user" 24 | ) 25 | provided_4_digits: Optional[int] = Field( 26 | description="the provided user last 4 digits of credit card" 27 | ) 28 | 29 | make sure you have the information before you can proceed, but only one field at a time 30 | if the input from user was wrong please tell them why. 31 | 32 | DO NOT FILL IN THE USERS INFORMATION, YOU NEED TO COLLECT IT. 33 | """ 34 | assistant_prompt = ChatPromptTemplate.from_messages( 35 | [ 36 | ("system", system), 37 | ( 38 | "human", 39 | "User question: {user_question}" 40 | "Chat history: {messages}" 41 | "\n\n What the user have provided so far {provided_required_information} \n\n", 42 | ), 43 | ] 44 | ) 45 | 46 | 47 | def assistant_node(state: AssistantGraphState) -> Dict[str, Any]: 48 | get_information_chain = assistant_prompt | llm 49 | res = get_information_chain.invoke( 50 | { 51 | "user_question": state["user_question"], 52 | "provided_required_information": state["required_information"], 53 | "messages": state["messages"] if "messages" in state else [], 54 | } 55 | ) 56 | 57 | return {"messages": [res]} 58 | 59 | 60 | def combine_required_info(info_list: List[RequiredInformation]) -> RequiredInformation: 61 | info_list = [info for info in info_list if info is not None] 62 | 63 | if len(info_list) == 1: 64 | return info_list[0] 65 | combined_info = {} 66 | for info in info_list: 67 | for key, value in info.dict().items(): 68 | if value is not None: 69 | combined_info[key] = value 70 | return RequiredInformation(**combined_info) 71 | 72 | 73 | def collect_info(state: AssistantGraphState) -> Dict[str, Any]: 74 | information_from_stdin = str(input("\nenter information\n")) 75 | structured_llm_user_info = llm.with_structured_output(RequiredInformation) 76 | 77 | information_chain = assistant_prompt | structured_llm_user_info 78 | res = information_chain.invoke( 79 | { 80 | "user_question": state["user_question"], 81 | "provided_required_information": information_from_stdin, 82 | "messages": state["messages"], 83 | } 84 | ) 85 | if "required_information" in state: 86 | required_info = combine_required_info( 87 | info_list=[res, state.get("required_information")] 88 | ) 89 | else: 90 | required_info = res 91 | return { 92 | "required_information": required_info, 93 | "messages": [HumanMessage(content=information_from_stdin)], 94 | } 95 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------