mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
3586 lines
144 KiB
HTML
3586 lines
144 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>OpenAPI specification</title>
|
|
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
<style>
|
|
body {
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
|
|
</style>
|
|
<script defer="defer" src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
|
|
<script defer="defer">
|
|
document.addEventListener("DOMContentLoaded", function () {
|
|
spec = {
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "[DRAFT] Llama Stack Specification",
|
|
"version": "0.0.1",
|
|
"description": "This is the specification of the llama stack that provides \n a set of endpoints and their corresponding interfaces that are tailored to \n best leverage Llama Models. The specification is still in draft and subject to change."
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "http://any-hosted-llama-stack.com"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/agentic_system/create": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgenticSystemCreateResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"AgenticSystem"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgenticSystemCreateRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/agentic_system/execute": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "non-stream response from the agentic system. **OR** Streamed agent execution response.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/AgenticSystemExecuteResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/AgenticSystemExecuteResponseStreamChunk"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"AgenticSystem"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AgenticSystemExecuteRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/datasets/create": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Datasets"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateDatasetRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/memory_banks/create": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "bank_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/agentic_system/delete": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"AgenticSystem"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "agent_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/datasets/delete": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"Datasets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/datasets/get": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Datasets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "dataset_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/memory_banks/get": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/jsonl": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/MemoryBank"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/post_training/job/artifacts": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJobArtifactsResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PostTraining"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "job_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/post_training/job/status": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJobStatusResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PostTraining"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "job_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/post_training/job/logs": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingJobLogStream"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"PostTraining"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "job_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/batch_chat_completion": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/jsonl": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatCompletionResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Inference"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchChatCompletionRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/batch_completion": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/jsonl": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CompletionResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Inference"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BatchCompletionRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/chat_completion": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "Normal chat completion response. **OR** Streamed chat completion response. The actual response is a series of such objects.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ChatCompletionResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/ChatCompletionResponseStreamChunk"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Inference"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatCompletionRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/completion": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "Normal completion response. **OR** streamed completion response.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/CompletionResponse"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/CompletionResponseStreamChunk"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"Inference"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CompletionRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/synthetic_data_generation/generate": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SyntheticDataGenerationResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"SyntheticDataGeneration"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SyntheticDataGenerationRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/memory_bank/get": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/jsonl": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/MemoryBankDocument"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/memory_bank/insert": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/post_training/preference_optimize/": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"PostTraining"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingRLHFRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/reward_scoring/score": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RewardScoringResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"RewardScoring"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RewardScoringRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/post_training/supervised_fine_tune/": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"PostTraining"
|
|
],
|
|
"parameters": [],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PostTrainingSFTRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/memory_bank/update": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
},
|
|
"/memory_banks/drop": {
|
|
"delete": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/memory_bank/delete": {
|
|
"post": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK"
|
|
}
|
|
},
|
|
"tags": [
|
|
"MemoryBanks"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "bank_uuid",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
|
|
"components": {
|
|
"schemas": {
|
|
"ShieldConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"shield_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama_guard",
|
|
"prompt_guard",
|
|
"code_guard"
|
|
],
|
|
"title": "The type of safety shield."
|
|
},
|
|
"params": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"shield_type",
|
|
"params"
|
|
]
|
|
},
|
|
"AgenticSystemCreateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"instructions": {
|
|
"type": "string"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b_chat",
|
|
"llama3_70b_chat"
|
|
]
|
|
},
|
|
"available_tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"web_search",
|
|
"math",
|
|
"image_gen",
|
|
"code_interpreter"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"parameters": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"input_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
},
|
|
"output_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"input_shields",
|
|
"output_shields"
|
|
]
|
|
}
|
|
},
|
|
"executable_tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"uniqueItems": true
|
|
},
|
|
"memory_bank_uuids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"input_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
},
|
|
"output_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"instructions",
|
|
"model",
|
|
"available_tools",
|
|
"executable_tools",
|
|
"memory_bank_uuids",
|
|
"input_shields",
|
|
"output_shields"
|
|
]
|
|
},
|
|
"AgenticSystemCreateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"agent_uuid": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"agent_uuid"
|
|
]
|
|
},
|
|
"AgenticSystemExecuteRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"agent_uuid": {
|
|
"type": "string"
|
|
},
|
|
"messages": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
},
|
|
"turn_history": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/AgenticSystemTurn"
|
|
}
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"agent_uuid",
|
|
"messages",
|
|
"turn_history",
|
|
"stream"
|
|
]
|
|
},
|
|
"AgenticSystemTurn": {
|
|
"type": "object",
|
|
"properties": {
|
|
"user_messages": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"step_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"model_inference",
|
|
"tool_execution",
|
|
"safety_filtering",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "The type of execution step.",
|
|
"default": "model_inference"
|
|
},
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"logprobs": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"step_type",
|
|
"uuid",
|
|
"text"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"step_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"model_inference",
|
|
"tool_execution",
|
|
"safety_filtering",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "The type of execution step.",
|
|
"default": "tool_execution"
|
|
},
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"tool_calls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "A tool call is a request to a tool."
|
|
}
|
|
},
|
|
"tool_responses": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"content"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"step_type",
|
|
"uuid",
|
|
"tool_calls",
|
|
"tool_responses"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"step_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"model_inference",
|
|
"tool_execution",
|
|
"safety_filtering",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "The type of execution step.",
|
|
"default": "safety_filtering"
|
|
},
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"violation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"violation_type": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "string"
|
|
},
|
|
"suggested_user_response": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"violation_type",
|
|
"details"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"step_type",
|
|
"uuid"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"step_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"model_inference",
|
|
"tool_execution",
|
|
"safety_filtering",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "The type of execution step.",
|
|
"default": "memory_retrieval"
|
|
},
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"documents": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
}
|
|
},
|
|
"scores": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"step_type",
|
|
"uuid",
|
|
"documents",
|
|
"scores"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"response_message": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"user_messages",
|
|
"steps",
|
|
"response_message"
|
|
],
|
|
"title": "A single turn in an interaction with an Agentic System."
|
|
},
|
|
"Attachment": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"url",
|
|
"mime_type"
|
|
],
|
|
"title": "Attachments are used to refer to external resources, such as images, videos, audio, etc."
|
|
},
|
|
"Message": {
|
|
"type": "object",
|
|
"properties": {
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"system",
|
|
"user",
|
|
"assistant",
|
|
"tool"
|
|
]
|
|
},
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"tool_calls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "A tool call is a request to a tool."
|
|
}
|
|
},
|
|
"tool_responses": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"content"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"role",
|
|
"content",
|
|
"tool_calls",
|
|
"tool_responses"
|
|
]
|
|
},
|
|
"URL": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"pattern": "^(https?://|file://|data:)"
|
|
},
|
|
"AgenticSystemExecuteResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"turn": {
|
|
"$ref": "#/components/schemas/AgenticSystemTurn"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"turn"
|
|
],
|
|
"title": "non-stream response from the agentic system."
|
|
},
|
|
"AgenticSystemExecuteResponseStreamChunk": {
|
|
"type": "object",
|
|
"properties": {
|
|
"event_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"step_start",
|
|
"step_end",
|
|
"step_progress"
|
|
],
|
|
"title": "The type of event."
|
|
},
|
|
"step_uuid": {
|
|
"type": "string"
|
|
},
|
|
"step_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"model_inference",
|
|
"tool_execution",
|
|
"safety_filtering",
|
|
"memory_retrieval"
|
|
],
|
|
"title": "The type of execution step."
|
|
},
|
|
"violation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"violation_type": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "string"
|
|
},
|
|
"suggested_user_response": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"violation_type",
|
|
"details"
|
|
]
|
|
},
|
|
"tool_call": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "A tool call is a request to a tool."
|
|
},
|
|
"tool_response_delta": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"content"
|
|
]
|
|
},
|
|
"response_text_delta": {
|
|
"type": "string"
|
|
},
|
|
"retrieved_document": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
},
|
|
"stop_reason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"not_stopped",
|
|
"finished_ok",
|
|
"max_tokens"
|
|
],
|
|
"title": "Stop reasons are used to indicate why the model stopped generating text."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"event_type",
|
|
"step_uuid",
|
|
"step_type"
|
|
],
|
|
"title": "Streamed agent execution response."
|
|
},
|
|
"CreateDatasetRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"dataset": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"dataset"
|
|
],
|
|
"title": "Request to create a dataset."
|
|
},
|
|
"Dataset": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columns": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dialog",
|
|
"text",
|
|
"media",
|
|
"number",
|
|
"json"
|
|
]
|
|
}
|
|
},
|
|
"content_url": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"columns",
|
|
"content_url",
|
|
"metadata"
|
|
],
|
|
"title": "Dataset to be used for training or evaluating language models."
|
|
},
|
|
"MemoryBank": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"name"
|
|
]
|
|
},
|
|
"PostTrainingJobArtifactsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string"
|
|
},
|
|
"checkpoints": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"iters": {
|
|
"type": "integer"
|
|
},
|
|
"path": {
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"iters",
|
|
"path"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"job_uuid",
|
|
"checkpoints"
|
|
],
|
|
"title": "Artifacts of a finetuning job."
|
|
},
|
|
"PostTrainingJobStatusResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"running",
|
|
"completed",
|
|
"failed",
|
|
"scheduled"
|
|
]
|
|
},
|
|
"scheduled_at": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"started_at": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"completed_at": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"resources_allocated": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"checkpoints": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"iters": {
|
|
"type": "integer"
|
|
},
|
|
"path": {
|
|
"$ref": "#/components/schemas/URL"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"iters",
|
|
"path"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"job_uuid",
|
|
"status",
|
|
"checkpoints"
|
|
],
|
|
"title": "Status of a finetuning job."
|
|
},
|
|
"PostTrainingJobLogStream": {
|
|
"type": "object",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string"
|
|
},
|
|
"log_lines": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"job_uuid",
|
|
"log_lines"
|
|
],
|
|
"title": "Stream of logs from a finetuning job."
|
|
},
|
|
"BatchChatCompletionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b_chat",
|
|
"llama3_70b_chat"
|
|
]
|
|
},
|
|
"batch_dialogs": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Dialog"
|
|
}
|
|
},
|
|
"sampling_params": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"type": "number",
|
|
"default": 0.0
|
|
},
|
|
"strategy": {
|
|
"type": "string",
|
|
"default": "greedy"
|
|
},
|
|
"top_p": {
|
|
"type": "number",
|
|
"default": 0.95
|
|
},
|
|
"top_k": {
|
|
"type": "integer",
|
|
"default": 0
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"temperature",
|
|
"strategy",
|
|
"top_p",
|
|
"top_k"
|
|
]
|
|
},
|
|
"available_tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"web_search",
|
|
"math",
|
|
"image_gen",
|
|
"code_interpreter"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"parameters": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"input_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
},
|
|
"output_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"input_shields",
|
|
"output_shields"
|
|
]
|
|
}
|
|
},
|
|
"max_tokens": {
|
|
"type": "integer",
|
|
"default": 0
|
|
},
|
|
"logprobs": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"model",
|
|
"batch_dialogs",
|
|
"sampling_params",
|
|
"available_tools",
|
|
"max_tokens",
|
|
"logprobs"
|
|
]
|
|
},
|
|
"Dialog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"$ref": "#/components/schemas/Message"
|
|
},
|
|
"message_history": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"message",
|
|
"message_history"
|
|
]
|
|
},
|
|
"ChatCompletionResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"tool_calls": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "A tool call is a request to a tool."
|
|
}
|
|
},
|
|
"stop_reason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"not_stopped",
|
|
"finished_ok",
|
|
"max_tokens"
|
|
],
|
|
"title": "Stop reasons are used to indicate why the model stopped generating text."
|
|
},
|
|
"logprobs": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"content",
|
|
"tool_calls"
|
|
],
|
|
"title": "Normal chat completion response."
|
|
},
|
|
"BatchCompletionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b",
|
|
"llama3_70b"
|
|
]
|
|
},
|
|
"content_batch": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"sampling_params": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"type": "number",
|
|
"default": 0.0
|
|
},
|
|
"strategy": {
|
|
"type": "string",
|
|
"default": "greedy"
|
|
},
|
|
"top_p": {
|
|
"type": "number",
|
|
"default": 0.95
|
|
},
|
|
"top_k": {
|
|
"type": "integer",
|
|
"default": 0
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"temperature",
|
|
"strategy",
|
|
"top_p",
|
|
"top_k"
|
|
]
|
|
},
|
|
"max_tokens": {
|
|
"type": "integer",
|
|
"default": 0
|
|
},
|
|
"logprobs": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"model",
|
|
"content_batch",
|
|
"sampling_params",
|
|
"max_tokens",
|
|
"logprobs"
|
|
]
|
|
},
|
|
"CompletionResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"stop_reason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"not_stopped",
|
|
"finished_ok",
|
|
"max_tokens"
|
|
],
|
|
"title": "Stop reasons are used to indicate why the model stopped generating text."
|
|
},
|
|
"logprobs": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"content"
|
|
],
|
|
"title": "Normal completion response."
|
|
},
|
|
"ChatCompletionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b_chat",
|
|
"llama3_70b_chat"
|
|
]
|
|
},
|
|
"dialog": {
|
|
"$ref": "#/components/schemas/Dialog"
|
|
},
|
|
"sampling_params": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"type": "number",
|
|
"default": 0.0
|
|
},
|
|
"strategy": {
|
|
"type": "string",
|
|
"default": "greedy"
|
|
},
|
|
"top_p": {
|
|
"type": "number",
|
|
"default": 0.95
|
|
},
|
|
"top_k": {
|
|
"type": "integer",
|
|
"default": 0
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"temperature",
|
|
"strategy",
|
|
"top_p",
|
|
"top_k"
|
|
]
|
|
},
|
|
"available_tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"web_search",
|
|
"math",
|
|
"image_gen",
|
|
"code_interpreter"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"parameters": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"input_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
},
|
|
"output_shields": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ShieldConfig"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"input_shields",
|
|
"output_shields"
|
|
]
|
|
}
|
|
},
|
|
"max_tokens": {
|
|
"type": "integer",
|
|
"default": 0
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"logprobs": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"model",
|
|
"dialog",
|
|
"sampling_params",
|
|
"available_tools",
|
|
"max_tokens",
|
|
"stream",
|
|
"logprobs"
|
|
]
|
|
},
|
|
"ChatCompletionResponseStreamChunk": {
|
|
"type": "object",
|
|
"properties": {
|
|
"text_delta": {
|
|
"type": "string"
|
|
},
|
|
"stop_reason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"not_stopped",
|
|
"finished_ok",
|
|
"max_tokens"
|
|
],
|
|
"title": "Stop reasons are used to indicate why the model stopped generating text."
|
|
},
|
|
"tool_call": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tool_name": {
|
|
"type": "string"
|
|
},
|
|
"arguments": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"tool_name",
|
|
"arguments"
|
|
],
|
|
"title": "A tool call is a request to a tool."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"text_delta"
|
|
],
|
|
"title": "Streamed chat completion response. The actual response is a series of such objects."
|
|
},
|
|
"CompletionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"content": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/Attachment"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b",
|
|
"llama3_70b"
|
|
]
|
|
},
|
|
"sampling_params": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"type": "number",
|
|
"default": 0.0
|
|
},
|
|
"strategy": {
|
|
"type": "string",
|
|
"default": "greedy"
|
|
},
|
|
"top_p": {
|
|
"type": "number",
|
|
"default": 0.95
|
|
},
|
|
"top_k": {
|
|
"type": "integer",
|
|
"default": 0
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"temperature",
|
|
"strategy",
|
|
"top_p",
|
|
"top_k"
|
|
]
|
|
},
|
|
"max_tokens": {
|
|
"type": "integer",
|
|
"default": 0
|
|
},
|
|
"stream": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"logprobs": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"content",
|
|
"model",
|
|
"sampling_params",
|
|
"max_tokens",
|
|
"stream",
|
|
"logprobs"
|
|
]
|
|
},
|
|
"CompletionResponseStreamChunk": {
|
|
"type": "object",
|
|
"properties": {
|
|
"text_delta": {
|
|
"type": "string"
|
|
},
|
|
"stop_reason": {
|
|
"type": "string",
|
|
"enum": [
|
|
"not_stopped",
|
|
"finished_ok",
|
|
"max_tokens"
|
|
],
|
|
"title": "Stop reasons are used to indicate why the model stopped generating text."
|
|
},
|
|
"logprobs": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"text_delta"
|
|
],
|
|
"title": "streamed completion response."
|
|
},
|
|
"SyntheticDataGenerationRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"prompts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
},
|
|
"filtering_function": {
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"random",
|
|
"top_k",
|
|
"top_p",
|
|
"top_k_top_p",
|
|
"sigmoid"
|
|
],
|
|
"title": "The type of filtering function.",
|
|
"default": "none"
|
|
},
|
|
"reward_scoring": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"prompts",
|
|
"filtering_function"
|
|
],
|
|
"title": "Request to generate synthetic data. A small batch of prompts and a filtering function"
|
|
},
|
|
"KScoredPromptGenerations": {
|
|
"type": "object",
|
|
"properties": {
|
|
"prompt": {
|
|
"$ref": "#/components/schemas/Message"
|
|
},
|
|
"k_scored_generations": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/ScoredMessage"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"prompt",
|
|
"k_scored_generations"
|
|
]
|
|
},
|
|
"ScoredMessage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"$ref": "#/components/schemas/Message"
|
|
},
|
|
"score": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"message",
|
|
"score"
|
|
]
|
|
},
|
|
"SyntheticDataGenerationResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"synthetic_data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/KScoredPromptGenerations"
|
|
}
|
|
},
|
|
"statistics": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"synthetic_data"
|
|
],
|
|
"title": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold."
|
|
},
|
|
"MemoryBankDocument": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"contentEncoding": "base64"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"uuid",
|
|
"content",
|
|
"metadata",
|
|
"mime_type"
|
|
]
|
|
},
|
|
"DPOAlignmentConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reward_scale": {
|
|
"type": "number"
|
|
},
|
|
"reward_clip": {
|
|
"type": "number"
|
|
},
|
|
"epsilon": {
|
|
"type": "number"
|
|
},
|
|
"gamma": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"reward_scale",
|
|
"reward_clip",
|
|
"epsilon",
|
|
"gamma"
|
|
]
|
|
},
|
|
"OptimizerConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"optimizer_type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"adam",
|
|
"adamw",
|
|
"sgd"
|
|
]
|
|
},
|
|
"lr": {
|
|
"type": "number"
|
|
},
|
|
"lr_min": {
|
|
"type": "number"
|
|
},
|
|
"weight_decay": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"optimizer_type",
|
|
"lr",
|
|
"lr_min",
|
|
"weight_decay"
|
|
]
|
|
},
|
|
"PostTrainingRLHFRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string"
|
|
},
|
|
"finetuned_model": {
|
|
"$ref": "#/components/schemas/URL"
|
|
},
|
|
"dataset": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
},
|
|
"validation_dataset": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
},
|
|
"algorithm": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dpo"
|
|
]
|
|
},
|
|
"algorithm_config": {
|
|
"$ref": "#/components/schemas/DPOAlignmentConfig"
|
|
},
|
|
"optimizer_config": {
|
|
"$ref": "#/components/schemas/OptimizerConfig"
|
|
},
|
|
"training_config": {
|
|
"$ref": "#/components/schemas/TrainingConfig"
|
|
},
|
|
"hyperparam_search_config": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"logger_config": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"job_uuid",
|
|
"finetuned_model",
|
|
"dataset",
|
|
"validation_dataset",
|
|
"algorithm",
|
|
"algorithm_config",
|
|
"optimizer_config",
|
|
"training_config",
|
|
"hyperparam_search_config",
|
|
"logger_config"
|
|
],
|
|
"title": "Request to finetune a model."
|
|
},
|
|
"TrainingConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"n_epochs": {
|
|
"type": "integer"
|
|
},
|
|
"batch_size": {
|
|
"type": "integer"
|
|
},
|
|
"shuffle": {
|
|
"type": "boolean"
|
|
},
|
|
"n_iters": {
|
|
"type": "integer"
|
|
},
|
|
"enable_activation_checkpointing": {
|
|
"type": "boolean"
|
|
},
|
|
"memory_efficient_fsdp_wrap": {
|
|
"type": "boolean"
|
|
},
|
|
"fsdp_cpu_offload": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"n_epochs",
|
|
"batch_size",
|
|
"shuffle",
|
|
"n_iters",
|
|
"enable_activation_checkpointing",
|
|
"memory_efficient_fsdp_wrap",
|
|
"fsdp_cpu_offload"
|
|
]
|
|
},
|
|
"RewardScoringRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"prompt_generations": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dialog": {
|
|
"$ref": "#/components/schemas/Dialog"
|
|
},
|
|
"k_generations": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Message"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"dialog",
|
|
"k_generations"
|
|
]
|
|
}
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_405b_reward"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"prompt_generations",
|
|
"model"
|
|
],
|
|
"title": "Request to score a reward function. A list of prompts and a list of responses per prompt."
|
|
},
|
|
"RewardScoringResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"scored_generations": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/KScoredPromptGenerations"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"scored_generations"
|
|
],
|
|
"title": "Response from the reward scoring. Batch of (prompt, response, score) tuples that pass the threshold."
|
|
},
|
|
"DoraFinetuningConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"lora_attn_modules": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"apply_lora_to_mlp": {
|
|
"type": "boolean"
|
|
},
|
|
"apply_lora_to_output": {
|
|
"type": "boolean"
|
|
},
|
|
"rank": {
|
|
"type": "integer"
|
|
},
|
|
"alpha": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"lora_attn_modules",
|
|
"apply_lora_to_mlp",
|
|
"apply_lora_to_output",
|
|
"rank",
|
|
"alpha"
|
|
]
|
|
},
|
|
"LoraFinetuningConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"lora_attn_modules": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"apply_lora_to_mlp": {
|
|
"type": "boolean"
|
|
},
|
|
"apply_lora_to_output": {
|
|
"type": "boolean"
|
|
},
|
|
"rank": {
|
|
"type": "integer"
|
|
},
|
|
"alpha": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"lora_attn_modules",
|
|
"apply_lora_to_mlp",
|
|
"apply_lora_to_output",
|
|
"rank",
|
|
"alpha"
|
|
]
|
|
},
|
|
"PostTrainingSFTRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"job_uuid": {
|
|
"type": "string"
|
|
},
|
|
"model": {
|
|
"type": "string",
|
|
"enum": [
|
|
"llama3_8b",
|
|
"llama3_70b"
|
|
]
|
|
},
|
|
"dataset": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
},
|
|
"validation_dataset": {
|
|
"$ref": "#/components/schemas/Dataset"
|
|
},
|
|
"algorithm": {
|
|
"type": "string",
|
|
"enum": [
|
|
"full",
|
|
"lora",
|
|
"qlora",
|
|
"dora"
|
|
]
|
|
},
|
|
"algorithm_config": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/LoraFinetuningConfig"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/QLoraFinetuningConfig"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/DoraFinetuningConfig"
|
|
}
|
|
]
|
|
},
|
|
"optimizer_config": {
|
|
"$ref": "#/components/schemas/OptimizerConfig"
|
|
},
|
|
"training_config": {
|
|
"$ref": "#/components/schemas/TrainingConfig"
|
|
},
|
|
"hyperparam_search_config": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"logger_config": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"job_uuid",
|
|
"model",
|
|
"dataset",
|
|
"validation_dataset",
|
|
"algorithm",
|
|
"algorithm_config",
|
|
"optimizer_config",
|
|
"training_config",
|
|
"hyperparam_search_config",
|
|
"logger_config"
|
|
],
|
|
"title": "Request to finetune a model."
|
|
},
|
|
"QLoraFinetuningConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"lora_attn_modules": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"apply_lora_to_mlp": {
|
|
"type": "boolean"
|
|
},
|
|
"apply_lora_to_output": {
|
|
"type": "boolean"
|
|
},
|
|
"rank": {
|
|
"type": "integer"
|
|
},
|
|
"alpha": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"lora_attn_modules",
|
|
"apply_lora_to_mlp",
|
|
"apply_lora_to_output",
|
|
"rank",
|
|
"alpha"
|
|
]
|
|
}
|
|
},
|
|
"responses": {}
|
|
},
|
|
"security": [
|
|
{
|
|
"Default": []
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "AgenticSystem",
|
|
"description": "Multi-step tool-use concretely helps address many common problems with LLMs that users may \n face:\n 1. Finding accurate and up-to-date information. LLMs are limited to training data and knowledge cut off date. \n 2. Current LLMs are limited in their understanding and reasoning abilities for solving more complex math problems, processing and analyzing data. Tools like code-execution or APIs like Wolfram can help bridge the gap.\n 3. Users may need help with a task that requires multiple tools to execute or a task that has multiple steps (e.g., graph plotting, etc.)\n 4. Our current LLMs are not able to generate other modalities (images, voice, video) directly. \n\nFinally, we want the underlying LLM to remain broadly steerable and adaptable to use cases which \nneed varying levels of safety protection. To enable this, we want to shift safety into a two-tiered \nsystem: \n 1. a set of \"always on\" safety checks are always performed at the model level, and\n 2. a set of configurable safety checks which can be run at the overall system level.",
|
|
"x-displayName": "The Llama 3 models released by Meta in July should not just be seen as a model, but really as a system starting the transition towards an entity capable of performing \"agentic\" tasks. By that we mean the following specific capabilities: 1. Ability to act as the central planner -- break a task down and perform multi-step reasoning. 2. Ability to perceive multimodal inputs -- text, images, files and eventually speech and video in later iterations. 3. Ability to use tools - a. built-in: the model has built-in knowledge of tools like search or code interpreter b. zero-shot: the model can learn to call tools using previously unseen, in-context tool definitions"
|
|
},
|
|
{
|
|
"name": "SyntheticDataGeneration"
|
|
},
|
|
{
|
|
"name": "Datasets"
|
|
},
|
|
{
|
|
"name": "MemoryBanks"
|
|
},
|
|
{
|
|
"name": "Inference",
|
|
"x-displayName": "Set of methods that can be called on the inference service."
|
|
},
|
|
{
|
|
"name": "PostTraining"
|
|
},
|
|
{
|
|
"name": "RewardScoring"
|
|
},
|
|
{
|
|
"name": "ShieldConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShieldConfig\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemCreateRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemCreateRequest\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemCreateResponse",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemCreateResponse\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemExecuteRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemExecuteRequest\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemTurn",
|
|
"description": "A single turn in an interaction with an Agentic System.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemTurn\" />"
|
|
},
|
|
{
|
|
"name": "Attachment",
|
|
"description": "Attachments are used to refer to external resources, such as images, videos, audio, etc.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />"
|
|
},
|
|
{
|
|
"name": "Message",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Message\" />"
|
|
},
|
|
{
|
|
"name": "URL",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/URL\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemExecuteResponse",
|
|
"description": "non-stream response from the agentic system.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemExecuteResponse\" />"
|
|
},
|
|
{
|
|
"name": "AgenticSystemExecuteResponseStreamChunk",
|
|
"description": "Streamed agent execution response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/AgenticSystemExecuteResponseStreamChunk\" />"
|
|
},
|
|
{
|
|
"name": "CreateDatasetRequest",
|
|
"description": "Request to create a dataset.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CreateDatasetRequest\" />"
|
|
},
|
|
{
|
|
"name": "Dataset",
|
|
"description": "Dataset to be used for training or evaluating language models.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/Dataset\" />"
|
|
},
|
|
{
|
|
"name": "MemoryBank",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBank\" />"
|
|
},
|
|
{
|
|
"name": "PostTrainingJobArtifactsResponse",
|
|
"description": "Artifacts of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobArtifactsResponse\" />"
|
|
},
|
|
{
|
|
"name": "PostTrainingJobStatusResponse",
|
|
"description": "Status of a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobStatusResponse\" />"
|
|
},
|
|
{
|
|
"name": "PostTrainingJobLogStream",
|
|
"description": "Stream of logs from a finetuning job.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingJobLogStream\" />"
|
|
},
|
|
{
|
|
"name": "BatchChatCompletionRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionRequest\" />"
|
|
},
|
|
{
|
|
"name": "Dialog",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Dialog\" />"
|
|
},
|
|
{
|
|
"name": "ChatCompletionResponse",
|
|
"description": "Normal chat completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponse\" />"
|
|
},
|
|
{
|
|
"name": "BatchCompletionRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequest\" />"
|
|
},
|
|
{
|
|
"name": "CompletionResponse",
|
|
"description": "Normal completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponse\" />"
|
|
},
|
|
{
|
|
"name": "ChatCompletionRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />"
|
|
},
|
|
{
|
|
"name": "ChatCompletionResponseStreamChunk",
|
|
"description": "Streamed chat completion response. The actual response is a series of such objects.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseStreamChunk\" />"
|
|
},
|
|
{
|
|
"name": "CompletionRequest",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequest\" />"
|
|
},
|
|
{
|
|
"name": "CompletionResponseStreamChunk",
|
|
"description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />"
|
|
},
|
|
{
|
|
"name": "SyntheticDataGenerationRequest",
|
|
"description": "Request to generate synthetic data. A small batch of prompts and a filtering function\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationRequest\" />"
|
|
},
|
|
{
|
|
"name": "KScoredPromptGenerations",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/KScoredPromptGenerations\" />"
|
|
},
|
|
{
|
|
"name": "ScoredMessage",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ScoredMessage\" />"
|
|
},
|
|
{
|
|
"name": "SyntheticDataGenerationResponse",
|
|
"description": "Response from the synthetic data generation. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationResponse\" />"
|
|
},
|
|
{
|
|
"name": "MemoryBankDocument",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/MemoryBankDocument\" />"
|
|
},
|
|
{
|
|
"name": "DPOAlignmentConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
|
|
},
|
|
{
|
|
"name": "OptimizerConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/OptimizerConfig\" />"
|
|
},
|
|
{
|
|
"name": "PostTrainingRLHFRequest",
|
|
"description": "Request to finetune a model.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingRLHFRequest\" />"
|
|
},
|
|
{
|
|
"name": "TrainingConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />"
|
|
},
|
|
{
|
|
"name": "RewardScoringRequest",
|
|
"description": "Request to score a reward function. A list of prompts and a list of responses per prompt.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoringRequest\" />"
|
|
},
|
|
{
|
|
"name": "RewardScoringResponse",
|
|
"description": "Response from the reward scoring. Batch of (prompt, response, score) tuples that pass the threshold.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoringResponse\" />"
|
|
},
|
|
{
|
|
"name": "DoraFinetuningConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DoraFinetuningConfig\" />"
|
|
},
|
|
{
|
|
"name": "LoraFinetuningConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LoraFinetuningConfig\" />"
|
|
},
|
|
{
|
|
"name": "PostTrainingSFTRequest",
|
|
"description": "Request to finetune a model.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/PostTrainingSFTRequest\" />"
|
|
},
|
|
{
|
|
"name": "QLoraFinetuningConfig",
|
|
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />"
|
|
}
|
|
],
|
|
"x-tagGroups": [
|
|
{
|
|
"name": "Operations",
|
|
"tags": [
|
|
"AgenticSystem",
|
|
"Datasets",
|
|
"Inference",
|
|
"MemoryBanks",
|
|
"PostTraining",
|
|
"RewardScoring",
|
|
"SyntheticDataGeneration"
|
|
]
|
|
},
|
|
{
|
|
"name": "Types",
|
|
"tags": [
|
|
"AgenticSystemCreateRequest",
|
|
"AgenticSystemCreateResponse",
|
|
"AgenticSystemExecuteRequest",
|
|
"AgenticSystemExecuteResponse",
|
|
"AgenticSystemExecuteResponseStreamChunk",
|
|
"AgenticSystemTurn",
|
|
"Attachment",
|
|
"BatchChatCompletionRequest",
|
|
"BatchCompletionRequest",
|
|
"ChatCompletionRequest",
|
|
"ChatCompletionResponse",
|
|
"ChatCompletionResponseStreamChunk",
|
|
"CompletionRequest",
|
|
"CompletionResponse",
|
|
"CompletionResponseStreamChunk",
|
|
"CreateDatasetRequest",
|
|
"DPOAlignmentConfig",
|
|
"Dataset",
|
|
"Dialog",
|
|
"DoraFinetuningConfig",
|
|
"KScoredPromptGenerations",
|
|
"LoraFinetuningConfig",
|
|
"MemoryBank",
|
|
"MemoryBankDocument",
|
|
"Message",
|
|
"OptimizerConfig",
|
|
"PostTrainingJobArtifactsResponse",
|
|
"PostTrainingJobLogStream",
|
|
"PostTrainingJobStatusResponse",
|
|
"PostTrainingRLHFRequest",
|
|
"PostTrainingSFTRequest",
|
|
"QLoraFinetuningConfig",
|
|
"RewardScoringRequest",
|
|
"RewardScoringResponse",
|
|
"ScoredMessage",
|
|
"ShieldConfig",
|
|
"SyntheticDataGenerationRequest",
|
|
"SyntheticDataGenerationResponse",
|
|
"TrainingConfig",
|
|
"URL"
|
|
]
|
|
}
|
|
]
|
|
};
|
|
options = {
|
|
downloadFileName: "openapi.json",
|
|
expandResponses: "200",
|
|
expandSingleSchemaField: true,
|
|
jsonSampleExpandLevel: "all",
|
|
schemaExpansionLevel: "all",
|
|
};
|
|
element = document.getElementById("openapi-container");
|
|
Redoc.init(spec, options, element);
|
|
|
|
if (spec.info && spec.info.title) {
|
|
document.title = spec.info.title;
|
|
}
|
|
});
|
|
</script>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="openapi-container"></div>
|
|
</body>
|
|
|
|
</html>
|