phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-07-29 15:23:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update wrapper request

Browse source
This commit is contained in:
Xi Yan 2024-09-09 11:15:22 -07:00
parent 838ab91ebf
commit 84b8a53a34
3 changed files with 556 additions and 113 deletions
Download patch file Download diff file Expand all files Collapse all files

373
rfcs/RFC-0001-llama-stack-assets/llama-stack-spec.html
View file

@ -21,7 +21,7 @@
"info": { "info": {
"title": "[DRAFT] Llama Stack Specification", "title": "[DRAFT] Llama Stack Specification",
"version": "0.0.1", "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.\n Generated at 2024-09-09 10:38:33.954536" "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.\n Generated at 2024-09-09 11:14:56.584501"
}, },
"servers": [ "servers": [
{ {
@ -51,7 +51,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/BatchChatCompletionRequest" "$ref": "#/components/schemas/BatchChatCompletionRequestWrapper"
} }
} }
}, },
@ -81,7 +81,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/BatchCompletionRequest" "$ref": "#/components/schemas/BatchCompletionRequestWrapper"
} }
} }
}, },
@ -157,7 +157,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/ChatCompletionRequest" "$ref": "#/components/schemas/ChatCompletionRequestWrapper"
} }
} }
}, },
@ -187,7 +187,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/CompletionRequest" "$ref": "#/components/schemas/CompletionRequestWrapper"
} }
} }
}, },
@ -277,7 +277,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/CreateAgenticSystemTurnRequest" "$ref": "#/components/schemas/CreateAgenticSystemTurnRequestWrapper"
} }
} }
}, },
@ -300,7 +300,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/CreateDatasetRequest" "$ref": "#/components/schemas/CreateDatasetRequestWrapper"
} }
} }
}, },
@ -330,7 +330,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/CreateExperimentRequest" "$ref": "#/components/schemas/CreateExperimentRequestWrapper"
} }
} }
}, },
@ -390,7 +390,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/CreateRunRequest" "$ref": "#/components/schemas/CreateRunRequestWrapper"
} }
} }
}, },
@ -572,7 +572,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/EvaluateQuestionAnsweringRequest" "$ref": "#/components/schemas/EvaluateQuestionAnsweringRequestWrapper"
} }
} }
}, },
@ -602,7 +602,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/EvaluateSummarizationRequest" "$ref": "#/components/schemas/EvaluateSummarizationRequestWrapper"
} }
} }
}, },
@ -632,7 +632,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/EvaluateTextGenerationRequest" "$ref": "#/components/schemas/EvaluateTextGenerationRequestWrapper"
} }
} }
}, },
@ -1024,7 +1024,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/GetLogsRequest" "$ref": "#/components/schemas/GetLogsRequestWrapper"
} }
} }
}, },
@ -1312,7 +1312,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/LogMessagesRequest" "$ref": "#/components/schemas/LogMessagesRequestWrapper"
} }
} }
}, },
@ -1335,7 +1335,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/LogMetricsRequest" "$ref": "#/components/schemas/LogMetricsRequestWrapper"
} }
} }
}, },
@ -1365,7 +1365,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/PreferenceOptimizeRequest" "$ref": "#/components/schemas/PreferenceOptimizeRequestWrapper"
} }
} }
}, },
@ -1425,7 +1425,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/RewardScoreRequest" "$ref": "#/components/schemas/RewardScoreRequestWrapper"
} }
} }
}, },
@ -1455,7 +1455,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/SupervisedFineTuneRequest" "$ref": "#/components/schemas/SupervisedFineTuneRequestWrapper"
} }
} }
}, },
@ -1485,7 +1485,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/SyntheticDataGenerateRequest" "$ref": "#/components/schemas/SyntheticDataGenerateRequestWrapper"
} }
} }
}, },
@ -1538,7 +1538,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UpdateExperimentRequest" "$ref": "#/components/schemas/UpdateExperimentRequestWrapper"
} }
} }
}, },
@ -1568,7 +1568,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UpdateRunRequest" "$ref": "#/components/schemas/UpdateRunRequestWrapper"
} }
} }
}, },
@ -1598,7 +1598,7 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/UploadArtifactRequest" "$ref": "#/components/schemas/UploadArtifactRequestWrapper"
} }
} }
}, },
@ -2020,6 +2020,18 @@
"content" "content"
] ]
}, },
"BatchChatCompletionRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/BatchChatCompletionRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"BatchChatCompletionResponse": { "BatchChatCompletionResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -2076,6 +2088,18 @@
"content_batch" "content_batch"
] ]
}, },
"BatchCompletionRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/BatchCompletionRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"BatchCompletionResponse": { "BatchCompletionResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -2174,6 +2198,18 @@
"messages" "messages"
] ]
}, },
"ChatCompletionRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/ChatCompletionRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"ChatCompletionResponseEvent": { "ChatCompletionResponseEvent": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -2316,6 +2352,18 @@
"content" "content"
] ]
}, },
"CompletionRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/CompletionRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"CompletionResponseStreamChunk": { "CompletionResponseStreamChunk": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -3181,7 +3229,7 @@
"mime_type" "mime_type"
] ]
}, },
"CreateAgenticSystemTurnRequest": { "CreateAgenticSystemTurnRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -3764,6 +3812,18 @@
"json" "json"
] ]
}, },
"CreateDatasetRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/CreateDatasetRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"CreateExperimentRequest": { "CreateExperimentRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -3801,6 +3861,18 @@
"name" "name"
] ]
}, },
"CreateExperimentRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/CreateExperimentRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"Experiment": { "Experiment": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4073,6 +4145,18 @@
"experiment_id" "experiment_id"
] ]
}, },
"CreateRunRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/CreateRunRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"Run": { "Run": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4285,6 +4369,18 @@
], ],
"title": "Request to evaluate question answering." "title": "Request to evaluate question answering."
}, },
"EvaluateQuestionAnsweringRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/EvaluateQuestionAnsweringRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"EvaluationJob": { "EvaluationJob": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4333,6 +4429,18 @@
], ],
"title": "Request to evaluate summarization." "title": "Request to evaluate summarization."
}, },
"EvaluateSummarizationRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/EvaluateSummarizationRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"EvaluateTextGenerationRequest": { "EvaluateTextGenerationRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4370,6 +4478,18 @@
], ],
"title": "Request to evaluate text generation." "title": "Request to evaluate text generation."
}, },
"EvaluateTextGenerationRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/EvaluateTextGenerationRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"GetAgenticSystemSessionRequest": { "GetAgenticSystemSessionRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4655,7 +4775,7 @@
"query" "query"
] ]
}, },
"GetLogsRequest": { "GetLogsRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -4926,6 +5046,18 @@
"logs" "logs"
] ]
}, },
"LogMessagesRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/LogMessagesRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"LogMetricsRequest": { "LogMetricsRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -4945,6 +5077,18 @@
"metrics" "metrics"
] ]
}, },
"LogMetricsRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/LogMetricsRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"DPOAlignmentConfig": { "DPOAlignmentConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5133,7 +5277,7 @@
"fsdp_cpu_offload" "fsdp_cpu_offload"
] ]
}, },
"PreferenceOptimizeRequest": { "PreferenceOptimizeRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -5313,7 +5457,7 @@
], ],
"title": "Request to score a reward function. A list of prompts and a list of responses per prompt." "title": "Request to score a reward function. A list of prompts and a list of responses per prompt."
}, },
"RewardScoreRequest": { "RewardScoreRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -5610,7 +5754,7 @@
"alpha" "alpha"
] ]
}, },
"SupervisedFineTuneRequest": { "SupervisedFineTuneRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -5667,7 +5811,7 @@
], ],
"title": "Request to generate synthetic data. A small batch of prompts and a filtering function" "title": "Request to generate synthetic data. A small batch of prompts and a filtering function"
}, },
"SyntheticDataGenerateRequest": { "SyntheticDataGenerateRequestWrapper": {
"type": "object", "type": "object",
"properties": { "properties": {
"request": { "request": {
@ -5779,6 +5923,18 @@
"experiment_id" "experiment_id"
] ]
}, },
"UpdateExperimentRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/UpdateExperimentRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"UpdateRunRequest": { "UpdateRunRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5823,6 +5979,18 @@
"run_id" "run_id"
] ]
}, },
"UpdateRunRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/UpdateRunRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
},
"UploadArtifactRequest": { "UploadArtifactRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5872,6 +6040,18 @@
"artifact_type", "artifact_type",
"content" "content"
] ]
},
"UploadArtifactRequestWrapper": {
"type": "object",
"properties": {
"request": {
"$ref": "#/components/schemas/UploadArtifactRequest"
}
},
"additionalProperties": false,
"required": [
"request"
]
} }
}, },
"responses": {} "responses": {}
@ -5888,29 +6068,29 @@
{ {
"name": "Telemetry" "name": "Telemetry"
}, },
{
"name": "Datasets"
},
{ {
"name": "PostTraining" "name": "PostTraining"
}, },
{
"name": "SyntheticDataGeneration"
},
{
"name": "Inference"
},
{
"name": "Evaluations"
},
{ {
"name": "BatchInference" "name": "BatchInference"
}, },
{
"name": "AgenticSystem"
},
{ {
"name": "RewardScoring" "name": "RewardScoring"
}, },
{ {
"name": "AgenticSystem" "name": "SyntheticDataGeneration"
},
{
"name": "Evaluations"
},
{
"name": "Inference"
},
{
"name": "Datasets"
}, },
{ {
"name": "BatchChatCompletionRequest", "name": "BatchChatCompletionRequest",
@ -5968,6 +6148,10 @@
"name": "UserMessage", "name": "UserMessage",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UserMessage\" />"
}, },
{
"name": "BatchChatCompletionRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionRequestWrapper\" />"
},
{ {
"name": "BatchChatCompletionResponse", "name": "BatchChatCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchChatCompletionResponse\" />"
@ -5976,6 +6160,10 @@
"name": "BatchCompletionRequest", "name": "BatchCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequest\" />"
}, },
{
"name": "BatchCompletionRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionRequestWrapper\" />"
},
{ {
"name": "BatchCompletionResponse", "name": "BatchCompletionResponse",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionResponse\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/BatchCompletionResponse\" />"
@ -5992,6 +6180,10 @@
"name": "ChatCompletionRequest", "name": "ChatCompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequest\" />"
}, },
{
"name": "ChatCompletionRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionRequestWrapper\" />"
},
{ {
"name": "ChatCompletionResponseEvent", "name": "ChatCompletionResponseEvent",
"description": "Chat completion response event.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEvent\" />" "description": "Chat completion response event.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/ChatCompletionResponseEvent\" />"
@ -6020,6 +6212,10 @@
"name": "CompletionRequest", "name": "CompletionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequest\" />"
}, },
{
"name": "CompletionRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CompletionRequestWrapper\" />"
},
{ {
"name": "CompletionResponseStreamChunk", "name": "CompletionResponseStreamChunk",
"description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />" "description": "streamed completion response.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/CompletionResponseStreamChunk\" />"
@ -6097,8 +6293,8 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Attachment\" />"
}, },
{ {
"name": "CreateAgenticSystemTurnRequest", "name": "CreateAgenticSystemTurnRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgenticSystemTurnRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateAgenticSystemTurnRequestWrapper\" />"
}, },
{ {
"name": "AgenticSystemTurnResponseEvent", "name": "AgenticSystemTurnResponseEvent",
@ -6168,10 +6364,18 @@
"name": "TrainEvalDatasetColumnType", "name": "TrainEvalDatasetColumnType",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainEvalDatasetColumnType\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainEvalDatasetColumnType\" />"
}, },
{
"name": "CreateDatasetRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateDatasetRequestWrapper\" />"
},
{ {
"name": "CreateExperimentRequest", "name": "CreateExperimentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateExperimentRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateExperimentRequest\" />"
}, },
{
"name": "CreateExperimentRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateExperimentRequestWrapper\" />"
},
{ {
"name": "Experiment", "name": "Experiment",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Experiment\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Experiment\" />"
@ -6192,6 +6396,10 @@
"name": "CreateRunRequest", "name": "CreateRunRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateRunRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateRunRequest\" />"
}, },
{
"name": "CreateRunRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/CreateRunRequestWrapper\" />"
},
{ {
"name": "Run", "name": "Run",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/Run\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Run\" />"
@ -6232,6 +6440,10 @@
"name": "EvaluateQuestionAnsweringRequest", "name": "EvaluateQuestionAnsweringRequest",
"description": "Request to evaluate question answering.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateQuestionAnsweringRequest\" />" "description": "Request to evaluate question answering.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateQuestionAnsweringRequest\" />"
}, },
{
"name": "EvaluateQuestionAnsweringRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateQuestionAnsweringRequestWrapper\" />"
},
{ {
"name": "EvaluationJob", "name": "EvaluationJob",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJob\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluationJob\" />"
@ -6240,10 +6452,18 @@
"name": "EvaluateSummarizationRequest", "name": "EvaluateSummarizationRequest",
"description": "Request to evaluate summarization.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateSummarizationRequest\" />" "description": "Request to evaluate summarization.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateSummarizationRequest\" />"
}, },
{
"name": "EvaluateSummarizationRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateSummarizationRequestWrapper\" />"
},
{ {
"name": "EvaluateTextGenerationRequest", "name": "EvaluateTextGenerationRequest",
"description": "Request to evaluate text generation.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateTextGenerationRequest\" />" "description": "Request to evaluate text generation.\n\n<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateTextGenerationRequest\" />"
}, },
{
"name": "EvaluateTextGenerationRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/EvaluateTextGenerationRequestWrapper\" />"
},
{ {
"name": "GetAgenticSystemSessionRequest", "name": "GetAgenticSystemSessionRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/GetAgenticSystemSessionRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GetAgenticSystemSessionRequest\" />"
@ -6289,8 +6509,8 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogSearchRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogSearchRequest\" />"
}, },
{ {
"name": "GetLogsRequest", "name": "GetLogsRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/GetLogsRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/GetLogsRequestWrapper\" />"
}, },
{ {
"name": "Log", "name": "Log",
@ -6332,10 +6552,18 @@
"name": "LogMessagesRequest", "name": "LogMessagesRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMessagesRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMessagesRequest\" />"
}, },
{
"name": "LogMessagesRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMessagesRequestWrapper\" />"
},
{ {
"name": "LogMetricsRequest", "name": "LogMetricsRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMetricsRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMetricsRequest\" />"
}, },
{
"name": "LogMetricsRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/LogMetricsRequestWrapper\" />"
},
{ {
"name": "DPOAlignmentConfig", "name": "DPOAlignmentConfig",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DPOAlignmentConfig\" />"
@ -6357,8 +6585,8 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/TrainingConfig\" />"
}, },
{ {
"name": "PreferenceOptimizeRequest", "name": "PreferenceOptimizeRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/PreferenceOptimizeRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PreferenceOptimizeRequestWrapper\" />"
}, },
{ {
"name": "QueryDocumentsRequest", "name": "QueryDocumentsRequest",
@ -6377,8 +6605,8 @@
"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\" />" "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": "RewardScoreRequest", "name": "RewardScoreRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoreRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RewardScoreRequestWrapper\" />"
}, },
{ {
"name": "RewardScoringResponse", "name": "RewardScoringResponse",
@ -6413,16 +6641,16 @@
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/QLoraFinetuningConfig\" />"
}, },
{ {
"name": "SupervisedFineTuneRequest", "name": "SupervisedFineTuneRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SupervisedFineTuneRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SupervisedFineTuneRequestWrapper\" />"
}, },
{ {
"name": "SyntheticDataGenerationRequest", "name": "SyntheticDataGenerationRequest",
"description": "Request to generate synthetic data. A small batch of prompts and a filtering function\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationRequest\" />" "description": "Request to generate synthetic data. A small batch of prompts and a filtering function\n\n<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerationRequest\" />"
}, },
{ {
"name": "SyntheticDataGenerateRequest", "name": "SyntheticDataGenerateRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerateRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SyntheticDataGenerateRequestWrapper\" />"
}, },
{ {
"name": "SyntheticDataGenerationResponse", "name": "SyntheticDataGenerationResponse",
@ -6436,13 +6664,25 @@
"name": "UpdateExperimentRequest", "name": "UpdateExperimentRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateExperimentRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateExperimentRequest\" />"
}, },
{
"name": "UpdateExperimentRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateExperimentRequestWrapper\" />"
},
{ {
"name": "UpdateRunRequest", "name": "UpdateRunRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateRunRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateRunRequest\" />"
}, },
{
"name": "UpdateRunRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UpdateRunRequestWrapper\" />"
},
{ {
"name": "UploadArtifactRequest", "name": "UploadArtifactRequest",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UploadArtifactRequest\" />" "description": "<SchemaDefinition schemaRef=\"#/components/schemas/UploadArtifactRequest\" />"
},
{
"name": "UploadArtifactRequestWrapper",
"description": "<SchemaDefinition schemaRef=\"#/components/schemas/UploadArtifactRequestWrapper\" />"
} }
], ],
"x-tagGroups": [ "x-tagGroups": [
@ -6480,8 +6720,10 @@
"ArtifactType", "ArtifactType",
"Attachment", "Attachment",
"BatchChatCompletionRequest", "BatchChatCompletionRequest",
"BatchChatCompletionRequestWrapper",
"BatchChatCompletionResponse", "BatchChatCompletionResponse",
"BatchCompletionRequest", "BatchCompletionRequest",
"BatchCompletionRequestWrapper",
"BatchCompletionResponse", "BatchCompletionResponse",
"BraveSearchToolDefinition", "BraveSearchToolDefinition",
"BuiltinShield", "BuiltinShield",
@ -6489,6 +6731,7 @@
"CancelEvaluationJobRequest", "CancelEvaluationJobRequest",
"CancelTrainingJobRequest", "CancelTrainingJobRequest",
"ChatCompletionRequest", "ChatCompletionRequest",
"ChatCompletionRequestWrapper",
"ChatCompletionResponseEvent", "ChatCompletionResponseEvent",
"ChatCompletionResponseEventType", "ChatCompletionResponseEventType",
"ChatCompletionResponseStreamChunk", "ChatCompletionResponseStreamChunk",
@ -6496,14 +6739,18 @@
"CodeInterpreterToolDefinition", "CodeInterpreterToolDefinition",
"CompletionMessage", "CompletionMessage",
"CompletionRequest", "CompletionRequest",
"CompletionRequestWrapper",
"CompletionResponseStreamChunk", "CompletionResponseStreamChunk",
"CreateAgenticSystemRequest", "CreateAgenticSystemRequest",
"CreateAgenticSystemSessionRequest", "CreateAgenticSystemSessionRequest",
"CreateAgenticSystemTurnRequest", "CreateAgenticSystemTurnRequestWrapper",
"CreateDatasetRequest", "CreateDatasetRequest",
"CreateDatasetRequestWrapper",
"CreateExperimentRequest", "CreateExperimentRequest",
"CreateExperimentRequestWrapper",
"CreateMemoryBankRequest", "CreateMemoryBankRequest",
"CreateRunRequest", "CreateRunRequest",
"CreateRunRequestWrapper",
"DPOAlignmentConfig", "DPOAlignmentConfig",
"DeleteAgenticSystemRequest", "DeleteAgenticSystemRequest",
"DeleteAgenticSystemSessionRequest", "DeleteAgenticSystemSessionRequest",
@ -6515,8 +6762,11 @@
"EmbeddingsRequest", "EmbeddingsRequest",
"EmbeddingsResponse", "EmbeddingsResponse",
"EvaluateQuestionAnsweringRequest", "EvaluateQuestionAnsweringRequest",
"EvaluateQuestionAnsweringRequestWrapper",
"EvaluateSummarizationRequest", "EvaluateSummarizationRequest",
"EvaluateSummarizationRequestWrapper",
"EvaluateTextGenerationRequest", "EvaluateTextGenerationRequest",
"EvaluateTextGenerationRequestWrapper",
"EvaluationJob", "EvaluationJob",
"EvaluationJobArtifactsResponse", "EvaluationJobArtifactsResponse",
"EvaluationJobLogStream", "EvaluationJobLogStream",
@ -6527,13 +6777,15 @@
"FunctionCallToolDefinition", "FunctionCallToolDefinition",
"GetAgenticSystemSessionRequest", "GetAgenticSystemSessionRequest",
"GetDocumentsRequest", "GetDocumentsRequest",
"GetLogsRequest", "GetLogsRequestWrapper",
"InferenceStep", "InferenceStep",
"InsertDocumentsRequest", "InsertDocumentsRequest",
"ListArtifactsRequest", "ListArtifactsRequest",
"Log", "Log",
"LogMessagesRequest", "LogMessagesRequest",
"LogMessagesRequestWrapper",
"LogMetricsRequest", "LogMetricsRequest",
"LogMetricsRequestWrapper",
"LogSearchRequest", "LogSearchRequest",
"LoraFinetuningConfig", "LoraFinetuningConfig",
"MemoryBank", "MemoryBank",
@ -6550,14 +6802,14 @@
"PostTrainingJobStatusResponse", "PostTrainingJobStatusResponse",
"PostTrainingRLHFRequest", "PostTrainingRLHFRequest",
"PostTrainingSFTRequest", "PostTrainingSFTRequest",
"PreferenceOptimizeRequest", "PreferenceOptimizeRequestWrapper",
"QLoraFinetuningConfig", "QLoraFinetuningConfig",
"QueryDocumentsRequest", "QueryDocumentsRequest",
"QueryDocumentsResponse", "QueryDocumentsResponse",
"RLHFAlgorithm", "RLHFAlgorithm",
"RestAPIExecutionConfig", "RestAPIExecutionConfig",
"RestAPIMethod", "RestAPIMethod",
"RewardScoreRequest", "RewardScoreRequestWrapper",
"RewardScoringRequest", "RewardScoringRequest",
"RewardScoringResponse", "RewardScoringResponse",
"Run", "Run",
@ -6570,8 +6822,8 @@
"ShieldDefinition", "ShieldDefinition",
"ShieldResponse", "ShieldResponse",
"StopReason", "StopReason",
"SupervisedFineTuneRequest", "SupervisedFineTuneRequestWrapper",
"SyntheticDataGenerateRequest", "SyntheticDataGenerateRequestWrapper",
"SyntheticDataGenerationRequest", "SyntheticDataGenerationRequest",
"SyntheticDataGenerationResponse", "SyntheticDataGenerationResponse",
"SystemMessage", "SystemMessage",
@ -6593,8 +6845,11 @@
"URL", "URL",
"UpdateDocumentsRequest", "UpdateDocumentsRequest",
"UpdateExperimentRequest", "UpdateExperimentRequest",
"UpdateExperimentRequestWrapper",
"UpdateRunRequest", "UpdateRunRequest",
"UpdateRunRequestWrapper",
"UploadArtifactRequest", "UploadArtifactRequest",
"UploadArtifactRequestWrapper",
"UserMessage", "UserMessage",
"WolframAlphaToolDefinition" "WolframAlphaToolDefinition"
] ]

