HUhuggingface
Text Embeddings Inference

Get Sparse Embeddings. Returns a 424 status code if the model is not an embedding model with SPLADE pooling.

Changed on
post/embed_sparse

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

prompt_namestring nullable

The name of the prompt that should be used by for encoding. If not set, no prompt will be applied.

Must be a key in the sentence-transformers configuration prompts dictionary.

For example if prompt_name is "query" and the prompts is {"query": "query: ", ...}, then the sentence "What is the capital of France?" will be encoded as "query: What is the capital of France?" because the prompt text will be prepended before any text to encode.

truncateboolean nullable
truncation_direction'Left' | 'Right'

Example request

{
  "prompt_name": "null"
}

Response

Embeddings

Changes

  • 9988d0e89620Revision changes
    • warning

      added the new Empty enum value to the response property for the response status

    • warning

      added the new Empty enum value to the response property for the response status

    • warning

      added the new Empty enum value to the response property for the response status

    • warning

      added the new Empty enum value to the response property for the response status

    • info

      added the non-success response with the status

  • b923798e3868Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      added subschema #2 to the request property oneOf list