mirror of
https://github.com/hwchase17/langchain.git
synced 2026-01-05 16:06:39 +00:00
Upgrade to using a literal for specifying the extra which is the
recommended approach in pydantic 2.
This works correctly also in pydantic v1.
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel, extra="forbid"):
x: int
Foo(x=5, y=1)
```
And
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel):
x: int
class Config:
extra = "forbid"
Foo(x=5, y=1)
```
## Enum -> literal using grit pattern:
```
engine marzano(0.1)
language python
or {
`extra=Extra.allow` => `extra="allow"`,
`extra=Extra.forbid` => `extra="forbid"`,
`extra=Extra.ignore` => `extra="ignore"`
}
```
Resorted attributes in config and removed doc-string in case we will
need to deal with going back and forth between pydantic v1 and v2 during
the 0.3 release. (This will reduce merge conflicts.)
## Sort attributes in Config:
```
engine marzano(0.1)
language python
function sort($values) js {
return $values.text.split(',').sort().join("\n");
}
class_definition($name, $body) as $C where {
$name <: `Config`,
$body <: block($statements),
$values = [],
$statements <: some bubble($values) assignment() as $A where {
$values += $A
},
$body => sort($values),
}
```
72 lines
2.3 KiB
Python
72 lines
2.3 KiB
Python
from typing import Any, List, Optional
|
|
|
|
from langchain_core.embeddings import Embeddings
|
|
from langchain_core.pydantic_v1 import BaseModel
|
|
|
|
|
|
class ModelScopeEmbeddings(BaseModel, Embeddings):
|
|
"""ModelScopeHub embedding models.
|
|
|
|
To use, you should have the ``modelscope`` python package installed.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
from langchain_community.embeddings import ModelScopeEmbeddings
|
|
model_id = "damo/nlp_corom_sentence-embedding_english-base"
|
|
embed = ModelScopeEmbeddings(model_id=model_id, model_revision="v1.0.0")
|
|
"""
|
|
|
|
embed: Any
|
|
model_id: str = "damo/nlp_corom_sentence-embedding_english-base"
|
|
"""Model name to use."""
|
|
model_revision: Optional[str] = None
|
|
|
|
def __init__(self, **kwargs: Any):
|
|
"""Initialize the modelscope"""
|
|
super().__init__(**kwargs)
|
|
try:
|
|
from modelscope.pipelines import pipeline
|
|
from modelscope.utils.constant import Tasks
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Could not import some python packages."
|
|
"Please install it with `pip install modelscope`."
|
|
) from e
|
|
self.embed = pipeline(
|
|
Tasks.sentence_embedding,
|
|
model=self.model_id,
|
|
model_revision=self.model_revision,
|
|
)
|
|
|
|
class Config:
|
|
extra = "forbid"
|
|
|
|
def embed_documents(self, texts: List[str]) -> List[List[float]]:
|
|
"""Compute doc embeddings using a modelscope embedding model.
|
|
|
|
Args:
|
|
texts: The list of texts to embed.
|
|
|
|
Returns:
|
|
List of embeddings, one for each text.
|
|
"""
|
|
texts = list(map(lambda x: x.replace("\n", " "), texts))
|
|
inputs = {"source_sentence": texts}
|
|
embeddings = self.embed(input=inputs)["text_embedding"]
|
|
return embeddings.tolist()
|
|
|
|
def embed_query(self, text: str) -> List[float]:
|
|
"""Compute query embeddings using a modelscope embedding model.
|
|
|
|
Args:
|
|
text: The text to embed.
|
|
|
|
Returns:
|
|
Embeddings for the text.
|
|
"""
|
|
text = text.replace("\n", " ")
|
|
inputs = {"source_sentence": [text]}
|
|
embedding = self.embed(input=inputs)["text_embedding"][0]
|
|
return embedding.tolist()
|