Text Embeddings Inference

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

post/embed_sparse

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/oracle/apis/text-embeddings-inference/docs/embed_sparse/post.ts
A function with typed inputs. Its response is checked against the schema.

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

No recorded changes to this operation across all 1 revision of this API.