Source code for langchain_community.utilities.merriam_webster

"""Util that calls Merriam-Webster."""
import json
from typing import Dict, Iterator, List, Optional
from urllib.parse import quote

import requests
from langchain_core.pydantic_v1 import BaseModel, Extra, root_validator
from langchain_core.utils import get_from_dict_or_env


[docs]class MerriamWebsterAPIWrapper(BaseModel): """Wrapper for Merriam-Webster. Docs for using: 1. Go to and register an developer account with a key for the Collegiate Dictionary 2. Get your API Key from 3. Save your API Key into MERRIAM_WEBSTER_API_KEY env variable """ merriam_webster_api_key: Optional[str] = None class Config: """Configuration for this pydantic object.""" extra = Extra.forbid @root_validator() def validate_environment(cls, values: Dict) -> Dict: """Validate that api key exists in environment.""" merriam_webster_api_key = get_from_dict_or_env( values, "merriam_webster_api_key", "MERRIAM_WEBSTER_API_KEY" ) values["merriam_webster_api_key"] = merriam_webster_api_key return values
[docs] def run(self, query: str) -> str: """Run query through Merriam-Webster API and return a formatted result.""" quoted_query = quote(query) request_url = ( f"{MERRIAM_WEBSTER_API_URL}/{quoted_query}" f"?key={self.merriam_webster_api_key}" ) response = requests.get(request_url, timeout=MERRIAM_WEBSTER_TIMEOUT) if response.status_code != 200: return response.text return self._format_response(query, response)
def _format_response(self, query: str, response: requests.Response) -> str: content = json.loads(response.content) if not content: return f"No Merriam-Webster definition was found for query '{query}'." if isinstance(content[0], str): result = f"No Merriam-Webster definition was found for query '{query}'.\n" if len(content) > 1: alternatives = [f"{i + 1}. {content[i]}" for i in range(len(content))] result += "You can try one of the following alternative queries:\n\n" result += "\n".join(alternatives) else: result += f"Did you mean '{content[0]}'?" else: result = self._format_definitions(query, content) return result def _format_definitions(self, query: str, definitions: List[Dict]) -> str: formatted_definitions: List[str] = [] for definition in definitions: formatted_definitions.extend(self._format_definition(definition)) if len(formatted_definitions) == 1: return f"Definition of '{query}':\n" f"{formatted_definitions[0]}" result = f"Definitions of '{query}':\n\n" for i, formatted_definition in enumerate(formatted_definitions, 1): result += f"{i}. {formatted_definition}\n" return result def _format_definition(self, definition: Dict) -> Iterator[str]: if "hwi" in definition: headword = definition["hwi"]["hw"].replace("*", "-") else: headword = definition["meta"]["id"].split(":")[0] if "fl" in definition: functional_label = definition["fl"] if "shortdef" in definition: for short_def in definition["shortdef"]: yield f"{headword}, {functional_label}: {short_def}" else: yield f"{headword}, {functional_label}"