github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-05-24 08:27:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated LocalAIEmbeddings docstring to better explain why openai (#10946)

Browse Source 
Fixes my misgivings in
https://github.com/langchain-ai/langchain/issues/10912
This commit is contained in:
James Braza 2023-09-28 19:56:42 -07:00 committed by GitHub
parent 2c114fcb5e
commit b11f21c25f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
libs/langchain/langchain/embeddings/localai.py
View File

@ -120,16 +120,19 @@ async def async_embed_with_retry(embeddings: LocalAIEmbeddings, **kwargs: Any) -
class LocalAIEmbeddings(BaseModel, Embeddings):
"""LocalAI embedding models.
To use, you should have the ``openai`` python package installed, and the
environment variable ``OPENAI_API_KEY`` set to a random string. You need to
specify ``OPENAI_API_BASE`` to point to your LocalAI service endpoint.
Since LocalAI and OpenAI have 1:1 compatibility between APIs, this class
uses the ``openai`` Python package's ``openai.Embedding`` as its client.
Thus, you should have the ``openai`` python package installed, and defeat
the environment variable ``OPENAI_API_KEY`` by setting to a random string.
You also need to specify ``OPENAI_API_BASE`` to point to your LocalAI
service endpoint.
Example:
.. code-block:: python
from langchain.embeddings import LocalAIEmbeddings
openai = LocalAIEmbeddings(
openai_api_key="random-key",
openai_api_key="random-string",
openai_api_base="http://localhost:8080"
)