GET
/
api
/
dataset
/
{dataset_id}
curl --request GET \
  --url https://api.trieve.ai/api/dataset/{dataset_id} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'
{
  "created_at": "2021-01-01 00:00:00.000",
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "name": "Trieve",
  "organization_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "server_configuration": {
    "AIMON_RERANKER_TASK_DEFINITION": "Your task is to grade the relevance of context document(s) against the specified user query.",
    "BM25_AVG_LEN": 256,
    "BM25_B": 0.75,
    "BM25_ENABLED": true,
    "BM25_K": 0.75,
    "DISTANCE_METRIC": "cosine",
    "EMBEDDING_BASE_URL": "https://embedding.trieve.ai",
    "EMBEDDING_MODEL_NAME": "jina-base-en",
    "EMBEDDING_QUERY_PREFIX": "",
    "EMBEDDING_SIZE": 768,
    "FREQUENCY_PENALTY": 0,
    "FULLTEXT_ENABLED": true,
    "INDEXED_ONLY": false,
    "LLM_BASE_URL": "https://api.openai.com/v1",
    "LLM_DEFAULT_MODEL": "gpt-4o",
    "LOCKED": false,
    "MAX_LIMIT": 10000,
    "MESSAGE_TO_QUERY_PROMPT": "Write a 1-2 sentence semantic search query along the lines of a hypothetical response to: \n\n",
    "N_RETRIEVALS_TO_INCLUDE": 8,
    "PRESENCE_PENALTY": 0,
    "QDRANT_ONLY": false,
    "RAG_PROMPT": "Use the following retrieved documents to respond briefly and accurately:",
    "SEMANTIC_ENABLED": true,
    "STOP_TOKENS": [
      "\n\n",
      "\n"
    ],
    "SYSTEM_PROMPT": "You are a helpful assistant",
    "TEMPERATURE": 0.5,
    "USE_MESSAGE_TO_QUERY_PROMPT": false
  },
  "tracking_id": "foobar-dataset",
  "updated_at": "2021-01-01 00:00:00.000"
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Path Parameters

​
dataset_id
string
required

The id of the dataset you want to retrieve.

Response

200
application/json

Dataset retrieved successfully

The response is of type object.