<aside> 🔔 This page is public.

</aside>

Previous API

This page list the changes and additions to the APIs for v1.8.

For the API as of v1.6 and v1.7, please refer to v1.6: Hybrid Search & Embedders

Breaking changes

In review: don’t display query vector in response

Semantic/hybrid search response before:

{
  "hits": [ ... unchanged ... ],
  "query": "A comforting movie about cute puppies",
  "vector": [
    -0.26044133,
    -0.53464675,
    -0.009057333,
    0.010902484,
    [.. removing 500+ values for brevity here ..]
    0.67254055,
    0.22270222,
    -0.22854002,
    0.78520995
  ],
  "processingTimeMs": 160,
  "limit": 100,
  "offset": 0,
  "estimatedTotalHits": 1000
}

Semantic/hybrid search response after:

{
  "hits": [ ... unchanged ... ],
  "query": "A comforting movie about cute puppies",
  "processingTimeMs": 160,
  "limit": 100,
  "offset": 0,
  "estimatedTotalHits": 1000
}

In review: remove the _semanticScore

Semantic/hybrid hit before:

    {
      "title": "Angel Dog",
      "overview": "This heart warming film is about a dog named Cooper who is the lone survivor of a terrible car accident. Jake, a family patriarch, loses his wife and children in the accident. Not being a dog person, Jake is angry and resentful toward the dog for even surviving. However, eventually Jake bonds with Cooper, and this bond ends up being the one thing that gets him out of bed in the morning, the one thing that helps him to go on living after such a tragic loss.",
      "id": 83735,
      "genres": [
        "Drama",
        "Family"
      ],
      "poster": "<https://image.tmdb.org/t/p/w500/5IAjwwvFz9RiaRGexwQvbwiEM24.jpg>",
      "release_date": 1300492800,
      "_rankingScore": 0.565953254699707,
      "_semanticScore": 0.56595325
    }

Semantic/hybrid hit after:

    {
      "title": "Angel Dog",
      "overview": "This heart warming film is about a dog named Cooper who is the lone survivor of a terrible car accident. Jake, a family patriarch, loses his wife and children in the accident. Not being a dog person, Jake is angry and resentful toward the dog for even surviving. However, eventually Jake bonds with Cooper, and this bond ends up being the one thing that gets him out of bed in the morning, the one thing that helps him to go on living after such a tragic loss.",
      "id": 83735,
      "genres": [
        "Drama",
        "Family"
      ],
      "poster": "<https://image.tmdb.org/t/p/w500/5IAjwwvFz9RiaRGexwQvbwiEM24.jpg>",
      "release_date": 1300492800,
      "_rankingScore": 0.565953254699707
    }

The _rankingScore has the same value as the _semanticScore, and should be used in its place. It can be enabled by adding "showRankingScore": true to the search query.

In review: don’t display vectors in score details

_rankingScoreDetails of a semantic search-returned document before:

"_rankingScoreDetails": {
  "vectorSort([-0.26044133, -0.53464675, -0.009057333, .. removing 500+ values for brevity here .. 0.32289985, 0.6428947, 0.78520995])": {
    "order": 0,
    "value": [
            -0.19964811205863953,
            0.4916475713253021,
            0.17062808573246002,
            -0.02287752740085125 
            -1.189256191253662,
            0.8196011781692505,
            -0.1416332870721817,
            -0.16320504248142242,
            0.5034922361373901,
            0.001925887307152152,
						[.. removing 500+ values for brevity here ..],
            0.6723353266716003,
            -1.102553129196167,
            -0.28498417139053345,
            0.007601038552820683,
            0.35341498255729675,
            0.3309010863304138
    ],
    "similarity": 0.5335760116577148
  }
},