langchain_community.embeddings.cloudflare_workersai
.CloudflareWorkersAIEmbeddings¶
- class langchain_community.embeddings.cloudflare_workersai.CloudflareWorkersAIEmbeddings[source]¶
Bases:
BaseModel
,Embeddings
Cloudflare Workers AI embedding model.
To use, you need to provide an API token and account ID to access Cloudflare Workers AI.
Example
from langchain_community.embeddings import CloudflareWorkersAIEmbeddings account_id = "my_account_id" api_token = "my_secret_api_token" model_name = "@cf/baai/bge-small-en-v1.5" cf = CloudflareWorkersAIEmbeddings( account_id=account_id, api_token=api_token, model_name=model_name )
Initialize the Cloudflare Workers AI client.
- param account_id: str [Required]¶
- param api_base_url: str = 'https://api.cloudflare.com/client/v4/accounts'¶
- param api_token: str [Required]¶
- param batch_size: int = 50¶
- param headers: Dict[str, str] = {'Authorization': 'Bearer '}¶
- param model_name: str = '@cf/baai/bge-base-en-v1.5'¶
- param strip_new_lines: bool = True¶
- async aembed_documents(texts: List[str]) List[List[float]] ¶
Asynchronous Embed search docs.
- async aembed_query(text: str) List[float] ¶
Asynchronous Embed query text.
- classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) Model ¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
- copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) Model ¶
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters
include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model
- Returns
new model instance
- dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny ¶
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- embed_documents(texts: List[str]) List[List[float]] [source]¶
Compute doc embeddings using Cloudflare Workers AI.
- Parameters
texts – The list of texts to embed.
- Returns
List of embeddings, one for each text.
- embed_query(text: str) List[float] [source]¶
Compute query embeddings using Cloudflare Workers AI.
- Parameters
text – The text to embed.
- Returns
Embeddings for the text.
- classmethod from_orm(obj: Any) Model ¶
- json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode ¶
Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
- classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- classmethod parse_obj(obj: Any) Model ¶
- classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny ¶
- classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode ¶
- classmethod update_forward_refs(**localns: Any) None ¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
- classmethod validate(value: Any) Model ¶