Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

community[patch]: Update doc-strings for text2vec embeddings #19657

Merged
merged 1 commit into from
Mar 27, 2024
Merged

community[patch]: Update doc-strings for text2vec embeddings #19657

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions libs/community/langchain_community/embeddings/text2vec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@ class Text2vecEmbeddings(Embeddings, BaseModel):
"""text2vec embedding models.

Install text2vec first, run 'pip install -U text2vec'.
The gitbub repository for text2vec is : https://github.com/shibing624/text2vec

Example:
.. code-block:: python

from langchain_community.embeddings.text2vec import Text2vecEmbeddings

embedding = Text2vecEmbeddings()
bookend.embed_documents([
embedding.embed_documents([
"This is a CoSENT(Cosine Sentence) model.",
"It maps sentences to a 768 dimensional dense vector space.",
])
bookend.embed_query(
embedding.embed_query(
"It can be used for text matching or semantic search."
)
"""
Expand Down
Loading