283
rfcs/RFC-0001-llama-stack-assets/llama-stack-spec.yaml
View file

@ -566,6 +566,14 @@ components:
- model - model
- messages_batch - messages_batch
type: object type: object
BatchChatCompletionRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/BatchChatCompletionRequest'
required:
- request
type: object
BatchChatCompletionResponse: BatchChatCompletionResponse:
additionalProperties: false additionalProperties: false
properties: properties:
@ -601,6 +609,14 @@ components:
- model - model
- content_batch - content_batch
type: object type: object
BatchCompletionRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/BatchCompletionRequest'
required:
- request
type: object
BatchCompletionResponse: BatchCompletionResponse:
additionalProperties: false additionalProperties: false
properties: properties:
@ -696,6 +712,14 @@ components:
- model - model
- messages - messages
type: object type: object
ChatCompletionRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/ChatCompletionRequest'
required:
- request
type: object
ChatCompletionResponseEvent: ChatCompletionResponseEvent:
additionalProperties: false additionalProperties: false
properties: properties:
@ -804,6 +828,14 @@ components:
- model - model
- content - content
type: object type: object
CompletionRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/CompletionRequest'
required:
- request
type: object
CompletionResponseStreamChunk: CompletionResponseStreamChunk:
additionalProperties: false additionalProperties: false
properties: properties:
@ -838,7 +870,7 @@ components:
- agent_id - agent_id
- session_name - session_name
type: object type: object
CreateAgenticSystemTurnRequest: CreateAgenticSystemTurnRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -858,6 +890,14 @@ components:
- dataset - dataset
title: Request to create a dataset. title: Request to create a dataset.
type: object type: object
CreateDatasetRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/CreateDatasetRequest'
required:
- request
type: object
CreateExperimentRequest: CreateExperimentRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -876,6 +916,14 @@ components:
required: required:
- name - name
type: object type: object
CreateExperimentRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/CreateExperimentRequest'
required:
- request
type: object
CreateMemoryBankRequest: CreateMemoryBankRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -947,6 +995,14 @@ components:
required: required:
- experiment_id - experiment_id
type: object type: object
CreateRunRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/CreateRunRequest'
required:
- request
type: object
DPOAlignmentConfig: DPOAlignmentConfig:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1112,6 +1168,14 @@ components:
- metrics - metrics
title: Request to evaluate question answering. title: Request to evaluate question answering.
type: object type: object
EvaluateQuestionAnsweringRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/EvaluateQuestionAnsweringRequest'
required:
- request
type: object
EvaluateSummarizationRequest: EvaluateSummarizationRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1138,6 +1202,14 @@ components:
- metrics - metrics
title: Request to evaluate summarization. title: Request to evaluate summarization.
type: object type: object
EvaluateSummarizationRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/EvaluateSummarizationRequest'
required:
- request
type: object
EvaluateTextGenerationRequest: EvaluateTextGenerationRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1165,6 +1237,14 @@ components:
- metrics - metrics
title: Request to evaluate text generation. title: Request to evaluate text generation.
type: object type: object
EvaluateTextGenerationRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/EvaluateTextGenerationRequest'
required:
- request
type: object
EvaluationJob: EvaluationJob:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1293,7 +1373,7 @@ components:
required: required:
- document_ids - document_ids
type: object type: object
GetLogsRequest: GetLogsRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -1386,6 +1466,14 @@ components:
required: required:
- logs - logs
type: object type: object
LogMessagesRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/LogMessagesRequest'
required:
- request
type: object
LogMetricsRequest: LogMetricsRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1399,6 +1487,14 @@ components:
- run_id - run_id
- metrics - metrics
type: object type: object
LogMetricsRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/LogMetricsRequest'
required:
- request
type: object
LogSearchRequest: LogSearchRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -1812,7 +1908,7 @@ components:
- logger_config - logger_config
title: Request to finetune a model. title: Request to finetune a model.
type: object type: object
PreferenceOptimizeRequest: PreferenceOptimizeRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -1932,7 +2028,7 @@ components:
- PUT - PUT
- DELETE - DELETE
type: string type: string
RewardScoreRequest: RewardScoreRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -2148,7 +2244,7 @@ components:
- end_of_message - end_of_message
- out_of_tokens - out_of_tokens
type: string type: string
SupervisedFineTuneRequest: SupervisedFineTuneRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -2156,7 +2252,7 @@ components:
required: required:
- request - request
type: object type: object
SyntheticDataGenerateRequest: SyntheticDataGenerateRequestWrapper:
additionalProperties: false additionalProperties: false
properties: properties:
request: request:
@ -2561,6 +2657,14 @@ components:
required: required:
- experiment_id - experiment_id
type: object type: object
UpdateExperimentRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/UpdateExperimentRequest'
required:
- request
type: object
UpdateRunRequest: UpdateRunRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2584,6 +2688,14 @@ components:
required: required:
- run_id - run_id
type: object type: object
UpdateRunRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/UpdateRunRequest'
required:
- request
type: object
UploadArtifactRequest: UploadArtifactRequest:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2612,6 +2724,14 @@ components:
- artifact_type - artifact_type
- content - content
type: object type: object
UploadArtifactRequestWrapper:
additionalProperties: false
properties:
request:
$ref: '#/components/schemas/UploadArtifactRequest'
required:
- request
type: object
UserMessage: UserMessage:
additionalProperties: false additionalProperties: false
properties: properties:
@ -2657,7 +2777,7 @@ info:
description: "This is the specification of the llama stack that provides\n \ description: "This is the specification of the llama stack that provides\n \
\ a set of endpoints and their corresponding interfaces that are tailored\ \ a set of endpoints and their corresponding interfaces that are tailored\
\ to\n best leverage Llama Models. The specification is still in\ \ to\n best leverage Llama Models. The specification is still in\
\ draft and subject to change.\n Generated at 2024-09-09 10:38:33.954536" \ draft and subject to change.\n Generated at 2024-09-09 11:14:56.584501"
title: '[DRAFT] Llama Stack Specification' title: '[DRAFT] Llama Stack Specification'
version: 0.0.1 version: 0.0.1
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
@ -2789,7 +2909,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CreateAgenticSystemTurnRequest' $ref: '#/components/schemas/CreateAgenticSystemTurnRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -2846,7 +2966,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/BatchChatCompletionRequest' $ref: '#/components/schemas/BatchChatCompletionRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -2864,7 +2984,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/BatchCompletionRequest' $ref: '#/components/schemas/BatchCompletionRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -2882,7 +3002,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CreateDatasetRequest' $ref: '#/components/schemas/CreateDatasetRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3004,7 +3124,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EvaluateQuestionAnsweringRequest' $ref: '#/components/schemas/EvaluateQuestionAnsweringRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3022,7 +3142,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EvaluateSummarizationRequest' $ref: '#/components/schemas/EvaluateSummarizationRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3040,7 +3160,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/EvaluateTextGenerationRequest' $ref: '#/components/schemas/EvaluateTextGenerationRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3076,7 +3196,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/UploadArtifactRequest' $ref: '#/components/schemas/UploadArtifactRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3094,7 +3214,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CreateExperimentRequest' $ref: '#/components/schemas/CreateExperimentRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3112,7 +3232,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CreateRunRequest' $ref: '#/components/schemas/CreateRunRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3159,7 +3279,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/UpdateExperimentRequest' $ref: '#/components/schemas/UpdateExperimentRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3177,7 +3297,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ChatCompletionRequest' $ref: '#/components/schemas/ChatCompletionRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3195,7 +3315,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CompletionRequest' $ref: '#/components/schemas/CompletionRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3231,7 +3351,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/GetLogsRequest' $ref: '#/components/schemas/GetLogsRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3249,7 +3369,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/LogMessagesRequest' $ref: '#/components/schemas/LogMessagesRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3490,7 +3610,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/PreferenceOptimizeRequest' $ref: '#/components/schemas/PreferenceOptimizeRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3508,7 +3628,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SupervisedFineTuneRequest' $ref: '#/components/schemas/SupervisedFineTuneRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3526,7 +3646,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/RewardScoreRequest' $ref: '#/components/schemas/RewardScoreRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3544,7 +3664,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/LogMetricsRequest' $ref: '#/components/schemas/LogMetricsRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3575,7 +3695,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/UpdateRunRequest' $ref: '#/components/schemas/UpdateRunRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3593,7 +3713,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SyntheticDataGenerateRequest' $ref: '#/components/schemas/SyntheticDataGenerateRequestWrapper'
required: true required: true
responses: responses:
'200': '200':
@ -3611,14 +3731,14 @@ servers:
tags: tags:
- name: Memory - name: Memory
- name: Telemetry - name: Telemetry
- name: Datasets
- name: PostTraining - name: PostTraining
- name: SyntheticDataGeneration
- name: Inference
- name: Evaluations
- name: BatchInference - name: BatchInference
- name: RewardScoring
- name: AgenticSystem - name: AgenticSystem
- name: RewardScoring
- name: SyntheticDataGeneration
- name: Evaluations
- name: Inference
- name: Datasets
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequest"
/> />
name: BatchChatCompletionRequest name: BatchChatCompletionRequest
@ -3661,12 +3781,18 @@ tags:
name: ToolResponseMessage name: ToolResponseMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" /> - description: <SchemaDefinition schemaRef="#/components/schemas/UserMessage" />
name: UserMessage name: UserMessage
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionRequestWrapper"
/>
name: BatchChatCompletionRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/BatchChatCompletionResponse"
/> />
name: BatchChatCompletionResponse name: BatchChatCompletionResponse
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequest"
/> />
name: BatchCompletionRequest name: BatchCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionRequestWrapper"
/>
name: BatchCompletionRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse" - description: <SchemaDefinition schemaRef="#/components/schemas/BatchCompletionResponse"
/> />
name: BatchCompletionResponse name: BatchCompletionResponse
@ -3679,6 +3805,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequest"
/> />
name: ChatCompletionRequest name: ChatCompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/ChatCompletionRequestWrapper"
/>
name: ChatCompletionRequestWrapper
- description: 'Chat completion response event. - description: 'Chat completion response event.
@ -3704,6 +3833,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequest"
/> />
name: CompletionRequest name: CompletionRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CompletionRequestWrapper"
/>
name: CompletionRequestWrapper
- description: 'streamed completion response. - description: 'streamed completion response.
@ -3759,9 +3891,9 @@ tags:
name: AgenticSystemTurnCreateRequest name: AgenticSystemTurnCreateRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/Attachment" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Attachment" />
name: Attachment name: Attachment
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgenticSystemTurnRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/CreateAgenticSystemTurnRequestWrapper"
/> />
name: CreateAgenticSystemTurnRequest name: CreateAgenticSystemTurnRequestWrapper
- description: 'Streamed agent execution response. - description: 'Streamed agent execution response.
@ -3818,9 +3950,15 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/TrainEvalDatasetColumnType" - description: <SchemaDefinition schemaRef="#/components/schemas/TrainEvalDatasetColumnType"
/> />
name: TrainEvalDatasetColumnType name: TrainEvalDatasetColumnType
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateDatasetRequestWrapper"
/>
name: CreateDatasetRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateExperimentRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/CreateExperimentRequest"
/> />
name: CreateExperimentRequest name: CreateExperimentRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateExperimentRequestWrapper"
/>
name: CreateExperimentRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/Experiment" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Experiment" />
name: Experiment name: Experiment
- description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentStatus" - description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentStatus"
@ -3834,6 +3972,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateRunRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/CreateRunRequest"
/> />
name: CreateRunRequest name: CreateRunRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/CreateRunRequestWrapper"
/>
name: CreateRunRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/Run" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Run" />
name: Run name: Run
- description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgenticSystemRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/DeleteAgenticSystemRequest"
@ -3868,6 +4009,9 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/EvaluateQuestionAnsweringRequest" <SchemaDefinition schemaRef="#/components/schemas/EvaluateQuestionAnsweringRequest"
/>' />'
name: EvaluateQuestionAnsweringRequest name: EvaluateQuestionAnsweringRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateQuestionAnsweringRequestWrapper"
/>
name: EvaluateQuestionAnsweringRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluationJob" /> - description: <SchemaDefinition schemaRef="#/components/schemas/EvaluationJob" />
name: EvaluationJob name: EvaluationJob
- description: 'Request to evaluate summarization. - description: 'Request to evaluate summarization.
@ -3876,12 +4020,18 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/EvaluateSummarizationRequest" <SchemaDefinition schemaRef="#/components/schemas/EvaluateSummarizationRequest"
/>' />'
name: EvaluateSummarizationRequest name: EvaluateSummarizationRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateSummarizationRequestWrapper"
/>
name: EvaluateSummarizationRequestWrapper
- description: 'Request to evaluate text generation. - description: 'Request to evaluate text generation.
<SchemaDefinition schemaRef="#/components/schemas/EvaluateTextGenerationRequest" <SchemaDefinition schemaRef="#/components/schemas/EvaluateTextGenerationRequest"
/>' />'
name: EvaluateTextGenerationRequest name: EvaluateTextGenerationRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/EvaluateTextGenerationRequestWrapper"
/>
name: EvaluateTextGenerationRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/GetAgenticSystemSessionRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/GetAgenticSystemSessionRequest"
/> />
name: GetAgenticSystemSessionRequest name: GetAgenticSystemSessionRequest
@ -3918,8 +4068,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/LogSearchRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/LogSearchRequest"
/> />
name: LogSearchRequest name: LogSearchRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/GetLogsRequest" /> - description: <SchemaDefinition schemaRef="#/components/schemas/GetLogsRequestWrapper"
name: GetLogsRequest />
name: GetLogsRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/Log" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Log" />
name: Log name: Log
- description: <SchemaDefinition schemaRef="#/components/schemas/Metric" /> - description: <SchemaDefinition schemaRef="#/components/schemas/Metric" />
@ -3956,9 +4107,15 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/LogMessagesRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/LogMessagesRequest"
/> />
name: LogMessagesRequest name: LogMessagesRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/LogMessagesRequestWrapper"
/>
name: LogMessagesRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/LogMetricsRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/LogMetricsRequest"
/> />
name: LogMetricsRequest name: LogMetricsRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/LogMetricsRequestWrapper"
/>
name: LogMetricsRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/DPOAlignmentConfig"
/> />
name: DPOAlignmentConfig name: DPOAlignmentConfig
@ -3974,9 +4131,9 @@ tags:
name: RLHFAlgorithm name: RLHFAlgorithm
- description: <SchemaDefinition schemaRef="#/components/schemas/TrainingConfig" /> - description: <SchemaDefinition schemaRef="#/components/schemas/TrainingConfig" />
name: TrainingConfig name: TrainingConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/PreferenceOptimizeRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/PreferenceOptimizeRequestWrapper"
/> />
name: PreferenceOptimizeRequest name: PreferenceOptimizeRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/QueryDocumentsRequest"
/> />
name: QueryDocumentsRequest name: QueryDocumentsRequest
@ -3992,9 +4149,9 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/RewardScoringRequest" />' <SchemaDefinition schemaRef="#/components/schemas/RewardScoringRequest" />'
name: RewardScoringRequest name: RewardScoringRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/RewardScoreRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/RewardScoreRequestWrapper"
/> />
name: RewardScoreRequest name: RewardScoreRequestWrapper
- description: 'Response from the reward scoring. Batch of (prompt, response, score) - description: 'Response from the reward scoring. Batch of (prompt, response, score)
tuples that pass the threshold. tuples that pass the threshold.
@ -4023,9 +4180,9 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/QLoraFinetuningConfig" - description: <SchemaDefinition schemaRef="#/components/schemas/QLoraFinetuningConfig"
/> />
name: QLoraFinetuningConfig name: QLoraFinetuningConfig
- description: <SchemaDefinition schemaRef="#/components/schemas/SupervisedFineTuneRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/SupervisedFineTuneRequestWrapper"
/> />
name: SupervisedFineTuneRequest name: SupervisedFineTuneRequestWrapper
- description: 'Request to generate synthetic data. A small batch of prompts and a - description: 'Request to generate synthetic data. A small batch of prompts and a
filtering function filtering function
@ -4033,9 +4190,9 @@ tags:
<SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationRequest" <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerationRequest"
/>' />'
name: SyntheticDataGenerationRequest name: SyntheticDataGenerationRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/SyntheticDataGenerateRequestWrapper"
/> />
name: SyntheticDataGenerateRequest name: SyntheticDataGenerateRequestWrapper
- description: 'Response from the synthetic data generation. Batch of (prompt, response, - description: 'Response from the synthetic data generation. Batch of (prompt, response,
score) tuples that pass the threshold. score) tuples that pass the threshold.
@ -4049,12 +4206,21 @@ tags:
- description: <SchemaDefinition schemaRef="#/components/schemas/UpdateExperimentRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/UpdateExperimentRequest"
/> />
name: UpdateExperimentRequest name: UpdateExperimentRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UpdateExperimentRequestWrapper"
/>
name: UpdateExperimentRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/UpdateRunRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/UpdateRunRequest"
/> />
name: UpdateRunRequest name: UpdateRunRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UpdateRunRequestWrapper"
/>
name: UpdateRunRequestWrapper
- description: <SchemaDefinition schemaRef="#/components/schemas/UploadArtifactRequest" - description: <SchemaDefinition schemaRef="#/components/schemas/UploadArtifactRequest"
/> />
name: UploadArtifactRequest name: UploadArtifactRequest
- description: <SchemaDefinition schemaRef="#/components/schemas/UploadArtifactRequestWrapper"
/>
name: UploadArtifactRequestWrapper
x-tagGroups: x-tagGroups:
- name: Operations - name: Operations
tags: tags:
@ -4086,8 +4252,10 @@ x-tagGroups:
- ArtifactType - ArtifactType
- Attachment - Attachment
- BatchChatCompletionRequest - BatchChatCompletionRequest
- BatchChatCompletionRequestWrapper
- BatchChatCompletionResponse - BatchChatCompletionResponse
- BatchCompletionRequest - BatchCompletionRequest
- BatchCompletionRequestWrapper
- BatchCompletionResponse - BatchCompletionResponse
- BraveSearchToolDefinition - BraveSearchToolDefinition
- BuiltinShield - BuiltinShield
@ -4095,6 +4263,7 @@ x-tagGroups:
- CancelEvaluationJobRequest - CancelEvaluationJobRequest
- CancelTrainingJobRequest - CancelTrainingJobRequest
- ChatCompletionRequest - ChatCompletionRequest
- ChatCompletionRequestWrapper
- ChatCompletionResponseEvent - ChatCompletionResponseEvent
- ChatCompletionResponseEventType - ChatCompletionResponseEventType
- ChatCompletionResponseStreamChunk - ChatCompletionResponseStreamChunk
@ -4102,14 +4271,18 @@ x-tagGroups:
- CodeInterpreterToolDefinition - CodeInterpreterToolDefinition
- CompletionMessage - CompletionMessage
- CompletionRequest - CompletionRequest
- CompletionRequestWrapper
- CompletionResponseStreamChunk - CompletionResponseStreamChunk
- CreateAgenticSystemRequest - CreateAgenticSystemRequest
- CreateAgenticSystemSessionRequest - CreateAgenticSystemSessionRequest
- CreateAgenticSystemTurnRequest - CreateAgenticSystemTurnRequestWrapper
- CreateDatasetRequest - CreateDatasetRequest
- CreateDatasetRequestWrapper
- CreateExperimentRequest - CreateExperimentRequest
- CreateExperimentRequestWrapper
- CreateMemoryBankRequest - CreateMemoryBankRequest
- CreateRunRequest - CreateRunRequest
- CreateRunRequestWrapper
- DPOAlignmentConfig - DPOAlignmentConfig
- DeleteAgenticSystemRequest - DeleteAgenticSystemRequest
- DeleteAgenticSystemSessionRequest - DeleteAgenticSystemSessionRequest
@ -4121,8 +4294,11 @@ x-tagGroups:
- EmbeddingsRequest - EmbeddingsRequest
- EmbeddingsResponse - EmbeddingsResponse
- EvaluateQuestionAnsweringRequest - EvaluateQuestionAnsweringRequest
- EvaluateQuestionAnsweringRequestWrapper
- EvaluateSummarizationRequest - EvaluateSummarizationRequest
- EvaluateSummarizationRequestWrapper
- EvaluateTextGenerationRequest - EvaluateTextGenerationRequest
- EvaluateTextGenerationRequestWrapper
- EvaluationJob - EvaluationJob
- EvaluationJobArtifactsResponse - EvaluationJobArtifactsResponse
- EvaluationJobLogStream - EvaluationJobLogStream
@ -4133,13 +4309,15 @@ x-tagGroups:
- FunctionCallToolDefinition - FunctionCallToolDefinition
- GetAgenticSystemSessionRequest - GetAgenticSystemSessionRequest
- GetDocumentsRequest - GetDocumentsRequest
- GetLogsRequest - GetLogsRequestWrapper
- InferenceStep - InferenceStep
- InsertDocumentsRequest - InsertDocumentsRequest
- ListArtifactsRequest - ListArtifactsRequest
- Log - Log
- LogMessagesRequest - LogMessagesRequest
- LogMessagesRequestWrapper
- LogMetricsRequest - LogMetricsRequest
- LogMetricsRequestWrapper
- LogSearchRequest - LogSearchRequest
- LoraFinetuningConfig - LoraFinetuningConfig
- MemoryBank - MemoryBank
@ -4156,14 +4334,14 @@ x-tagGroups:
- PostTrainingJobStatusResponse - PostTrainingJobStatusResponse
- PostTrainingRLHFRequest - PostTrainingRLHFRequest
- PostTrainingSFTRequest - PostTrainingSFTRequest
- PreferenceOptimizeRequest - PreferenceOptimizeRequestWrapper
- QLoraFinetuningConfig - QLoraFinetuningConfig
- QueryDocumentsRequest - QueryDocumentsRequest
- QueryDocumentsResponse - QueryDocumentsResponse
- RLHFAlgorithm - RLHFAlgorithm
- RestAPIExecutionConfig - RestAPIExecutionConfig
- RestAPIMethod - RestAPIMethod
- RewardScoreRequest - RewardScoreRequestWrapper
- RewardScoringRequest - RewardScoringRequest
- RewardScoringResponse - RewardScoringResponse
- Run - Run
@ -4176,8 +4354,8 @@ x-tagGroups:
- ShieldDefinition - ShieldDefinition
- ShieldResponse - ShieldResponse
- StopReason - StopReason
- SupervisedFineTuneRequest - SupervisedFineTuneRequestWrapper
- SyntheticDataGenerateRequest - SyntheticDataGenerateRequestWrapper
- SyntheticDataGenerationRequest - SyntheticDataGenerationRequest
- SyntheticDataGenerationResponse - SyntheticDataGenerationResponse
- SystemMessage - SystemMessage
@ -4199,7 +4377,10 @@ x-tagGroups:
- URL - URL
- UpdateDocumentsRequest - UpdateDocumentsRequest
- UpdateExperimentRequest - UpdateExperimentRequest
- UpdateExperimentRequestWrapper
- UpdateRunRequest - UpdateRunRequest
- UpdateRunRequestWrapper
- UploadArtifactRequest - UploadArtifactRequest
- UploadArtifactRequestWrapper
- UserMessage - UserMessage
- WolframAlphaToolDefinition - WolframAlphaToolDefinition

13
rfcs/openapi_generator/pyopenapi/generator.py
View file

@ -470,9 +470,16 @@ class Generator:
request_name, request_type = first request_name, request_type = first
from dataclasses import make_dataclass from dataclasses import make_dataclass
op_name = "".join(word.capitalize() for word in op.name.split("_"))
request_name = f"{op_name}Request" if len(op.request_params) == 1 and "Request" in first[1].__name__:
request_type = make_dataclass(request_name, op.request_params) # TODO(ashwin): Undo the "Request" hack and this entire block eventually
op_name = "".join(word.capitalize() for word in op.name.split("_"))
request_name = f"{op_name}RequestWrapper"
request_type = make_dataclass(request_name, op.request_params)
else:
op_name = "".join(word.capitalize() for word in op.name.split("_"))
request_name = f"{op_name}Request"
request_type = make_dataclass(request_name, op.request_params)
requestBody = RequestBody( requestBody = RequestBody(
content={ content={