semantic_router.encoders.huggingface.HFEndpointEncoder#

class semantic_router.encoders.huggingface.HFEndpointEncoder(name='hugging_face_custom_endpoint', huggingface_url=None, huggingface_api_key=None, score_threshold=0.8)#

Bases: BaseEncoder

A class to encode documents using a Hugging Face transformer model endpoint.

Attributes:: huggingface_url (str): The URL of the Hugging Face API endpoint. huggingface_api_key (str): The API key for authenticating with the Hugging Face API. score_threshold (float): A threshold value used for filtering or processing the embeddings.

__init__(name='hugging_face_custom_endpoint', huggingface_url=None, huggingface_api_key=None, score_threshold=0.8)#

Initializes the HFEndpointEncoder with the specified parameters.

Args:

name (str, optional): The name of the encoder. Defaults to: “hugging_face_custom_endpoint”.
huggingface_url (str, optional): The URL of the Hugging Face API endpoint.: Cannot be None.
huggingface_api_key (str, optional): The API key for the Hugging Face API.: Cannot be None.
score_threshold (float, optional): A threshold for processing the embeddings.: Defaults to 0.8.

Raises:

ValueError: If either huggingface_url or huggingface_api_key is None.

Methods

`__init__`([name, huggingface_url, ...])	Initializes the HFEndpointEncoder with the specified parameters.
`acall`(docs)	rtype: `Coroutine`[`Any`, `Any`, `List`[`List`[`float`]]]
`construct`([_fields_set])	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
`copy`(*[, include, exclude, update, deep])	Duplicate a model, optionally choose which fields to include, exclude and change.
`dict`(*[, include, exclude, by_alias, ...])	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
`from_orm`(obj)	rtype: Model
`json`(*[, include, exclude, by_alias, ...])	Generate a JSON representation of the model, include and exclude arguments as per dict().
`parse_file`(path, *[, content_type, ...])	rtype: Model
`parse_obj`(obj)	rtype: Model
`parse_raw`(b, *[, content_type, encoding, ...])	rtype: Model
`query`(payload[, max_retries, retry_interval])	Sends a query to the Hugging Face API and returns the response.
`schema`([by_alias, ref_template])	rtype: DictStrAny
`schema_json`(*[, by_alias, ref_template])	rtype: `str`
`set_score_threshold`(v)
`update_forward_refs`(**localns)	Try to update ForwardRefs on fields based on this Model, globalns and localns.
`validate`(value)	rtype: Model

Attributes

`name`
`huggingface_url`
`huggingface_api_key`
`score_threshold`
`type`

classmethod construct(_fields_set=None, **values)#

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

Return type:: Model

copy(*, include=None, exclude=None, update=None, deep=False)#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

include (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to include in new model
exclude (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to exclude from new model, as with values this takes precedence over include
update (Optional[DictStrAny]) – 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 (bool) – set to True to make a deep copy of the model

Return type:

Model

Returns:

new model instance

dict(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False)#

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Return type:: DictStrAny

json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **dumps_kwargs)#

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().

Return type:: str

query(payload, max_retries=3, retry_interval=5)#

Sends a query to the Hugging Face API and returns the response.

Args:: payload (dict): The payload to send in the request.
Returns:: dict: The response from the Hugging Face API.
Raises:: ValueError: If the query fails or the response status is not 200.

classmethod update_forward_refs(**localns)#

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Return type:: None