New Base Rag Dataset

POST 
/v2/projects/:project_id/synth/rag/

Create a new RAG (Retrieved Augmented Generation) synthetic dataset.

Parameters:

• project_id (str): The ID of the project associated with the dataset.
• samples (int): The number of samples to generate for the dataset.
• files (List[UploadFile]): The list of uploaded files for dataset generation.
• name (Optional[str], optional): The name of the dataset. If not provided, a random name will be generated. Defaults to None.

Returns:

• schemas.NamedObjIdentifier: An object containing the ID and name of the created dataset.

Raises:

• HTTPException: If the number of samples is less than 1 or if the user's usage limit is exceeded.

Request

Path Parameters

project_id Project Idrequired

Query Parameters

samples Samplesrequired
name any

multipart/form-data

Body

required

files binary[]required

Responses

200

Successful Response

application/json

Schema

Schema

id Id (string)required
name Name (string)required

Example (from schema)

{
  "id": "string",
  "name": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

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

Loading...