Retrieve - Lyzr

Retrieve

curl --request GET \
  --url https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/ \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Error: '123343' is not a valid ObjectId, it must be a 12-byte input or a 24-character hex string"
}

GET

/

rag

/

{rag_id}

/

retrieve

/

Retrieve

curl --request GET \
  --url https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/ \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://rag-prod.studio.lyzr.ai/v3/rag/{rag_id}/retrieve/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "Error: '123343' is not a valid ObjectId, it must be a 12-byte input or a 24-character hex string"
}

Authorizations

x-api-key

string

header

required

Path Parameters

rag_id

string

required

The unique identifier (ID) of the RAG system to query (must be a 24-character hex string).

Example:

"654c602a46c3b6d4e28741b0"

Query Parameters

query

string

required

The search query string used to retrieve documents.

Example:

"type the necessary query"

top_k

integer

required

The maximum number of top relevant documents to return.

Example:

10

lambda_param

number<float>

required

Factor for Maximum Marginal Relevance (MMR) trade-off (0.0 to 1.0).

Example:

0.6

retrieval_type

enum<string>

required

The retrieval strategy to use.

Available options:

basic,

mmr,

hyde,

time_aware

Example:

"basic"

score_threshold

number<float>

required

Minimum score required for a document to be included (0.0 to 1.0).

Example:

0

time_decay_factor

number<float>

required

Factor for time-aware retrieval to weight newer documents higher.

Example:

0.7

Response

Documents successfully retrieved.

Placeholder for the retrieved document structure (typically a list of Document objects with relevance scores).