Create Prompt Mixin Prompts

POST 
/api/v1/projects/:project_id/prompts

Create a new PromptMixin prompt set.

Request

Path Parameters

project_id anyrequired

Query Parameters

organization_id any

Cookie Parameters

session any

application/json

Body

required

project_id uuidrequired

The ID of the project.

id

object

The ID of the prompt set.

anyOf

MOD1

string

name Name (string)required

The name of the prompt set.

prompts

object[]

required

The prompts.

Array [

prompt_key Prompt Key (string)required

The key of the prompt in the PromptMixin.

prompt_class Prompt Class (string)required

The class of the prompt (PromptTemplate or ChatPromptTemplate).

prompt_type Prompt Type (string)required

The type of prompt.

template

object

The template of the prompt.

anyOf

MOD1

string

message_templates

object

The chat message templates of the prompt.

anyOf

MOD1

Array [

id uuidrequired

index Index (integer)required

The index of the message in the chat.

annotations

object[]

Retrieval annotations for the message.

Array [

type Type (string)required

data Data (string)required

class_name Class Name (string)

Default value: base_component

]

role MessageRole (string)required

Message role.

Possible values: [system, user, assistant, function, tool, chatbot, model]

content

object

Text content of the generation

anyOf

MOD1

string

additional_kwargs

object

Additional arguments passed to the model

property name* string

class_name Class Name (string)

Default value: base_component

]

]

Responses

200

Successful Response

application/json

Schema

Schema

project_id uuidrequired

The ID of the project.

id

object

The ID of the prompt set.

anyOf

MOD1

string

name Name (string)required

The name of the prompt set.

prompts

object[]

required

The prompts.

Array [

prompt_key Prompt Key (string)required

The key of the prompt in the PromptMixin.

prompt_class Prompt Class (string)required

The class of the prompt (PromptTemplate or ChatPromptTemplate).

prompt_type Prompt Type (string)required

The type of prompt.

template

object

The template of the prompt.

anyOf

MOD1

string

message_templates

object

The chat message templates of the prompt.

anyOf

MOD1

Array [

id uuidrequired

index Index (integer)required

The index of the message in the chat.

annotations

object[]

Retrieval annotations for the message.

Array [

type Type (string)required

data Data (string)required

class_name Class Name (string)

Default value: base_component

]

role MessageRole (string)required

Message role.

Possible values: [system, user, assistant, function, tool, chatbot, model]

content

object

Text content of the generation

anyOf

MOD1

string

additional_kwargs

object

Additional arguments passed to the model

property name* string

class_name Class Name (string)

Default value: base_component

]

]

Example (from schema)

{
  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "prompts": [
    {
      "prompt_key": "string",
      "prompt_class": "string",
      "prompt_type": "string",
      "template": "string",
      "message_templates": [
        null
      ]
    }
  ]
}

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...