HUhuggingface
Text Embeddings Inference

Get Sentence Similarity. Returns a 424 status code if the model is not an embedding model.

Changed on
post/similarity

Request

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

Request body

Example request

{
  "inputs": {
    "sentences": [
      "What is Machine Learning?"
    ],
    "source_sentence": "What is Deep Learning?"
  },
  "parameters": {
    "prompt_name": "null"
  }
}

Response

Sentence Similarity

number[] required

Example response

[
  0,
  1,
  0.5
]

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

      the request property ///// became optional

    • info

      added the non-success response with the status

  • c8403e993990Revision changes
    • info

      endpoint added