Chunks

Rank Chunks

Description

Sorts a list of text chunks by similarity against a given query string.

Details

Use this API endpoint to rank which text chunks provide the most relevant responses to a given a query string.

This is useful for stuffing chunks into a prompt where order may matter or for filtering out less relevant chunks according to the ranking strategy. For example, this API may be useful when doing retrieval augment generation (RAG). Sometimes vector store similarity search does not always return the best ranking of text chunks, since this is heavily dependent on embedding generation. This API endpoint can act as a post-processing step to re-sort the given chunks using more complex strategies that may outperform vector search, and then filter only the top-k most relevant chunks to stuff into the prompt for RAG.

Restrictions and Limits

Ranking can be a very intensive and slow process depending on methodology where duration scales with number of chunks. For best performance, we recommend ranking less than 640 chunks at a time, and you may see a decrease in performance as the number of chunks ranked increases.

POST

chunks

rank

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const rankedChunksResponse = await client.chunks.rank({
    query: 'query',
    rank_strategy: { method: 'cross_encoder' },
    relevant_chunks: [{ chunk_id: 'chunk_id', score: 0, text: 'text' }],
  });

  console.log(rankedChunksResponse.relevant_chunks);
}

main();

{
  "relevant_chunks": [
    {
      "chunk_id": "<string>",
      "text": "<string>",
      "embedding": [
        123
      ],
      "metadata": {},
      "user_supplied_metadata": {},
      "attachment_url": "<string>",
      "title": "<string>",
      "score": 123
    }
  ]
}

Authorizations

x-api-key

string

header

required

Body

application/json

query

string

required

Natural language query to re-rank chunks against. If a vector store query was originally used to retrieve these chunks, please use the same query for this ranking

relevant_chunks

object[]

required

List of chunks to rank

rank_strategy

object

required

The ranking strategy to use.

Rank strategies determine how the ranking is done, They consist of the ranking method name and additional params needed to compute the ranking.

Use the built-in cross_encoder or rouge strategies or create a custom one with the Models API.

top_k

integer

Number of chunks to return. Must be greater than 0 if specified. If not specified, all chunks will be returned.

Required range: x > 0

account_id

string

Account to rank chunks with. If you have access to more than one account, you must specify an account_id

Response

200

application/json

Successful Response

relevant_chunks

object[]

required

List of chunks ranked by the requested rank strategy

Update Upload Schedule Execute Agent

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const rankedChunksResponse = await client.chunks.rank({
    query: 'query',
    rank_strategy: { method: 'cross_encoder' },
    relevant_chunks: [{ chunk_id: 'chunk_id', score: 0, text: 'text' }],
  });

  console.log(rankedChunksResponse.relevant_chunks);
}

main();

{
  "relevant_chunks": [
    {
      "chunk_id": "<string>",
      "text": "<string>",
      "embedding": [
        123
      ],
      "metadata": {},
      "user_supplied_metadata": {},
      "attachment_url": "<string>",
      "title": "<string>",
      "score": 123
    }
  ]
}

Knowledge Bases

Chunks

Agents

Completions

Chat Completions

Models

Users

Accounts

Organizations

Question Sets

Evaluations

Evaluation Configs

Evaluation Datasets

Studio Projects

Application Specs

Questions

Knowledge Base Data Sources

Model Templates V3 (Beta)

Model server

API Reference

Fine Tuning Jobs V3 (Beta)

Training Datasets V3 (Beta)

package deployments

Beta

Applications

ChatThreads

Interactions

MonitoringDashboard

Chat Themes

account groups

account

Guardrails

Rank Chunks

Description

Details

Restrictions and Limits

Authorizations

Body

Response