Update writer integration (#4363)

# Update Writer LLM integration

Changes the parameters and base URL to be in line with Writer's current
API.
Based on the documentation on this page:
https://dev.writer.com/reference/completions-1
This commit is contained in:
Heath 2023-05-08 21:59:46 -07:00 committed by GitHub
parent 04f765b838
commit 0d568daacb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,8 +13,8 @@ from langchain.utils import get_from_dict_or_env
class Writer(LLM): class Writer(LLM):
"""Wrapper around Writer large language models. """Wrapper around Writer large language models.
To use, you should have the environment variable ``WRITER_API_KEY`` To use, you should have the environment variable ``WRITER_API_KEY`` and
set with your API key. ``WRITER_ORG_ID`` set with your API key and organization ID respectively.
Example: Example:
.. code-block:: python .. code-block:: python
@ -23,56 +23,44 @@ class Writer(LLM):
writer = Writer(model_id="palmyra-base") writer = Writer(model_id="palmyra-base")
""" """
model_id: str = "palmyra-base" writer_org_id: Optional[str] = None
"""Writer organization ID."""
model_id: str = "palmyra-instruct"
"""Model name to use.""" """Model name to use."""
tokens_to_generate: int = 24 min_tokens: Optional[int] = None
"""Max number of tokens to generate.""" """Minimum number of tokens to generate."""
max_tokens: Optional[int] = None
"""Maximum number of tokens to generate."""
temperature: Optional[float] = None
"""What sampling temperature to use."""
top_p: Optional[float] = None
"""Total probability mass of tokens to consider at each step."""
stop: Optional[List[str]] = None
"""Sequences when completion generation will stop."""
presence_penalty: Optional[float] = None
"""Penalizes repeated tokens regardless of frequency."""
repetition_penalty: Optional[float] = None
"""Penalizes repeated tokens according to frequency."""
best_of: Optional[int] = None
"""Generates this many completions server-side and returns the "best"."""
logprobs: bool = False logprobs: bool = False
"""Whether to return log probabilities.""" """Whether to return log probabilities."""
temperature: float = 1.0 n: Optional[int] = None
"""What sampling temperature to use.""" """How many completions to generate."""
length: int = 256
"""The maximum number of tokens to generate in the completion."""
top_p: float = 1.0
"""Total probability mass of tokens to consider at each step."""
top_k: int = 1
"""The number of highest probability vocabulary tokens to
keep for top-k-filtering."""
repetition_penalty: float = 1.0
"""Penalizes repeated tokens according to frequency."""
random_seed: int = 0
"""The model generates random results.
Changing the random seed alone will produce a different response
with similar characteristics. It is possible to reproduce results
by fixing the random seed (assuming all other hyperparameters
are also fixed)"""
beam_search_diversity_rate: float = 1.0
"""Only applies to beam search, i.e. when the beam width is >1.
A higher value encourages beam search to return a more diverse
set of candidates"""
beam_width: Optional[int] = None
"""The number of concurrent candidates to keep track of during
beam search"""
length_pentaly: float = 1.0
"""Only applies to beam search, i.e. when the beam width is >1.
Larger values penalize long candidates more heavily, thus preferring
shorter candidates"""
writer_api_key: Optional[str] = None writer_api_key: Optional[str] = None
"""Writer API key."""
stop: Optional[List[str]] = None
"""Sequences when completion generation will stop"""
base_url: Optional[str] = None base_url: Optional[str] = None
"""Base url to use, if None decides based on model name.""" """Base url to use, if None decides based on model name."""
@ -84,34 +72,41 @@ class Writer(LLM):
@root_validator() @root_validator()
def validate_environment(cls, values: Dict) -> Dict: def validate_environment(cls, values: Dict) -> Dict:
"""Validate that api key exists in environment.""" """Validate that api key and organization id exist in environment."""
writer_api_key = get_from_dict_or_env( writer_api_key = get_from_dict_or_env(
values, "writer_api_key", "WRITER_API_KEY" values, "writer_api_key", "WRITER_API_KEY"
) )
values["writer_api_key"] = writer_api_key values["writer_api_key"] = writer_api_key
writer_org_id = get_from_dict_or_env(values, "writer_org_id", "WRITER_ORG_ID")
values["writer_org_id"] = writer_org_id
return values return values
@property @property
def _default_params(self) -> Mapping[str, Any]: def _default_params(self) -> Mapping[str, Any]:
"""Get the default parameters for calling Writer API.""" """Get the default parameters for calling Writer API."""
return { return {
"tokens_to_generate": self.tokens_to_generate, "minTokens": self.min_tokens,
"stop": self.stop, "maxTokens": self.max_tokens,
"logprobs": self.logprobs,
"temperature": self.temperature, "temperature": self.temperature,
"top_p": self.top_p, "topP": self.top_p,
"top_k": self.top_k, "stop": self.stop,
"repetition_penalty": self.repetition_penalty, "presencePenalty": self.presence_penalty,
"random_seed": self.random_seed, "repetitionPenalty": self.repetition_penalty,
"beam_search_diversity_rate": self.beam_search_diversity_rate, "bestOf": self.best_of,
"beam_width": self.beam_width, "logprobs": self.logprobs,
"length_pentaly": self.length_pentaly, "n": self.n,
} }
@property @property
def _identifying_params(self) -> Mapping[str, Any]: def _identifying_params(self) -> Mapping[str, Any]:
"""Get the identifying parameters.""" """Get the identifying parameters."""
return {**{"model_id": self.model_id}, **self._default_params} return {
**{"model_id": self.model_id, "writer_org_id": self.writer_org_id},
**self._default_params,
}
@property @property
def _llm_type(self) -> str: def _llm_type(self) -> str:
@ -124,7 +119,7 @@ class Writer(LLM):
stop: Optional[List[str]] = None, stop: Optional[List[str]] = None,
run_manager: Optional[CallbackManagerForLLMRun] = None, run_manager: Optional[CallbackManagerForLLMRun] = None,
) -> str: ) -> str:
"""Call out to Writer's complete endpoint. """Call out to Writer's completions endpoint.
Args: Args:
prompt: The prompt to pass into the model. prompt: The prompt to pass into the model.
@ -142,12 +137,15 @@ class Writer(LLM):
base_url = self.base_url base_url = self.base_url
else: else:
base_url = ( base_url = (
"https://api.llm.writer.com/v1/models/{self.model_id}/completions" "https://enterprise-api.writer.com/llm"
f"/organization/{self.writer_org_id}"
f"/model/{self.model_id}/completions"
) )
response = requests.post( response = requests.post(
url=base_url, url=base_url,
headers={ headers={
"Authorization": f"Bearer {self.writer_api_key}", "Authorization": f"{self.writer_api_key}",
"Content-Type": "application/json", "Content-Type": "application/json",
"Accept": "application/json", "Accept": "application/json",
}, },